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

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

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"

list

The request was successful; the request was well-formed and received properly.

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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, connectionName
list	select	subscriptionId, resourceGroupName, workspaceName	target, category, includeAll
create	insert	subscriptionId, resourceGroupName, workspaceName, connectionName, data__properties
update	update	subscriptionId, resourceGroupName, workspaceName, connectionName
delete	delete	subscriptionId, resourceGroupName, workspaceName, connectionName
test_connection	exec	subscriptionId, resourceGroupName, workspaceName, connectionName, properties

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
connectionName	string	Friendly name of the workspace connection
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	Azure Machine Learning Workspace Name
category	string	Category of the workspace connection.
includeAll	boolean	query parameter that indicates if get connection call should return both connections and datastores
target	string	Target of the workspace connection.

SELECT examples

get

The request was successful; the request was well-formed and received properly.

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

list

The request was successful; the request was well-formed and received properly.

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

INSERT examples

create

No description available.

INSERT INTO azure.ml_services.workspace_connections (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
connectionName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ connectionName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_connections resource.
    - name: workspaceName
      value: string
      description: Required parameter for the workspace_connections resource.
    - name: connectionName
      value: string
      description: Required parameter for the workspace_connections resource.
    - name: properties
      value: object

UPDATE examples

update

No description available.

UPDATE azure.ml_services.workspace_connections
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND connectionName = '{{ connectionName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

No description available.

DELETE FROM azure.ml_services.workspace_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND connectionName = '{{ connectionName }}' --required
;

Lifecycle Methods

test_connection

Accepted

EXEC azure.ml_services.workspace_connections.test_connection 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@connectionName='{{ connectionName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;