RemoteComputeAttachConfiguration Class

  • Reference

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
ComputeTargetAttachConfiguration
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

username
str
Required

The username needed to access the resource.

subscription_id
str
default value: None

The Azure subscription ID in which virtual machine is located.

resource_group
str
default value: None

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

vm_name
str
default value: None

The virtual machine name.

resource_id
str
default value: None

The arm resource_id of the resource to be attached.

address
str
default value: None

The address of the resource to be attached.

ssh_port
int
default value: 22

The exposed port for the resource. Defaults to 22.

password
str
Required

The password needed to access the resource.

private_key_file
str
Required

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

private_key_passphrase
str
Required

The private key phrase needed to access the resource.

username
str
Required

The username needed to access the resource.

subscription_id
str
Required

The Azure subscription ID in which virtual machine is located.

resource_group
str
Required

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

vm_name
str
Required

The virtual machine name.

resource_id
str
Required

The arm resource_id of the resource to be attached.

address
str
Required

The address of the resource to be attached.

ssh_port
int
Required

The exposed port for the resource. Defaults to 22.

password
str
Required

The password needed to access the resource.

private_key_file
str
Required

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

private_key_passphrase
str
Required

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

ComputeTargetException