workbenches

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

Overview

Name	workbenches
Type	Resource
Id	azure.cognitive_services.workbenches

Fields

The following fields are returned by SELECT queries:

get

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.
connectivityEndpoints	object	Network connectivity endpoints assigned to the workbench.
creationTime	string (date-time)	Creation time of the workbench resource.
datasetId	string	The dataset ID to mount for the workbench.
errors	array	Error details for the workbench resource.
etag	string	Resource Etag.
identity	object	Identity for the resource.
idleTimeBeforeShutdown	string	ISO 8601 duration before the idle workbench is automatically shut down (e.g., 'PT30M').
imageLink	string	Container image URI (e.g., MCR or ACR image path) for the workbench. Required.
location	string	The location of the workbench resource.
provisioningState	string	Provisioning state of the workbench resource. Known values are: "Accepted", "Succeeded", "Failed", "Canceled", "Deleting", "Scaling", "Disabled", "Starting", "Stopping", "Restarting", and "Stopped". (Accepted, Succeeded, Failed, Canceled, Deleting, Scaling, Disabled, Starting, Stopping, Restarting, Stopped)
sshSettings	object	SSH configuration for remote access to the workbench.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetClusterId	string	ARM resource ID of the parent cluster that hosts this workbench. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
webEndpoint	string	The web endpoint URL for accessing the workbench.

list

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.
connectivityEndpoints	object	Network connectivity endpoints assigned to the workbench.
creationTime	string (date-time)	Creation time of the workbench resource.
datasetId	string	The dataset ID to mount for the workbench.
errors	array	Error details for the workbench resource.
etag	string	Resource Etag.
identity	object	Identity for the resource.
idleTimeBeforeShutdown	string	ISO 8601 duration before the idle workbench is automatically shut down (e.g., 'PT30M').
imageLink	string	Container image URI (e.g., MCR or ACR image path) for the workbench. Required.
location	string	The location of the workbench resource.
provisioningState	string	Provisioning state of the workbench resource. Known values are: "Accepted", "Succeeded", "Failed", "Canceled", "Deleting", "Scaling", "Disabled", "Starting", "Stopping", "Restarting", and "Stopped". (Accepted, Succeeded, Failed, Canceled, Deleting, Scaling, Disabled, Starting, Stopping, Restarting, Stopped)
sshSettings	object	SSH configuration for remote access to the workbench.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetClusterId	string	ARM resource ID of the parent cluster that hosts this workbench. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
webEndpoint	string	The web endpoint URL for accessing the workbench.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, project_name, workbench_name, subscription_id		Gets the specified workbench associated with the project.
list	select	resource_group_name, account_name, project_name, subscription_id		Gets the workbenches associated with the project.
create_or_update	insert	resource_group_name, account_name, project_name, workbench_name, subscription_id, properties		Creates or updates a workbench associated with the project.
update	update	resource_group_name, account_name, project_name, workbench_name, subscription_id, properties		Updates a workbench associated with the project.
create_or_update	replace	resource_group_name, account_name, project_name, workbench_name, subscription_id, properties		Creates or updates a workbench associated with the project.
delete	delete	resource_group_name, account_name, project_name, workbench_name, subscription_id		Deletes the specified workbench associated with the project.
start	exec	resource_group_name, account_name, project_name, workbench_name, subscription_id		Starts a stopped workbench resource. This is a long-running operation that returns 202 Accepted. Returns 204 if the workbench is already in the target state.
stop	exec	resource_group_name, account_name, project_name, workbench_name, subscription_id		Stops a running workbench resource. This is a long-running operation that returns 202 Accepted. Returns 204 if the workbench is already in the target state.
restart	exec	resource_group_name, account_name, project_name, workbench_name, subscription_id		Restarts a running workbench resource. This is a long-running operation that returns 202 Accepted. Returns 204 if the workbench is already in the target state.

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
account_name	string	The name of Cognitive Services account. Required.
project_name	string	The name of Cognitive Services account's project. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workbench_name	string	The name of the workbench associated with the project. Required.

SELECT examples

get

Gets the specified workbench associated with the project.

SELECT
id,
name,
connectivityEndpoints,
creationTime,
datasetId,
errors,
etag,
identity,
idleTimeBeforeShutdown,
imageLink,
location,
provisioningState,
sshSettings,
systemData,
tags,
targetClusterId,
type,
webEndpoint
FROM azure.cognitive_services.workbenches
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND workbench_name = '{{ workbench_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the workbenches associated with the project.

SELECT
id,
name,
connectivityEndpoints,
creationTime,
datasetId,
errors,
etag,
identity,
idleTimeBeforeShutdown,
imageLink,
location,
provisioningState,
sshSettings,
systemData,
tags,
targetClusterId,
type,
webEndpoint
FROM azure.cognitive_services.workbenches
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a workbench associated with the project.

INSERT INTO azure.cognitive_services.workbenches (
properties,
location,
tags,
identity,
resource_group_name,
account_name,
project_name,
workbench_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ project_name }}',
'{{ workbench_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: workbenches
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workbenches resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the workbenches resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the workbenches resource.
  - name: workbench_name
    value: "{{ workbench_name }}"
    description: Required parameter for the workbenches resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workbenches resource.
  - name: properties
    description: |
      Properties of the workbench resource. Required.
    value:
      targetClusterId: "{{ targetClusterId }}"
      imageLink: "{{ imageLink }}"
      idleTimeBeforeShutdown: "{{ idleTimeBeforeShutdown }}"
      datasetId: "{{ datasetId }}"
      sshSettings:
        sshPublicKey: "{{ sshPublicKey }}"
        adminEnabled: {{ adminEnabled }}
      connectivityEndpoints:
        publicIpAddress: "{{ publicIpAddress }}"
        sshPort: {{ sshPort }}
      webEndpoint: "{{ webEndpoint }}"
      provisioningState: "{{ provisioningState }}"
      errors:
        - code: "{{ code }}"
          message: "{{ message }}"
          target: "{{ target }}"
          details: "{{ details }}"
          additionalInfo: "{{ additionalInfo }}"
      creationTime: "{{ creationTime }}"
  - name: location
    value: "{{ location }}"
    description: |
      The location of the workbench resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: identity
    description: |
      Identity for the resource.
    value:
      type: "{{ type }}"
      tenantId: "{{ tenantId }}"
      principalId: "{{ principalId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates a workbench associated with the project.

UPDATE azure.cognitive_services.workbenches
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND project_name = '{{ project_name }}' --required
AND workbench_name = '{{ workbench_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a workbench associated with the project.

REPLACE azure.cognitive_services.workbenches
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND project_name = '{{ project_name }}' --required
AND workbench_name = '{{ workbench_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified workbench associated with the project.

DELETE FROM azure.cognitive_services.workbenches
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND project_name = '{{ project_name }}' --required
AND workbench_name = '{{ workbench_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

start

Starts a stopped workbench resource. This is a long-running operation that returns 202 Accepted. Returns 204 if the workbench is already in the target state.

EXEC azure.cognitive_services.workbenches.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@workbench_name='{{ workbench_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stops a running workbench resource. This is a long-running operation that returns 202 Accepted. Returns 204 if the workbench is already in the target state.

EXEC azure.cognitive_services.workbenches.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@workbench_name='{{ workbench_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

restart

Restarts a running workbench resource. This is a long-running operation that returns 202 Accepted. Returns 204 if the workbench is already in the target state.

EXEC azure.cognitive_services.workbenches.restart 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@workbench_name='{{ workbench_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;