Share via

Microsoft.ApiManagement service/apis

  • Artikel

Definisi sumber daya Bicep

Jenis sumber daya layanan/api dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/apis, tambahkan Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2023-05-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'
    }
  }
}

Nilai properti

layanan/api

Nama Deskripsi Nilai
nama Nama sumber daya

Lihat cara mengatur nama dan jenis untuk sumber daya anak di Bicep.		 string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
induk Di Bicep, Anda dapat menentukan sumber daya induk untuk sumber daya anak. Anda hanya perlu menambahkan properti ini ketika sumber daya anak dideklarasikan di luar sumber daya induk.

Untuk informasi selengkapnya, lihat Sumber daya anak di luar sumber daya induk.		 Nama simbolis untuk sumber daya jenis: layanan
properti Entitas API membuat properti pembaruan. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nama Deskripsi Nilai
apiRevision Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat string
apiRevisionDescription Deskripsi Revisi API. string
apiType Jenis API yang akan dibuat.
* http membuat REST API
* soap membuat API pass-through SOAP
* websocket membuat API websocket
* graphql membuat API GraphQL.
Jenis baru dapat ditambahkan di masa mendatang.		 'graphql'
'grpc'
'http'
'odata'
'sabun'
'websocket'
apiVersion Menunjukkan pengidentifikasi versi API jika API diberi versi string
apiVersionDescription Deskripsi Versi API. string
apiVersionSet Detail set versi ApiVersionSetContractDetails
apiVersionSetId Pengidentifikasi sumber daya untuk ApiVersionSet terkait. string
authenticationSettings Kumpulan pengaturan autentikasi yang disertakan ke dalam API ini. AuthenticationSettingsContract
Hubungi Informasi kontak untuk API. ApiContactInformation
deskripsi Deskripsi API. Mungkin menyertakan tag pemformatan HTML. string
displayName Nama API. Panjangnya harus 1 hingga 300 karakter. string
format Format Konten tempat API diimpor. Format baru dapat ditambahkan di masa mendatang '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 Menunjukkan apakah revisi API adalah revisi api saat ini. bool
lisensi Informasi lisensi untuk API. ApiLicenseInformation
jalur URL relatif secara unik mengidentifikasi API ini dan semua jalur sumber dayanya dalam instans layanan API Management. Ini ditambahkan ke URL basis titik akhir API yang ditentukan selama pembuatan instans layanan untuk membentuk URL publik untuk API ini. string (diperlukan)
Protokol Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini. Array string yang berisi salah satu dari:
'http'
'https'
'ws'
'wss'
serviceUrl URL absolut dari layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter. string
sourceApiId Pengidentifikasi API dari API sumber. string
subscriptionKeyParameterNames Protokol tempat API tersedia. SubscriptionKeyParameterNamesContract
subscriptionRequired Menentukan apakah API atau Langganan produk diperlukan untuk mengakses API. bool
termsOfServiceUrl URL ke Ketentuan Layanan untuk API. HARUS dalam format URL. string
translateRequiredQueryParameters Strategi menerjemahkan parameter kueri yang diperlukan ke parameter templat. Secara default memiliki nilai 'templat'. Nilai yang mungkin: 'templat', 'kueri' 'kueri'
'templat'
jenis Jenis API. 'graphql'
'grpc'
'http'
'odata'
'sabun'
'websocket'
nilai Nilai konten saat Mengimpor API. string
wsdlSelector Kriteria untuk membatasi impor WSDL ke subset dokumen. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nama Deskripsi Nilai
deskripsi Deskripsi Set Versi API. string
id Pengidentifikasi untuk Set Versi API yang ada. Hilangkan nilai ini untuk membuat Set Versi baru. string
nama Nama tampilan Set Versi API. string
versionHeaderName Nama parameter header HTTP yang menunjukkan Versi API jika versioningScheme diatur ke header. string
versioningScheme Nilai yang menentukan di mana pengidentifikasi Versi API akan berada dalam permintaan HTTP. 'Header'
'Kueri'
'Segment'
versionQueryName Nama parameter kueri yang menunjukkan Versi API jika versioningScheme diatur ke query. string

AuthenticationSettingsContract

Nama Deskripsi Nilai
oAuth2 Pengaturan Autentikasi OAuth2 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings Kumpulan pengaturan autentikasi OAuth2 yang disertakan dalam API ini. OAuth2AuthenticationSettingsContract[]
openid Pengaturan Autentikasi OpenID Connect OpenIdAuthenticationSettingsContract
openidAuthenticationSettings Kumpulan pengaturan autentikasi Open ID Connect yang disertakan ke dalam API ini. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nama Deskripsi Nilai
authorizationServerId Pengidentifikasi server otorisasi OAuth. string
scope cakupan operasi. string

OpenIdAuthenticationSettingsContract

Nama Deskripsi Nilai
bearerTokenSendingMethods Cara mengirim token ke server. Array string yang berisi salah satu dari:
'authorizationHeader'
'kueri'
openidProviderId Pengidentifikasi server otorisasi OAuth. string

ApiContactInformation

Nama Deskripsi Nilai
email Alamat email orang/organisasi kontak. HARUS dalam format alamat email string
nama Nama pengidentifikasi kontak/organisasi string
url URL yang menunjuk ke informasi kontak. HARUS dalam format URL string

ApiLicenseInformation

Nama Deskripsi Nilai
nama Nama lisensi yang digunakan untuk API string
url URL ke lisensi yang digunakan untuk API. HARUS dalam format URL string

SubscriptionKeyParameterNamesContract

Nama Deskripsi Nilai
header Nama header kunci langganan. string
query Nama parameter string kueri kunci langganan. string

ApiCreateOrUpdatePropertiesWsdlSelector

Nama Deskripsi Nilai
wsdlEndpointName Nama titik akhir(port) untuk diimpor dari WSDL string
wsdlServiceName Nama layanan yang akan diimpor dari WSDL string

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Membuat instance API Management dan semua sub-sumber daya menggunakan templat

Sebarkan ke Azure		 Templat ini menunjukkan cara membuat layanan API Management dan mengonfigurasi sub-entitas
Membuat Azure Front Door di depan Azure API Management

Sebarkan ke Azure		 Sampel ini menunjukkan cara menggunakan Azure Front Door sebagai load balancer global di depan Azure API Management.

Definisi sumber daya templat ARM

Jenis sumber daya layanan/api dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/apis, tambahkan JSON berikut ke templat Anda.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2023-05-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"
    }
  }
}

Nilai properti

layanan/api

Nama Deskripsi Nilai
jenis Jenis sumber daya 'Microsoft.ApiManagement/service/apis'
apiVersion Versi api sumber daya '2023-05-01-preview'
nama Nama sumber daya

Lihat cara mengatur nama dan jenis untuk sumber daya anak di templat JSON ARM.		 string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
properti Entitas API membuat properti pembaruan. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nama Deskripsi Nilai
apiRevision Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat string
apiRevisionDescription Deskripsi Revisi API. string
apiType Jenis API yang akan dibuat.
* http membuat REST API
* soap membuat API pass-through SOAP
* websocket membuat API websocket
* graphql membuat API GraphQL.
Jenis baru dapat ditambahkan di masa mendatang.		 'graphql'
'grpc'
'http'
'odata'
'sabun'
'websocket'
apiVersion Menunjukkan pengidentifikasi versi API jika API diberi versi string
apiVersionDescription Deskripsi Versi API. string
apiVersionSet Detail set versi ApiVersionSetContractDetails
apiVersionSetId Pengidentifikasi sumber daya untuk ApiVersionSet terkait. string
authenticationSettings Kumpulan pengaturan autentikasi yang disertakan ke dalam API ini. AuthenticationSettingsContract
Hubungi Informasi kontak untuk API. ApiContactInformation
deskripsi Deskripsi API. Mungkin menyertakan tag pemformatan HTML. string
displayName Nama API. Panjangnya harus 1 hingga 300 karakter. string
format Format Konten tempat API diimpor. Format baru dapat ditambahkan di masa mendatang '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 Menunjukkan apakah revisi API adalah revisi api saat ini. bool
lisensi Informasi lisensi untuk API. ApiLicenseInformation
jalur URL relatif secara unik mengidentifikasi API ini dan semua jalur sumber dayanya dalam instans layanan API Management. Ini ditambahkan ke URL basis titik akhir API yang ditentukan selama pembuatan instans layanan untuk membentuk URL publik untuk API ini. string (diperlukan)
Protokol Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini. Array string yang berisi salah satu dari:
'http'
'https'
'ws'
'wss'
serviceUrl URL absolut dari layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter. string
sourceApiId Pengidentifikasi API dari API sumber. string
subscriptionKeyParameterNames Protokol tempat API tersedia. SubscriptionKeyParameterNamesContract
subscriptionRequired Menentukan apakah API atau Langganan produk diperlukan untuk mengakses API. bool
termsOfServiceUrl URL ke Ketentuan Layanan untuk API. HARUS dalam format URL. string
translateRequiredQueryParameters Strategi menerjemahkan parameter kueri yang diperlukan ke parameter templat. Secara default memiliki nilai 'templat'. Nilai yang mungkin: 'templat', 'kueri' 'kueri'
'templat'
jenis Jenis API. 'graphql'
'grpc'
'http'
'odata'
'sabun'
'websocket'
nilai Nilai konten saat Mengimpor API. string
wsdlSelector Kriteria untuk membatasi impor WSDL ke subset dokumen. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nama Deskripsi Nilai
deskripsi Deskripsi Set Versi API. string
id Pengidentifikasi untuk Set Versi API yang ada. Hilangkan nilai ini untuk membuat Set Versi baru. string
nama Nama tampilan Set Versi API. string
versionHeaderName Nama parameter header HTTP yang menunjukkan Versi API jika versioningScheme diatur ke header. string
versioningScheme Nilai yang menentukan di mana pengidentifikasi Versi API akan berada dalam permintaan HTTP. 'Header'
'Kueri'
'Segment'
versionQueryName Nama parameter kueri yang menunjukkan Versi API jika versioningScheme diatur ke query. string

AuthenticationSettingsContract

Nama Deskripsi Nilai
oAuth2 Pengaturan Autentikasi OAuth2 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings Kumpulan pengaturan autentikasi OAuth2 yang disertakan dalam API ini. OAuth2AuthenticationSettingsContract[]
openid Pengaturan Autentikasi OpenID Connect OpenIdAuthenticationSettingsContract
openidAuthenticationSettings Kumpulan pengaturan autentikasi Open ID Connect yang disertakan ke dalam API ini. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nama Deskripsi Nilai
authorizationServerId Pengidentifikasi server otorisasi OAuth. string
scope cakupan operasi. string

OpenIdAuthenticationSettingsContract

Nama Deskripsi Nilai
bearerTokenSendingMethods Cara mengirim token ke server. Array string yang berisi salah satu dari:
'authorizationHeader'
'kueri'
openidProviderId Pengidentifikasi server otorisasi OAuth. string

ApiContactInformation

Nama Deskripsi Nilai
email Alamat email orang/organisasi kontak. HARUS dalam format alamat email string
nama Nama pengidentifikasi kontak/organisasi string
url URL yang menunjuk ke informasi kontak. HARUS dalam format URL string

ApiLicenseInformation

Nama Deskripsi Nilai
nama Nama lisensi yang digunakan untuk API string
url URL ke lisensi yang digunakan untuk API. HARUS dalam format URL string

SubscriptionKeyParameterNamesContract

Nama Deskripsi Nilai
header Nama header kunci langganan. string
query Nama parameter string kueri kunci langganan. string

ApiCreateOrUpdatePropertiesWsdlSelector

Nama Deskripsi Nilai
wsdlEndpointName Nama titik akhir(port) untuk diimpor dari WSDL string
wsdlServiceName Nama layanan yang akan diimpor dari WSDL string

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Membuat instance API Management dan semua sub-sumber daya menggunakan templat

Sebarkan ke Azure		 Templat ini menunjukkan cara membuat layanan API Management dan mengonfigurasi sub-entitas
Membuat Azure Front Door di depan Azure API Management

Sebarkan ke Azure		 Sampel ini menunjukkan cara menggunakan Azure Front Door sebagai penyeimbang beban global di depan Azure API Management.

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya layanan/api dapat disebarkan dengan operasi yang menargetkan:

  • Grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/apis, tambahkan Terraform berikut ke templat Anda.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2023-05-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"
      }
    }
  })
}

Nilai properti

layanan/api

Nama Deskripsi Nilai
jenis Jenis sumber daya "Microsoft.ApiManagement/service/apis@2023-05-01-preview"
nama Nama sumber daya string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
parent_id ID sumber daya yang merupakan induk untuk sumber daya ini. ID untuk sumber daya jenis: layanan
properti Entitas API membuat properti pembaruan. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nama Deskripsi Nilai
apiRevision Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat string
apiRevisionDescription Deskripsi Revisi API. string
apiType Jenis API yang akan dibuat.
* http membuat REST API
* soap membuat API pass-through SOAP
* websocket membuat API websocket
* graphql membuat API GraphQL.
Jenis baru dapat ditambahkan di masa mendatang.		 "graphql"
"grpc"
"http"
"odata"
"sabun"
"websocket"
apiVersion Menunjukkan pengidentifikasi versi API jika API diberi versi string
apiVersionDescription Deskripsi Versi API. string
apiVersionSet Detail set versi ApiVersionSetContractDetails
apiVersionSetId Pengidentifikasi sumber daya untuk ApiVersionSet terkait. string
authenticationSettings Kumpulan pengaturan autentikasi yang disertakan ke dalam API ini. AuthenticationSettingsContract
Hubungi Informasi kontak untuk API. ApiContactInformation
deskripsi Deskripsi API. Mungkin menyertakan tag pemformatan HTML. string
displayName Nama API. Panjangnya harus 1 hingga 300 karakter. string
format Format Konten tempat API diimpor. Format baru dapat ditambahkan di masa mendatang "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 Menunjukkan apakah revisi API adalah revisi api saat ini. bool
lisensi Informasi lisensi untuk API. ApiLicenseInformation
jalur URL relatif secara unik mengidentifikasi API ini dan semua jalur sumber dayanya dalam instans layanan API Management. Ini ditambahkan ke URL basis titik akhir API yang ditentukan selama pembuatan instans layanan untuk membentuk URL publik untuk API ini. string (diperlukan)
Protokol Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini. Array string yang berisi salah satu dari:
"http"
"https"
"ws"
"wss"
serviceUrl URL absolut dari layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter. string
sourceApiId Pengidentifikasi API dari API sumber. string
subscriptionKeyParameterNames Protokol tempat API tersedia. SubscriptionKeyParameterNamesContract
subscriptionRequired Menentukan apakah API atau langganan Produk diperlukan untuk mengakses API. bool
termsOfServiceUrl URL ke Ketentuan Layanan untuk API. HARUS dalam format URL. string
translateRequiredQueryParameters Strategi menerjemahkan parameter kueri yang diperlukan ke parameter templat. Secara default memiliki nilai 'templat'. Nilai yang mungkin: 'templat', 'kueri' "kueri"
"templat"
jenis Jenis API. "graphql"
"grpc"
"http"
"odata"
"sabun"
"websocket"
nilai Nilai konten saat Mengimpor API. string
wsdlSelector Kriteria untuk membatasi impor WSDL ke subset dokumen. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nama Deskripsi Nilai
deskripsi Deskripsi Set Versi API. string
id Pengidentifikasi untuk Set Versi API yang ada. Hilangkan nilai ini untuk membuat Set Versi baru. string
nama Nama tampilan Set Versi API. string
versionHeaderName Nama parameter header HTTP yang menunjukkan Versi API jika versioningScheme diatur ke header. string
versioningScheme Nilai yang menentukan di mana pengidentifikasi Versi API akan berada dalam permintaan HTTP. "Header"
"Kueri"
"Segment"
versionQueryName Nama parameter kueri yang menunjukkan Versi API jika versioningScheme diatur ke query. string

AuthenticationSettingsContract

Nama Deskripsi Nilai
oAuth2 Pengaturan Autentikasi OAuth2 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings Kumpulan pengaturan autentikasi OAuth2 yang disertakan dalam API ini. OAuth2AuthenticationSettingsContract[]
openid Pengaturan Autentikasi OpenID Connect OpenIdAuthenticationSettingsContract
openidAuthenticationSettings Kumpulan pengaturan autentikasi Open ID Connect yang disertakan ke dalam API ini. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nama Deskripsi Nilai
authorizationServerId Pengidentifikasi server otorisasi OAuth. string
scope cakupan operasi. string

OpenIdAuthenticationSettingsContract

Nama Deskripsi Nilai
bearerTokenSendingMethods Cara mengirim token ke server. Array string yang berisi salah satu dari:
"authorizationHeader"
"kueri"
openidProviderId Pengidentifikasi server otorisasi OAuth. string

ApiContactInformation

Nama Deskripsi Nilai
email Alamat email orang/organisasi kontak. HARUS dalam format alamat email string
nama Nama pengidentifikasi kontak/organisasi string
url URL yang menunjuk ke informasi kontak. HARUS dalam format URL string

ApiLicenseInformation

Nama Deskripsi Nilai
nama Nama lisensi yang digunakan untuk API string
url URL ke lisensi yang digunakan untuk API. HARUS dalam format URL string

SubscriptionKeyParameterNamesContract

Nama Deskripsi Nilai
header Nama header kunci langganan. string
query Nama parameter string kueri kunci langganan. string

ApiCreateOrUpdatePropertiesWsdlSelector

Nama Deskripsi Nilai
wsdlEndpointName Nama titik akhir(port) untuk diimpor dari WSDL string
wsdlServiceName Nama layanan yang akan diimpor dari WSDL string