Sdílet prostřednictvím

ApiContractProperties interface

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

Vlastnosti entity rozhraní API

Extends
ApiEntityBaseContract

Vlastnosti

apiVersionSet

Podrobnosti o sadě verzí
displayName

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

Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během 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, která toto rozhraní API implementuje. Nesmí být delší než 2 000 znaků.
sourceApiId

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

Zděděné vlastnosti

apiRevision

Popisuje revizi rozhraní API. Pokud není zadána žá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
apiVersionSetId

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

Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API.
contact

Kontaktní informace pro rozhraní API
description

Popis rozhraní API Může obsahovat značky formátování HTML.
isCurrent

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

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

Informace o licenci pro rozhraní API
subscriptionKeyParameterNames

Protokoly, u kterých je rozhraní API dostupné.
subscriptionRequired

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

Adresa URL podmínek služby pro rozhraní API. Musí být ve formátu adresy URL.

Podrobnosti vlastnosti

apiVersionSet

Podrobnosti o sadě verzí

apiVersionSet?: ApiVersionSetContractDetails

Hodnota vlastnosti

ApiVersionSetContractDetails

displayName

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

displayName?: string

Hodnota vlastnosti

string

path

Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během 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, která toto rozhraní API implementuje. Nesmí být delší než 2 000 znaků.

serviceUrl?: string

Hodnota vlastnosti

string

sourceApiId

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

sourceApiId?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

apiRevision

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

apiRevision?: string

Hodnota vlastnosti

string

zděděný zapiEntityBaseContract.apiRevision

apiRevisionDescription

Popis revize rozhraní API

apiRevisionDescription?: string

Hodnota vlastnosti

string

zděděné zapiEntityBaseContract.apiRevisionDescription

apiType

Typ rozhraní API

apiType?: string

Hodnota vlastnosti

string

zděděno zApiEntityBaseContract.apiType

apiVersion

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

apiVersion?: string

Hodnota vlastnosti

string

zděděný zapiEntityBaseContract.apiVersion

apiVersionDescription

Popis verze rozhraní API

apiVersionDescription?: string

Hodnota vlastnosti

string

zděděný zapiEntityBaseContract.apiVersionDescription

apiVersionSetId

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

apiVersionSetId?: string

Hodnota vlastnosti

string

zděděno zApiEntityBaseContract.apiVersionSetId

authenticationSettings

Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API.

authenticationSettings?: AuthenticationSettingsContract

Hodnota vlastnosti

AuthenticationSettingsContract

zděděno zApiEntityBaseContract.authenticationSettings

contact

Kontaktní informace pro rozhraní API

contact?: ApiContactInformation

Hodnota vlastnosti

ApiContactInformation

zděděno zApiEntityBaseContract.contact

description

Popis rozhraní API Může obsahovat značky formátování HTML.

description?: string

Hodnota vlastnosti

string

zděděný zapiEntityBaseContract.description

isCurrent

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

isCurrent?: boolean

Hodnota vlastnosti

boolean

zděděné zApiEntityBaseContract.isCurrent

isOnline

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

isOnline?: boolean

Hodnota vlastnosti

boolean

zděděno zApiEntityBaseContract.isOnline

license

Informace o licenci pro rozhraní API

license?: ApiLicenseInformation

Hodnota vlastnosti

ApiLicenseInformation

zděděno zApiEntityBaseContract.license

subscriptionKeyParameterNames

Protokoly, u kterých je rozhraní API dostupné.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Hodnota vlastnosti

SubscriptionKeyParameterNamesContract

zděděné zapiEntityBaseContract.subscriptionKeyParameterNames

subscriptionRequired

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

subscriptionRequired?: boolean

Hodnota vlastnosti

boolean

zděděno zApiEntityBaseContract.subscriptionRequired

termsOfServiceUrl

Adresa URL podmínek služby pro rozhraní API. Musí být ve formátu adresy URL.

termsOfServiceUrl?: string

Hodnota vlastnosti

string

zděděné zapiEntityBaseContract.termsOfServiceUrl