Layanan/api Microsoft.ApiManagement

2025-06-25

Terbaru
pratinjau 2024-06-01
2024-05-01
pratinjau 2023-09-01
Pratinjau 05-01 2023
Pratinjau 03-03-2023
pratinjau 2022-09-01
2022-08-01
pratinjau 2022-04-01
pratinjau 2021-12-01
2021-08-01
pratinjau 2021-04-01
pratinjau 2021-01-01
2020-12-01
pratinjau 2020-06-01
2019-12-01
Pratinjau 12-12-2019
2019-01-01
pratinjau 2018-06-01
2018-01-01
2017-03-01
2016-10-10
2016-07-07

Definisi sumber daya Bicep

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

Grup sumber daya - Lihat perintah penyebaran 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 Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2024-06-01-preview' = {
  parent: resourceSymbolicName
  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

Microsoft.ApiManagement/service/api

Nama	Deskripsi	Nilai
Nama	Nama sumber daya	tali Kendala: Panjang min = 1 Panjang maksimum = 256 Pola = `^[^*#&+:<>?]+$` (diperlukan)
ortu	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 Turunan di luar sumber daya induk.	Nama simbolis untuk sumber daya jenis: layanan
Properti	Pembuatan entitas API dari properti pembaruan.	ApiCreateOrUpdatePropertiesOrApiContractProperties

Informasi Kontak Api

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nama	Deskripsi	Nilai
apiRevisi	Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat	tali Kendala: Panjang min = 1 Panjang maksimum = 100
apiRevisionDescription	Deskripsi Revisi API.	tali Kendala: Panjang maksimum = 256
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.	'Grafik' 'grpc' 'http' 'odata' 'sabun' 'Websocket'
apiVersi	Menunjukkan pengidentifikasi versi API jika API diberi versi	tali Kendala: Panjang maksimum = 100
apiVersiDeskripsi	Deskripsi Versi API.	tali Kendala: Panjang maksimum = 256
apiVersionSet	Detail set versi	ApiVersionSetContractDetails
apiVersionSetId	Pengidentifikasi sumber daya untuk ApiVersionSet terkait.	tali
autentikasiSetelan	Kumpulan pengaturan autentikasi yang disertakan dalam API ini.	AutentikasiPengaturanKontrak
kontak	Informasi kontak untuk API.	ApiContactInformation
deskripsi	Deskripsi API. Dapat mencakup tag pemformatan HTML.	tali
nama tampilan	Nama API. Panjangnya harus 1 hingga 300 karakter.	tali Kendala: Panjang min = 1 Panjang maksimum = 300
bentuk	Format Konten tempat API diimpor. Format baru dapat ditambahkan di masa mendatang	'Tautan grafql' 'grpc' 'tautan grpc' 'odata' 'Tautan odata' 'OpenAPI' 'OpenAPI+JSON' 'OpenAPI+JSON-Link' 'tautan terbuka' 'Angkuh-JSON' 'tautan-json angkuh' 'wadl-link-json' 'wadl-xml' 'WSDL' 'Tautan WSDL'
isArus	Menunjukkan apakah revisi API adalah revisi api saat ini.	bool
lisensi	Informasi lisensi untuk API.	ApiLicenseInformation
jalan	URL relatif secara unik mengidentifikasi API ini dan semua jalur sumber dayanya dalam instans layanan API Management. Ini ditambahkan ke URL dasar titik akhir API yang ditentukan selama pembuatan instans layanan untuk membentuk URL publik untuk API ini.	tali Kendala: Panjang maksimum = 400 (diperlukan)
Protokol	Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini.	Array string yang berisi salah satu dari: 'http' 'https' 'ws' 'WSS'
layananUrl	URL absolut layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter.	tali Kendala: Panjang maksimum = 2000
sumberApiId	Pengidentifikasi API dari API sumber.	tali
subscriptionKeyParameterNames	Protokol tempat API tersedia.	SubscriptionKeyParameterNamesContract
langgananWajib	Menentukan apakah API atau Langganan produk diperlukan untuk mengakses API.	bool
syaratLayananUrl	URL ke Ketentuan Layanan untuk API. HARUS dalam format URL.	tali
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.	'Grafik' 'grpc' 'http' 'odata' 'sabun' 'Websocket'
nilai	Nilai konten saat Mengimpor API.	tali
wsdlPemilih	Kriteria untuk membatasi impor WSDL ke subset dokumen.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

Informasi Lisensi Api

Nama	Deskripsi	Nilai
Nama	Nama lisensi yang digunakan untuk API	tali
URL	URL ke lisensi yang digunakan untuk API. HARUS dalam format URL	tali

ApiVersionSetContractDetails

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

AutentikasiPengaturanKontrak

Nama	Deskripsi	Nilai
oAuth2	Pengaturan Autentikasi OAuth2	OAuth2AuthenticationSettingsContract
oAuth2OtentikasiPengaturan	Kumpulan pengaturan autentikasi OAuth2 yang disertakan ke dalam API ini.	OAuth2AuthenticationSettingsContract[]
openid (sistem otentikasi terbuka)	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.	tali
ruang lingkup	cakupan operasi.	tali

OpenIdAuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

Nama	Deskripsi	Nilai
Header	Nama header kunci langganan.	tali
kueri	Nama parameter string kueri kunci langganan.	tali

Definisi sumber daya templat ARM

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

Grup sumber daya - Lihat perintah penyebaran 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 JSON berikut ke templat Anda.

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

Microsoft.ApiManagement/service/api

Nama	Deskripsi	Nilai
apiVersi	Versi api	'Pratinjau 2024-06-01'
Nama	Nama sumber daya	tali Kendala: Panjang min = 1 Panjang maksimum = 256 Pola = `^[^*#&+:<>?]+$` (diperlukan)
Properti	Pembuatan entitas API dari properti pembaruan.	ApiCreateOrUpdatePropertiesOrApiContractProperties
jenis	Jenis sumber daya	'Microsoft.ApiManagement/service/apis'

Informasi Kontak Api

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nama	Deskripsi	Nilai
apiRevisi	Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat	tali Kendala: Panjang min = 1 Panjang maksimum = 100
apiRevisionDescription	Deskripsi Revisi API.	tali Kendala: Panjang maksimum = 256
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.	'Grafik' 'grpc' 'http' 'odata' 'sabun' 'Websocket'
apiVersi	Menunjukkan pengidentifikasi versi API jika API diberi versi	tali Kendala: Panjang maksimum = 100
apiVersiDeskripsi	Deskripsi Versi API.	tali Kendala: Panjang maksimum = 256
apiVersionSet	Detail set versi	ApiVersionSetContractDetails
apiVersionSetId	Pengidentifikasi sumber daya untuk ApiVersionSet terkait.	tali
autentikasiSetelan	Kumpulan pengaturan autentikasi yang disertakan dalam API ini.	AutentikasiPengaturanKontrak
kontak	Informasi kontak untuk API.	ApiContactInformation
deskripsi	Deskripsi API. Dapat mencakup tag pemformatan HTML.	tali
nama tampilan	Nama API. Panjangnya harus 1 hingga 300 karakter.	tali Kendala: Panjang min = 1 Panjang maksimum = 300
bentuk	Format Konten tempat API diimpor. Format baru dapat ditambahkan di masa mendatang	'Tautan grafql' 'grpc' 'tautan grpc' 'odata' 'Tautan odata' 'OpenAPI' 'OpenAPI+JSON' 'OpenAPI+JSON-Link' 'tautan terbuka' 'Angkuh-JSON' 'tautan-json angkuh' 'wadl-link-json' 'wadl-xml' 'WSDL' 'Tautan WSDL'
isArus	Menunjukkan apakah revisi API adalah revisi api saat ini.	bool
lisensi	Informasi lisensi untuk API.	ApiLicenseInformation
jalan	URL relatif secara unik mengidentifikasi API ini dan semua jalur sumber dayanya dalam instans layanan API Management. Ini ditambahkan ke URL dasar titik akhir API yang ditentukan selama pembuatan instans layanan untuk membentuk URL publik untuk API ini.	tali Kendala: Panjang maksimum = 400 (diperlukan)
Protokol	Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini.	Array string yang berisi salah satu dari: 'http' 'https' 'ws' 'WSS'
layananUrl	URL absolut layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter.	tali Kendala: Panjang maksimum = 2000
sumberApiId	Pengidentifikasi API dari API sumber.	tali
subscriptionKeyParameterNames	Protokol tempat API tersedia.	SubscriptionKeyParameterNamesContract
langgananWajib	Menentukan apakah API atau Langganan produk diperlukan untuk mengakses API.	bool
syaratLayananUrl	URL ke Ketentuan Layanan untuk API. HARUS dalam format URL.	tali
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.	'Grafik' 'grpc' 'http' 'odata' 'sabun' 'Websocket'
nilai	Nilai konten saat Mengimpor API.	tali
wsdlPemilih	Kriteria untuk membatasi impor WSDL ke subset dokumen.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

Informasi Lisensi Api

Nama	Deskripsi	Nilai
Nama	Nama lisensi yang digunakan untuk API	tali
URL	URL ke lisensi yang digunakan untuk API. HARUS dalam format URL	tali

ApiVersionSetContractDetails

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

AutentikasiPengaturanKontrak

Nama	Deskripsi	Nilai
oAuth2	Pengaturan Autentikasi OAuth2	OAuth2AuthenticationSettingsContract
oAuth2OtentikasiPengaturan	Kumpulan pengaturan autentikasi OAuth2 yang disertakan ke dalam API ini.	OAuth2AuthenticationSettingsContract[]
openid (sistem otentikasi terbuka)	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.	tali
ruang lingkup	cakupan operasi.	tali

OpenIdAuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

Nama	Deskripsi	Nilai
Header	Nama header kunci langganan.	tali
kueri	Nama parameter string kueri kunci langganan.	tali

Contoh Penggunaan

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@2024-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    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

Microsoft.ApiManagement/service/api

Nama	Deskripsi	Nilai
Nama	Nama sumber daya	tali Kendala: Panjang min = 1 Panjang maksimum = 256 Pola = `^[^*#&+:<>?]+$` (diperlukan)
parent_id	ID sumber daya yang merupakan induk untuk sumber daya ini.	ID untuk sumber daya jenis: layanan
Properti	Pembuatan entitas API dari properti pembaruan.	ApiCreateOrUpdatePropertiesOrApiContractProperties
jenis	Jenis sumber daya	"Microsoft.ApiManagement/service/apis@2024-06-01-preview"

Informasi Kontak Api

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nama	Deskripsi	Nilai
apiRevisi	Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat	tali Kendala: Panjang min = 1 Panjang maksimum = 100
apiRevisionDescription	Deskripsi Revisi API.	tali Kendala: Panjang maksimum = 256
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.	'Grafik' 'grpc' 'http' 'odata' 'sabun' 'Websocket'
apiVersi	Menunjukkan pengidentifikasi versi API jika API diberi versi	tali Kendala: Panjang maksimum = 100
apiVersiDeskripsi	Deskripsi Versi API.	tali Kendala: Panjang maksimum = 256
apiVersionSet	Detail set versi	ApiVersionSetContractDetails
apiVersionSetId	Pengidentifikasi sumber daya untuk ApiVersionSet terkait.	tali
autentikasiSetelan	Kumpulan pengaturan autentikasi yang disertakan dalam API ini.	AutentikasiPengaturanKontrak
kontak	Informasi kontak untuk API.	ApiContactInformation
deskripsi	Deskripsi API. Dapat mencakup tag pemformatan HTML.	tali
nama tampilan	Nama API. Panjangnya harus 1 hingga 300 karakter.	tali Kendala: Panjang min = 1 Panjang maksimum = 300
bentuk	Format Konten tempat API diimpor. Format baru dapat ditambahkan di masa mendatang	'Tautan grafql' 'grpc' 'tautan grpc' 'odata' 'Tautan odata' 'OpenAPI' 'OpenAPI+JSON' 'OpenAPI+JSON-Link' 'tautan terbuka' 'Angkuh-JSON' 'tautan-json angkuh' 'wadl-link-json' 'wadl-xml' 'WSDL' 'Tautan WSDL'
isArus	Menunjukkan apakah revisi API adalah revisi api saat ini.	bool
lisensi	Informasi lisensi untuk API.	ApiLicenseInformation
jalan	URL relatif secara unik mengidentifikasi API ini dan semua jalur sumber dayanya dalam instans layanan API Management. Ini ditambahkan ke URL dasar titik akhir API yang ditentukan selama pembuatan instans layanan untuk membentuk URL publik untuk API ini.	tali Kendala: Panjang maksimum = 400 (diperlukan)
Protokol	Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini.	Array string yang berisi salah satu dari: 'http' 'https' 'ws' 'WSS'
layananUrl	URL absolut layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter.	tali Kendala: Panjang maksimum = 2000
sumberApiId	Pengidentifikasi API dari API sumber.	tali
subscriptionKeyParameterNames	Protokol tempat API tersedia.	SubscriptionKeyParameterNamesContract
langgananWajib	Menentukan apakah API atau Langganan produk diperlukan untuk mengakses API.	bool
syaratLayananUrl	URL ke Ketentuan Layanan untuk API. HARUS dalam format URL.	tali
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.	'Grafik' 'grpc' 'http' 'odata' 'sabun' 'Websocket'
nilai	Nilai konten saat Mengimpor API.	tali
wsdlPemilih	Kriteria untuk membatasi impor WSDL ke subset dokumen.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

Informasi Lisensi Api

Nama	Deskripsi	Nilai
Nama	Nama lisensi yang digunakan untuk API	tali
URL	URL ke lisensi yang digunakan untuk API. HARUS dalam format URL	tali

ApiVersionSetContractDetails

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

AutentikasiPengaturanKontrak

Nama	Deskripsi	Nilai
oAuth2	Pengaturan Autentikasi OAuth2	OAuth2AuthenticationSettingsContract
oAuth2OtentikasiPengaturan	Kumpulan pengaturan autentikasi OAuth2 yang disertakan ke dalam API ini.	OAuth2AuthenticationSettingsContract[]
openid (sistem otentikasi terbuka)	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.	tali
ruang lingkup	cakupan operasi.	tali

OpenIdAuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

Nama	Deskripsi	Nilai
Header	Nama header kunci langganan.	tali
kueri	Nama parameter string kueri kunci langganan.	tali

Bagikan melalui

Layanan/api Microsoft.ApiManagement

Definisi sumber daya Bicep

Format sumber daya

Nilai Properti

Microsoft.ApiManagement/service/api

Informasi Kontak Api

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

Informasi Lisensi Api

ApiVersionSetContractDetails

AutentikasiPengaturanKontrak

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

Definisi sumber daya templat ARM

Format sumber daya

Nilai Properti

Microsoft.ApiManagement/service/api

Informasi Kontak Api

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

Informasi Lisensi Api

ApiVersionSetContractDetails

AutentikasiPengaturanKontrak

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

Contoh Penggunaan

Definisi sumber daya Terraform (penyedia AzAPI)

Format sumber daya

Nilai Properti

Microsoft.ApiManagement/service/api

Informasi Kontak Api

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

Informasi Lisensi Api

ApiVersionSetContractDetails

AutentikasiPengaturanKontrak

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

Saran dan Komentar

Sumber Daya Tambahan: