ApiEntityBaseContract interface

Pakiet:

@azure/arm-apimanagement

Szczegóły kontraktu podstawowego interfejsu API.

Właściwości

apiRevision	Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1
apiRevisionDescription	Opis poprawki interfejsu API.
apiType	Typ interfejsu API.
apiVersion	Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji
apiVersionDescription	Opis wersji interfejsu API.
apiVersionSetId	Identyfikator zasobu powiązanego elementu ApiVersionSet.
authenticationSettings	Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API.
contact	Informacje kontaktowe dotyczące interfejsu API.
description	Opis interfejsu API. Może zawierać tagi formatowania HTML.
isCurrent	Wskazuje, czy poprawka interfejsu API jest bieżącą poprawką interfejsu API.
isOnline	Wskazuje, czy poprawka interfejsu API jest dostępna za pośrednictwem bramy. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
license	Informacje o licencji dla interfejsu API.
subscriptionKeyParameterNames	Protokoły, za pośrednictwem których udostępniono interfejs API.
subscriptionRequired	Określa, czy do uzyskiwania dostępu do interfejsu API jest wymagana subskrypcja interfejsu API lub produktu.
termsOfServiceUrl	Adres URL warunków użytkowania usługi dla interfejsu API. MUSI być w formacie adresu URL.

Szczegóły właściwości

apiRevision

Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1

apiRevision?: string

Wartość właściwości

string

apiRevisionDescription

Opis poprawki interfejsu API.

apiRevisionDescription?: string

Wartość właściwości

string

apiType

Typ interfejsu API.

apiType?: string

Wartość właściwości

string

apiVersion

Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji

apiVersion?: string

Wartość właściwości

string

apiVersionDescription

Opis wersji interfejsu API.

apiVersionDescription?: string

Wartość właściwości

string

apiVersionSetId

Identyfikator zasobu powiązanego elementu ApiVersionSet.

apiVersionSetId?: string

Wartość właściwości

string

authenticationSettings

Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API.

authenticationSettings?: AuthenticationSettingsContract

Wartość właściwości

AuthenticationSettingsContract

contact

Informacje kontaktowe dotyczące interfejsu API.

contact?: ApiContactInformation

Wartość właściwości

ApiContactInformation

description

Opis interfejsu API. Może zawierać tagi formatowania HTML.

description?: string

Wartość właściwości

string

isCurrent

Wskazuje, czy poprawka interfejsu API jest bieżącą poprawką interfejsu API.

isCurrent?: boolean

Wartość właściwości

boolean

isOnline

Wskazuje, czy poprawka interfejsu API jest dostępna za pośrednictwem bramy. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

isOnline?: boolean

Wartość właściwości

boolean

license

Informacje o licencji dla interfejsu API.

license?: ApiLicenseInformation

Wartość właściwości

ApiLicenseInformation

subscriptionKeyParameterNames

Protokoły, za pośrednictwem których udostępniono interfejs API.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Wartość właściwości

SubscriptionKeyParameterNamesContract

subscriptionRequired

Określa, czy do uzyskiwania dostępu do interfejsu API jest wymagana subskrypcja interfejsu API lub produktu.

subscriptionRequired?: boolean

Wartość właściwości

boolean

termsOfServiceUrl

Adres URL warunków użytkowania usługi dla interfejsu API. MUSI być w formacie adresu URL.

termsOfServiceUrl?: string

Wartość właściwości

string