Tag interface

Package:

@azure/arm-apimanagement

Interface representing a Tag.

Methods

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)	Assign tag to the Api.
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)	Assign tag to the Operation.
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)	Assign tag to the Product.
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)	Creates a tag.
delete(string, string, string, string, TagDeleteOptionalParams)	Deletes specific tag of the API Management service instance.
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)	Detach the tag from the Api.
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)	Detach the tag from the Operation.
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)	Detach the tag from the Product.
get(string, string, string, TagGetOptionalParams)	Gets the details of the tag specified by its identifier.
getByApi(string, string, string, string, TagGetByApiOptionalParams)	Get tag associated with the API.
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)	Get tag associated with the Operation.
getByProduct(string, string, string, string, TagGetByProductOptionalParams)	Get tag associated with the Product.
getEntityState(string, string, string, TagGetEntityStateOptionalParams)	Gets the entity state version of the tag specified by its identifier.
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)	Gets the entity state version of the tag specified by its identifier.
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)	Gets the entity state version of the tag specified by its identifier.
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)	Gets the entity state version of the tag specified by its identifier.
listByApi(string, string, string, TagListByApiOptionalParams)	Lists all Tags associated with the API.
listByOperation(string, string, string, string, TagListByOperationOptionalParams)	Lists all Tags associated with the Operation.
listByProduct(string, string, string, TagListByProductOptionalParams)	Lists all Tags associated with the Product.
listByService(string, string, TagListByServiceOptionalParams)	Lists a collection of tags defined within a service instance.
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)	Updates the details of the tag specified by its identifier.

Method Details

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

Assign tag to the Api.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagAssignToApiOptionalParams

The options parameters.

Returns

Promise<TagAssignToApiResponse>

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

Assign tag to the Operation.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

operationId

string

Operation identifier within an API. Must be unique in the current API Management service instance.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagAssignToOperationOptionalParams

The options parameters.

Returns

Promise<TagContract>

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

Assign tag to the Product.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

productId

string

Product identifier. Must be unique in the current API Management service instance.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagAssignToProductOptionalParams

The options parameters.

Returns

Promise<TagContract>

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

Creates a tag.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

parameters

TagCreateUpdateParameters

Create parameters.

options

TagCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<TagCreateOrUpdateResponse>

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

Deletes specific tag of the API Management service instance.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options

TagDeleteOptionalParams

The options parameters.

Returns

Promise<void>

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

Detach the tag from the Api.

function detachFromApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagDetachFromApiOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagDetachFromApiOptionalParams

The options parameters.

Returns

Promise<void>

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

Detach the tag from the Operation.

function detachFromOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagDetachFromOperationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

operationId

string

Operation identifier within an API. Must be unique in the current API Management service instance.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagDetachFromOperationOptionalParams

The options parameters.

Returns

Promise<void>

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

Detach the tag from the Product.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

productId

string

Product identifier. Must be unique in the current API Management service instance.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagDetachFromProductOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, TagGetOptionalParams)

Gets the details of the tag specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagGetOptionalParams

The options parameters.

Returns

Promise<TagGetResponse>

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

Get tag associated with the API.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagGetByApiOptionalParams

The options parameters.

Returns

Promise<TagGetByApiResponse>

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

Get tag associated with the Operation.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

operationId

string

Operation identifier within an API. Must be unique in the current API Management service instance.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagGetByOperationOptionalParams

The options parameters.

Returns

Promise<TagGetByOperationResponse>

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

Get tag associated with the Product.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

productId

string

Product identifier. Must be unique in the current API Management service instance.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagGetByProductOptionalParams

The options parameters.

Returns

Promise<TagGetByProductResponse>

getEntityState(string, string, string, TagGetEntityStateOptionalParams)

Gets the entity state version of the tag specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagGetEntityStateOptionalParams

The options parameters.

Returns

Promise<TagGetEntityStateHeaders>

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

Gets the entity state version of the tag specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagGetEntityStateByApiOptionalParams

The options parameters.

Returns

Promise<TagGetEntityStateByApiHeaders>

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

Gets the entity state version of the tag specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

operationId

string

Operation identifier within an API. Must be unique in the current API Management service instance.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagGetEntityStateByOperationOptionalParams

The options parameters.

Returns

Promise<TagGetEntityStateByOperationHeaders>

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

Gets the entity state version of the tag specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

productId

string

Product identifier. Must be unique in the current API Management service instance.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

options

TagGetEntityStateByProductOptionalParams

The options parameters.

Returns

Promise<TagGetEntityStateByProductHeaders>

listByApi(string, string, string, TagListByApiOptionalParams)

Lists all Tags associated with the API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: TagListByApiOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

options

TagListByApiOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

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

Lists all Tags associated with the Operation.

function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: TagListByOperationOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

operationId

string

Operation identifier within an API. Must be unique in the current API Management service instance.

options

TagListByOperationOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByProduct(string, string, string, TagListByProductOptionalParams)

Lists all Tags associated with the Product.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

productId

string

Product identifier. Must be unique in the current API Management service instance.

options

TagListByProductOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByService(string, string, TagListByServiceOptionalParams)

Lists a collection of tags defined within a service instance.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options

TagListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

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

Updates the details of the tag specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

tagId

string

Tag identifier. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters

TagCreateUpdateParameters

Update parameters.

options

TagUpdateOptionalParams

The options parameters.

Returns

Promise<TagUpdateResponse>