Udostępnij za pośrednictwem

ApiContract interface

  • Odwołanie
Pakiet:
@azure/arm-apimanagement

Szczegóły interfejsu API.

Rozszerzenie
ProxyResource

Właściwości

apiRevision

Opisuje poprawkę interfejsu API. Jeśli nie zostanie podana żadna wartość, 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.
apiVersionSet

Szczegóły zestawu wersji
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.
displayName

Nazwa interfejsu API. Musi mieć długość od 1 do 300 znaków.
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.
path

Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w ramach wystąpienia 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.
subscriptionKeyParameterNames

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

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

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

Właściwości dziedziczone

id

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
name

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

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Szczegóły właściwości

apiRevision

Opisuje poprawkę interfejsu API. Jeśli nie zostanie podana żadna wartość, 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

apiVersionSet

Szczegóły zestawu wersji

apiVersionSet?: ApiVersionSetContractDetails

Wartość właściwości

ApiVersionSetContractDetails

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

displayName

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

displayName?: 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

path

Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w ramach wystąpienia 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

subscriptionKeyParameterNames

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

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Wartość właściwości

SubscriptionKeyParameterNamesContract

subscriptionRequired

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

subscriptionRequired?: boolean

Wartość właściwości

boolean

termsOfServiceUrl

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

termsOfServiceUrl?: string

Wartość właściwości

string

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

id

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

id?: string

Wartość właściwości

string

Dziedziczone zProxyResource.id

name

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

name?: string

Wartość właściwości

string

Dziedziczone zProxyResource.name

type

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

type?: string

Wartość właściwości

string

Dziedziczone zproxyResource.type