ApiContractProperties interface

Pakiet:

@azure/arm-apimanagement

Właściwości jednostki interfejsu API

Rozszerzenie

ApiEntityBaseContract

Właściwości

apiVersionSet	Szczegóły zestawu wersji
displayName	Nazwa interfejsu API. Musi mieć długość od 1 do 300 znaków.
path	Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API.
protocols	Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.
provisioningState	Stan aprowizacji UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
serviceUrl	Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków.
sourceApiId	Identyfikator interfejsu API źródłowego interfejsu API.

Właściwości dziedziczone

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

apiVersionSet

Szczegóły zestawu wersji

apiVersionSet?: ApiVersionSetContractDetails

Wartość właściwości

ApiVersionSetContractDetails

displayName

Nazwa interfejsu API. Musi mieć długość od 1 do 300 znaków.

displayName?: string

Wartość właściwości

string

path

Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API.

path: string

Wartość właściwości

string

protocols

Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.

protocols?: string[]

Wartość właściwości

string[]

provisioningState

Stan aprowizacji UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

provisioningState?: string

Wartość właściwości

string

serviceUrl

Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków.

serviceUrl?: string

Wartość właściwości

string

sourceApiId

Identyfikator interfejsu API źródłowego interfejsu API.

sourceApiId?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

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

dziedziczone zApiEntityBaseContract.apiRevision

apiRevisionDescription

Opis poprawki interfejsu API.

apiRevisionDescription?: string

Wartość właściwości

string

dziedziczone zApiEntityBaseContract.apiRevisionDescription

apiType

Typ interfejsu API.

apiType?: string

Wartość właściwości

string

dziedziczone zApiEntityBaseContract.apiType

apiVersion

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

apiVersion?: string

Wartość właściwości

string

dziedziczone zApiEntityBaseContract.apiVersion

apiVersionDescription

Opis wersji interfejsu API.

apiVersionDescription?: string

Wartość właściwości

string

dziedziczone zApiEntityBaseContract.apiVersionDescription

apiVersionSetId

Identyfikator zasobu powiązanego elementu ApiVersionSet.

apiVersionSetId?: string

Wartość właściwości

string

dziedziczone zApiEntityBaseContract.apiVersionSetId

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Wartość właściwości

AuthenticationSettingsContract

dziedziczone zApiEntityBaseContract.authenticationSettings

contact

Informacje kontaktowe dotyczące interfejsu API.

contact?: ApiContactInformation

Wartość właściwości

ApiContactInformation

dziedziczone zApiEntityBaseContract.contact

description

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

description?: string

Wartość właściwości

string

dziedziczone zApiEntityBaseContract.description

isCurrent

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

isCurrent?: boolean

Wartość właściwości

boolean

dziedziczone zApiEntityBaseContract.isCurrent

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

dziedziczone zApiEntityBaseContract.isOnline

license

Informacje o licencji dla interfejsu API.

license?: ApiLicenseInformation

Wartość właściwości

ApiLicenseInformation

dziedziczone zApiEntityBaseContract.license

subscriptionKeyParameterNames

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

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Wartość właściwości

SubscriptionKeyParameterNamesContract

dziedziczone zApiEntityBaseContract.subscriptionKeyParameterNames

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

dziedziczone zApiEntityBaseContract.subscriptionRequired

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

dziedziczone zApiEntityBaseContract.termsOfServiceUrl