ApiTagDescription interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en ApiTagDescription.

Metoder

createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)	Skapa/uppdatera taggbeskrivning i api:ets omfång.
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)	Ta bort taggbeskrivning för API:et.
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)	Hämta taggbeskrivning i API-omfånget
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)	Hämtar entitetstillståndsversionen för taggen som anges av dess identifierare.
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)	Visar en lista över alla beskrivningar av taggar i API-omfånget. Modell som liknar swagger – tagDescription definieras på API-nivå, men taggen kan tilldelas till åtgärderna

Metodinformation

createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)

Skapa/uppdatera taggbeskrivning i api:ets omfång.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

tagDescriptionId

string

Taggbeskrivningsidentifierare. Används när du skapar tagDescription för API/Taggassociation. Baserat på API- och taggnamn.

parameters

TagDescriptionCreateParameters

Skapa parametrar.

options

ApiTagDescriptionCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ApiTagDescriptionCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)

Ta bort taggbeskrivning för API:et.

function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

tagDescriptionId

string

Taggbeskrivningsidentifierare. Används när du skapar tagDescription för API/Taggassociation. Baserat på API- och taggnamn.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

options

ApiTagDescriptionDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, string, string, ApiTagDescriptionGetOptionalParams)

Hämta taggbeskrivning i API-omfånget

function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

tagDescriptionId

string

Taggbeskrivningsidentifierare. Används när du skapar tagDescription för API/Taggassociation. Baserat på API- och taggnamn.

options

ApiTagDescriptionGetOptionalParams

Alternativparametrarna.

Returer

Promise<ApiTagDescriptionGetResponse>

getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)

Hämtar entitetstillståndsversionen för taggen som anges av dess identifierare.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

tagDescriptionId

string

Taggbeskrivningsidentifierare. Används när du skapar tagDescription för API/Taggassociation. Baserat på API- och taggnamn.

options

ApiTagDescriptionGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<ApiTagDescriptionGetEntityTagHeaders>

listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)

Visar en lista över alla beskrivningar av taggar i API-omfånget. Modell som liknar swagger – tagDescription definieras på API-nivå, men taggen kan tilldelas till åtgärderna

function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

options

ApiTagDescriptionListByServiceOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>