workspace_connections

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

Overview

Name	workspace_connections
Type	Resource
Id	azure.machine_learning_services.workspace_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	ResourceId of the workspace connection.
name	string	Friendly name of the workspace connection.
authType	string	Authorization type of the workspace connection.
category	string	Category of the workspace connection.
target	string	Target of the workspace connection.
type	string	Resource type of workspace connection.
value	string	Value details of the workspace connection.

list

Name	Datatype	Description
id	string	ResourceId of the workspace connection.
name	string	Friendly name of the workspace connection.
authType	string	Authorization type of the workspace connection.
category	string	Category of the workspace connection.
target	string	Target of the workspace connection.
type	string	Resource type of workspace connection.
value	string	Value details of the workspace connection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, connection_name, subscription_id		Get the detail of a workspace connection.
list	select	resource_group_name, workspace_name, subscription_id	target, category	List all connections under a AML workspace.
create	insert	resource_group_name, workspace_name, connection_name, subscription_id		Add a new workspace connection.
delete	delete	resource_group_name, workspace_name, connection_name, subscription_id		Delete a workspace connection.

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
connection_name	string	Friendly name of the workspace connection. Required.
resource_group_name	string	Name of the resource group in which workspace is located. Required.
subscription_id	string
workspace_name	string	Name of Azure Machine Learning workspace. Required.
category	string	Category of the workspace connection. Default value is None.
target	string	Target of the workspace connection. Default value is None.

SELECT examples

get

Get the detail of a workspace connection.

SELECT
id,
name,
authType,
category,
target,
type,
value
FROM azure.machine_learning_services.workspace_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all connections under a AML workspace.

SELECT
id,
name,
authType,
category,
target,
type,
value
FROM azure.machine_learning_services.workspace_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND target = '{{ target }}'
AND category = '{{ category }}'
;

INSERT examples

create

Add a new workspace connection.

INSERT INTO azure.machine_learning_services.workspace_connections (
name,
properties,
resource_group_name,
workspace_name,
connection_name,
subscription_id
)
SELECT 
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_connections resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspace_connections resource.
  - name: connection_name
    value: "{{ connection_name }}"
    description: Required parameter for the workspace_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_connections resource.
  - name: name
    value: "{{ name }}"
    description: |
      Friendly name of the workspace connection.
  - name: properties
    value:
      category: "{{ category }}"
      target: "{{ target }}"
      authType: "{{ authType }}"
      value: "{{ value }}"

DELETE examples

delete

Delete a workspace connection.

DELETE FROM azure.machine_learning_services.workspace_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;