Share via

az batch node remote-login-settings

Retrieve the remote login settings for a Batch compute node.

Commands

Name Description Type Status
az batch node remote-login-settings show

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

 Core GA

az batch node remote-login-settings show

Edit

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.

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

Required Parameters

--node-id

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

--pool-id

The ID of the Pool that contains the Compute Node. Required.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-endpoint

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

Property Value
Parameter group: Batch Account Arguments
--account-key

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

Property Value
Parameter group: Batch Account Arguments
--account-name

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

Property Value
Parameter group: Batch Account Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False