ComputeInstanceProvisioningConfiguration Class
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
-
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
- vm_size
- 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.
- admin_user_ssh_public_key
- str
The SSH public key of the administrator user account.
- vnet_resourcegroup_name
- str
The name of the resource group where the virtual network is located.
An optional dictionary of key value tags to associate with the ComputeInstance object.
- vm_size
- 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.
- vnet_resourcegroup_name
- str
The name of the resource group where the virtual network is located.
An optional dictionary of key value tags to associate with the ComputeInstance object.
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
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for