ApiTagDescription interface
Rozhraní představující ApiTagDescription.
Metody
| create |
Vytvořte nebo aktualizujte popis značky v oboru rozhraní API. |
| delete(string, string, string, string, string, Api |
Odstraňte popis značky pro rozhraní API. |
| get(string, string, string, string, Api |
Získání popisu značky v oboru rozhraní API |
| get |
Získá verzi stavu entity značky určené jejím identifikátorem. |
| list |
Vypíše všechny popisy značek v rozsahu rozhraní API. Model podobný swaggeru – popis tagDescription se definuje na úrovni rozhraní API, ale značku je možné přiřadit k operacím. |
Podrobnosti metody
createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)
Vytvořte nebo aktualizujte popis značky v oboru rozhraní API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>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.
- tagDescriptionId
-
string
Identifikátor popisu značky. Používá se při vytváření popisů tagDescription pro přidružení rozhraní API/značky. Na základě rozhraní API a názvů značek.
- parameters
- TagDescriptionCreateParameters
Vytvořte parametry.
Parametry možností.
Návraty
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)
Odstraňte popis značky pro rozhraní API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): 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.
- tagDescriptionId
-
string
Identifikátor popisu značky. Používá se při vytváření popisů tagDescription pro přidružení rozhraní API/značky. Na základě rozhraní API a názvů značek.
- 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.
Parametry možností.
Návraty
Promise<void>
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)
Získání popisu značky v oboru rozhraní API
function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>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.
- tagDescriptionId
-
string
Identifikátor popisu značky. Používá se při vytváření popisů tagDescription pro přidružení rozhraní API/značky. Na základě rozhraní API a názvů značek.
Parametry možností.
Návraty
Promise<ApiTagDescriptionGetResponse>
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)
Získá verzi stavu entity značky určené jejím identifikátorem.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>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.
- tagDescriptionId
-
string
Identifikátor popisu značky. Používá se při vytváření popisů tagDescription pro přidružení rozhraní API/značky. Na základě rozhraní API a názvů značek.
Parametry možností.
Návraty
Promise<ApiTagDescriptionGetEntityTagHeaders>
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)
Vypíše všechny popisy značek v rozsahu rozhraní API. Model podobný swaggeru – popis tagDescription se definuje na úrovni rozhraní API, ale značku je možné přiřadit k operacím.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], 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.
Parametry možností.