ComputeInstanceProvisioningConfiguration Class

  • Reference

Represents configuration parameters for provisioning ComputeInstance targets.

Use the provisioning_configuration method of the ComputeInstance class to create a ComputeInstanceProvisioningConfiguration object.

Create a configuration object for provisioning a ComputeInstance target.

Inheritance
ComputeTargetProvisioningConfiguration
ComputeInstanceProvisioningConfiguration

Constructor

ComputeInstanceProvisioningConfiguration(vm_size='', ssh_public_access=False, admin_user_ssh_public_key=None, vnet_resourcegroup_name=None, vnet_name=None, subnet_name=None, tags=None, description=None, assigned_user_object_id=None, assigned_user_tenant_id=None)

Parameters

Name Description
vm_size
Required
str

The size of agent VMs. More details can be found here: https://aka.ms/azureml-vm-details. Note that not all sizes are available in all regions, as detailed in the previous link. Defaults to Standard_DS3_V2.
ssh_public_access
bool

Indicates the state of the public SSH port. Possible values are:

  • False - The public ssh port is closed.
  • True - The public ssh port is open.
Default value: False
admin_user_ssh_public_key
str

The SSH public key of the administrator user account.

Default value: None
vnet_resourcegroup_name
str

The name of the resource group where the virtual network is located.

Default value: None
vnet_name
str

The name of the virtual network.

Default value: None
subnet_name
str

The name of the subnet inside the VNet.

Default value: None
tags
dict[str, str]

An optional dictionary of key value tags to associate with the ComputeInstance object.

Default value: None
description
str

An optional description for the ComputeInstance object.

Default value: None
vm_size
Required
str

The size of agent VMs. More details can be found here: https://aka.ms/azureml-vm-details. Note that not all sizes are available in all regions, as detailed in the previous link. Defaults to Standard_DS3_V2.
ssh_public_access
Required
bool

Indicates the state of the public SSH port. Possible values are:

  • False - The public ssh port is closed.
  • True - The public ssh port is open.
admin_user_ssh_public_key
Required
str

The SSH public key of the administrator user account.
vnet_resourcegroup_name
Required
str

The name of the resource group where the virtual network is located.
vnet_name
Required
str

The name of the virtual network.
subnet_name
Required
str

The name of the subnet inside the vnet.
tags
Required
dict[str, str]

An optional dictionary of key value tags to associate with the ComputeInstance object.
description
Required
str

An optional description for the ComputeInstance object.
assigned_user_object_id
str

The AAD Object ID of the assigned user (preview).

Default value: None
assigned_user_tenant_id
str

The AAD Tenant ID of the assigned user (preview).

Default value: None

Methods

validate_configuration

Check that the specified configuration values are valid.

Raises a ComputeTargetException if validation fails.

validate_configuration

Check that the specified configuration values are valid.

Raises a ComputeTargetException if validation fails.

validate_configuration()

Exceptions

Type Description
ComputeTargetException