workspace_connections

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

Overview

Name	workspace_connections
Type	Resource
Id	azure.ml_services.workspace_connections

Fields

vw_workspace_connections

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
auth_type	text	field from the properties object
category	text	field from the properties object
connectionName	text	field from the properties object
created_by_workspace_arm_id	text	field from the properties object
error	text	field from the properties object
expiry_time	text	field from the properties object
group	text	field from the properties object
is_shared_to_all	text	field from the properties object
metadata	text	field from the properties object
pe_requirement	text	field from the properties object
pe_status	text	field from the properties object
resourceGroupName	text	field from the properties object
shared_user_list	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
target	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
use_workspace_managed_identity	text	field from the properties object
workspaceName	text	field from the properties object

workspace_connections

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
properties	object
systemData	object	Metadata pertaining to creation and last modification of the resource.
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	connectionName, resourceGroupName, subscriptionId, workspaceName
list	SELECT	resourceGroupName, subscriptionId, workspaceName
create	INSERT	connectionName, resourceGroupName, subscriptionId, workspaceName, data__properties
delete	DELETE	connectionName, resourceGroupName, subscriptionId, workspaceName
update	UPDATE	connectionName, resourceGroupName, subscriptionId, workspaceName
test_connection	EXEC	connectionName, resourceGroupName, subscriptionId, workspaceName, data__properties

SELECT examples

vw_workspace_connections

SELECT
id,
name,
auth_type,
category,
connectionName,
created_by_workspace_arm_id,
error,
expiry_time,
group,
is_shared_to_all,
metadata,
pe_requirement,
pe_status,
resourceGroupName,
shared_user_list,
subscriptionId,
system_data,
target,
type,
use_workspace_managed_identity,
workspaceName
FROM azure.ml_services.vw_workspace_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

workspace_connections

SELECT
id,
name,
properties,
systemData,
type
FROM azure.ml_services.workspace_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.ml_services.workspace_connections (
connectionName,
resourceGroupName,
subscriptionId,
workspaceName,
data__properties,
properties
)
SELECT 
'{{ connectionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ data__properties }}',
'{{ properties }}'
;

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: properties
      value:
        - name: authType
          value: []
        - name: category
          value: []
        - name: createdByWorkspaceArmId
          value: string
        - name: error
          value: string
        - name: expiryTime
          value: string
        - name: group
          value: []
        - name: isSharedToAll
          value: boolean
        - name: metadata
          value: object
        - name: peRequirement
          value: []
        - name: peStatus
          value: []
        - name: sharedUserList
          value:
            - string
        - name: target
          value: string
        - name: useWorkspaceManagedIdentity
          value: boolean

UPDATE example

Updates a workspace_connections resource.

/*+ update */
UPDATE azure.ml_services.workspace_connections
SET 
properties = '{{ properties }}'
WHERE 
connectionName = '{{ connectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified workspace_connections resource.

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