TagImpl | @azure/arm-apimanagement

Class containing Tag operations.

Hierarchy

TagImpl

Implements

Constructors

constructor

new TagImpl(client: ApiManagementClientContext): TagImpl

- Defined in operations/tag.ts:69
Initialize a new instance of the class Tag class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns TagImpl

Methods

assignToApi

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

Implementation of Tag.assignToApi
- Defined in operations/tag.ts:598
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>

Implementation of Tag.assignToOperation
- Defined in operations/tag.ts:486
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>

Implementation of Tag.assignToProduct
- Defined in operations/tag.ts:702
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>

Implementation of Tag.createOrUpdate
- Defined in operations/tag.ts:799
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>

Implementation of Tag.delete
- Defined in operations/tag.ts:845
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>

Implementation of Tag.detachFromApi
- Defined in operations/tag.ts:620
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>

Implementation of Tag.detachFromOperation
- Defined in operations/tag.ts:511
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>

Implementation of Tag.detachFromProduct
- Defined in operations/tag.ts:723
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>

Implementation of Tag.get
- Defined in operations/tag.ts:779
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>

Implementation of Tag.getByApi
- Defined in operations/tag.ts:576
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>

Implementation of Tag.getByOperation
- Defined in operations/tag.ts:461
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>

Implementation of Tag.getByProduct
- Defined in operations/tag.ts:681
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>

Implementation of Tag.getEntityState
- Defined in operations/tag.ts:760
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>

Implementation of Tag.getEntityStateByApi
- Defined in operations/tag.ts:554
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>

Implementation of Tag.getEntityStateByOperation
- Defined in operations/tag.ts:436
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>

Implementation of Tag.getEntityStateByProduct
- Defined in operations/tag.ts:660
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>

Implementation of Tag.listByApi
- Defined in operations/tag.ts:178
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>

Implementation of Tag.listByOperation
- Defined in operations/tag.ts:89
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>

Implementation of Tag.listByProduct
- Defined in operations/tag.ts:258
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>

Implementation of Tag.listByService
- Defined in operations/tag.ts:337
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>

Implementation of Tag.update
- Defined in operations/tag.ts:822
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

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns TagImpl

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