workspace_tags

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

Overview

Name	workspace_tags
Type	Resource
Id	azure.api_management.workspace_tags

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Tag 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	select	resourceGroupName, serviceName, workspaceId, tagId, subscriptionId		Gets the details of the tag specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, workspaceId, subscriptionId	$filter, $top, $skip, scope	Lists a collection of tags defined within a workspace in a service instance.
create_or_update	insert	resourceGroupName, serviceName, workspaceId, tagId, subscriptionId	If-Match	Creates a tag.
update	update	resourceGroupName, serviceName, workspaceId, tagId, If-Match, subscriptionId		Updates the details of the tag specified by its identifier.
delete	delete	resourceGroupName, serviceName, workspaceId, tagId, If-Match, subscriptionId		Deletes specific tag of the workspace in an API Management service instance.

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.
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.
workspaceId	string	Workspace 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

Gets the details of the tag specified by its identifier.

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

list_by_service

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

SELECT
properties
FROM azure.api_management.workspace_tags
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- 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.workspace_tags (
data__properties,
resourceGroupName,
serviceName,
workspaceId,
tagId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ workspaceId }}',
'{{ tagId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: workspace_tags
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_tags resource.
    - name: serviceName
      value: string
      description: Required parameter for the workspace_tags resource.
    - name: workspaceId
      value: string
      description: Required parameter for the workspace_tags resource.
    - name: tagId
      value: string
      description: Required parameter for the workspace_tags resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_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.workspace_tags
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND workspaceId = '{{ workspaceId }}' --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 workspace in an API Management service instance.

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