RemoteComputeAttachConfiguration Class

Represents configuration parameters for attaching remote compute targets.

Use the attach_configuration method of the RemoteCompute class to specify attach parameters.

Initialize the configuration object.

Inheritance
RemoteComputeAttachConfiguration

Constructor

RemoteComputeAttachConfiguration(username, subscription_id=None, resource_group=None, vm_name=None, resource_id=None, address=None, ssh_port=22, password='', private_key_file='', private_key_passphrase='')

Parameters

Name Description
username
Required
str

The username needed to access the resource.

subscription_id
str

The Azure subscription ID in which virtual machine is located.

Default value: None
resource_group
str

The name of the resource group in which virtual machine is located.

Default value: None
vm_name
str

The virtual machine name.

Default value: None
resource_id
str

The arm resource_id of the resource to be attached.

Default value: None
address
str

The address of the resource to be attached.

Default value: None
ssh_port
int

The exposed port for the resource. Defaults to 22.

Default value: 22
password
Required
str

The password needed to access the resource.

private_key_file
Required
str

The path to a file containing the private key for the resource.

private_key_passphrase
Required
str

The private key phrase needed to access the resource.

username
Required
str

The username needed to access the resource.

subscription_id
Required
str

The Azure subscription ID in which virtual machine is located.

resource_group
Required
str

The name of the resource group in which virtual machine is located.

vm_name
Required
str

The virtual machine name.

resource_id
Required
str

The arm resource_id of the resource to be attached.

address
Required
str

The address of the resource to be attached.

ssh_port
Required
int

The exposed port for the resource. Defaults to 22.

password
Required
str

The password needed to access the resource.

private_key_file
Required
str

Path to a file containing the private key for the resource.

private_key_passphrase
Required
str

The private key phrase needed to access the resource.

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