Microsoft.ApiManagement hizmeti/apis

  • Makale

Bicep kaynak tanımı

Hizmet/apis kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • kaynak grupları - Bkz. kaynak grubu dağıtım komutları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/apis kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2023-09-01-preview' = {
  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'
      }
      oAuth2AuthenticationSettings: [
        {
          authorizationServerId: 'string'
          scope: 'string'
        }
      ]
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      openidAuthenticationSettings: [
        {
          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'
    translateRequiredQueryParameters: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Özellik değerleri

hizmet/api'ler

Ad Açıklama Değer
ad Kaynak adı

Bicep'nde alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (gerekli)

Karakter sınırı: 1-80

Geçerli karakterler:
Alfasayısallar ve kısa çizgiler.

Harfle başlayın ve alfasayısal ile bitirin.
ebeveyn Bicep'te bir alt kaynak için üst kaynak belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir.

Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında.		 Kaynak türü için sembolik ad: hizmet
Özellikler Güncelleştirme özelliklerinin API varlığı oluşturma. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Ad Açıklama Değer
apiRevision API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
apiRevisionDescription API Düzeltmesi'nin açıklaması. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 256
apiType Oluşturulacak API türü.
* http REST API oluşturur
* soap bir SOAP geçiş API'si oluşturur
* websocket websocket API'si oluşturur
* graphql GraphQL API'si oluşturur.
Gelecekte yeni türler eklenebilir.		 'graphql'
'grpc'
'http'
'odata'
'soap'
'websocket'
apiVersion API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir dizgi

Kısıtlama -ları:
Maksimum uzunluk = 100
apiVersionDescription API Sürümünün açıklaması. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 256
apiVersionSet Sürüm kümesi ayrıntıları apiVersionSetContractDetails
apiVersionSetId İlgili ApiVersionSet için kaynak tanımlayıcısı. dizgi
authenticationSettings Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu. AuthenticationSettingsContract
temas API için iletişim bilgileri. ApiContactInformation
Açıklama API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir. dizgi
displayName API adı. 1 ile 300 karakter uzunluğunda olmalıdır. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 300
biçim API'nin içeri aktarıldığı İçeriğin biçimi. Gelecekte yeni biçimler eklenebilir 'graphql-link'
'grpc'
'grpc-link'
'odata'
'odata-link'
'openapi'
'openapi+json'
'openapi+json-link'
'openapi-link'
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir. Bool
lisans API için lisans bilgileri. ApiLicenseInformation
yol Bu API'yi ve API Management hizmet örneği içindeki tüm kaynak yollarını benzersiz olarak tanımlayan göreli URL. Bu API için genel bir URL oluşturmak üzere hizmet örneği oluşturma sırasında belirtilen API uç nokta temel URL'sine eklenir. dize (gerekli)

Kısıtlama -ları:
Maksimum uzunluk = 400
Protokol Bu API'deki işlemlerin çağrılabileceği protokolleri açıklar. Herhangi birini içeren dize dizisi:
'http'
'https'
'ws'
'wss'
serviceUrl Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 2000
sourceApiId Kaynak API'nin API tanımlayıcısı. dizgi
subscriptionKeyParameterNames API'nin kullanılabilir hale getirildiği protokoller. SubscriptionKeyParameterNamesContract
subscriptionRequired API'ye erişmek için bir API'nin mi yoksa Ürün aboneliğinin mi gerekli olduğunu belirtir. Bool
termsOfServiceUrl API için Hizmet Koşulları'nın URL'si. URL biçiminde olmalıdır. dizgi
translateRequiredQueryParameters Gerekli sorgu parametrelerini şablon parametrelerine çevirme stratejisi. Varsayılan olarak 'template' değerine sahiptir. Olası değerler: 'template', 'query' 'query'
'şablon'
tür API türü. 'graphql'
'grpc'
'http'
'odata'
'soap'
'websocket'
değer API içeri aktarılırken içerik değeri. dizgi
wsdlSelector WSDL'nin içeri aktarılmasını belgenin bir alt kümesiyle sınırlama ölçütleri. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Ad Açıklama Değer
Açıklama API Sürüm Kümesi açıklaması. dizgi
Kimliği Mevcut API Sürüm Kümesi tanımlayıcısı. Yeni bir Sürüm Kümesi oluşturmak için bu değeri atla. dizgi
ad API Sürüm Kümesinin görünen Adı. dizgi
versionHeaderName VersioningScheme headerolarak ayarlandıysa API Sürümünü gösteren HTTP üst bilgi parametresinin adı. dizgi
versioningScheme API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer. 'Üst Bilgi'
'Sorgu'
'Segment'
versionQueryName VersioningScheme queryolarak ayarlandıysa API Sürümünü gösteren sorgu parametresinin adı. dizgi

AuthenticationSettingsContract

Ad Açıklama Değer
oAuth2 OAuth2 Kimlik Doğrulama ayarları OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings Bu API'ye dahil edilen OAuth2 kimlik doğrulama ayarlarının koleksiyonu. OAuth2AuthenticationSettingsContract[]
openid OpenID Connect Kimlik Doğrulama Ayarları OpenIdAuthenticationSettingsContract
openidAuthenticationSettings Bu API'ye dahil edilen Open ID Connect kimlik doğrulama ayarlarının koleksiyonu. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Ad Açıklama Değer
authorizationServerId OAuth yetkilendirme sunucusu tanımlayıcısı. dizgi
kapsam işlem kapsamı. dizgi

OpenIdAuthenticationSettingsContract

Ad Açıklama Değer
bearerTokenSendingMethods Sunucuya belirteç gönderme. Herhangi birini içeren dize dizisi:
'authorizationHeader'
'query'
openidProviderId OAuth yetkilendirme sunucusu tanımlayıcısı. dizgi

ApiContactInformation

Ad Açıklama Değer
E-posta İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde olmalıdır dizgi
ad İlgili kişinin/kuruluşun tanımlayıcı adı dizgi
URL kişi bilgilerine işaret eden URL. URL biçiminde olmalıdır dizgi

ApiLicenseInformation

Ad Açıklama Değer
ad API için kullanılan lisans adı dizgi
URL API için kullanılan lisansın URL'si. URL biçiminde olmalıdır dizgi

SubscriptionKeyParameterNamesContract

Ad Açıklama Değer
üstbilgi Abonelik anahtarı üst bilgi adı. dizgi
sorgu Abonelik anahtarı sorgu dizesi parametre adı. dizgi

ApiCreateOrUpdatePropertiesWsdlSelector

Ad Açıklama Değer
wsdlEndpointName WSDL'den içeri aktarılacağınız uç noktanın (bağlantı noktası) adı dizgi
wsdlServiceName WSDL'den içeri aktaracak hizmetin adı dizgi

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Açıklama
Şablon kullanarak API Management örneği ve tüm alt kaynakları oluşturma

Azure 'a dağıtma		 Bu şablon, API Management hizmeti oluşturma ve alt varlıkları yapılandırma adımlarını gösterir
Azure API Management önünde Azure Front Door oluşturma

Azure 'a dağıtma		 Bu örnek, Azure API Management'ın önünde genel yük dengeleyici olarak Azure Front Door'un nasıl kullanılacağını gösterir.

ARM şablonu kaynak tanımı

Hizmet/apis kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • kaynak grupları - Bkz. kaynak grubu dağıtım komutları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/apis kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2023-09-01-preview",
  "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"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "string",
          "scope": "string"
        }
      ],
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "openidAuthenticationSettings": [
        {
          "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",
    "translateRequiredQueryParameters": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Özellik değerleri

hizmet/api'ler

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.ApiManagement/service/apis'
apiVersion Kaynak API'sinin sürümü '2023-09-01-preview'
ad Kaynak adı

JSON ARM şablonlarında alt kaynakların adlarını ve türlerini ayarlamayı öğrenin.		 dize (gerekli)

Karakter sınırı: 1-80

Geçerli karakterler:
Alfasayısallar ve kısa çizgiler.

Harfle başlayın ve alfasayısal ile bitirin.
Özellikler Güncelleştirme özelliklerinin API varlığı oluşturma. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Ad Açıklama Değer
apiRevision API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
apiRevisionDescription API Düzeltmesi'nin açıklaması. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 256
apiType Oluşturulacak API türü.
* http REST API oluşturur
* soap bir SOAP geçiş API'si oluşturur
* websocket websocket API'si oluşturur
* graphql GraphQL API'si oluşturur.
Gelecekte yeni türler eklenebilir.		 'graphql'
'grpc'
'http'
'odata'
'soap'
'websocket'
apiVersion API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir dizgi

Kısıtlama -ları:
Maksimum uzunluk = 100
apiVersionDescription API Sürümünün açıklaması. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 256
apiVersionSet Sürüm kümesi ayrıntıları apiVersionSetContractDetails
apiVersionSetId İlgili ApiVersionSet için kaynak tanımlayıcısı. dizgi
authenticationSettings Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu. AuthenticationSettingsContract
temas API için iletişim bilgileri. ApiContactInformation
Açıklama API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir. dizgi
displayName API adı. 1 ile 300 karakter uzunluğunda olmalıdır. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 300
biçim API'nin içeri aktarıldığı İçeriğin biçimi. Gelecekte yeni biçimler eklenebilir 'graphql-link'
'grpc'
'grpc-link'
'odata'
'odata-link'
'openapi'
'openapi+json'
'openapi+json-link'
'openapi-link'
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir. Bool
lisans API için lisans bilgileri. ApiLicenseInformation
yol Bu API'yi ve API Management hizmet örneği içindeki tüm kaynak yollarını benzersiz olarak tanımlayan göreli URL. Bu API için genel bir URL oluşturmak üzere hizmet örneği oluşturma sırasında belirtilen API uç nokta temel URL'sine eklenir. dize (gerekli)

Kısıtlama -ları:
Maksimum uzunluk = 400
Protokol Bu API'deki işlemlerin çağrılabileceği protokolleri açıklar. Herhangi birini içeren dize dizisi:
'http'
'https'
'ws'
'wss'
serviceUrl Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 2000
sourceApiId Kaynak API'nin API tanımlayıcısı. dizgi
subscriptionKeyParameterNames API'nin kullanılabilir hale getirildiği protokoller. SubscriptionKeyParameterNamesContract
subscriptionRequired API'ye erişmek için bir API'nin mi yoksa Ürün aboneliğinin mi gerekli olduğunu belirtir. Bool
termsOfServiceUrl API için Hizmet Koşulları'nın URL'si. URL biçiminde olmalıdır. dizgi
translateRequiredQueryParameters Gerekli sorgu parametrelerini şablon parametrelerine çevirme stratejisi. Varsayılan olarak 'template' değerine sahiptir. Olası değerler: 'template', 'query' 'query'
'şablon'
tür API türü. 'graphql'
'grpc'
'http'
'odata'
'soap'
'websocket'
değer API içeri aktarılırken içerik değeri. dizgi
wsdlSelector WSDL'nin içeri aktarılmasını belgenin bir alt kümesiyle sınırlama ölçütleri. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Ad Açıklama Değer
Açıklama API Sürüm Kümesi açıklaması. dizgi
Kimliği Mevcut API Sürüm Kümesi tanımlayıcısı. Yeni bir Sürüm Kümesi oluşturmak için bu değeri atla. dizgi
ad API Sürüm Kümesinin görünen Adı. dizgi
versionHeaderName VersioningScheme headerolarak ayarlandıysa API Sürümünü gösteren HTTP üst bilgi parametresinin adı. dizgi
versioningScheme API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer. 'Üst Bilgi'
'Sorgu'
'Segment'
versionQueryName VersioningScheme queryolarak ayarlandıysa API Sürümünü gösteren sorgu parametresinin adı. dizgi

AuthenticationSettingsContract

Ad Açıklama Değer
oAuth2 OAuth2 Kimlik Doğrulama ayarları OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings Bu API'ye dahil edilen OAuth2 kimlik doğrulama ayarlarının koleksiyonu. OAuth2AuthenticationSettingsContract[]
openid OpenID Connect Kimlik Doğrulama Ayarları OpenIdAuthenticationSettingsContract
openidAuthenticationSettings Bu API'ye dahil edilen Open ID Connect kimlik doğrulama ayarlarının koleksiyonu. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Ad Açıklama Değer
authorizationServerId OAuth yetkilendirme sunucusu tanımlayıcısı. dizgi
kapsam işlem kapsamı. dizgi

OpenIdAuthenticationSettingsContract

Ad Açıklama Değer
bearerTokenSendingMethods Sunucuya belirteç gönderme. Herhangi birini içeren dize dizisi:
'authorizationHeader'
'query'
openidProviderId OAuth yetkilendirme sunucusu tanımlayıcısı. dizgi

ApiContactInformation

Ad Açıklama Değer
E-posta İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde olmalıdır dizgi
ad İlgili kişinin/kuruluşun tanımlayıcı adı dizgi
URL kişi bilgilerine işaret eden URL. URL biçiminde olmalıdır dizgi

ApiLicenseInformation

Ad Açıklama Değer
ad API için kullanılan lisans adı dizgi
URL API için kullanılan lisansın URL'si. URL biçiminde olmalıdır dizgi

SubscriptionKeyParameterNamesContract

Ad Açıklama Değer
üstbilgi Abonelik anahtarı üst bilgi adı. dizgi
sorgu Abonelik anahtarı sorgu dizesi parametre adı. dizgi

ApiCreateOrUpdatePropertiesWsdlSelector

Ad Açıklama Değer
wsdlEndpointName WSDL'den içeri aktarılacağınız uç noktanın (bağlantı noktası) adı dizgi
wsdlServiceName WSDL'den içeri aktaracak hizmetin adı dizgi

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Açıklama
Şablon kullanarak API Management örneği ve tüm alt kaynakları oluşturma

Azure 'a dağıtma		 Bu şablon, API Management hizmeti oluşturma ve alt varlıkları yapılandırma adımlarını gösterir
Azure API Management önünde Azure Front Door oluşturma

Azure 'a dağıtma		 Bu örnek, Azure API Management'ın önünde genel yük dengeleyici olarak Azure Front Door'un nasıl kullanılacağını gösterir.

Terraform (AzAPI sağlayıcısı) kaynak tanımı

Hizmet/apis kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • Kaynak grupları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/apis kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2023-09-01-preview"
  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"
        }
        oAuth2AuthenticationSettings = [
          {
            authorizationServerId = "string"
            scope = "string"
          }
        ]
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        openidAuthenticationSettings = [
          {
            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"
      translateRequiredQueryParameters = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Özellik değerleri

hizmet/api'ler

Ad Açıklama Değer
tür Kaynak türü "Microsoft.ApiManagement/service/apis@2023-09-01-preview"
ad Kaynak adı dize (gerekli)

Karakter sınırı: 1-80

Geçerli karakterler:
Alfasayısallar ve kısa çizgiler.

Harfle başlayın ve alfasayısal ile bitirin.
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü için kimlik: hizmet
Özellikler Güncelleştirme özelliklerinin API varlığı oluşturma. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Ad Açıklama Değer
apiRevision API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
apiRevisionDescription API Düzeltmesi'nin açıklaması. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 256
apiType Oluşturulacak API türü.
* http REST API oluşturur
* soap bir SOAP geçiş API'si oluşturur
* websocket websocket API'si oluşturur
* graphql GraphQL API'si oluşturur.
Gelecekte yeni türler eklenebilir.		 "graphql"
"grpc"
"http"
"odata"
"soap"
"websocket"
apiVersion API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir dizgi

Kısıtlama -ları:
Maksimum uzunluk = 100
apiVersionDescription API Sürümünün açıklaması. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 256
apiVersionSet Sürüm kümesi ayrıntıları apiVersionSetContractDetails
apiVersionSetId İlgili ApiVersionSet için kaynak tanımlayıcısı. dizgi
authenticationSettings Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu. AuthenticationSettingsContract
temas API için iletişim bilgileri. ApiContactInformation
Açıklama API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir. dizgi
displayName API adı. 1 ile 300 karakter uzunluğunda olmalıdır. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 300
biçim API'nin içeri aktarıldığı İçeriğin biçimi. Gelecekte yeni biçimler eklenebilir "graphql-link"
"grpc"
"grpc-link"
"odata"
"odata-link"
"openapi"
"openapi+json"
"openapi+json-link"
"openapi-link"
"swagger-json"
"swagger-link-json"
"wadl-link-json"
"wadl-xml"
"wsdl"
"wsdl-link"
isCurrent API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir. Bool
lisans API için lisans bilgileri. ApiLicenseInformation
yol Bu API'yi ve API Management hizmet örneği içindeki tüm kaynak yollarını benzersiz olarak tanımlayan göreli URL. Bu API için genel bir URL oluşturmak üzere hizmet örneği oluşturma sırasında belirtilen API uç nokta temel URL'sine eklenir. dize (gerekli)

Kısıtlama -ları:
Maksimum uzunluk = 400
Protokol Bu API'deki işlemlerin çağrılabileceği protokolleri açıklar. Herhangi birini içeren dize dizisi:
"http"
"https"
"ws"
"wss"
serviceUrl Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 2000
sourceApiId Kaynak API'nin API tanımlayıcısı. dizgi
subscriptionKeyParameterNames API'nin kullanılabilir hale getirildiği protokoller. SubscriptionKeyParameterNamesContract
subscriptionRequired API'ye erişmek için bir API'nin mi yoksa Ürün aboneliğinin mi gerekli olduğunu belirtir. Bool
termsOfServiceUrl API için Hizmet Koşulları'nın URL'si. URL biçiminde olmalıdır. dizgi
translateRequiredQueryParameters Gerekli sorgu parametrelerini şablon parametrelerine çevirme stratejisi. Varsayılan olarak 'template' değerine sahiptir. Olası değerler: 'template', 'query' "query"
"şablon"
tür API türü. "graphql"
"grpc"
"http"
"odata"
"soap"
"websocket"
değer API içeri aktarılırken içerik değeri. dizgi
wsdlSelector WSDL'nin içeri aktarılmasını belgenin bir alt kümesiyle sınırlama ölçütleri. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Ad Açıklama Değer
Açıklama API Sürüm Kümesi açıklaması. dizgi
Kimliği Mevcut API Sürüm Kümesi tanımlayıcısı. Yeni bir Sürüm Kümesi oluşturmak için bu değeri atla. dizgi
ad API Sürüm Kümesinin görünen Adı. dizgi
versionHeaderName VersioningScheme headerolarak ayarlandıysa API Sürümünü gösteren HTTP üst bilgi parametresinin adı. dizgi
versioningScheme API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer. "Üst Bilgi"
"Sorgu"
"Segment"
versionQueryName VersioningScheme queryolarak ayarlandıysa API Sürümünü gösteren sorgu parametresinin adı. dizgi

AuthenticationSettingsContract

Ad Açıklama Değer
oAuth2 OAuth2 Kimlik Doğrulama ayarları OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings Bu API'ye dahil edilen OAuth2 kimlik doğrulama ayarlarının koleksiyonu. OAuth2AuthenticationSettingsContract[]
openid OpenID Connect Kimlik Doğrulama Ayarları OpenIdAuthenticationSettingsContract
openidAuthenticationSettings Bu API'ye dahil edilen Open ID Connect kimlik doğrulama ayarlarının koleksiyonu. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Ad Açıklama Değer
authorizationServerId OAuth yetkilendirme sunucusu tanımlayıcısı. dizgi
kapsam işlem kapsamı. dizgi

OpenIdAuthenticationSettingsContract

Ad Açıklama Değer
bearerTokenSendingMethods Sunucuya belirteç gönderme. Herhangi birini içeren dize dizisi:
"authorizationHeader"
"query"
openidProviderId OAuth yetkilendirme sunucusu tanımlayıcısı. dizgi

ApiContactInformation

Ad Açıklama Değer
E-posta İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde olmalıdır dizgi
ad İlgili kişinin/kuruluşun tanımlayıcı adı dizgi
URL kişi bilgilerine işaret eden URL. URL biçiminde olmalıdır dizgi

ApiLicenseInformation

Ad Açıklama Değer
ad API için kullanılan lisans adı dizgi
URL API için kullanılan lisansın URL'si. URL biçiminde olmalıdır dizgi

SubscriptionKeyParameterNamesContract

Ad Açıklama Değer
üstbilgi Abonelik anahtarı üst bilgi adı. dizgi
sorgu Abonelik anahtarı sorgu dizesi parametre adı. dizgi

ApiCreateOrUpdatePropertiesWsdlSelector

Ad Açıklama Değer
wsdlEndpointName WSDL'den içeri aktarılacağınız uç noktanın (bağlantı noktası) adı dizgi
wsdlServiceName WSDL'den içeri aktaracak hizmetin adı dizgi