Tag interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en tagg.

Metoder

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)	Tilldela tagg till API:et.
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)	Tilldela tagg till åtgärden.
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)	Tilldela taggen till produkten.
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)	Skapar en tagg.
delete(string, string, string, string, TagDeleteOptionalParams)	Tar bort en specifik tagg för API Management-tjänstinstansen.
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)	Koppla från taggen från API:et.
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)	Koppla bort taggen från åtgärden.
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)	Koppla från taggen från produkten.
get(string, string, string, TagGetOptionalParams)	Hämtar information om taggen som anges av dess identifierare.
getByApi(string, string, string, string, TagGetByApiOptionalParams)	Hämta tagg som är associerad med API:et.
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)	Hämta tagg som är associerad med åtgärden.
getByProduct(string, string, string, string, TagGetByProductOptionalParams)	Hämta tagg som är associerad med produkten.
getEntityState(string, string, string, TagGetEntityStateOptionalParams)	Hämtar entitetstillståndsversionen av taggen som anges av dess identifierare.
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)	Hämtar entitetstillståndsversionen av taggen som anges av dess identifierare.
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)	Hämtar entitetstillståndsversionen av taggen som anges av dess identifierare.
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)	Hämtar entitetstillståndsversionen av taggen som anges av dess identifierare.
listByApi(string, string, string, TagListByApiOptionalParams)	Visar en lista över alla taggar som är associerade med API:et.
listByOperation(string, string, string, string, TagListByOperationOptionalParams)	Visar en lista över alla taggar som är associerade med åtgärden.
listByProduct(string, string, string, TagListByProductOptionalParams)	Visar en lista över alla taggar som är associerade med produkten.
listByService(string, string, TagListByServiceOptionalParams)	Visar en samling taggar som definierats i en tjänstinstans.
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)	Uppdateringar information om taggen som anges av dess identifierare.

Metodinformation

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)

Tilldela tagg till API:et.

function assignToApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagAssignToApiOptionalParams): Promise<TagAssignToApiResponse>

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.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagAssignToApiOptionalParams

Alternativparametrarna.

Returer

Promise<TagAssignToApiResponse>

assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)

Tilldela tagg till åtgärden.

function assignToOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagAssignToOperationOptionalParams): Promise<TagContract>

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.

operationId

string

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagAssignToOperationOptionalParams

Alternativparametrarna.

Returer

Promise<TagContract>

assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)

Tilldela taggen till produkten.

function assignToProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagAssignToProductOptionalParams): Promise<TagContract>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagAssignToProductOptionalParams

Alternativparametrarna.

Returer

Promise<TagContract>

createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)

Skapar en tagg.

function createOrUpdate(resourceGroupName: string, serviceName: string, tagId: string, parameters: TagCreateUpdateParameters, options?: TagCreateOrUpdateOptionalParams): Promise<TagCreateOrUpdateResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

parameters

TagCreateUpdateParameters

Skapa parametrar.

options

TagCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<TagCreateOrUpdateResponse>

delete(string, string, string, string, TagDeleteOptionalParams)

Tar bort en specifik tagg för API Management-tjänstinstansen.

function delete(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, options?: TagDeleteOptionalParams): Promise<void>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

ifMatch

string

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

options

TagDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)

Koppla från taggen från API:et.

function detachFromApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagDetachFromApiOptionalParams): 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.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagDetachFromApiOptionalParams

Alternativparametrarna.

Returer

Promise<void>

detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)

Koppla bort taggen från åtgärden.

function detachFromOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagDetachFromOperationOptionalParams): 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.

operationId

string

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagDetachFromOperationOptionalParams

Alternativparametrarna.

Returer

Promise<void>

detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)

Koppla från taggen från produkten.

function detachFromProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagDetachFromProductOptionalParams): Promise<void>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagDetachFromProductOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, string, TagGetOptionalParams)

Hämtar information om taggen som anges av dess identifierare.

function get(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetOptionalParams): Promise<TagGetResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagGetOptionalParams

Alternativparametrarna.

Returer

Promise<TagGetResponse>

getByApi(string, string, string, string, TagGetByApiOptionalParams)

Hämta tagg som är associerad med API:et.

function getByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetByApiOptionalParams): Promise<TagGetByApiResponse>

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.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagGetByApiOptionalParams

Alternativparametrarna.

Returer

Promise<TagGetByApiResponse>

getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)

Hämta tagg som är associerad med åtgärden.

function getByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetByOperationOptionalParams): Promise<TagGetByOperationResponse>

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.

operationId

string

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagGetByOperationOptionalParams

Alternativparametrarna.

Returer

Promise<TagGetByOperationResponse>

getByProduct(string, string, string, string, TagGetByProductOptionalParams)

Hämta tagg som är associerad med produkten.

function getByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetByProductOptionalParams): Promise<TagGetByProductResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagGetByProductOptionalParams

Alternativparametrarna.

Returer

Promise<TagGetByProductResponse>

getEntityState(string, string, string, TagGetEntityStateOptionalParams)

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

function getEntityState(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetEntityStateOptionalParams): Promise<TagGetEntityStateHeaders>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagGetEntityStateOptionalParams

Alternativparametrarna.

Returer

Promise<TagGetEntityStateHeaders>

getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)

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

function getEntityStateByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetEntityStateByApiOptionalParams): Promise<TagGetEntityStateByApiHeaders>

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.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagGetEntityStateByApiOptionalParams

Alternativparametrarna.

Returer

Promise<TagGetEntityStateByApiHeaders>

getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)

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

function getEntityStateByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetEntityStateByOperationOptionalParams): Promise<TagGetEntityStateByOperationHeaders>

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.

operationId

string

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagGetEntityStateByOperationOptionalParams

Alternativparametrarna.

Returer

Promise<TagGetEntityStateByOperationHeaders>

getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)

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

function getEntityStateByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetEntityStateByProductOptionalParams): Promise<TagGetEntityStateByProductHeaders>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagGetEntityStateByProductOptionalParams

Alternativparametrarna.

Returer

Promise<TagGetEntityStateByProductHeaders>

listByApi(string, string, string, TagListByApiOptionalParams)

Visar en lista över alla taggar som är associerade med API:et.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: TagListByApiOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], 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

TagListByApiOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByOperation(string, string, string, string, TagListByOperationOptionalParams)

Visar en lista över alla taggar som är associerade med åtgärden.

function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: TagListByOperationOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], 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.

operationId

string

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagListByOperationOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByProduct(string, string, string, TagListByProductOptionalParams)

Visar en lista över alla taggar som är associerade med produkten.

function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: TagListByProductOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

TagListByProductOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByService(string, string, TagListByServiceOptionalParams)

Visar en samling taggar som definierats i en tjänstinstans.

function listByService(resourceGroupName: string, serviceName: string, options?: TagListByServiceOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

options

TagListByServiceOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)

Uppdateringar information om taggen som anges av dess identifierare.

function update(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, parameters: TagCreateUpdateParameters, options?: TagUpdateOptionalParams): Promise<TagUpdateResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

tagId

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

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.

parameters

TagCreateUpdateParameters

Uppdatera parametrar.

options

TagUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<TagUpdateResponse>