다음을 통해 공유

Microsoft.ApiManagement 서비스/api 2017-03-01

  • 아티클

Bicep 리소스 정의

다음을 대상으로 하는 작업을 사용하여 서비스/api 리소스 유형을 배포할 수 있습니다.

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/api 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2017-03-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    apiRevision: 'string'
    apiVersion: 'string'
    apiVersionSet: {
      properties: {
        description: 'string'
        displayName: 'string'
        versionHeaderName: 'string'
        versioningScheme: 'string'
        versionQueryName: 'string'
      }
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
    }
    contentFormat: 'string'
    contentValue: 'string'
    description: 'string'
    displayName: 'string'
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    type: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

속성 값

ApiCreateOrUpdatePropertiesOrApiContractProperties

이름 묘사 값
apiRevision API의 수정 버전을 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 생성됩니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
apiVersion API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다. 문자열

제약 조건:
최대 길이 =
apiVersionSet Api 버전 집합 계약 세부 정보입니다. ApiVersionSetContract
apiVersionSetId 관련 ApiVersionSet에 대한 리소스 식별자입니다. 문자열
authenticationSettings 이 API에 포함된 인증 설정의 컬렉션입니다. AuthenticationSettingsContract
contentFormat API를 가져오는 콘텐츠의 형식입니다. 'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
contentValue API를 가져올 때의 콘텐츠 값입니다. 문자열
묘사 API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. 문자열
displayName API 이름입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
길 이 API 및 API Management 서비스 인스턴스 내의 모든 리소스 경로를 고유하게 식별하는 상대 URL입니다. 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기본 URL에 추가되어 이 API에 대한 공용 URL을 형성합니다. 문자열

제약 조건:
최대 길이 = (필수)
프로토콜 이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다. 다음 중 어느 것을 포함하는 문자열 배열:
'http'
'https'
serviceUrl 이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
subscriptionKeyParameterNames API를 사용할 수 있는 프로토콜입니다. SubscriptionKeyParameterNamesContract
형 API의 유형입니다. 'http'
'soap'
wsdlSelector WSDL의 가져오기를 문서의 하위 집합으로 제한하는 조건입니다. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

이름 묘사 값
wsdlEndpointName WSDL에서 가져올 엔드포인트(포트)의 이름 문자열
wsdlServiceName WSDL에서 가져올 서비스 이름 문자열

ApiVersionSetContract

이름 묘사 값
속성 API 버전 집합의 속성입니다. ApiVersionSetContractProperties

ApiVersionSetContractProperties

이름 묘사 값
묘사 API 버전 집합에 대한 설명입니다. 문자열
displayName API 버전 집합의 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1(필수)
versionHeaderName versioningScheme이 header설정된 경우 API 버전을 나타내는 HTTP 헤더 매개 변수의 이름입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
versioningScheme HTTP 요청에 API 버전 식별자를 배치할 위치를 결정하는 값입니다. 'Header'
'Query'
'Segment'(필수)
versionQueryName versioningScheme이 query설정된 경우 API 버전을 나타내는 쿼리 매개 변수의 이름입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1

AuthenticationSettingsContract

이름 묘사 값
oAuth2 OAuth2 인증 설정 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/api

이름 묘사 값
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
패턴 = ^[^*#&+:<>?]+$(필수)
부모 Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다.

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.		 형식의 리소스에 대한 기호 이름: 서비스
속성 업데이트 속성의 API 엔터티 만들기 ApiCreateOrUpdatePropertiesOrApiContractProperties

OAuth2AuthenticationSettingsContract

이름 묘사 값
authorizationServerId OAuth 권한 부여 서버 식별자입니다. 문자열
범위 작업 범위입니다. 문자열

SubscriptionKeyParameterNamesContract

이름 묘사 값
머리글 구독 키 헤더 이름입니다. 문자열
쿼리 구독 키 쿼리 문자열 매개 변수 이름입니다. 문자열

ARM 템플릿 리소스 정의

다음을 대상으로 하는 작업을 사용하여 서비스/api 리소스 유형을 배포할 수 있습니다.

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/api 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2017-03-01",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiVersion": "string",
    "apiVersionSet": {
      "properties": {
        "description": "string",
        "displayName": "string",
        "versionHeaderName": "string",
        "versioningScheme": "string",
        "versionQueryName": "string"
      }
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      }
    },
    "contentFormat": "string",
    "contentValue": "string",
    "description": "string",
    "displayName": "string",
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "type": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

속성 값

ApiCreateOrUpdatePropertiesOrApiContractProperties

이름 묘사 값
apiRevision API의 수정 버전을 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 생성됩니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
apiVersion API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다. 문자열

제약 조건:
최대 길이 =
apiVersionSet Api 버전 집합 계약 세부 정보입니다. ApiVersionSetContract
apiVersionSetId 관련 ApiVersionSet에 대한 리소스 식별자입니다. 문자열
authenticationSettings 이 API에 포함된 인증 설정의 컬렉션입니다. AuthenticationSettingsContract
contentFormat API를 가져오는 콘텐츠의 형식입니다. 'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
contentValue API를 가져올 때의 콘텐츠 값입니다. 문자열
묘사 API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. 문자열
displayName API 이름입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
길 이 API 및 API Management 서비스 인스턴스 내의 모든 리소스 경로를 고유하게 식별하는 상대 URL입니다. 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기본 URL에 추가되어 이 API에 대한 공용 URL을 형성합니다. 문자열

제약 조건:
최대 길이 = (필수)
프로토콜 이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다. 다음 중 어느 것을 포함하는 문자열 배열:
'http'
'https'
serviceUrl 이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
subscriptionKeyParameterNames API를 사용할 수 있는 프로토콜입니다. SubscriptionKeyParameterNamesContract
형 API의 유형입니다. 'http'
'soap'
wsdlSelector WSDL의 가져오기를 문서의 하위 집합으로 제한하는 조건입니다. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

이름 묘사 값
wsdlEndpointName WSDL에서 가져올 엔드포인트(포트)의 이름 문자열
wsdlServiceName WSDL에서 가져올 서비스 이름 문자열

ApiVersionSetContract

이름 묘사 값
속성 API 버전 집합의 속성입니다. ApiVersionSetContractProperties

ApiVersionSetContractProperties

이름 묘사 값
묘사 API 버전 집합에 대한 설명입니다. 문자열
displayName API 버전 집합의 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1(필수)
versionHeaderName versioningScheme이 header설정된 경우 API 버전을 나타내는 HTTP 헤더 매개 변수의 이름입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
versioningScheme HTTP 요청에 API 버전 식별자를 배치할 위치를 결정하는 값입니다. 'Header'
'Query'
'Segment'(필수)
versionQueryName versioningScheme이 query설정된 경우 API 버전을 나타내는 쿼리 매개 변수의 이름입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1

AuthenticationSettingsContract

이름 묘사 값
oAuth2 OAuth2 인증 설정 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/api

이름 묘사 값
apiVersion api 버전 '2017-03-01'
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
패턴 = ^[^*#&+:<>?]+$(필수)
속성 업데이트 속성의 API 엔터티 만들기 ApiCreateOrUpdatePropertiesOrApiContractProperties
형 리소스 종류 'Microsoft.ApiManagement/service/api'

OAuth2AuthenticationSettingsContract

이름 묘사 값
authorizationServerId OAuth 권한 부여 서버 식별자입니다. 문자열
범위 작업 범위입니다. 문자열

SubscriptionKeyParameterNamesContract

이름 묘사 값
머리글 구독 키 헤더 이름입니다. 문자열
쿼리 구독 키 쿼리 문자열 매개 변수 이름입니다. 문자열

Terraform(AzAPI 공급자) 리소스 정의

다음을 대상으로 하는 작업을 사용하여 서비스/api 리소스 유형을 배포할 수 있습니다.

  • 리소스 그룹

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/api 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2017-03-01"
  name = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiVersion = "string"
      apiVersionSet = {
        properties = {
          description = "string"
          displayName = "string"
          versionHeaderName = "string"
          versioningScheme = "string"
          versionQueryName = "string"
        }
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
      }
      contentFormat = "string"
      contentValue = "string"
      description = "string"
      displayName = "string"
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      type = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

속성 값

ApiCreateOrUpdatePropertiesOrApiContractProperties

이름 묘사 값
apiRevision API의 수정 버전을 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 생성됩니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
apiVersion API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다. 문자열

제약 조건:
최대 길이 =
apiVersionSet Api 버전 집합 계약 세부 정보입니다. ApiVersionSetContract
apiVersionSetId 관련 ApiVersionSet에 대한 리소스 식별자입니다. 문자열
authenticationSettings 이 API에 포함된 인증 설정의 컬렉션입니다. AuthenticationSettingsContract
contentFormat API를 가져오는 콘텐츠의 형식입니다. 'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
contentValue API를 가져올 때의 콘텐츠 값입니다. 문자열
묘사 API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. 문자열
displayName API 이름입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
길 이 API 및 API Management 서비스 인스턴스 내의 모든 리소스 경로를 고유하게 식별하는 상대 URL입니다. 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기본 URL에 추가되어 이 API에 대한 공용 URL을 형성합니다. 문자열

제약 조건:
최대 길이 = (필수)
프로토콜 이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다. 다음 중 어느 것을 포함하는 문자열 배열:
'http'
'https'
serviceUrl 이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
subscriptionKeyParameterNames API를 사용할 수 있는 프로토콜입니다. SubscriptionKeyParameterNamesContract
형 API의 유형입니다. 'http'
'soap'
wsdlSelector WSDL의 가져오기를 문서의 하위 집합으로 제한하는 조건입니다. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

이름 묘사 값
wsdlEndpointName WSDL에서 가져올 엔드포인트(포트)의 이름 문자열
wsdlServiceName WSDL에서 가져올 서비스 이름 문자열

ApiVersionSetContract

이름 묘사 값
속성 API 버전 집합의 속성입니다. ApiVersionSetContractProperties

ApiVersionSetContractProperties

이름 묘사 값
묘사 API 버전 집합에 대한 설명입니다. 문자열
displayName API 버전 집합의 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1(필수)
versionHeaderName versioningScheme이 header설정된 경우 API 버전을 나타내는 HTTP 헤더 매개 변수의 이름입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
versioningScheme HTTP 요청에 API 버전 식별자를 배치할 위치를 결정하는 값입니다. 'Header'
'Query'
'Segment'(필수)
versionQueryName versioningScheme이 query설정된 경우 API 버전을 나타내는 쿼리 매개 변수의 이름입니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1

AuthenticationSettingsContract

이름 묘사 값
oAuth2 OAuth2 인증 설정 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/api

이름 묘사 값
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 1
패턴 = ^[^*#&+:<>?]+$(필수)
parent_id 이 리소스의 부모인 리소스의 ID입니다. 유형의 리소스에 대한 ID: 서비스
속성 업데이트 속성의 API 엔터티 만들기 ApiCreateOrUpdatePropertiesOrApiContractProperties
형 리소스 종류 "Microsoft.ApiManagement/service/apis@2017-03-01"

OAuth2AuthenticationSettingsContract

이름 묘사 값
authorizationServerId OAuth 권한 부여 서버 식별자입니다. 문자열
범위 작업 범위입니다. 문자열

SubscriptionKeyParameterNamesContract

이름 묘사 값
머리글 구독 키 헤더 이름입니다. 문자열
쿼리 구독 키 쿼리 문자열 매개 변수 이름입니다. 문자열