Share via


Microsoft.ApiManagement 서비스/api 2021-08-01

Bicep 리소스 정의

서비스/api 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.

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

리소스 형식

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      name: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
    }
    contact: {
      email: 'string'
      name: 'string'
      url: 'string'
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    license: {
      name: 'string'
      url: 'string'
    }
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    termsOfServiceUrl: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

속성 값

service/api

Name Description
name 리소스 이름

Bicep에서 자식 리소스의 이름과 형식을 설정하는 방법을 참조하세요.
string(필수)

문자 제한: 1-80

유효한 문자:
영숫자 및 하이픈

문자로 시작하고 영숫자로 끝납니다.
부모(parent) Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가하면 됩니다.

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

Name Description
apiRevision API의 수정 버전에 대해 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 만들어집니다. 문자열
apiRevisionDescription API 수정 버전에 대한 설명입니다. 문자열
apiType 만들 API의 유형입니다.
* http REST API를 만듭니다.
* soap SOAP 통과 API 만들기
* websocket websocket API를 만듭니다.
* graphql는 GraphQL API를 만듭니다.
'graphql'
'http'
'soap'
'websocket'
apiVersion API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다. 문자열
apiVersionDescription API 버전에 대한 설명입니다. string
apiVersionSet 버전 집합 세부 정보 ApiVersionSetContractDetails
apiVersionSetId 관련 ApiVersionSet에 대한 리소스 식별자입니다. string
authenticationSettings 이 API에 포함된 인증 설정의 컬렉션입니다. AuthenticationSettingsContract
contact API에 대한 연락처 정보입니다. ApiContactInformation
description API에 대한 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다. 문자열
displayName API 이름입니다. 길이는 1~300자여야 합니다. 문자열
format API를 가져오는 콘텐츠의 형식입니다. 'graphql-link'
'openapi'
'openapi+json'
'openapi+json-link'
'openapi-link'
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent API 수정 버전이 현재 API 수정 버전인지를 나타냅니다. bool
license API에 대한 라이선스 정보입니다. ApiLicenseInformation
path API Management 서비스 인스턴스 내의 이 API 및 모든 해당 리소스 경로를 고유하게 식별하는 상대 URL입니다. 이 API에 대한 공용 URL을 형성하는 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기준 URL에 추가됩니다. string(필수)
프로토콜 이 API의 작업을 호출할 수 있는 프로토콜을 설명합니다. 다음 중 어느 것을 포함하는 문자열 배열:
'http'
'https'
'ws'
'wss'
serviceUrl 이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. 2000자를 초과할 수 없습니다. 문자열
sourceApiId 원본 API의 API 식별자입니다. 문자열
subscriptionKeyParameterNames API를 사용할 수 있는 프로토콜입니다. SubscriptionKeyParameterNamesContract
subscriptionRequired API에 액세스하는 데 API 또는 제품 구독이 필요한지 여부를 지정합니다. bool
termsOfServiceUrl API에 대한 서비스 약관에 대한 URL입니다. URL 형식이어야 합니다. 문자열
type API 유형입니다. 'graphql'
'http'
'soap'
'websocket'
API를 가져올 때 콘텐츠 값입니다. 문자열
wsdlSelector WSDL 가져오기를 문서의 하위 집합으로 제한하는 조건입니다. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Name Description
description API 버전 집합에 대한 설명입니다. 문자열
id 기존 API 버전 집합의 식별자입니다. 이 값을 생략하여 새 버전 집합을 만듭니다. 문자열
name API 버전 집합의 표시 이름입니다. 문자열
versionHeaderName versioningScheme이 로 설정된 header경우 API 버전을 나타내는 HTTP 헤더 매개 변수의 이름입니다. 문자열
versioningScheme API 버전 식별자를 HTTP 요청에 배치할 위치를 결정하는 값입니다. 'Header'
'쿼리'
'세그먼트'
versionQueryName versioningScheme이 로 설정된 query경우 API 버전을 나타내는 쿼리 매개 변수의 이름입니다. 문자열

AuthenticationSettingsContract

Name Description
oAuth2 OAuth2 인증 설정 OAuth2AuthenticationSettingsContract
openid OpenID Connect 인증 설정 OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

Name Description
authorizationServerId OAuth 권한 부여 서버 식별자입니다. 문자열
scope 작업 scope. 문자열

OpenIdAuthenticationSettingsContract

Name Description
bearerTokenSendingMethods 서버에 토큰을 보내는 방법입니다. 다음 중 어느 것을 포함하는 문자열 배열:
'authorizationHeader'
'query'
openidProviderId OAuth 권한 부여 서버 식별자입니다. 문자열

ApiContactInformation

Name Description
이메일 연락처/organization 전자 메일 주소입니다. 전자 메일 주소 형식이어야 합니다. 문자열
name 연락처/organization 식별 이름 문자열
url 연락처 정보를 가리키는 URL입니다. URL 형식이어야 합니다. string

ApiLicenseInformation

Name Description
name API에 사용되는 라이선스 이름 string
url API에 사용되는 라이선스의 URL입니다. URL 형식이어야 합니다. string

SubscriptionKeyParameterNamesContract

Name Description
header 구독 키 헤더 이름입니다. string
Query 구독 키 쿼리 문자열 매개 변수 이름입니다. 문자열

ApiCreateOrUpdatePropertiesWsdlSelector

Name Description
wsdlEndpointName WSDL에서 가져올 엔드포인트(포트)의 이름 string
wsdlServiceName WSDL에서 가져올 서비스 이름 string

빠른 시작 템플릿

다음 빠른 시작 템플릿은 이 리소스 종류를 배포합니다.

템플릿 Description
템플릿을 사용하여 API Management 인스턴스 및 모든 하위 리소스 만들기

Azure에 배포
이 템플릿은 API Management 서비스를 만들고 하위 엔터티를 구성하는 방법을 보여 줍니다.
Azure API Management 앞에서 Azure Front Door 만들기

Azure에 배포
이 샘플에서는 Azure API Management 앞에서 Azure Front Door를 전역 부하 분산 장치로 사용하는 방법을 보여 줍니다.

ARM 템플릿 리소스 정의

서비스/api 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.

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

리소스 형식

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "name": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      }
    },
    "contact": {
      "email": "string",
      "name": "string",
      "url": "string"
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "license": {
      "name": "string",
      "url": "string"
    },
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "termsOfServiceUrl": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

속성 값

service/api

Name Description
형식 리소스 종류 'Microsoft.ApiManagement/service/api'
apiVersion 리소스 api 버전 '2021-08-01'
name 리소스 이름

JSON ARM 템플릿에서 자식 리소스의 이름 및 형식을 설정하는 방법을 참조하세요.
string(필수)

문자 제한: 1-80

유효한 문자:
영숫자 및 하이픈

문자로 시작하고 영숫자로 끝납니다.
properties 업데이트 속성의 API 엔터티 만들기 ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Name Description
apiRevision API의 수정 버전에 대해 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 만들어집니다. 문자열
apiRevisionDescription API 수정 버전에 대한 설명입니다. string
apiType 만들 API의 유형입니다.
* http REST API를 만듭니다.
* soap SOAP 통과 API 만들기
* websocket websocket API를 만듭니다.
* graphql는 GraphQL API를 만듭니다.
'graphql'
'http'
'soap'
'websocket'
apiVersion API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다. string
apiVersionDescription API 버전에 대한 설명입니다. 문자열
apiVersionSet 버전 집합 세부 정보 ApiVersionSetContractDetails
apiVersionSetId 관련 ApiVersionSet에 대한 리소스 식별자입니다. 문자열
authenticationSettings 이 API에 포함된 인증 설정의 컬렉션입니다. AuthenticationSettingsContract
contact API에 대한 연락처 정보입니다. ApiContactInformation
description API에 대한 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다. string
displayName API 이름입니다. 길이는 1~300자여야 합니다. 문자열
format API를 가져오는 콘텐츠의 형식입니다. 'graphql-link'
'openapi'
'openapi+json'
'openapi+json-link'
'openapi-link'
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent API 수정 버전이 현재 api 수정 버전인지를 나타냅니다. bool
license API에 대한 라이선스 정보입니다. ApiLicenseInformation
path API Management 서비스 인스턴스 내의 이 API 및 모든 해당 리소스 경로를 고유하게 식별하는 상대 URL입니다. 이 API에 대한 공용 URL을 형성하는 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기준 URL에 추가됩니다. string(필수)
프로토콜 이 API의 작업을 호출할 수 있는 프로토콜을 설명합니다. 다음 중 어느 것을 포함하는 문자열 배열:
'http'
'https'
'ws'
'wss'
serviceUrl 이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. 2000자를 초과할 수 없습니다. 문자열
sourceApiId 원본 API의 API 식별자입니다. 문자열
subscriptionKeyParameterNames API를 사용할 수 있는 프로토콜입니다. SubscriptionKeyParameterNamesContract
subscriptionRequired API에 액세스하는 데 API 또는 제품 구독이 필요한지 여부를 지정합니다. bool
termsOfServiceUrl API에 대한 서비스 약관의 URL입니다. URL 형식이어야 합니다. 문자열
type API의 유형입니다. 'graphql'
'http'
'soap'
'websocket'
API를 가져올 때의 콘텐츠 값입니다. 문자열
wsdlSelector WSDL의 가져오기를 문서의 하위 집합으로 제한하는 조건입니다. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Name Description
description API 버전 집합에 대한 설명입니다. 문자열
id 기존 API 버전 집합의 식별자입니다. 이 값을 생략하여 새 버전 집합을 만듭니다. 문자열
name API 버전 집합의 표시 이름입니다. 문자열
versionHeaderName versioningScheme이 로 설정된 header경우 API 버전을 나타내는 HTTP 헤더 매개 변수의 이름입니다. 문자열
versioningScheme API 버전 식별자를 HTTP 요청에 배치할 위치를 결정하는 값입니다. 'Header'
'쿼리'
'세그먼트'
versionQueryName versioningScheme이 로 설정된 query경우 API 버전을 나타내는 쿼리 매개 변수의 이름입니다. 문자열

AuthenticationSettingsContract

Name Description
oAuth2 OAuth2 인증 설정 OAuth2AuthenticationSettingsContract
openid OpenID Connect 인증 설정 OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

Name Description
authorizationServerId OAuth 권한 부여 서버 식별자입니다. 문자열
scope 작업 scope. 문자열

OpenIdAuthenticationSettingsContract

Name Description
bearerTokenSendingMethods 서버에 토큰을 보내는 방법입니다. 다음 중 어느 것을 포함하는 문자열 배열:
'authorizationHeader'
'query'
openidProviderId OAuth 권한 부여 서버 식별자입니다. 문자열

ApiContactInformation

Name Description
이메일 연락처/organization 전자 메일 주소입니다. 전자 메일 주소 형식이어야 합니다. 문자열
name 연락처/organization 식별 이름 string
url 연락처 정보를 가리키는 URL입니다. URL 형식이어야 합니다. string

ApiLicenseInformation

Name Description
name API에 사용되는 라이선스 이름 문자열
url API에 사용되는 라이선스의 URL입니다. URL 형식이어야 합니다. string

SubscriptionKeyParameterNamesContract

Name Description
header 구독 키 헤더 이름입니다. string
Query 구독 키 쿼리 문자열 매개 변수 이름입니다. 문자열

ApiCreateOrUpdatePropertiesWsdlSelector

Name Description
wsdlEndpointName WSDL에서 가져올 엔드포인트(포트)의 이름 string
wsdlServiceName WSDL에서 가져올 서비스 이름 문자열

빠른 시작 템플릿

다음 빠른 시작 템플릿은 이 리소스 유형을 배포합니다.

템플릿 Description
템플릿을 사용하여 API Management 인스턴스 및 모든 하위 리소스 만들기

Azure에 배포
이 템플릿은 API Management 서비스를 만들고 하위 엔터티를 구성하는 방법을 보여 줍니다.
Azure API Management 앞에서 Azure Front Door 만들기

Azure에 배포
이 샘플에서는 Azure API Management 앞에서 Azure Front Door를 전역 부하 분산 장치로 사용하는 방법을 보여 줍니다.

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

서비스/api 리소스 종류는 다음을 대상으로 하는 작업으로 배포할 수 있습니다.

  • 리소스 그룹

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        name = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
      }
      contact = {
        email = "string"
        name = "string"
        url = "string"
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      license = {
        name = "string"
        url = "string"
      }
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      termsOfServiceUrl = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

속성 값

service/api

Name Description
형식 리소스 종류 "Microsoft.ApiManagement/service/apis@2021-08-01"
name 리소스 이름 string(필수)

문자 제한: 1-80

유효한 문자:
영숫자 및 하이픈

문자로 시작하고 영숫자로 끝납니다.
parent_id 이 리소스의 부모인 리소스의 ID입니다. 유형의 리소스에 대한 ID: 서비스
properties 업데이트 속성의 API 엔터티 만들기 ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Name Description
apiRevision API의 수정 버전에 대해 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 만들어집니다. 문자열
apiRevisionDescription API 수정 버전에 대한 설명입니다. 문자열
apiType 만들 API의 유형입니다.
* http REST API를 만듭니다.
* soap SOAP 통과 API 만들기
* websocket websocket API를 만듭니다.
* graphql는 GraphQL API를 만듭니다.
"graphql"
"http"
"soap"
"websocket"
apiVersion API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다. string
apiVersionDescription API 버전에 대한 설명입니다. 문자열
apiVersionSet 버전 집합 세부 정보 ApiVersionSetContractDetails
apiVersionSetId 관련 ApiVersionSet에 대한 리소스 식별자입니다. 문자열
authenticationSettings 이 API에 포함된 인증 설정의 컬렉션입니다. AuthenticationSettingsContract
contact API에 대한 연락처 정보입니다. ApiContactInformation
description API에 대한 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다. string
displayName API 이름입니다. 길이는 1~300자여야 합니다. string
format API를 가져오는 콘텐츠의 형식입니다. "graphql-link"
"openapi"
"openapi+json"
"openapi+json-link"
"openapi-link"
"swagger-json"
"swagger-link-json"
"wadl-link-json"
"wadl-xml"
"wsdl"
"wsdl-link"
isCurrent API 수정 버전이 현재 api 수정 버전인지를 나타냅니다. bool
license API에 대한 라이선스 정보입니다. ApiLicenseInformation
path API Management 서비스 인스턴스 내의 이 API 및 모든 해당 리소스 경로를 고유하게 식별하는 상대 URL입니다. 이 API에 대한 공용 URL을 형성하는 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기준 URL에 추가됩니다. string(필수)
프로토콜 이 API의 작업을 호출할 수 있는 프로토콜을 설명합니다. 다음 중 어느 것을 포함하는 문자열 배열:
"http"
"https"
"ws"
"wss"
serviceUrl 이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. 2000자를 초과할 수 없습니다. 문자열
sourceApiId 원본 API의 API 식별자입니다. 문자열
subscriptionKeyParameterNames API를 사용할 수 있는 프로토콜입니다. SubscriptionKeyParameterNamesContract
subscriptionRequired API에 액세스하는 데 API 또는 제품 구독이 필요한지 여부를 지정합니다. bool
termsOfServiceUrl API에 대한 서비스 약관의 URL입니다. URL 형식이어야 합니다. 문자열
type API의 유형입니다. "graphql"
"http"
"soap"
"websocket"
API를 가져올 때의 콘텐츠 값입니다. 문자열
wsdlSelector WSDL의 가져오기를 문서의 하위 집합으로 제한하는 조건입니다. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Name Description
description API 버전 집합에 대한 설명입니다. 문자열
id 기존 API 버전 집합의 식별자입니다. 이 값을 생략하여 새 버전 집합을 만듭니다. 문자열
name API 버전 집합의 표시 이름입니다. 문자열
versionHeaderName versioningScheme이 로 설정된 header경우 API 버전을 나타내는 HTTP 헤더 매개 변수의 이름입니다. 문자열
versioningScheme API 버전 식별자가 HTTP 요청에 위치할 위치를 결정하는 값입니다. "헤더"
"쿼리"
"세그먼트"
versionQueryName versioningScheme이 로 설정된 query경우 API 버전을 나타내는 쿼리 매개 변수의 이름입니다. 문자열

AuthenticationSettingsContract

Name Description
oAuth2 OAuth2 인증 설정 OAuth2AuthenticationSettingsContract
openid OpenID Connect 인증 설정 OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

Name Description
authorizationServerId OAuth 권한 부여 서버 식별자입니다. 문자열
scope 작업 scope. 문자열

OpenIdAuthenticationSettingsContract

Name Description
bearerTokenSendingMethods 서버에 토큰을 보내는 방법입니다. 다음 중 어느 것을 포함하는 문자열 배열:
"authorizationHeader"
"query"
openidProviderId OAuth 권한 부여 서버 식별자입니다. string

ApiContactInformation

Name Description
이메일 연락처/organization 전자 메일 주소입니다. 전자 메일 주소 형식이어야 합니다. 문자열
name 연락처/organization 식별 이름 문자열
url 연락처 정보를 가리키는 URL입니다. URL 형식이어야 합니다. string

ApiLicenseInformation

Name Description
name API에 사용되는 라이선스 이름 string
url API에 사용되는 라이선스의 URL입니다. URL 형식이어야 합니다. string

SubscriptionKeyParameterNamesContract

Name Description
header 구독 키 헤더 이름입니다. string
Query 구독 키 쿼리 문자열 매개 변수 이름입니다. string

ApiCreateOrUpdatePropertiesWsdlSelector

Name Description
wsdlEndpointName WSDL에서 가져올 엔드포인트(포트)의 이름 문자열
wsdlServiceName WSDL에서 가져올 서비스 이름 string