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
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]Required Parameters
The ID of the Compute Node for which to obtain the remote login settings.
The ID of the Pool that contains the Compute Node.
Optional Parameters
Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.
Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.
Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
