Udostępnij przez

ApiCreateOrUpdateParameter interface

Pakiet:
@azure/arm-apimanagement

Tworzenie lub aktualizowanie parametrów 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.
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.
format

Format zawartości, w której jest importowany interfejs API. Nowe formaty można dodawać w przyszłości
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 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.
soapApiType

Typ interfejsu API do utworzenia.

  • http tworzy interfejs API REST
  • soap tworzy interfejs API przekazywania protokołu SOAP
  • websocket tworzy interfejs API protokołu websocket
  • graphql tworzy interfejs API GraphQL. Nowe typy można dodawać w przyszłości.
sourceApiId

Identyfikator interfejsu API źródłowego 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.
translateRequiredQueryParametersConduct

Strategia tłumaczenia wymaganych parametrów zapytania na szablony. Domyślnie ma wartość "template". Możliwe wartości: "template", "query"
value

Wartość zawartości podczas importowania interfejsu API.
wsdlSelector

Kryteria ograniczania importu WSDL do podzestawu dokumentu.

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

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

format

Format zawartości, w której jest importowany interfejs API. Nowe formaty można dodawać w przyszłości

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

soapApiType

Typ interfejsu API do utworzenia.

  • http tworzy interfejs API REST
  • soap tworzy interfejs API przekazywania protokołu SOAP
  • websocket tworzy interfejs API protokołu websocket
  • graphql tworzy interfejs API GraphQL. Nowe typy można dodawać w przyszłości.
soapApiType?: string

Wartość właściwości

string

sourceApiId

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

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

translateRequiredQueryParametersConduct

Strategia tłumaczenia wymaganych parametrów zapytania na szablony. Domyślnie ma wartość "template". Możliwe wartości: "template", "query"

translateRequiredQueryParametersConduct?: string

Wartość właściwości

string

value

Wartość zawartości podczas importowania interfejsu API.

value?: string

Wartość właściwości

string

wsdlSelector

Kryteria ograniczania importu WSDL do podzestawu dokumentu.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Wartość właściwości

ApiCreateOrUpdatePropertiesWsdlSelector