ApiSchema interface
Rozhraní představující ApiSchema.
Metody
| begin |
Vytvoří nebo aktualizuje konfiguraci schématu pro rozhraní API. |
| begin |
Vytvoří nebo aktualizuje konfiguraci schématu pro rozhraní API. |
| delete(string, string, string, string, string, Api |
Odstraní konfiguraci schématu v rozhraní API. |
| get(string, string, string, string, Api |
Získejte konfiguraci schématu na úrovni rozhraní API. |
| get |
Získá stav entity (Etag) verze schématu určeného jeho identifikátorem. |
| list |
Získejte konfiguraci schématu na úrovni rozhraní API. |
Podrobnosti metody
beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
Vytvoří nebo aktualizuje konfiguraci schématu pro rozhraní API.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor revize rozhraní API. Musí být jedinečný v aktuální instanci služby Gestione API. Neaktuální revize má příponu ;rev=n, kde n je číslo revize.
- schemaId
-
string
Identifikátor ID schématu. Musí být jedinečný v aktuální instanci služby Gestione API.
- parameters
- SchemaContract
Obsah schématu, který se má použít.
Parametry možností.
Návraty
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
Vytvoří nebo aktualizuje konfiguraci schématu pro rozhraní API.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor revize rozhraní API. Musí být jedinečný v aktuální instanci služby Gestione API. Neaktuální revize má příponu ;rev=n, kde n je číslo revize.
- schemaId
-
string
Identifikátor ID schématu. Musí být jedinečný v aktuální instanci služby Gestione API.
- parameters
- SchemaContract
Obsah schématu, který se má použít.
Parametry možností.
Návraty
Promise<ApiSchemaCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)
Odstraní konfiguraci schématu v rozhraní API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor revize rozhraní API. Musí být jedinečný v aktuální instanci služby Gestione API. Neaktuální revize má příponu ;rev=n, kde n je číslo revize.
- schemaId
-
string
Identifikátor ID schématu. Musí být jedinečný v aktuální instanci služby Gestione API.
- ifMatch
-
string
Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro nepodmíněnou aktualizaci.
- options
- ApiSchemaDeleteOptionalParams
Parametry možností.
Návraty
Promise<void>
get(string, string, string, string, ApiSchemaGetOptionalParams)
Získejte konfiguraci schématu na úrovni rozhraní API.
function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor revize rozhraní API. Musí být jedinečný v aktuální instanci služby Gestione API. Neaktuální revize má příponu ;rev=n, kde n je číslo revize.
- schemaId
-
string
Identifikátor ID schématu. Musí být jedinečný v aktuální instanci služby Gestione API.
- options
- ApiSchemaGetOptionalParams
Parametry možností.
Návraty
Promise<ApiSchemaGetResponse>
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)
Získá stav entity (Etag) verze schématu určeného jeho identifikátorem.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor revize rozhraní API. Musí být jedinečný v aktuální instanci služby Gestione API. Neaktuální revize má příponu ;rev=n, kde n je číslo revize.
- schemaId
-
string
Identifikátor ID schématu. Musí být jedinečný v aktuální instanci služby Gestione API.
Parametry možností.
Návraty
Promise<ApiSchemaGetEntityTagHeaders>
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)
Získejte konfiguraci schématu na úrovni rozhraní API.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- apiId
-
string
Identifikátor revize rozhraní API. Musí být jedinečný v aktuální instanci služby Gestione API. Neaktuální revize má příponu ;rev=n, kde n je číslo revize.
- options
- ApiSchemaListByApiOptionalParams
Parametry možností.