ApiContract interface
Podrobnosti rozhraní API
- Extends
Vlastnosti
| api |
Popisuje revizi rozhraní API. Pokud se nezadá žádná hodnota, vytvoří se výchozí revize 1. |
| api |
Popis revize rozhraní API |
| api |
Typ rozhraní API |
| api |
Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí. |
| api |
Popis verze rozhraní API. |
| api |
Podrobnosti sady verzí |
| api |
Identifikátor prostředku pro související ApiVersionSet. |
| authentication |
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. |
| display |
Název rozhraní API. Musí mít délku 1 až 300 znaků. |
| is |
Označuje, jestli je revize rozhraní API aktuální revize rozhraní API. |
| is |
Označuje, jestli je revize rozhraní API přístupná prostřednictvím brány. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server. |
| license | Informace o licenci pro rozhraní API |
| path | Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v instanci Gestione API služby Připojí se k základní adrese URL koncového bodu rozhraní API zadané 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. |
| service |
Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2 000 znaků. |
| source |
Identifikátor rozhraní API zdrojového rozhraní API |
| subscription |
Protokoly, přes které je k dispozici rozhraní API. |
| subscription |
Určuje, jestli se pro přístup k rozhraní API vyžaduje rozhraní API nebo předplatné produktu. |
| terms |
Adresa URL podmínek služby pro rozhraní API. MUSÍ být ve formátu adresy URL. |
Zděděné vlastnosti
| id | Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{resourceType}/{název_prostředku} POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server. |
| name | Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server. |
| type | Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server. |
Podrobnosti vlastnosti
apiRevision
Popisuje revizi rozhraní API. Pokud se nezadá žádná hodnota, vytvoří se výchozí revize 1.
apiRevision?: stringHodnota vlastnosti
string
apiRevisionDescription
Popis revize rozhraní API
apiRevisionDescription?: stringHodnota vlastnosti
string
apiType
Typ rozhraní API
apiType?: stringHodnota vlastnosti
string
apiVersion
Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.
apiVersion?: stringHodnota vlastnosti
string
apiVersionDescription
Popis verze rozhraní API.
apiVersionDescription?: stringHodnota vlastnosti
string
apiVersionSet
Podrobnosti sady verzí
apiVersionSet?: ApiVersionSetContractDetailsHodnota vlastnosti
apiVersionSetId
Identifikátor prostředku pro související ApiVersionSet.
apiVersionSetId?: stringHodnota vlastnosti
string
authenticationSettings
Kolekce nastavení ověřování zahrnutých do tohoto rozhraní API
authenticationSettings?: AuthenticationSettingsContractHodnota vlastnosti
contact
Kontaktní informace pro rozhraní API.
contact?: ApiContactInformationHodnota vlastnosti
description
Popis rozhraní API. Mohou obsahovat značky formátování HTML.
description?: stringHodnota vlastnosti
string
displayName
Název rozhraní API. Musí mít délku 1 až 300 znaků.
displayName?: stringHodnota vlastnosti
string
isCurrent
Označuje, jestli je revize rozhraní API aktuální revize rozhraní API.
isCurrent?: booleanHodnota vlastnosti
boolean
isOnline
Označuje, jestli je revize rozhraní API přístupná prostřednictvím brány. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
isOnline?: booleanHodnota vlastnosti
boolean
license
Informace o licenci pro rozhraní API
license?: ApiLicenseInformationHodnota vlastnosti
path
Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v instanci Gestione API služby Připojí se k základní adrese URL koncového bodu rozhraní API zadané při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.
path?: stringHodnota 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ž 2 000 znaků.
serviceUrl?: stringHodnota vlastnosti
string
sourceApiId
Identifikátor rozhraní API zdrojového rozhraní API
sourceApiId?: stringHodnota vlastnosti
string
subscriptionKeyParameterNames
Protokoly, přes které je k dispozici rozhraní API.
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContractHodnota vlastnosti
subscriptionRequired
Určuje, jestli se pro přístup k rozhraní API vyžaduje rozhraní API nebo předplatné produktu.
subscriptionRequired?: booleanHodnota vlastnosti
boolean
termsOfServiceUrl
Adresa URL podmínek služby pro rozhraní API. MUSÍ být ve formátu adresy URL.
termsOfServiceUrl?: stringHodnota vlastnosti
string
Podrobnosti zděděných vlastností
id
Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{resourceType}/{název_prostředku} POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
id?: stringHodnota vlastnosti
string
Zděděno zProxyResource.id
name
Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
name?: stringHodnota vlastnosti
string
Zděděno zProxyResource.name
type
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
type?: stringHodnota vlastnosti
string
Zděděno zProxyResource.type