Share via

ComputeInstanceSshSettings Class

Credentials for an administrator user account to SSH into the compute node.

Can only be configured if ssh_public_access_enabled is set to true on compute resource.

Constructor

ComputeInstanceSshSettings(*, ssh_key_value: str | None = None, **kwargs: Any)

Parameters

Name Description
ssh_key_value
Required
Optional[str]

The SSH public key of the administrator user account.

Keyword-Only Parameters

Name Description
ssh_key_value
Default value: None

Examples

Configuring ComputeInstanceSshSettings object.


   from azure.ai.ml.entities import ComputeInstanceSshSettings

   ssh_settings = ComputeInstanceSshSettings(  # type:ignore
       ssh_key_value="ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ administrator@MININT-2023"
   )

Attributes

admin_username

The name of the administrator user account which can be used to SSH into nodes.

Returns

Type Description
str

The name of the administrator user account.

ssh_port

SSH port.

Returns

Type Description
str

SSH port.