Microsoft Azure Pool API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Pool API
schemes:
- https
tags:
- name: Pool
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools
  : get:
      tags:
      - Pool
      operationId: microsoftAzurePoolListbybatchaccount
      description: Lists all of the pools in the specified account.
      x-ms-examples:
        ListPool:
          $ref: ./examples/PoolList.json
        ListPoolWithFilter:
          $ref: ./examples/PoolListWithFilter.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - name: maxresults
        in: query
        required: false
        type: integer
        format: int32
        description: The maximum number of items to return in the response.
      - name: $select
        in: query
        required: false
        type: string
        description: Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection.
      - name: $filter
        in: query
        required: false
        type: string
        description: "OData filter expression. Valid properties for filtering are:\n\n name\n properties/allocationState\n properties/allocationStateTransitionTime\n properties/creationTime\n properties/provisioningState\n properties/provisioningStateTransitionTime\n properties/lastModified\n properties/vmSize\n properties/interNodeCommunication\n properties/scaleSettings/autoScale\n properties/scaleSettings/fixedScale"
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains a list of certificates associated with the account.
          schema:
            $ref: '#/definitions/ListPoolsResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}
  : put:
      tags:
      - Pool
      operationId: microsoftAzurePoolCreate
      description: Creates a new pool inside the specified account.
      x-ms-examples:
        CreatePool - Minimal CloudServiceConfiguration:
          $ref: ./examples/PoolCreate_MinimalCloudServiceConfiguration.json
        CreatePool - Minimal VirtualMachineConfiguration:
          $ref: ./examples/PoolCreate_MinimalVirtualMachineConfiguration.json
        CreatePool - Full CloudServiceConfiguration:
          $ref: ./examples/PoolCreate_CloudServiceConfiguration.json
        CreatePool - Custom Image:
          $ref: ./examples/PoolCreate_SharedImageGallery.json
        CreatePool - Public IPs:
          $ref: ./examples/PoolCreate_PublicIPs.json
        CreatePool - Full VirtualMachineConfiguration:
          $ref: ./examples/PoolCreate_VirtualMachineConfiguration.json
        CreatePool - No public IP:
          $ref: ./examples/PoolCreate_NoPublicIPAddresses.json
        CreatePool - UserAssignedIdentities:
          $ref: ./examples/PoolCreate_UserAssignedIdentities.json
        CreatePool - VirtualMachineConfiguration Extensions:
          $ref: ./examples/PoolCreate_VirtualMachineConfiguration_Extensions.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/PoolNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/Pool'
        description: Additional parameters for pool creation.
      - name: If-Match
        in: header
        required: false
        type: string
        description: The entity state (ETag) version of the pool to update. A value of "*" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied.
      - name: If-None-Match
        in: header
        required: false
        type: string
        description: Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the pool entity.
          schema:
            $ref: '#/definitions/Pool'
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools Poolname
    patch:
      tags:
      - Pool
      operationId: microsoftAzurePoolUpdate
      description: Updates the properties of an existing pool.
      x-ms-examples:
        UpdatePool - Resize Pool:
          $ref: ./examples/PoolUpdate_ResizePool.json
        UpdatePool - Enable Autoscale:
          $ref: ./examples/PoolUpdate_EnableAutoScale.json
        UpdatePool - Remove Start Task:
          $ref: ./examples/PoolUpdate_RemoveStartTask.json
        UpdatePool - Other Properties:
          $ref: ./examples/PoolUpdate_OtherProperties.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/PoolNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/Pool'
        description: Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.
      - name: If-Match
        in: header
        required: false
        type: string
        description: The entity state (ETag) version of the pool to update. This value can be omitted or set to "*" to apply the operation unconditionally.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the pool entity.
          schema:
            $ref: '#/definitions/Pool'
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools Poolname
    delete:
      tags:
      - Pool
      operationId: microsoftAzurePoolDelete
      description: Deletes the specified pool.
      x-ms-examples:
        DeletePool:
          $ref: ./examples/PoolDelete.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/PoolNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful.
        '202':
          description: The operation will be completed asynchronously.
          headers:
            Location:
              description: The URL of the resource used to check the status of the asynchronous operation.
              type: string
            Retry-After:
              description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.
              type: integer
              format: int32
        '204':
          description: The operation was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools Poolname
    get:
      tags:
      - Pool
      operationId: microsoftAzurePoolGet
      description: Gets information about the specified pool.
      x-ms-examples:
        GetPool:
          $ref: ./examples/PoolGet.json
        GetPool - VirtualMachineConfiguration Extensions:
          $ref: ./examples/PoolGet_VirtualMachineConfiguration_Extensions.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/PoolNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the pool entity.
          schema:
            $ref: '#/definitions/Pool'
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools Poolname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/disableAutoScale
  : post:
      tags:
      - Pool
      operationId: microsoftAzurePoolDisableautoscale
      description: Disables automatic scaling for a pool.
      x-ms-examples:
        Disable AutoScale:
          $ref: ./examples/PoolDisableAutoScale.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/PoolNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the pool entity.
          schema:
            $ref: '#/definitions/Pool'
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools Poolname Disableautoscale
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/stopResize
  : post:
      tags:
      - Pool
      operationId: microsoftAzurePoolStopresize
      summary: Microsoft Azure Stops An Ongoing Resize Operation On The Pool
      description: 'This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.'
      x-ms-examples:
        StopPoolResize:
          $ref: ./examples/PoolStopResize.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/PoolNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the pool entity.
          schema:
            $ref: '#/definitions/Pool'
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
definitions:
  ComputeNodeDeallocationOption:
    type: string
    title: Determines what to do with a node and its running task(s) after it has been selected for deallocation.
    enum:
    - Requeue
    - Terminate
    - TaskCompletion
    - RetainedData
    x-ms-enum:
      name: ComputeNodeDeallocationOption
      modelAsString: false
      values:
      - value: Requeue
        description: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated.
      - value: Terminate
        description: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated.
      - value: TaskCompletion
        description: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed.
      - value: RetainedData
        description: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired.
  AutoScaleRun:
    properties:
      evaluationTime:
        type: string
        format: date-time
        title: The time at which the autoscale formula was last evaluated.
      results:
        type: string
        title: The final values of all variables used in the evaluation of the autoscale formula.
        description: Each variable value is returned in the form $variable=value, and variables are separated by semicolons.
      error:
        $ref: '#/definitions/AutoScaleRunError'
        title: Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful.
    required:
    - evaluationTime
    title: The results and errors from an execution of a pool autoscale formula.
  ProxyResource:
    properties:
      id:
        readOnly: true
        type: string
        description: The ID of the resource.
      name:
        readOnly: true
        type: string
        description: The name of the resource.
      type:
        readOnly: true
        type: string
        description: The type of the resource.
      etag:
        readOnly: true
        type: string
        description: The ETag of the resource, used for concurrency statements.
    description: A definition of an Azure resource.
    x-ms-azure-resource: true
  UserIdentity:
    properties:
      userName:
        type: string
        title: The name of the user identity under which the task is run.
        description: The userName and autoUser properties are mutually exclusive; you must specify one but not both.
      autoUser:
        $ref: '#/definitions/AutoUserSpecification'
        title: The auto user under which the task is run.
        description: The userName and autoUser properties are mutually exclusive; you must specify one but not both.
    title: The definition of the user identity under which the task is run.
    description: Specify either the userName or autoUser property, but not both.
  TaskSchedulingPolicy:
    properties:
      nodeFillType:
        type: string
        title: How tasks should be distributed across compute nodes.
        enum:
        - Spread
        - Pack
        x-ms-enum:
          name: ComputeNodeFillType
          modelAsString: false
          values:
          - value: Spread
            description: Tasks should be assigned evenly across all nodes in the pool.
          - value: Pack
            description: As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool.
    required:
    - nodeFillType
    title: Specifies how tasks should be distributed across compute nodes.
  AutoScaleRunError:
    properties:
      code:
        type: string
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        type: string
        description: A message describing the error, intended to be suitable for display in a user interface.
      details:
        type: array
        items:
          $ref: '#/definitions/AutoScaleRunError'
        title: Additional details about the error.
    title: An error that occurred when autoscaling a pool.
    required:
    - code
    - message
  LinuxUserConfiguration:
    properties:
      uid:
        type: integer
        format: int32
        title: The user ID of the user account.
        description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.
      gid:
        type: integer
        format: int32
        title: The group ID for the user account.
        description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.
      sshPrivateKey:
        type: string
        title: The SSH private key for the user account.
        description: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).
    title: Properties used to create a user account on a Linux node.
  ApplicationPackageReference:
    properties:
      id:
        type: string
        title: The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists.
      version:
        type: string
        title: The version of the application to deploy. If omitted, the default version is deployed.
        description: If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.
    title: Link to an application package inside the batch account
    required:
    - id
  ContainerConfiguration:
    properties:
      type:
        type: string
        title: The container technology to be used.
        enum:
        - DockerCompatible
        x-ms-enum:
          name: ContainerType
          modelAsString: false
          values:
          - value: DockerCompatible
            description: A Docker compatible container technology will be used to launch the containers.
      containerImageNames:
        type: array
        items:
          type: string
        title: The collection of container image names.
        description: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry.
      containerRegistries:
        type: array
        items:
          $ref: '#/definitions/ContainerRegistry'
        title: Additional private registries from which containers can be pulled.
        description: If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.
    required:
    - type
    title: The configuration for container-enabled pools.
  ResizeError:
    properties:
      code:
        type: string
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        type: string
        description: A message describing the error, intended to be suitable for display in a user interface.
      details:
        type: array
        items:
          $ref: '#/definitions/ResizeError'
        title: Additional details about the error.
    title: An error that occurred when resizing a pool.
    required:
    - code
    - message
  NFSMountConfiguration:
    properties:
      source:
        type: string
        title: The URI of the file system to mount.
      relativeMountPath:
        type: string
        title: The relative path on the compute node where the file system will be mounted
        description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
      mountOptions:
        type: string
        title: Additional command line options to pass to the mount command.
        description: These are 'net use' options in Windows and 'mount' options in Linux.
    required:
    - source
    - relativeMountPath
    title: Information used to connect to an NFS file system.
  CloudErrorBody:
    x-ms-external: true
    properties:
      code:
        type: string
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        type: string
        description: A message describing the error, intended to be suitable for display in a user interface.
      target:
        type: string
        description: The target of the particular error. For example, the name of the property in error.
      details:
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        description: A list of additional details about the error.
    description: An error response from the Batch service.
  DiskEncryptionConfiguration:
    properties:
      targets:
        type: array
        items:
          type: string
          x-nullable: false
          title: The disks to encrypt on each compute node.
          description: If omitted, no disks on the compute nodes in the pool will be encrypted.
          enum:
          - OsDisk
          - TemporaryDisk
          x-ms-enum:
            name: DiskEncryptionTarget
            modelAsString: false
            values:
            - value: OsDisk
              description: The OS Disk on the compute node is encrypted.
              name: OsDisk
            - value: TemporaryDisk
              description: The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time.
              name: TemporaryDisk
        title: The list of disk targets Batch Service will encrypt on the compute node
        description: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.
    description: The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image.
  DeploymentConfiguration:
    properties:
      cloudServiceConfiguration:
        $ref: '#/definitions/CloudServiceConfiguration'
        title: The cloud service configuration for the pool.
        description: This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.
      virtualMachineConfiguration:
        $ref: '#/definitions/VirtualMachineConfiguration'
        title: The virtual machine configuration for the pool.
        description: This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
    title: Deployment configuration properties.
  TaskContainerSettings:
    properties:
      containerRunOptions:
        type: string
        title: Additional options to the container create command.
        description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.
      imageName:
        type: string
        title: The image to use to create the container in which the task will run.
        description: This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default.
      registry:
        $ref: '#/definitions/ContainerRegistry'
        title: The private registry which contains the container image.
        description: This setting can be omitted if was already provided at pool creation.
      workingDirectory:
        type: string
        title: A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.
        enum:
        - TaskWorkingDirectory
        - ContainerImageDefault
        x-ms-enum:
          name: ContainerWorkingDirectory
          modelAsString: false
          values:
          - value: TaskWorkingDirectory
            description: Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch.
          - value: ContainerImageDefault
            description: Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch.
    required:
    - imageName
    title: The container settings for a task.
  MountConfiguration:
    properties:
      azureBlobFileSystemConfiguration:
        $ref: '#/definitions/AzureBlobFileSystemConfiguration'
        title: The Azure Storage Container to mount using blob FUSE on each node.
        description: This property is mutually exclusive with all other properties.
      nfsMountConfiguration:
        $ref: '#/definitions/NFSMountConfiguration'
        title: The NFS file system to mount on each node.
        description: This property is mutually exclusive with all other properties.
      cifsMountConfiguration:
        $ref: '#/definitions/CIFSMountConfiguration'
        title: The CIFS/SMB file system to mount on each node.
        description: This property is mutually exclusive with all other properties.
      azureFileShareConfiguration:
        $ref: '#/definitions/AzureFileShareConfiguration'
        title: The Azure File Share to mount on each node.
        description: This property is mutually exclusive with all other properties.
    title: The file system to mount on each node.
  CIFSMountConfiguration:
    properties:
      username:
        type: string
        title: The user to use for authentication against the CIFS file system.
      source:
        type: string
        title: The URI of the file system to mount.
      relativeMountPath:
        type: string
        title: The relative path on the compute node where the file system will be mounted
        description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
      mountOptions:
        type: string
        title: Additional command line options to pass to the mount command.
        description: These are 'net use' options in Windows and 'mount' options in Linux.
      password:
        type: string
        title: The password to use for authentication against the CIFS file system.
    required:
    - username
    - source
    - password
    - relativeMountPath
    title: Information used to connect to a CIFS file system.
  MetadataItem:
    properties:
      name:
        type: string
        title: The name of the metadata item.
      value:
        type: string
        title: The value of the metadata item.
    required:
    - name
    - value
    title: A name-value pair associated with a Batch service resource.
    description: The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.
  AutoUserSpecification:
    properties:
      scope:
        type: string
        title: The scope for the auto user
        description: The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.
        enum:
        - Task
        - Pool
        x-ms-enum:
          name: AutoUserScope
          modelAsString: false
          values:
          - value: Task
            description: Specifies that the service should create a new user for the task.
          - value: Pool
            description: Specifies that the task runs as the common auto user account which is created on every node in a pool.
      elevationLevel:
        title: The elevation level of the auto user.
        description: The default value is nonAdmin.
        $ref: '#/definitions/ElevationLevel'
    title: Specifies the parameters for the auto user that runs a task on the Batch service.
  ContainerRegistry:
    properties:
      registryServer:
        type: string
        title: The registry URL.
        description: If omitted, the default is "docker.io".
      username:
        type: string
        x-ms-client-name: userName
        title: The user name to log into the registry server.
      password:
        type: string
        title: The password to log into the registry server.
    required:
    - username
    - password
    title: A private container registry.
  ImageReference:
    properties:
      publisher:
        type: string
        title: The publisher of the Azure Virtual Machines Marketplace image.
        description: For example, Canonical or MicrosoftWindowsServer.
      offer:
        type: string
        title: The offer type of the Azure Virtual Machines Marketplace image.
        description: For example, UbuntuServer or WindowsServer.
      sku:
        type: string
        title: The SKU of the Azure Virtual Machines Marketplace image.
        description: For example, 18.04-LTS or 2019-Datacenter.
      version:
        type: string
        title: The version of the Azure Virtual Machines Marketplace image.
        description: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.
      id:
        type: string
        title: The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Micros

# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-pool-api-openapi.yml