tags

Creates, updates, deletes, gets or lists a tags resource.

Overview

Name	tags
Type	Resource
Id	azure.api_management.tags

Fields

The following fields are returned by SELECT queries:

get_by_operation

Gets the details of the tag specified by its identifier.

Name	Datatype	Description
properties	object	Tag entity contract properties.

list_by_operation

The operation returns a collection of tags associated with the Operation entity.

Name	Datatype	Description
properties	object	Tag entity contract properties.

get_by_api

Gets the details of the tag specified by its identifier.

Name	Datatype	Description
properties	object	Tag entity contract properties.

get_by_product

Gets the details of the tag specified by its identifier.

Name	Datatype	Description
properties	object	Tag entity contract properties.

get

The response body contains the specified Tag entity.

Name	Datatype	Description
properties	object	Tag entity contract properties.

list_by_api

The operation returns a collection of tags associated with the Api entity.

Name	Datatype	Description
properties	object	Tag entity contract properties.

list_by_product

The operation returns a collection of tags associated with the Product entity.

Name	Datatype	Description
properties	object	Tag entity contract properties.

list_by_service

Lists a collection of Tag entities.

Name	Datatype	Description
properties	object	Tag entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_operation	select	resourceGroupName, serviceName, apiId, operationId, tagId, subscriptionId		Get tag associated with the Operation.
list_by_operation	select	resourceGroupName, serviceName, apiId, operationId, subscriptionId	$filter, $top, $skip	Lists all Tags associated with the Operation.
get_by_api	select	resourceGroupName, serviceName, apiId, tagId, subscriptionId		Get tag associated with the API.
get_by_product	select	resourceGroupName, serviceName, productId, tagId, subscriptionId		Get tag associated with the Product.
get	select	resourceGroupName, serviceName, tagId, subscriptionId		Gets the details of the tag specified by its identifier.
list_by_api	select	resourceGroupName, serviceName, apiId, subscriptionId	$filter, $top, $skip	Lists all Tags associated with the API.
list_by_product	select	resourceGroupName, serviceName, productId, subscriptionId	$filter, $top, $skip	Lists all Tags associated with the Product.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip, scope	Lists a collection of tags defined within a service instance.
create_or_update	insert	resourceGroupName, serviceName, tagId, subscriptionId	If-Match	Creates a tag.
update	update	resourceGroupName, serviceName, tagId, If-Match, subscriptionId		Updates the details of the tag specified by its identifier.
delete	delete	resourceGroupName, serviceName, tagId, If-Match, subscriptionId		Deletes specific tag of the API Management service instance.
assign_to_operation	exec	resourceGroupName, serviceName, apiId, operationId, tagId, subscriptionId		Assign tag to the Operation.
detach_from_operation	exec	resourceGroupName, serviceName, apiId, operationId, tagId, subscriptionId		Detach the tag from the Operation.
assign_to_api	exec	resourceGroupName, serviceName, apiId, tagId, subscriptionId		Assign tag to the Api.
detach_from_api	exec	resourceGroupName, serviceName, apiId, tagId, subscriptionId		Detach the tag from the Api.
assign_to_product	exec	resourceGroupName, serviceName, productId, tagId, subscriptionId		Assign tag to the Product.
detach_from_product	exec	resourceGroupName, serviceName, productId, tagId, subscriptionId		Detach the tag from the Product.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
If-Match	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.
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	The ID of an ongoing async operation.
productId	string	Product identifier. Must be unique in the current API Management service instance.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
tagId	string	Tag identifier. Must be unique in the current API Management service instance.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.
scope	string	Scope like 'apis', 'products' or 'apis/{apiId}

SELECT examples

get_by_operation

Get tag associated with the Operation.

SELECT
properties
FROM azure.api_management.tags
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND operationId = '{{ operationId }}' -- required
AND tagId = '{{ tagId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_operation

Lists all Tags associated with the Operation.

SELECT
properties
FROM azure.api_management.tags
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND operationId = '{{ operationId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

get_by_api

Get tag associated with the API.

SELECT
properties
FROM azure.api_management.tags
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND tagId = '{{ tagId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

get_by_product

Get tag associated with the Product.

SELECT
properties
FROM azure.api_management.tags
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND productId = '{{ productId }}' -- required
AND tagId = '{{ tagId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

get

Gets the details of the tag specified by its identifier.

SELECT
properties
FROM azure.api_management.tags
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND tagId = '{{ tagId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_api

Lists all Tags associated with the API.

SELECT
properties
FROM azure.api_management.tags
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

list_by_product

Lists all Tags associated with the Product.

SELECT
properties
FROM azure.api_management.tags
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND productId = '{{ productId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

list_by_service

Lists a collection of tags defined within a service instance.

SELECT
properties
FROM azure.api_management.tags
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND scope = '{{ scope }}'
;

INSERT examples

create_or_update

Creates a tag.

INSERT INTO azure.api_management.tags (
data__properties,
resourceGroupName,
serviceName,
tagId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ tagId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: tags
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the tags resource.
    - name: serviceName
      value: string
      description: Required parameter for the tags resource.
    - name: tagId
      value: string
      description: Required parameter for the tags resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the tags resource.
    - name: properties
      value: object
      description: |
        Properties supplied to Create Tag operation.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

Updates the details of the tag specified by its identifier.

UPDATE azure.api_management.tags
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND tagId = '{{ tagId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes specific tag of the API Management service instance.

DELETE FROM azure.api_management.tags
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND tagId = '{{ tagId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

assign_to_operation

Assign tag to the Operation.

EXEC azure.api_management.tags.assign_to_operation 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@apiId='{{ apiId }}' --required, 
@operationId='{{ operationId }}' --required, 
@tagId='{{ tagId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

detach_from_operation

Detach the tag from the Operation.

EXEC azure.api_management.tags.detach_from_operation 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@apiId='{{ apiId }}' --required, 
@operationId='{{ operationId }}' --required, 
@tagId='{{ tagId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

assign_to_api

Assign tag to the Api.

EXEC azure.api_management.tags.assign_to_api 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@apiId='{{ apiId }}' --required, 
@tagId='{{ tagId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

detach_from_api

Detach the tag from the Api.

EXEC azure.api_management.tags.detach_from_api 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@apiId='{{ apiId }}' --required, 
@tagId='{{ tagId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

assign_to_product

Assign tag to the Product.

EXEC azure.api_management.tags.assign_to_product 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@productId='{{ productId }}' --required, 
@tagId='{{ tagId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

detach_from_product

Detach the tag from the Product.

EXEC azure.api_management.tags.detach_from_product 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@productId='{{ productId }}' --required, 
@tagId='{{ tagId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;