workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.ml_services.workspaces

Fields

vw_workspaces

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	text	The name of the resource
description	text	field from the properties object
allow_public_access_when_behind_vnet	text	field from the properties object
allow_role_assignment_on_rg	text	field from the properties object
application_insights	text	field from the properties object
associated_workspaces	text	field from the properties object
container_registries	text	field from the properties object
container_registry	text	field from the properties object
discovery_url	text	field from the properties object
enable_data_isolation	text	field from the properties object
enable_service_side_cmk_encryption	text	field from the properties object
enable_simplified_cmk	text	field from the properties object
enable_software_bill_of_materials	text	field from the properties object
encryption	text	field from the properties object
existing_workspaces	text	field from the properties object
feature_store_settings	text	field from the properties object
friendly_name	text	field from the properties object
hbi_workspace	text	field from the properties object
hub_resource_id	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
image_build_compute	text	field from the properties object
ip_allowlist	text	field from the properties object
key_vault	text	field from the properties object
key_vaults	text	field from the properties object
kind	text	field from the properties object
location	text	field from the properties object
managed_network	text	field from the properties object
ml_flow_tracking_uri	text	field from the properties object
notebook_info	text	field from the properties object
primary_user_assigned_identity	text	field from the properties object
private_endpoint_connections	text	field from the properties object
private_link_count	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
serverless_compute_settings	text	field from the properties object
service_managed_resources_settings	text	field from the properties object
service_provisioned_resource_group	text	field from the properties object
shared_private_link_resources	text	field from the properties object
sku	text	The resource model definition representing SKU
soft_delete_retention_in_days	text	field from the properties object
storage_account	text	field from the properties object
storage_accounts	text	field from the properties object
storage_hns_enabled	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
system_datastores_auth_mode	text	field from the properties object
tags	text	field from the properties object
tenant_id	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
v1_legacy_mode	text	field from the properties object
workspaceName	text	field from the properties object
workspace_hub_config	text	field from the properties object
workspace_id	text	field from the properties object

workspaces

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
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string
location	string
properties	object	The properties of a machine learning workspace.
sku	object	The resource model definition representing SKU
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, workspaceName
list_by_resource_group	SELECT	resourceGroupName, subscriptionId
list_by_subscription	SELECT	subscriptionId
create_or_update	INSERT	resourceGroupName, subscriptionId, workspaceName, data__properties
delete	DELETE	resourceGroupName, subscriptionId, workspaceName
update	UPDATE	resourceGroupName, subscriptionId, workspaceName
diagnose	EXEC	resourceGroupName, subscriptionId, workspaceName
prepare_notebook	EXEC	resourceGroupName, subscriptionId, workspaceName
resync_keys	EXEC	resourceGroupName, subscriptionId, workspaceName

SELECT examples

vw_workspaces

SELECT
id,
name,
description,
allow_public_access_when_behind_vnet,
allow_role_assignment_on_rg,
application_insights,
associated_workspaces,
container_registries,
container_registry,
discovery_url,
enable_data_isolation,
enable_service_side_cmk_encryption,
enable_simplified_cmk,
enable_software_bill_of_materials,
encryption,
existing_workspaces,
feature_store_settings,
friendly_name,
hbi_workspace,
hub_resource_id,
identity,
image_build_compute,
ip_allowlist,
key_vault,
key_vaults,
kind,
location,
managed_network,
ml_flow_tracking_uri,
notebook_info,
primary_user_assigned_identity,
private_endpoint_connections,
private_link_count,
provisioning_state,
public_network_access,
resourceGroupName,
serverless_compute_settings,
service_managed_resources_settings,
service_provisioned_resource_group,
shared_private_link_resources,
sku,
soft_delete_retention_in_days,
storage_account,
storage_accounts,
storage_hns_enabled,
subscriptionId,
system_data,
system_datastores_auth_mode,
tags,
tenant_id,
type,
v1_legacy_mode,
workspaceName,
workspace_hub_config,
workspace_id
FROM azure.ml_services.vw_workspaces
WHERE subscriptionId = '{{ subscriptionId }}';

workspaces

SELECT
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.ml_services.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.ml_services.workspaces (
resourceGroupName,
subscriptionId,
workspaceName,
data__properties,
identity,
kind,
location,
properties,
sku,
tags
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ data__properties }}',
'{{ identity }}',
'{{ kind }}',
'{{ location }}',
'{{ properties }}',
'{{ sku }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - 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
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []
    - name: kind
      value: string
    - name: location
      value: string
    - name: properties
      value:
        - name: allowPublicAccessWhenBehindVnet
          value: boolean
        - name: allowRoleAssignmentOnRG
          value: boolean
        - name: applicationInsights
          value: string
        - name: associatedWorkspaces
          value:
            - string
        - name: containerRegistries
          value:
            - string
        - name: containerRegistry
          value: string
        - name: description
          value: string
        - name: discoveryUrl
          value: string
        - name: enableDataIsolation
          value: boolean
        - name: enableServiceSideCMKEncryption
          value: boolean
        - name: enableSimplifiedCmk
          value: boolean
        - name: enableSoftwareBillOfMaterials
          value: boolean
        - name: encryption
          value:
            - name: cosmosDbResourceId
              value: string
            - name: identity
              value:
                - name: userAssignedIdentity
                  value: string
            - name: keyVaultProperties
              value:
                - name: identityClientId
                  value: string
                - name: keyIdentifier
                  value: string
                - name: keyVaultArmId
                  value: string
            - name: searchAccountResourceId
              value: string
            - name: status
              value: []
            - name: storageAccountResourceId
              value: string
        - name: existingWorkspaces
          value:
            - string
        - name: featureStoreSettings
          value:
            - name: computeRuntime
              value:
                - name: sparkRuntimeVersion
                  value: string
            - name: offlineStoreConnectionName
              value: string
            - name: onlineStoreConnectionName
              value: string
        - name: friendlyName
          value: string
        - name: hbiWorkspace
          value: boolean
        - name: hubResourceId
          value: string
        - name: imageBuildCompute
          value: string
        - name: ipAllowlist
          value:
            - string
        - name: keyVault
          value: string
        - name: keyVaults
          value:
            - string
        - name: managedNetwork
          value:
            - name: isolationMode
              value: []
            - name: networkId
              value: string
            - name: outboundRules
              value: object
            - name: status
              value:
                - name: sparkReady
                  value: boolean
                - name: status
                  value: []
            - name: changeableIsolationModes
              value:
                - []
        - name: mlFlowTrackingUri
          value: string
        - name: notebookInfo
          value:
            - name: fqdn
              value: string
            - name: isPrivateLinkEnabled
              value: boolean
            - name: notebookPreparationError
              value:
                - name: errorMessage
                  value: string
                - name: statusCode
                  value: integer
            - name: resourceId
              value: string
        - name: primaryUserAssignedIdentity
          value: string
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: location
                value: string
              - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                      - name: subnetArmId
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: actionsRequired
                        value: string
                      - name: description
                        value: string
                      - name: status
                        value: []
                  - name: provisioningState
                    value: []
              - name: sku
                value:
                  - name: name
                    value: string
                  - name: tier
                    value: []
                  - name: size
                    value: string
                  - name: family
                    value: string
                  - name: capacity
                    value: integer
              - name: tags
                value: object
        - name: privateLinkCount
          value: integer
        - name: provisioningState
          value: []
        - name: publicNetworkAccess
          value: []
        - name: serverlessComputeSettings
          value:
            - name: serverlessComputeCustomSubnet
              value: string
            - name: serverlessComputeNoPublicIP
              value: boolean
        - name: serviceManagedResourcesSettings
          value:
            - name: cosmosDb
              value:
                - name: collectionsThroughput
                  value: integer
        - name: serviceProvisionedResourceGroup
          value: string
        - name: sharedPrivateLinkResources
          value:
            - - name: name
                value: string
              - name: properties
                value:
                  - name: groupId
                    value: string
                  - name: privateLinkResourceId
                    value: string
                  - name: requestMessage
                    value: string
        - name: softDeleteRetentionInDays
          value: integer
        - name: storageAccount
          value: string
        - name: storageAccounts
          value:
            - string
        - name: storageHnsEnabled
          value: boolean
        - name: systemDatastoresAuthMode
          value: string
        - name: tenantId
          value: string
        - name: v1LegacyMode
          value: boolean
        - name: workspaceHubConfig
          value:
            - name: additionalWorkspaceStorageAccounts
              value:
                - string
            - name: defaultWorkspaceResourceGroup
              value: string
        - name: workspaceId
          value: string
    - name: tags
      value: object

UPDATE example

Updates a workspaces resource.

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

DELETE example

Deletes the specified workspaces resource.

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