operationalization_clusters

Creates, updates, deletes, gets or lists an operationalization_clusters resource.

Overview

Name	operationalization_clusters
Type	Resource
Id	azure.machine_learning_compute.operationalization_clusters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
appInsights	object	AppInsights configuration.
clusterType	string	The cluster type. Known values are: "ACS" and "Local".
containerRegistry	object	Container Registry properties.
containerService	object	Parameters for the Azure Container Service cluster.
createdOn	string (date-time)	The date and time when the cluster was created.
description	string	The description of the cluster.
globalServiceConfiguration	object	Contains global configuration for the web services in the cluster.
location	string	Specifies the location of the resource. Required.
modifiedOn	string (date-time)	The date and time when the cluster was last modified.
provisioningErrors	array	List of provisioning errors reported by the resource provider.
provisioningState	string	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. Known values are: "Unknown", "Updating", "Creating", "Deleting", "Succeeded", "Failed", and "Canceled".
storageAccount	object	Storage Account properties.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.

list_by_resource_group

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
appInsights	object	AppInsights configuration.
clusterType	string	The cluster type. Known values are: "ACS" and "Local".
containerRegistry	object	Container Registry properties.
containerService	object	Parameters for the Azure Container Service cluster.
createdOn	string (date-time)	The date and time when the cluster was created.
description	string	The description of the cluster.
globalServiceConfiguration	object	Contains global configuration for the web services in the cluster.
location	string	Specifies the location of the resource. Required.
modifiedOn	string (date-time)	The date and time when the cluster was last modified.
provisioningErrors	array	List of provisioning errors reported by the resource provider.
provisioningState	string	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. Known values are: "Unknown", "Updating", "Creating", "Deleting", "Succeeded", "Failed", and "Canceled".
storageAccount	object	Storage Account properties.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.

list_by_subscription_id

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
appInsights	object	AppInsights configuration.
clusterType	string	The cluster type. Known values are: "ACS" and "Local".
containerRegistry	object	Container Registry properties.
containerService	object	Parameters for the Azure Container Service cluster.
createdOn	string (date-time)	The date and time when the cluster was created.
description	string	The description of the cluster.
globalServiceConfiguration	object	Contains global configuration for the web services in the cluster.
location	string	Specifies the location of the resource. Required.
modifiedOn	string (date-time)	The date and time when the cluster was last modified.
provisioningErrors	array	List of provisioning errors reported by the resource provider.
provisioningState	string	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. Known values are: "Unknown", "Updating", "Creating", "Deleting", "Succeeded", "Failed", and "Canceled".
storageAccount	object	Storage Account properties.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, subscription_id		Gets the operationalization cluster resource view. Note that the credentials are not returned by this call. Call ListKeys to get them.
list_by_resource_group	select	resource_group_name, subscription_id	$skiptoken	Gets the clusters in the specified resource group.
list_by_subscription_id	select	subscription_id	$skiptoken	Gets the operationalization clusters in the specified subscription.
create_or_update	insert	resource_group_name, cluster_name, subscription_id, location		Create or update an operationalization cluster.
update	update	resource_group_name, cluster_name, subscription_id		The PATCH operation can be used to update only the tags for a cluster. Use PUT operation to update other properties.
create_or_update	replace	resource_group_name, cluster_name, subscription_id, location		Create or update an operationalization cluster.
delete	delete	resource_group_name, cluster_name, subscription_id	deleteAll	Deletes the specified cluster.
list_keys	exec	resource_group_name, cluster_name, subscription_id		Gets the credentials for the specified cluster such as Storage, ACR and ACS credentials. This is a long running operation because it fetches keys from dependencies.
check_system_services_updates_available	exec	resource_group_name, cluster_name, subscription_id		Checks if updates are available for system services in the cluster.
update_system_services	exec	resource_group_name, cluster_name, subscription_id		Updates system services in a cluster.

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
cluster_name	string	The name of the cluster. Required.
resource_group_name	string	Name of the resource group in which the cluster is located. Required.
subscription_id	string
$skiptoken	string	Continuation token for pagination. Default value is None.
deleteAll	boolean	If true, deletes all resources associated with this cluster. Default value is None.

SELECT examples

get

Gets the operationalization cluster resource view. Note that the credentials are not returned by this call. Call ListKeys to get them.

SELECT
id,
name,
appInsights,
clusterType,
containerRegistry,
containerService,
createdOn,
description,
globalServiceConfiguration,
location,
modifiedOn,
provisioningErrors,
provisioningState,
storageAccount,
tags,
type
FROM azure.machine_learning_compute.operationalization_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets the clusters in the specified resource group.

SELECT
id,
name,
appInsights,
clusterType,
containerRegistry,
containerService,
createdOn,
description,
globalServiceConfiguration,
location,
modifiedOn,
provisioningErrors,
provisioningState,
storageAccount,
tags,
type
FROM azure.machine_learning_compute.operationalization_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

list_by_subscription_id

Gets the operationalization clusters in the specified subscription.

SELECT
id,
name,
appInsights,
clusterType,
containerRegistry,
containerService,
createdOn,
description,
globalServiceConfiguration,
location,
modifiedOn,
provisioningErrors,
provisioningState,
storageAccount,
tags,
type
FROM azure.machine_learning_compute.operationalization_clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Create or update an operationalization cluster.

INSERT INTO azure.machine_learning_compute.operationalization_clusters (
location,
tags,
properties,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: operationalization_clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the operationalization_clusters resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the operationalization_clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the operationalization_clusters resource.
  - name: location
    value: "{{ location }}"
    description: |
      Specifies the location of the resource. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Contains resource tags defined as key/value pairs.
  - name: properties
    value:
      description: "{{ description }}"
      clusterType: "{{ clusterType }}"
      storageAccount:
        resourceId: "{{ resourceId }}"
      containerRegistry:
        resourceId: "{{ resourceId }}"
      containerService:
        clusterFqdn: "{{ clusterFqdn }}"
        orchestratorType: "{{ orchestratorType }}"
        orchestratorProperties:
          servicePrincipal:
            clientId: "{{ clientId }}"
            secret: "{{ secret }}"
        systemServices:
          - systemServiceType: "{{ systemServiceType }}"
            publicIpAddress: "{{ publicIpAddress }}"
            version: "{{ version }}"
        masterCount: {{ masterCount }}
        agentCount: {{ agentCount }}
        agentVmSize: "{{ agentVmSize }}"
      appInsights:
        resourceId: "{{ resourceId }}"
      globalServiceConfiguration:
        : "{{  }}"
        etag: "{{ etag }}"
        ssl:
          status: "{{ status }}"
          cert: "{{ cert }}"
          key: "{{ key }}"
          cname: "{{ cname }}"
        serviceAuth:
          primaryAuthKeyHash: "{{ primaryAuthKeyHash }}"
          secondaryAuthKeyHash: "{{ secondaryAuthKeyHash }}"
        autoScale:
          status: "{{ status }}"
          minReplicas: {{ minReplicas }}
          maxReplicas: {{ maxReplicas }}
          targetUtilization: {{ targetUtilization }}
          refreshPeriodInSeconds: {{ refreshPeriodInSeconds }}

UPDATE examples

update

The PATCH operation can be used to update only the tags for a cluster. Use PUT operation to update other properties.

UPDATE azure.machine_learning_compute.operationalization_clusters
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Create or update an operationalization cluster.

REPLACE azure.machine_learning_compute.operationalization_clusters
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified cluster.

DELETE FROM azure.machine_learning_compute.operationalization_clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND deleteAll = '{{ deleteAll }}'
;

Lifecycle Methods

list_keys

Gets the credentials for the specified cluster such as Storage, ACR and ACS credentials. This is a long running operation because it fetches keys from dependencies.

EXEC azure.machine_learning_compute.operationalization_clusters.list_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

check_system_services_updates_available

Checks if updates are available for system services in the cluster.

EXEC azure.machine_learning_compute.operationalization_clusters.check_system_services_updates_available 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_system_services

Updates system services in a cluster.

EXEC azure.machine_learning_compute.operationalization_clusters.update_system_services 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;