Compute Node - Update User

Mises à jour le mot de passe et l’heure d’expiration d’un compte d’utilisateur sur le nœud de calcul spécifié.
Cette opération remplace toutes les propriétés pouvant être mises à jour du compte. Par exemple, si l’élément expiryTime n’est pas spécifié, la valeur actuelle est remplacée par la valeur par défaut, et n’est pas laissée non modifiée. Vous pouvez mettre à jour un compte d’utilisateur sur un nœud de calcul uniquement lorsqu’il est dans l’état inactif ou en cours d’exécution.

PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?api-version=2022-01-01.15.0
PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?timeout={timeout}&api-version=2022-01-01.15.0

Paramètres URI

Name In Required 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 mettre à jour un compte d’utilisateur.

poolId
path True
  • string

ID du pool qui contient le nœud de calcul.

userName
path True
  • string

Nom du compte d’utilisateur à mettre à jour.

api-version
query True
  • string

Version de l’API cliente.

timeout
query
  • integer
int32

Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

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

Name Required Type Description
client-request-id
  • string
uuid

L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration, comme les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id
  • boolean

Indique si le serveur doit retourner l’ID 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 actuelle de l’horloge système ; définissez-le explicitement si vous appelez directement l’API REST.

Corps de la demande

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

Name 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, le délai d’expiration a une précision jusqu’à un jour.

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. S’il est omis, un mot de passe existant est supprimé.

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. S’il est spécifié pour un nœud de calcul Windows, le service Batch rejette la demande ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (Requête incorrecte). En cas d’omission, une clé publique SSH existante est supprimée.

Réponses

Name Type Description
200 OK

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

Erreur du service Batch.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

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

Authorization

Type: apiKey
In: header

Exemples

Node update user

Sample Request

PUT account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users/userName?api-version=2022-01-01.15.0



{
  "password": "12345",
  "expiryTime": "2016-11-27T00:45:48.7320857Z"
}

Sample Response

Définitions

BatchError

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

BatchErrorDetail

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

ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

NodeUpdateUserParameter

Ensemble de modifications à apporter à un compte d’utilisateur sur un nœud de calcul.

BatchError

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

Name 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 inclus dans une réponse d’erreur Azure Batch.

Name 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.

ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Name Type Description
lang
  • string

Code de langue du message d’erreur

value
  • string

Texte du message.

NodeUpdateUserParameter

Ensemble de modifications à apporter à un compte d’utilisateur sur un nœud de calcul.

Name 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, le délai d’expiration a une précision jusqu’à un jour.

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. S’il est omis, un mot de passe existant est supprimé.

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. S’il est spécifié pour un nœud de calcul Windows, le service Batch rejette la demande ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (Requête incorrecte). En cas d’omission, une clé publique SSH existante est supprimée.