workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.api_management.workspaces

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified workspace entity.

Name	Datatype	Description
properties	object	Workspace entity contract properties.

list_by_service

Paged Result response of workspaces.

Name	Datatype	Description
properties	object	Workspace 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, subscriptionId		Gets the details of the workspace specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip	Lists all workspaces of the API Management service instance.
create_or_update	insert	resourceGroupName, serviceName, workspaceId, subscriptionId	If-Match	Creates a new workspace or updates an existing one.
update	update	resourceGroupName, serviceName, workspaceId, If-Match, subscriptionId		Updates the details of the workspace specified by its identifier.
delete	delete	resourceGroupName, serviceName, workspaceId, If-Match, subscriptionId		Deletes the specified workspace.

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.
workspaceId	string	Workspace identifier. Must be unique in the current API Management service instance.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br></br>| description | 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.

SELECT examples

get

Gets the details of the workspace specified by its identifier.

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

list_by_service

Lists all workspaces of the API Management service instance.

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

Manifest

# Description fields are for documentation purposes
- name: workspaces
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspaces resource.
    - name: serviceName
      value: string
      description: Required parameter for the workspaces resource.
    - name: workspaceId
      value: string
      description: Required parameter for the workspaces resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspaces resource.
    - name: properties
      value: object
      description: |
        Workspace entity contract properties.
    - 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 workspace specified by its identifier.

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

DELETE examples

delete

Deletes the specified workspace.

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