workspace

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

Overview

Name	workspace
Type	Resource
Id	azure.api_management.workspace

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.
description	string	Description of the workspace.
displayName	string	Name of the workspace. 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.
description	string	Description of the workspace.
displayName	string	Name of the workspace. 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, subscription_id		Gets the details of the workspace specified by its identifier.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter, $top, $skip	Lists all workspaces of the API Management service instance.
create_or_update	insert	resource_group_name, service_name, workspace_id, subscription_id		Creates a new workspace or updates an existing one.
update	update	resource_group_name, service_name, workspace_id, subscription_id		Updates the details of the workspace specified by its identifier.
create_or_update	replace	resource_group_name, service_name, workspace_id, subscription_id		Creates a new workspace or updates an existing one.
delete	delete	resource_group_name, service_name, workspace_id, subscription_id		Deletes the specified workspace.
get_entity_tag	exec	resource_group_name, service_name, workspace_id, subscription_id		Gets the entity state (Etag) version of the workspace 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
workspace_id	string	Workspace identifier. Must be unique in the current API Management service instance. Required.
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | 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.

SELECT examples

get

Gets the details of the workspace specified by its identifier.

SELECT
id,
name,
description,
displayName,
systemData,
type
FROM azure.api_management.workspace
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
;

list_by_service

Lists all workspaces of the API Management service instance.

SELECT
id,
name,
description,
displayName,
systemData,
type
FROM azure.api_management.workspace
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates a new workspace or updates an existing one.

INSERT INTO azure.api_management.workspace (
properties,
resource_group_name,
service_name,
workspace_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ workspace_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the workspace resource.
  - name: workspace_id
    value: "{{ workspace_id }}"
    description: Required parameter for the workspace resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace resource.
  - name: properties
    description: |
      Workspace entity contract properties.
    value:
      displayName: "{{ displayName }}"
      description: "{{ description }}"

UPDATE examples

update

Updates the details of the workspace specified by its identifier.

UPDATE azure.api_management.workspace
SET 
properties = '{{ properties }}'
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
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates a new workspace or updates an existing one.

REPLACE azure.api_management.workspace
SET 
properties = '{{ properties }}'
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
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified workspace.

DELETE FROM azure.api_management.workspace
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
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the workspace specified by its identifier.

EXEC azure.api_management.workspace.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;