Bagikan melalui

ApiCreateOrUpdateParameter interface

Paket:
@azure/arm-apimanagement

Parameter Buat atau Perbarui API.

Properti

apiRevision

Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat
apiRevisionDescription

Deskripsi Revisi API.
apiType

Jenis API.
apiVersion

Menunjukkan pengidentifikasi versi API jika API diberi versi
apiVersionDescription

Deskripsi Versi API.
apiVersionSet

Detail set versi
apiVersionSetId

Pengidentifikasi sumber daya untuk ApiVersionSet terkait.
authenticationSettings

Kumpulan pengaturan autentikasi yang disertakan dalam API ini.
contact

Informasi kontak untuk API.
description

Deskripsi API. Dapat mencakup tag pemformatan HTML.
displayName

Nama API. Panjangnya harus 1 hingga 300 karakter.
format

Format Konten tempat API diimpor. Format baru dapat ditambahkan di masa mendatang
isCurrent

Menunjukkan apakah revisi API adalah revisi api saat ini.
isOnline

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 dasar 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.
provisioningState

STATUS provisi CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
serviceUrl

URL absolut layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter.
soapApiType

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.
sourceApiId

Pengidentifikasi API dari API sumber.
subscriptionKeyParameterNames

Protokol tempat API tersedia.
subscriptionRequired

Menentukan apakah API atau Langganan produk diperlukan untuk mengakses API.
termsOfServiceUrl

URL ke Ketentuan Layanan untuk API. HARUS dalam format URL.
translateRequiredQueryParametersConduct

Strategi menerjemahkan parameter kueri yang diperlukan ke parameter templat. Secara default memiliki nilai 'templat'. Nilai yang mungkin: 'templat', 'kueri'
value

Nilai konten saat Mengimpor API.
wsdlSelector

Kriteria untuk membatasi impor WSDL ke subset dokumen.

Detail Properti

apiRevision

Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat

apiRevision?: string

Nilai Properti

string

apiRevisionDescription

Deskripsi Revisi API.

apiRevisionDescription?: string

Nilai Properti

string

apiType

Jenis API.

apiType?: string

Nilai Properti

string

apiVersion

Menunjukkan pengidentifikasi versi API jika API diberi versi

apiVersion?: string

Nilai Properti

string

apiVersionDescription

Deskripsi Versi API.

apiVersionDescription?: string

Nilai Properti

string

apiVersionSet

Detail set versi

apiVersionSet?: ApiVersionSetContractDetails

Nilai Properti

ApiVersionSetContractDetails

apiVersionSetId

Pengidentifikasi sumber daya untuk ApiVersionSet terkait.

apiVersionSetId?: string

Nilai Properti

string

authenticationSettings

Kumpulan pengaturan autentikasi yang disertakan dalam API ini.

authenticationSettings?: AuthenticationSettingsContract

Nilai Properti

AuthenticationSettingsContract

contact

Informasi kontak untuk API.

contact?: ApiContactInformation

Nilai Properti

ApiContactInformation

description

Deskripsi API. Dapat mencakup tag pemformatan HTML.

description?: string

Nilai Properti

string

displayName

Nama API. Panjangnya harus 1 hingga 300 karakter.

displayName?: string

Nilai Properti

string

format

Format Konten tempat API diimpor. Format baru dapat ditambahkan di masa mendatang

format?: string

Nilai Properti

string

isCurrent

Menunjukkan apakah revisi API adalah revisi api saat ini.

isCurrent?: boolean

Nilai Properti

boolean

isOnline

Menunjukkan apakah revisi API dapat diakses melalui gateway. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

isOnline?: boolean

Nilai Properti

boolean

license

Informasi lisensi untuk API.

license?: ApiLicenseInformation

Nilai Properti

ApiLicenseInformation

path

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.

path?: string

Nilai Properti

string

protocols

Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini.

protocols?: string[]

Nilai Properti

string[]

provisioningState

STATUS provisi CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

provisioningState?: string

Nilai Properti

string

serviceUrl

URL absolut layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter.

serviceUrl?: string

Nilai Properti

string

soapApiType

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.
soapApiType?: string

Nilai Properti

string

sourceApiId

Pengidentifikasi API dari API sumber.

sourceApiId?: string

Nilai Properti

string

subscriptionKeyParameterNames

Protokol tempat API tersedia.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Nilai Properti

SubscriptionKeyParameterNamesContract

subscriptionRequired

Menentukan apakah API atau Langganan produk diperlukan untuk mengakses API.

subscriptionRequired?: boolean

Nilai Properti

boolean

termsOfServiceUrl

URL ke Ketentuan Layanan untuk API. HARUS dalam format URL.

termsOfServiceUrl?: string

Nilai Properti

string

translateRequiredQueryParametersConduct

Strategi menerjemahkan parameter kueri yang diperlukan ke parameter templat. Secara default memiliki nilai 'templat'. Nilai yang mungkin: 'templat', 'kueri'

translateRequiredQueryParametersConduct?: string

Nilai Properti

string

value

Nilai konten saat Mengimpor API.

value?: string

Nilai Properti

string

wsdlSelector

Kriteria untuk membatasi impor WSDL ke subset dokumen.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Nilai Properti

ApiCreateOrUpdatePropertiesWsdlSelector