workspace_tag

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

Overview

Name	workspace_tag
Type	Resource
Id	azure.api_management.workspace_tag

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Tag name. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Tag name. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, workspace_id, tag_id, subscription_id		Gets the details of the tag specified by its identifier.
list_by_service	select	resource_group_name, service_name, workspace_id, subscription_id	$filter, $top, $skip, scope	Lists a collection of tags defined within a workspace in a service instance.
create_or_update	insert	resource_group_name, service_name, workspace_id, tag_id, subscription_id		Creates a tag.
update	update	resource_group_name, service_name, workspace_id, tag_id, subscription_id		Updates the details of the tag specified by its identifier.
create_or_update	replace	resource_group_name, service_name, workspace_id, tag_id, subscription_id		Creates a tag.
delete	delete	resource_group_name, service_name, workspace_id, tag_id, subscription_id		Deletes specific tag of the workspace in an API Management service instance.
get_entity_state	exec	resource_group_name, service_name, workspace_id, tag_id, subscription_id		Gets the entity state version of the tag specified by its identifier.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
tag_id	string	Tag identifier. Must be unique in the current API Management service instance. Required.
workspace_id	string	Workspace identifier. Must be unique in the current API Management service instance. Required.
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.
scope	string	Scope like 'apis', 'products' or 'apis/{apiId}. Default value is None.

SELECT examples

get

Gets the details of the tag specified by its identifier.

SELECT
id,
name,
displayName,
systemData,
type
FROM azure.api_management.workspace_tag
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND tag_id = '{{ tag_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists a collection of tags defined within a workspace in a service instance.

SELECT
id,
name,
displayName,
systemData,
type
FROM azure.api_management.workspace_tag
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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.workspace_tag (
properties,
resource_group_name,
service_name,
workspace_id,
tag_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ workspace_id }}',
'{{ tag_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_tag
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_tag resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the workspace_tag resource.
  - name: workspace_id
    value: "{{ workspace_id }}"
    description: Required parameter for the workspace_tag resource.
  - name: tag_id
    value: "{{ tag_id }}"
    description: Required parameter for the workspace_tag resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_tag resource.
  - name: properties
    description: |
      Properties supplied to Create Tag operation.
    value:
      displayName: "{{ displayName }}"

UPDATE examples

update

Updates the details of the tag specified by its identifier.

UPDATE azure.api_management.workspace_tag
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND tag_id = '{{ tag_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates a tag.

REPLACE azure.api_management.workspace_tag
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND tag_id = '{{ tag_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes specific tag of the workspace in an API Management service instance.

DELETE FROM azure.api_management.workspace_tag
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND tag_id = '{{ tag_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_state

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

EXEC azure.api_management.workspace_tag.get_entity_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@tag_id='{{ tag_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;