workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.desktop_virtualization.workspaces

Fields

vw_workspaces

Name	Datatype	Description
description	text	field from the properties object
application_group_references	text	field from the properties object
cloud_pc_resource	text	field from the properties object
etag	text	The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
friendly_name	text	field from the properties object
identity	text	Identity for the resource.
kind	text	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
managed_by	text	field from the properties object
object_id	text	field from the properties object
plan	text	Plan for the resource.
private_endpoint_connections	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	The resource model definition representing SKU
subscriptionId	text	field from the properties object
workspaceName	text	field from the properties object

workspaces

Name	Datatype	Description
etag	string	The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
identity	object	Identity for the resource.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
plan	object	Plan for the resource.
properties	object	Schema for Workspace properties.
sku	object	The resource model definition representing SKU

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, workspaceName	Get a workspace.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List workspaces.
list_by_subscription	SELECT	subscriptionId	List workspaces in subscription.
create_or_update	INSERT	resourceGroupName, subscriptionId, workspaceName	Create or update a workspace.
delete	DELETE	resourceGroupName, subscriptionId, workspaceName	Remove a workspace.
update	UPDATE	resourceGroupName, subscriptionId, workspaceName	Update a workspace.

SELECT examples

List workspaces in subscription.

vw_workspaces

SELECT
description,
application_group_references,
cloud_pc_resource,
etag,
friendly_name,
identity,
kind,
managed_by,
object_id,
plan,
private_endpoint_connections,
public_network_access,
resourceGroupName,
sku,
subscriptionId,
workspaceName
FROM azure.desktop_virtualization.vw_workspaces
WHERE subscriptionId = '{{ subscriptionId }}';

workspaces

SELECT
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.desktop_virtualization.workspaces
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.desktop_virtualization.workspaces (
resourceGroupName,
subscriptionId,
workspaceName,
managedBy,
kind,
identity,
sku,
plan,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ managedBy }}',
'{{ kind }}',
'{{ identity }}',
'{{ sku }}',
'{{ plan }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: managedBy
      value: string
    - name: kind
      value: string
    - name: etag
      value: string
    - name: identity
      value: string
    - name: sku
      value: string
    - name: plan
      value: string
    - name: properties
      value:
        - name: objectId
          value: string
        - name: description
          value: string
        - name: friendlyName
          value: string
        - name: applicationGroupReferences
          value:
            - string
        - name: cloudPcResource
          value: boolean
        - name: publicNetworkAccess
          value: string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: groupIds
                    value:
                      - string
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: []
              - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: systemData
                value:
                  - name: createdBy
                    value: string
                  - name: createdByType
                    value: string
                  - name: createdAt
                    value: string
                  - name: lastModifiedBy
                    value: string
                  - name: lastModifiedByType
                    value: string
                  - name: lastModifiedAt
                    value: string

UPDATE example

Updates a workspaces resource.

/*+ update */
UPDATE azure.desktop_virtualization.workspaces
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified workspaces resource.

/*+ delete */
DELETE FROM azure.desktop_virtualization.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';