ApiContract interface
Detail API.
- Memperluas
Properti
| api |
Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat |
| api |
Deskripsi Revisi API. |
| api |
Jenis API. |
| api |
Menunjukkan pengidentifikasi versi API jika API diberi versi |
| api |
Deskripsi Versi API. |
| api |
Detail set versi |
| api |
Pengidentifikasi sumber daya untuk ApiVersionSet terkait. |
| authentication |
Kumpulan pengaturan autentikasi yang disertakan ke dalam API ini. |
| contact | Informasi kontak untuk API. |
| description | Deskripsi API. Mungkin menyertakan tag pemformatan HTML. |
| display |
Nama API. Panjangnya harus 1 hingga 300 karakter. |
| is |
Menunjukkan apakah revisi API adalah revisi api saat ini. |
| is |
Menunjukkan apakah revisi API dapat diakses melalui gateway. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server. |
| license | Informasi lisensi untuk API. |
| path | 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. |
| protocols | Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini. |
| service |
URL absolut dari layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter. |
| source |
Pengidentifikasi API dari API sumber. |
| subscription |
Protokol tempat API tersedia. |
| subscription |
Menentukan apakah API atau langganan Produk diperlukan untuk mengakses API. |
| terms |
URL ke Ketentuan Layanan untuk API. HARUS dalam format URL. |
Properti yang Diwariskan
| id | ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server. |
| name | Nama CATATAN sumber daya: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server. |
| type | Jenis sumber daya. Misalnya CATATAN "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts": Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server. |
Detail Properti
apiRevision
Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat
apiRevision?: stringNilai Properti
string
apiRevisionDescription
Deskripsi Revisi API.
apiRevisionDescription?: stringNilai Properti
string
apiType
Jenis API.
apiType?: stringNilai Properti
string
apiVersion
Menunjukkan pengidentifikasi versi API jika API diberi versi
apiVersion?: stringNilai Properti
string
apiVersionDescription
Deskripsi Versi API.
apiVersionDescription?: stringNilai Properti
string
apiVersionSet
Detail set versi
apiVersionSet?: ApiVersionSetContractDetailsNilai Properti
apiVersionSetId
Pengidentifikasi sumber daya untuk ApiVersionSet terkait.
apiVersionSetId?: stringNilai Properti
string
authenticationSettings
Kumpulan pengaturan autentikasi yang disertakan ke dalam API ini.
authenticationSettings?: AuthenticationSettingsContractNilai Properti
contact
description
Deskripsi API. Mungkin menyertakan tag pemformatan HTML.
description?: stringNilai Properti
string
displayName
Nama API. Panjangnya harus 1 hingga 300 karakter.
displayName?: stringNilai Properti
string
isCurrent
Menunjukkan apakah revisi API adalah revisi api saat ini.
isCurrent?: booleanNilai Properti
boolean
isOnline
Menunjukkan apakah revisi API dapat diakses melalui gateway. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
isOnline?: booleanNilai Properti
boolean
license
path
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.
path?: stringNilai Properti
string
protocols
Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini.
protocols?: string[]Nilai Properti
string[]
serviceUrl
URL absolut dari layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter.
serviceUrl?: stringNilai Properti
string
sourceApiId
Pengidentifikasi API dari API sumber.
sourceApiId?: stringNilai Properti
string
subscriptionKeyParameterNames
Protokol tempat API tersedia.
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContractNilai Properti
subscriptionRequired
Menentukan apakah API atau langganan Produk diperlukan untuk mengakses API.
subscriptionRequired?: booleanNilai Properti
boolean
termsOfServiceUrl
URL ke Ketentuan Layanan untuk API. HARUS dalam format URL.
termsOfServiceUrl?: stringNilai Properti
string
Detail Properti yang Diwariskan
id
ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
id?: stringNilai Properti
string
Diwarisi DariProxyResource.id
name
Nama CATATAN sumber daya: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
name?: stringNilai Properti
string
Diwarisi DariProxyResource.name
type
Jenis sumber daya. Misalnya CATATAN "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts": Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
type?: stringNilai Properti
string
Diwarisi DariProxyResource.type