Compute Node - Get Remote Login Settings
Obtient les paramètres requis pour la connexion à distance à un nœud de calcul.
Avant de pouvoir vous connecter à distance à un nœud de calcul à l’aide des paramètres de connexion à distance, vous devez créer un compte d’utilisateur sur le nœud de calcul. Cette API ne peut être appelée que sur les pools créés avec la propriété de configuration de machine virtuelle. Pour les pools créés avec une configuration de service cloud, consultez l’API GetRemoteDesktop.
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2023-11-01.18.0
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?timeout={timeout}&api-version=2023-11-01.18.0
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
URL de base pour toutes les demandes de service Azure Batch. |
node
|
path | True |
string |
ID du nœud de calcul pour lequel obtenir les paramètres de connexion à distance. |
pool
|
path | True |
string |
ID du pool qui contient le nœud de calcul. |
api-version
|
query | True |
string |
Version de l’API cliente. |
timeout
|
query |
integer int32 |
Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes. |
En-tête de la demande
Media Types: "application/json; odata=minimalmetadata"
Nom | Obligatoire | Type | Description |
---|---|---|---|
client-request-id |
string uuid |
Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Indique si le serveur doit retourner le client-request-id dans la réponse. |
|
ocp-date |
string date-time-rfc1123 |
Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure d’horloge système actuelle ; définissez-la explicitement si vous appelez l’API REST directement. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Réponse contenant les paramètres de connexion. En-têtes
|
|
Other Status Codes |
Erreur du service Batch. |
Sécurité
azure_auth
Microsoft Entra flux de code d’authentification OAuth 2.0
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Authorization
Type:
apiKey
Dans:
header
Exemples
Node get remote login settings
Exemple de requête
GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/remoteloginsettings?api-version=2023-11-01.18.0
Exemple de réponse
{
"remoteLoginIPAddress": "1.1.1.1",
"remoteLoginPort": 50000
}
Définitions
Nom | Description |
---|---|
Batch |
Réponse d’erreur reçue du service Azure Batch. |
Batch |
Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch. |
Compute |
Paramètres de connexion à distance pour un nœud de calcul. |
Error |
Message d’erreur reçu dans une réponse d’erreur Azure Batch. |
BatchError
Réponse d’erreur reçue du service Azure Batch.
Nom | Type | Description |
---|---|---|
code |
string |
Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation. |
message |
Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur. |
|
values |
Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur. |
BatchErrorDetail
Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch.
Nom | Type | Description |
---|---|---|
key |
string |
Identificateur spécifiant la signification de la propriété Value. |
value |
string |
Informations supplémentaires incluses dans la réponse d’erreur. |
ComputeNodeGetRemoteLoginSettingsResult
Paramètres de connexion à distance pour un nœud de calcul.
Nom | Type | Description |
---|---|---|
remoteLoginIPAddress |
string |
Adresse IP utilisée pour la connexion à distance au nœud de calcul. |
remoteLoginPort |
integer |
Port utilisé pour la connexion à distance au nœud de calcul. |
ErrorMessage
Message d’erreur reçu dans une réponse d’erreur Azure Batch.
Nom | Type | Description |
---|---|---|
lang |
string |
Code de langue du message d’erreur |
value |
string |
Texte du message. |