Compute Node - Add User

  • Référence
Service:
Batch Service
API Version:
2023-11-01.18.0

Ajoute un compte d’utilisateur au nœud de calcul spécifié.
Vous pouvez ajouter un compte d’utilisateur à un nœud de calcul uniquement lorsqu’il est à l’état inactif ou en cours d’exécution.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?timeout={timeout}&api-version=2023-11-01.18.0

Paramètres URI

Nom Dans Obligatoire Type Description
batchUrl
 path True

string

URL de base pour toutes les demandes de service Azure Batch.
nodeId
 path True

string

ID de l’ordinateur sur lequel vous souhaitez créer un compte d’utilisateur.
poolId
 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.

Corps de la demande

Media Types: "application/json; odata=minimalmetadata"

Nom Obligatoire Type Description
name True

string

Nom d’utilisateur du compte.
expiryTime

string

Heure à laquelle le compte doit expirer.
En cas d’omission, la valeur par défaut est de 1 jour à partir de l’heure actuelle. Pour les nœuds de calcul Linux, expiryTime a une précision pouvant aller jusqu’à un jour.
isAdmin

boolean

Indique si le compte doit être un administrateur sur le nœud de calcul.
La valeur par défaut est false.
password

string

Mot de passe du compte.
Le mot de passe est requis pour les nœuds de calcul Windows (ceux créés avec « cloudServiceConfiguration » ou créés avec « virtualMachineConfiguration » à l’aide d’une référence d’image Windows). Pour les nœuds de calcul Linux, le mot de passe peut éventuellement être spécifié avec la propriété sshPublicKey.
sshPublicKey

string

Clé publique SSH qui peut être utilisée pour la connexion à distance au nœud de calcul.
La clé publique doit être compatible avec l’encodage OpenSSH et doit être encodée en base 64. Cette propriété ne peut être spécifiée que pour les nœuds de calcul Linux. Si cela est spécifié pour un nœud de calcul Windows, le service Batch rejette la demande ; si vous appelez l’API REST directement, le code http status est 400 (requête incorrecte).

Réponses

Nom Type Description
201 Created

La demande adressée au service Batch a réussi.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Erreur du service Batch.

Sécurité

azure_auth

Microsoft Entra flux de code d’authentification OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
In: header

Exemples

Node add user

Sample Request

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2023-11-01.18.0



{
  "name": "userName",
  "isAdmin": false,
  "expiryTime": "2017-08-01T00:00:00Z",
  "password": "Password"
}

Sample Response

Status code:
201

Définitions

Nom Description
BatchError

Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail

Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch.
ComputeNodeUser

Un compte d’utilisateur pour l’accès RDP ou SSH sur un nœud de calcul.
ErrorMessage

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

ErrorMessage

Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values

BatchErrorDetail[]

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.

ComputeNodeUser

Un compte d’utilisateur pour l’accès RDP ou SSH sur un nœud de calcul.

Nom Type Description
expiryTime

string

Heure à laquelle le compte doit expirer.
En cas d’omission, la valeur par défaut est de 1 jour à partir de l’heure actuelle. Pour les nœuds de calcul Linux, expiryTime a une précision pouvant aller jusqu’à un jour.
isAdmin

boolean

Indique si le compte doit être un administrateur sur le nœud de calcul.
La valeur par défaut est false.
name

string

Nom d’utilisateur du compte.
password

string

Mot de passe du compte.
Le mot de passe est requis pour les nœuds de calcul Windows (ceux créés avec « cloudServiceConfiguration » ou créés avec « virtualMachineConfiguration » à l’aide d’une référence d’image Windows). Pour les nœuds de calcul Linux, le mot de passe peut éventuellement être spécifié avec la propriété sshPublicKey.
sshPublicKey

string

Clé publique SSH qui peut être utilisée pour la connexion à distance au nœud de calcul.
La clé publique doit être compatible avec l’encodage OpenSSH et doit être encodée en base 64. Cette propriété ne peut être spécifiée que pour les nœuds de calcul Linux. Si cela est spécifié pour un nœud de calcul Windows, le service Batch rejette la demande ; si vous appelez l’API REST directement, le code http status est 400 (requête incorrecte).

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.