Sdílet prostřednictvím

ApiCreateOrUpdateParameter interface

  • Reference
Balíček:
@azure/arm-apimanagement

Parametry vytvoření nebo aktualizace rozhraní API.

Vlastnosti

apiRevision

Popisuje revizi rozhraní API. Pokud se nezadá žádná hodnota, vytvoří se výchozí revize 1.
apiRevisionDescription

Popis revize rozhraní API
apiType

Typ rozhraní API
apiVersion

Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.
apiVersionDescription

Popis verze rozhraní API.
apiVersionSet

Podrobnosti sady verzí
apiVersionSetId

Identifikátor prostředku pro související ApiVersionSet.
authenticationSettings

Kolekce nastavení ověřování zahrnutých do tohoto rozhraní API
contact

Kontaktní informace pro rozhraní API.
description

Popis rozhraní API. Mohou obsahovat značky formátování HTML.
displayName

Název rozhraní API. Musí mít délku 1 až 300 znaků.
format

Formát obsahu, ve kterém se rozhraní API importuje.
isCurrent

Označuje, jestli je revize rozhraní API aktuální revize rozhraní API.
isOnline

Označuje, jestli je revize rozhraní API přístupná prostřednictvím brány. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
license

Informace o licencích pro rozhraní API
path

Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby Gestione API. Připojí se k základní adrese URL koncového bodu rozhraní API zadanou při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.
protocols

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.
serviceUrl

Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2000 znaků.
soapApiType

Typ rozhraní API, které chcete vytvořit.

  • http vytvoří rozhraní REST API.
  • soap vytvoří předávací rozhraní API protokolu SOAP.
  • websocket vytvoří rozhraní WEBSocket API.
  • graphql vytvoří rozhraní GraphQL API.
sourceApiId

Identifikátor rozhraní API zdrojového rozhraní API
subscriptionKeyParameterNames

Protokoly, přes které je k dispozici rozhraní API.
subscriptionRequired

Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo product.
termsOfServiceUrl

Adresa URL pro podmínky služby pro rozhraní API. MUSÍ být ve formátu adresy URL.
translateRequiredQueryParametersConduct

Strategie překladu požadovaných parametrů dotazu na parametry šablony. Ve výchozím nastavení má hodnotu "šablona". Možné hodnoty: 'template', 'query'
value

Hodnota obsahu při importu rozhraní API
wsdlSelector

Kritéria pro omezení importu WSDL na podmnožinu dokumentu

Podrobnosti vlastnosti

apiRevision

Popisuje revizi rozhraní API. Pokud se nezadá žádná hodnota, vytvoří se výchozí revize 1.

apiRevision?: string

Hodnota vlastnosti

string

apiRevisionDescription

Popis revize rozhraní API

apiRevisionDescription?: string

Hodnota vlastnosti

string

apiType

Typ rozhraní API

apiType?: string

Hodnota vlastnosti

string

apiVersion

Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.

apiVersion?: string

Hodnota vlastnosti

string

apiVersionDescription

Popis verze rozhraní API.

apiVersionDescription?: string

Hodnota vlastnosti

string

apiVersionSet

Podrobnosti sady verzí

apiVersionSet?: ApiVersionSetContractDetails

Hodnota vlastnosti

ApiVersionSetContractDetails

apiVersionSetId

Identifikátor prostředku pro související ApiVersionSet.

apiVersionSetId?: string

Hodnota vlastnosti

string

authenticationSettings

Kolekce nastavení ověřování zahrnutých do tohoto rozhraní API

authenticationSettings?: AuthenticationSettingsContract

Hodnota vlastnosti

AuthenticationSettingsContract

contact

Kontaktní informace pro rozhraní API.

contact?: ApiContactInformation

Hodnota vlastnosti

ApiContactInformation

description

Popis rozhraní API. Mohou obsahovat značky formátování HTML.

description?: string

Hodnota vlastnosti

string

displayName

Název rozhraní API. Musí mít délku 1 až 300 znaků.

displayName?: string

Hodnota vlastnosti

string

format

Formát obsahu, ve kterém se rozhraní API importuje.

format?: string

Hodnota vlastnosti

string

isCurrent

Označuje, jestli je revize rozhraní API aktuální revize rozhraní API.

isCurrent?: boolean

Hodnota vlastnosti

boolean

isOnline

Označuje, jestli je revize rozhraní API přístupná prostřednictvím brány. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

isOnline?: boolean

Hodnota vlastnosti

boolean

license

Informace o licencích pro rozhraní API

license?: ApiLicenseInformation

Hodnota vlastnosti

ApiLicenseInformation

path

Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby Gestione API. Připojí se k základní adrese URL koncového bodu rozhraní API zadanou při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.

path?: string

Hodnota vlastnosti

string

protocols

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.

protocols?: string[]

Hodnota vlastnosti

string[]

serviceUrl

Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2000 znaků.

serviceUrl?: string

Hodnota vlastnosti

string

soapApiType

Typ rozhraní API, které chcete vytvořit.

  • http vytvoří rozhraní REST API.
  • soap vytvoří předávací rozhraní API protokolu SOAP.
  • websocket vytvoří rozhraní WEBSocket API.
  • graphql vytvoří rozhraní GraphQL API.
soapApiType?: string

Hodnota vlastnosti

string

sourceApiId

Identifikátor rozhraní API zdrojového rozhraní API

sourceApiId?: string

Hodnota vlastnosti

string

subscriptionKeyParameterNames

Protokoly, přes které je k dispozici rozhraní API.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Hodnota vlastnosti

SubscriptionKeyParameterNamesContract

subscriptionRequired

Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo product.

subscriptionRequired?: boolean

Hodnota vlastnosti

boolean

termsOfServiceUrl

Adresa URL pro podmínky služby pro rozhraní API. MUSÍ být ve formátu adresy URL.

termsOfServiceUrl?: string

Hodnota vlastnosti

string

translateRequiredQueryParametersConduct

Strategie překladu požadovaných parametrů dotazu na parametry šablony. Ve výchozím nastavení má hodnotu "šablona". Možné hodnoty: 'template', 'query'

translateRequiredQueryParametersConduct?: string

Hodnota vlastnosti

string

value

Hodnota obsahu při importu rozhraní API

value?: string

Hodnota vlastnosti

string

wsdlSelector

Kritéria pro omezení importu WSDL na podmnožinu dokumentu

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Hodnota vlastnosti

ApiCreateOrUpdatePropertiesWsdlSelector