Udostępnij za pośrednictwem

ApiContractProperties interface

  • Odwołanie
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 dla tego interfejsu API.
protocols

Opisuje, na których protokołach można wywołać operacje w tym interfejsie API.
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.

Właściwości dziedziczone

apiRevision

Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna poprawka 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 interfejsu API.
subscriptionKeyParameterNames

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

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

Adres URL warunków użytkowania 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 dla tego interfejsu API.

path: string

Wartość właściwości

string

protocols

Opisuje, na których protokołach można wywołać operacje w tym interfejsie API.

protocols?: 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.

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 poprawka 1

apiRevision?: string

Wartość właściwości

string

Dziedziczone zklasy ApiEntityBaseContract.apiRevision

apiRevisionDescription

Opis poprawki interfejsu API.

apiRevisionDescription?: string

Wartość właściwości

string

Dziedziczone zklasy ApiEntityBaseContract.apiRevisionDescription

apiType

Typ interfejsu API.

apiType?: string

Wartość właściwości

string

Dziedziczone zklasy ApiEntityBaseContract.apiType

apiVersion

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

apiVersion?: string

Wartość właściwości

string

Dziedziczone zklasy ApiEntityBaseContract.apiVersion

apiVersionDescription

Opis wersji interfejsu API.

apiVersionDescription?: string

Wartość właściwości

string

Dziedziczone zklasy ApiEntityBaseContract.apiVersionDescription

apiVersionSetId

Identyfikator zasobu powiązanego elementu ApiVersionSet.

apiVersionSetId?: string

Wartość właściwości

string

Dziedziczone zklasy ApiEntityBaseContract.apiVersionSetId

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Wartość właściwości

AuthenticationSettingsContract

Dziedziczone zklasy ApiEntityBaseContract.authenticationSettings

contact

Informacje kontaktowe dotyczące interfejsu API.

contact?: ApiContactInformation

Wartość właściwości

ApiContactInformation

Dziedziczone zklasy ApiEntityBaseContract.contact

description

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

description?: string

Wartość właściwości

string

Dziedziczone zklasy ApiEntityBaseContract.description

isCurrent

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

isCurrent?: boolean

Wartość właściwości

boolean

Dziedziczone zklasy ApiEntityBaseContract.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 zklasy ApiEntityBaseContract.isOnline

license

Informacje o licencji interfejsu API.

license?: ApiLicenseInformation

Wartość właściwości

ApiLicenseInformation

Dziedziczone zklasy ApiEntityBaseContract.license

subscriptionKeyParameterNames

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

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Wartość właściwości

SubscriptionKeyParameterNamesContract

Dziedziczone zklasy ApiEntityBaseContract.subscriptionKeyParameterNames

subscriptionRequired

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

subscriptionRequired?: boolean

Wartość właściwości

boolean

Dziedziczone zklasy ApiEntityBaseContract.subscriptionRequired

termsOfServiceUrl

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

termsOfServiceUrl?: string

Wartość właściwości

string

Dziedziczone zklasy ApiEntityBaseContract.termsOfServiceUrl