workspace_groups

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

Overview

Name	workspace_groups
Type	Resource
Id	azure.api_management.workspace_groups

Fields

vw_workspace_groups

Name	Datatype	Description
description	text	field from the properties object
built_in	text	field from the properties object
display_name	text	field from the properties object
external_id	text	field from the properties object
groupId	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	field from the properties object
workspaceId	text	field from the properties object

workspace_groups

Name	Datatype	Description
properties	object	Group contract Properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	groupId, resourceGroupName, serviceName, subscriptionId, workspaceId	Gets the details of the group specified by its identifier.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId, workspaceId	Lists a collection of groups defined within a workspace in a service instance.
create_or_update	INSERT	groupId, resourceGroupName, serviceName, subscriptionId, workspaceId	Creates or Updates a group.
delete	DELETE	If-Match, groupId, resourceGroupName, serviceName, subscriptionId, workspaceId	Deletes specific group of the workspace in an API Management service instance.
update	UPDATE	If-Match, groupId, resourceGroupName, serviceName, subscriptionId, workspaceId	Updates the details of the group specified by its identifier.

SELECT examples

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

vw_workspace_groups

SELECT
description,
built_in,
display_name,
external_id,
groupId,
resourceGroupName,
serviceName,
subscriptionId,
type,
workspaceId
FROM azure.api_management.vw_workspace_groups
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceId = '{{ workspaceId }}';

workspace_groups

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

INSERT example

Use the following StackQL query and manifest file to create a new workspace_groups resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.workspace_groups (
groupId,
resourceGroupName,
serviceName,
subscriptionId,
workspaceId,
properties
)
SELECT 
'{{ groupId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ workspaceId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: displayName
          value: string
        - name: description
          value: string
        - name: type
          value: string
        - name: externalId
          value: string

UPDATE example

Updates a workspace_groups resource.

/*+ update */
UPDATE azure.api_management.workspace_groups
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND groupId = '{{ groupId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceId = '{{ workspaceId }}';

DELETE example

Deletes the specified workspace_groups resource.

/*+ delete */
DELETE FROM azure.api_management.workspace_groups
WHERE If-Match = '{{ If-Match }}'
AND groupId = '{{ groupId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceId = '{{ workspaceId }}';