az batch node remote-login-settings

Retrieve the remote login settings for a Batch compute node.

Commands

az batch node remote-login-settings show

Gets the settings required for remote login to a Compute Node.

az batch node remote-login-settings show

Gets the settings required for remote login to a Compute Node.

Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node. This API can be invoked only on Pools created with the virtual machine configuration property. For Pools created with a cloud service configuration, see the GetRemoteDesktop API.

az batch node remote-login-settings show --node-id
                                         --pool-id
                                         [--account-endpoint]
                                         [--account-key]
                                         [--account-name]
                                         [--query-examples]
                                         [--subscription]

Required Parameters

--node-id

The ID of the Compute Node for which to obtain the remote login settings.

--pool-id

The ID of the Pool that contains the Compute Node.

Optional Parameters

--account-endpoint

Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.

--account-key

Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.

--account-name

Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.