Compute Node - Add User

Agrega una cuenta de usuario al nodo de ejecución especificado.
Puede agregar una cuenta de usuario a un nodo de ejecución solo cuando se encuentra en estado inactivo o en ejecución.

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

Parámetros de identificador URI

Name In Required Type Description
batchUrl
path True
  • string

Dirección URL base de todas las solicitudes de servicio de Azure Batch.

nodeId
path True
  • string

El identificador de la máquina en la que desea crear una cuenta de usuario.

poolId
path True
  • string

Identificador del grupo que contiene el nodo de proceso.

api-version
query True
  • string

Versión de la API de cliente.

timeout
query
  • integer
int32

Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos.

Encabezado de la solicitud

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

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

La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id
  • boolean

Si el servidor debe devolver el client-request-id en la respuesta.

ocp-date
  • string
date-time-rfc1123

Hora a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST.

Cuerpo de la solicitud

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

Name Required Type Description
name True
  • string

Nombre de usuario de la cuenta.

expiryTime
  • string

Hora a la que debe expirar la cuenta.
Si se omite, el valor predeterminado es 1 día de la hora actual. En el caso de los nodos de proceso de Linux, expiryTime tiene una precisión hasta un día.

isAdmin
  • boolean

Si la cuenta debe ser un administrador en el nodo de proceso.
El valor predeterminado es false.

password
  • string

La contraseña de la cuenta.
La contraseña es necesaria para Windows nodos de proceso (los creados con "cloudServiceConfiguration" o creados con "virtualMachineConfiguration" mediante una referencia de imagen Windows). En el caso de los nodos de ejecución de Linux, la contraseña se puede especificar opcionalmente junto con la propiedad sshPublicKey.

sshPublicKey
  • string

Clave pública SSH que se puede usar para el inicio de sesión remoto en el nodo de proceso.
La clave pública debe ser compatible con la codificación OpenSSH y debe estar codificada en base 64. Esta propiedad solo se puede especificar para los nodos de ejecución de Linux. Si se especifica para un Windows nodo de ejecución, el servicio Batch rechaza la solicitud; si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

Respuestas

Name Type Description
201 Created

La solicitud al servicio Batch se realizó correctamente.

Headers

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

Error del servicio Batch.

Seguridad

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

Node add user

Sample Request

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2022-01-01.15.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "name": "userName",
  "isAdmin": false,
  "expiryTime": "2017-08-01T00:00:00Z",
  "password": "Password"
}

Sample Response

Definiciones

BatchError

Respuesta de error recibida del servicio Azure Batch.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error Azure Batch.

ComputeNodeUser

Una cuenta de usuario para el acceso RDP o SSH en un nodo de proceso.

ErrorMessage

Mensaje de error recibido en una respuesta de error Azure Batch.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Name Type Description
code
  • string

Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.

message

Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.

values

Colección de pares clave-valor que contiene detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error Azure Batch.

Name Type Description
key
  • string

Identificador que especifica el significado de la propiedad Value.

value
  • string

La información adicional incluida con la respuesta de error.

ComputeNodeUser

Una cuenta de usuario para el acceso RDP o SSH en un nodo de proceso.

Name Type Description
expiryTime
  • string

Hora a la que debe expirar la cuenta.
Si se omite, el valor predeterminado es 1 día de la hora actual. En el caso de los nodos de proceso de Linux, expiryTime tiene una precisión hasta un día.

isAdmin
  • boolean

Si la cuenta debe ser un administrador en el nodo de proceso.
El valor predeterminado es false.

name
  • string

Nombre de usuario de la cuenta.

password
  • string

La contraseña de la cuenta.
La contraseña es necesaria para Windows nodos de proceso (los creados con "cloudServiceConfiguration" o creados con "virtualMachineConfiguration" mediante una referencia de imagen Windows). En el caso de los nodos de ejecución de Linux, la contraseña se puede especificar opcionalmente junto con la propiedad sshPublicKey.

sshPublicKey
  • string

Clave pública SSH que se puede usar para el inicio de sesión remoto en el nodo de proceso.
La clave pública debe ser compatible con la codificación OpenSSH y debe estar codificada en base 64. Esta propiedad solo se puede especificar para los nodos de ejecución de Linux. Si se especifica para un Windows nodo de ejecución, el servicio Batch rechaza la solicitud; si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

ErrorMessage

Mensaje de error recibido en una respuesta de error Azure Batch.

Name Type Description
lang
  • string

Código de idioma del mensaje de error

value
  • string

Texto del mensaje.