Tag | @azure/arm-apimanagement

Interface representing a Tag.

Hierarchy

Implemented by

TagImpl

Methods

assignToApi

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

- Defined in operationsInterfaces/tag.ts:224
Assign tag to the Api.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagAssignToApiOptionalParams
  
  The options parameters.
Returns Promise<TagAssignToApiResponse>

assignToOperation

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

- Defined in operationsInterfaces/tag.ts:156
Assign tag to the Operation.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagAssignToOperationOptionalParams
  
  The options parameters.
Returns Promise<TagAssignToOperationResponse>

assignToProduct

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

- Defined in operationsInterfaces/tag.ts:285
Assign tag to the Product.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagAssignToProductOptionalParams
  
  The options parameters.
Returns Promise<TagAssignToProductResponse>

createOrUpdate

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

- Defined in operationsInterfaces/tag.ts:341
Creates a tag.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<TagCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/tag.ts:375
Deletes specific tag of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

detachFromApi

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

- Defined in operationsInterfaces/tag.ts:240
Detach the tag from the Api.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagDetachFromApiOptionalParams
  
  The options parameters.
Returns Promise<void>

detachFromOperation

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

- Defined in operationsInterfaces/tag.ts:175
Detach the tag from the Operation.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagDetachFromOperationOptionalParams
  
  The options parameters.
Returns Promise<void>

detachFromProduct

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

- Defined in operationsInterfaces/tag.ts:300
Detach the tag from the Product.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagDetachFromProductOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/tag.ts:327
Gets the details of the tag specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- tagId: string
  
  Tag identifier. Must be unique in the current API Management service instance.
- Optional options: TagGetOptionalParams
  
  The options parameters.
Returns Promise<TagGetResponse>

getByApi

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

- Defined in operationsInterfaces/tag.ts:208
Get tag associated with the API.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagGetByApiOptionalParams
  
  The options parameters.
Returns Promise<TagGetByApiResponse>

getByOperation

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

- Defined in operationsInterfaces/tag.ts:137
Get tag associated with the Operation.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagGetByOperationOptionalParams
  
  The options parameters.
Returns Promise<TagGetByOperationResponse>

getByProduct

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

- Defined in operationsInterfaces/tag.ts:270
Get tag associated with the Product.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagGetByProductOptionalParams
  
  The options parameters.
Returns Promise<TagGetByProductResponse>

getEntityState

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

- Defined in operationsInterfaces/tag.ts:314
Gets the entity state version of the tag specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- tagId: string
  
  Tag identifier. Must be unique in the current API Management service instance.
- Optional options: TagGetEntityStateOptionalParams
  
  The options parameters.
Returns Promise<TagGetEntityStateResponse>

getEntityStateByApi

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

- Defined in operationsInterfaces/tag.ts:192
Gets the entity state version of the tag specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagGetEntityStateByApiOptionalParams
  
  The options parameters.
Returns Promise<TagGetEntityStateByApiResponse>

getEntityStateByOperation

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

- Defined in operationsInterfaces/tag.ts:118
Gets the entity state version of the tag specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagGetEntityStateByOperationOptionalParams
  
  The options parameters.
Returns Promise<TagGetEntityStateByOperationResponse>

getEntityStateByProduct

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

- Defined in operationsInterfaces/tag.ts:255
Gets the entity state version of the tag specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagGetEntityStateByProductOptionalParams
  
  The options parameters.
Returns Promise<TagGetEntityStateByProductResponse>

listByApi

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

- Defined in operationsInterfaces/tag.ts:77
Lists all Tags associated with the API.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagListByApiOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TagContract>

listByOperation

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

- Defined in operationsInterfaces/tag.ts:62
Lists all Tags associated with the Operation.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagListByOperationOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TagContract>

listByProduct

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

- Defined in operationsInterfaces/tag.ts:90
Lists all Tags associated with the Product.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- productId: string
  
  Product identifier. Must be unique in the current API Management service instance.
- Optional options: TagListByProductOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TagContract>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: TagListByServiceOptionalParams): PagedAsyncIterableIterator<TagContract>

- Defined in operationsInterfaces/tag.ts:102
Lists a collection of tags defined within a service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: TagListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TagContract>

update

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

- Defined in operationsInterfaces/tag.ts:358
Updates the details of the tag specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: TagUpdateOptionalParams
  
  The options parameters.
Returns Promise<TagUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

assignToApi

Parameters

resourceGroupName: string

serviceName: string

apiId: string

tagId: string

Optional options: TagAssignToApiOptionalParams

Returns Promise<TagAssignToApiResponse>

assignToOperation

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

tagId: string

Optional options: TagAssignToOperationOptionalParams

Returns Promise<TagAssignToOperationResponse>

assignToProduct

Parameters

resourceGroupName: string

serviceName: string

productId: string

tagId: string

Optional options: TagAssignToProductOptionalParams

Returns Promise<TagAssignToProductResponse>

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

tagId: string

parameters: TagCreateUpdateParameters

Optional options: TagCreateOrUpdateOptionalParams

Returns Promise<TagCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

tagId: string

ifMatch: string

Optional options: TagDeleteOptionalParams

Returns Promise<void>

detachFromApi

Parameters

resourceGroupName: string

serviceName: string

apiId: string

tagId: string

Optional options: TagDetachFromApiOptionalParams

Returns Promise<void>

detachFromOperation

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

tagId: string

Optional options: TagDetachFromOperationOptionalParams

Returns Promise<void>

detachFromProduct

Parameters

resourceGroupName: string

serviceName: string

productId: string

tagId: string

Optional options: TagDetachFromProductOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

tagId: string

Optional options: TagGetOptionalParams

Returns Promise<TagGetResponse>

getByApi

Parameters