BatchNodeUserCreateOptions

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-batch-node-user-create-options-schema.json",
  "title": "BatchNodeUserCreateOptions",
  "description": "Parameters for creating a user account for RDP or SSH access on an Azure Batch Compute Node.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-batch-nodes-api-openapi.yml#/components/schemas/BatchNodeUserCreateOptions",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The user name of the Account."
    },
    "isAdmin": {
      "type": "boolean",
      "description": "Whether the Account should be an administrator on the Compute Node. The default value is false."
    },
    "expiryTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day."
    },
    "password": {
      "type": "string",
      "format": "password",
      "description": "The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property.",
      "x-ms-secret": true
    },
    "sshPublicKey": {
      "type": "string",
      "description": "The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
    }
  },
  "required": [
    "name"
  ]
}