Compartir a través de

Pool - Create

  • Referencia
Servicio:
Batch Management
Versión de la API:
2024-07-01

Crea un nuevo grupo dentro de la cuenta especificada.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}?api-version=2024-07-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
accountName
 path True

string

Nombre de la cuenta de Batch.

Patrón de Regex: ^[a-zA-Z0-9]+$
poolName
 path True

string

Nombre del grupo. Debe ser único dentro de la cuenta.

Patrón de Regex: ^[a-zA-Z0-9_-]+$
resourceGroupName
 path True

string

Nombre del grupo de recursos que contiene la cuenta de Batch.
subscriptionId
 path True

string

Identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-00000-00000000000000)
api-version
 query True

string

Versión de la API que se va a usar con la solicitud HTTP.

Encabezado de la solicitud

Nombre Requerido Tipo Description
If-Match

string

Versión del estado de entidad (ETag) del grupo que se va a actualizar. Se puede usar un valor de "*" para aplicar la operación solo si el grupo ya existe. Si se omite, esta operación siempre se aplicará.
If-None-Match

string

Establézcalo en "*" para permitir la creación de un nuevo grupo, pero para evitar la actualización de un grupo existente. Se omitirán otros valores.

Cuerpo de la solicitud

Nombre Tipo Description
identity

BatchPoolIdentity

Tipo de identidad que se usa para el grupo de Batch.
Tipo de identidad que se usa para el grupo de Batch.
properties.applicationLicenses

string[]

La lista de licencias de aplicación que el servicio Batch pondrá a disposición en cada nodo de proceso del grupo.
La lista de licencias de aplicación debe ser un subconjunto de licencias de aplicaciones de servicio de Batch disponibles. Si se solicita una licencia que no se admite, se producirá un error en la creación del grupo.
properties.applicationPackages

ApplicationPackageReference[]

Lista de paquetes de aplicación que se van a instalar en cada nodo de proceso del grupo.
Los cambios en las referencias del paquete de aplicación afectan a todos los nodos de proceso nuevos que se unen al grupo, pero no afectan a los nodos de proceso que ya están en el grupo hasta que se reinician o se vuelven a crear imágenes. Hay un máximo de 10 referencias de paquete de aplicación en cualquier grupo determinado.
properties.certificates

CertificateReference[]

Lista de certificados que se van a instalar en cada nodo de proceso del grupo.
En el caso de los nodos de proceso de Windows, el servicio Batch instala los certificados en el almacén de certificados y la ubicación especificados. En el caso de los nodos de proceso de Linux, los certificados se almacenan en un directorio dentro del directorio de trabajo de la tarea y se proporciona una variable de entorno AZ_BATCH_CERTIFICATES_DIR a la tarea para consultar esta ubicación. Para los certificados con visibilidad de "remoteUser", se crea un directorio "certs" en el directorio principal del usuario (por ejemplo, /home/{user-name}/certs) y los certificados se colocan en ese directorio.

Advertencia: esta propiedad está en desuso y se quitará después de febrero de 2024. Use el de extensión de Azure KeyVault de .
properties.deploymentConfiguration

DeploymentConfiguration

Esta propiedad describe las máquinas virtuales en las que se implementarán los nodos del grupo.
properties.displayName

string

Nombre para mostrar del grupo.
El nombre para mostrar no debe ser único y puede contener caracteres Unicode de hasta una longitud máxima de 1024.
properties.interNodeCommunication

InterNodeCommunicationState

Si el grupo permite la comunicación directa entre nodos.
Esto impone restricciones en las que se pueden asignar nodos al grupo. La habilitación de este valor puede reducir la posibilidad de asignar el número solicitado de nodos en el grupo. Si no se especifica, este valor tiene como valor predeterminado "Disabled".
properties.metadata

MetadataItem[]

Lista de pares nombre-valor asociados al grupo como metadatos.
El servicio Batch no asigna ningún significado a los metadatos; es únicamente para el uso del código de usuario.
properties.mountConfiguration

MountConfiguration[]

Lista de sistemas de archivos que se van a montar en cada nodo del grupo.
Esto admite Azure Files, NFS, CIFS/SMB y Blobfuse.
properties.networkConfiguration

NetworkConfiguration

Configuración de red del grupo.
Configuración de red de un grupo.
properties.resourceTags

object

Etiquetas especificadas por el usuario asociadas al grupo.
Etiquetas definidas por el usuario que se van a asociar al grupo de Azure Batch. Cuando se especifica, estas etiquetas se propagan a los recursos de Azure de respaldo asociados al grupo. Esta propiedad solo se puede especificar cuando se creó la cuenta de Batch con la propiedad poolAllocationMode establecida en "UserSubscription".
properties.scaleSettings

ScaleSettings

Valores que configuran el número de nodos del grupo.
Define el tamaño deseado del grupo. Esto puede ser "fixedScale" donde se especifica targetDedicatedNodes solicitado o "autoScale", que define una fórmula que se vuelve a evaluar periódicamente. Si no se especifica esta propiedad, el grupo tendrá una escala fija con 0 targetDedicatedNodes.
properties.startTask

StartTask

Tarea especificada para ejecutarse en cada nodo de proceso a medida que se une al grupo.
En una operación PATCH (actualización), esta propiedad se puede establecer en un objeto vacío para quitar la tarea de inicio del grupo.
properties.targetNodeCommunicationMode

NodeCommunicationMode

Modo de comunicación de nodo deseado para el grupo.
Si se omite, el valor predeterminado es Default.
properties.taskSchedulingPolicy

TaskSchedulingPolicy

Cómo se distribuyen las tareas entre los nodos de proceso de un grupo.
Si no se especifica, el valor predeterminado se propaga.
properties.taskSlotsPerNode

integer

Número de ranuras de tareas que se pueden usar para ejecutar tareas simultáneas en un único nodo de proceso del grupo.
El valor predeterminado es 1. El valor máximo es el menor de 4 veces el número de núcleos de vmSize del grupo o 256.
properties.upgradePolicy

UpgradePolicy

Directiva de actualización del grupo.
Describe una directiva de actualización: automática, manual o gradual.
properties.userAccounts

UserAccount[]

Lista de cuentas de usuario que se van a crear en cada nodo del grupo.
properties.vmSize

string

Tamaño de las máquinas virtuales del grupo. Todas las máquinas virtuales de un grupo tienen el mismo tamaño.
Para obtener información sobre los tamaños de máquina virtual disponibles, consulte Tamaños de máquinas virtuales (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) o Tamaños de máquinas virtuales (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch admite todos los tamaños de máquina virtual de Azure, excepto STANDARD_A0 y aquellos con premium Storage (STANDARD_GS, STANDARD_DS y serie STANDARD_DSV2).
tags

object

Etiquetas del recurso.

Respuestas

Nombre Tipo Description
200 OK

Pool

La operación se realizó correctamente. La respuesta contiene la entidad del grupo.

Encabezados

ETag: string
Other Status Codes

CloudError

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de código de autenticación de Microsoft Entra OAuth 2.0

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

CreatePool - accelerated networking
CreatePool - Custom Image
CreatePool - Full VirtualMachineConfiguration
CreatePool - Minimal VirtualMachineConfiguration
CreatePool - No public IP
CreatePool - Public IPs
CreatePool - ResourceTags
CreatePool - SecurityProfile
CreatePool - Tags
CreatePool - UpgradePolicy
CreatePool - UserAssignedIdentities
CreatePool - VirtualMachineConfiguration Extensions
CreatePool - VirtualMachineConfiguration OSDisk
CreatePool - VirtualMachineConfiguration ServiceArtifactReference

CreatePool - accelerated networking

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "STANDARD_D1_V2",
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "enableAcceleratedNetworking": true
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8DB46CB72A227E2"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB46CB72A227E2\"",
  "properties": {
    "lastModified": "2023-04-27T02:59:41.8592226Z",
    "creationTime": "2023-04-27T02:59:41.8592226Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-04-27T02:59:41.8592226Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2023-04-27T03:00:34.0646502Z",
    "vmSize": "STANDARD_D1_V2",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "dynamicVnetAssignmentScope": "none",
      "enableAcceleratedNetworking": true
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-04-27T02:59:41.8592226Z"
    },
    "currentDedicatedNodes": 1,
    "currentLowPriorityNodes": 0,
    "currentNodeCommunicationMode": "Classic"
  }
}

CreatePool - Custom Image

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Full VirtualMachineConfiguration

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "licenseType": "Windows_Server",
        "dataDisks": [
          {
            "lun": 0,
            "caching": "ReadWrite",
            "diskSizeGB": 30,
            "storageAccountType": "Premium_LRS"
          },
          {
            "lun": 1,
            "caching": "None",
            "diskSizeGB": 200,
            "storageAccountType": "Standard_LRS"
          }
        ],
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk",
            "TemporaryDisk"
          ]
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        },
        "osDisk": {
          "ephemeralOSDiskSettings": {
            "placement": "CacheDisk"
          }
        }
      }
    },
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "name": "testnat",
            "protocol": "TCP",
            "backendPort": 12001,
            "frontendPortRangeStart": 15000,
            "frontendPortRangeEnd": 15100,
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "sourceAddressPrefix": "192.100.12.45",
                "priority": 150,
                "sourcePortRanges": [
                  "1",
                  "2"
                ]
              },
              {
                "access": "Deny",
                "sourceAddressPrefix": "*",
                "priority": 3500,
                "sourcePortRanges": [
                  "*"
                ]
              }
            ]
          }
        ]
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "licenseType": "Windows_Server",
        "dataDisks": [
          {
            "lun": 0,
            "caching": "ReadWrite",
            "diskSizeGB": 30,
            "storageAccountType": "Premium_LRS"
          },
          {
            "lun": 1,
            "caching": "None",
            "diskSizeGB": 200,
            "storageAccountType": "Standard_LRS"
          }
        ],
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk",
            "TemporaryDisk"
          ]
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        }
      }
    },
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "name": "testnat",
            "protocol": "TCP",
            "backendPort": 12001,
            "frontendPortRangeStart": 15000,
            "frontendPortRangeEnd": 15100,
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "sourceAddressPrefix": "192.100.12.45",
                "priority": 150,
                "sourcePortRanges": [
                  "1",
                  "2"
                ]
              },
              {
                "access": "Deny",
                "sourceAddressPrefix": "*",
                "priority": 3500,
                "sourcePortRanges": [
                  "*"
                ]
              }
            ]
          }
        ]
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Minimal VirtualMachineConfiguration

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - No public IP

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "NoPublicIPAddresses"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "NoPublicIPAddresses"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Public IPs

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
        ]
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
        ]
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - ResourceTags

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "Standard_d4s_v3",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "resourceTags": {
      "TagName1": "TagValue1",
      "TagName2": "TagValue2"
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8DB554F8E08BCF4"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB554F8E08BCF4\"",
  "properties": {
    "lastModified": "2023-06-14T07:03:58.3231917Z",
    "creationTime": "2023-06-14T07:03:58.3231917Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "vmSize": "STANDARD_D4S_V3",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-09-27T07:33:13.0625789Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "resourceTags": {
      "TagName1": "TagValue1",
      "TagName2": "TagValue2"
    }
  }
}

CreatePool - SecurityProfile

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "Standard_d4s_v3",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04",
        "securityProfile": {
          "securityType": "trustedLaunch",
          "encryptionAtHost": true,
          "uefiSettings": {
            "secureBootEnabled": null,
            "vTpmEnabled": false
          }
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8DB554F8E08BCF4"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB554F8E08BCF4\"",
  "properties": {
    "lastModified": "2023-06-14T07:03:58.3231917Z",
    "creationTime": "2023-06-14T07:03:58.3231917Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "vmSize": "STANDARD_D4S_V3",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04",
        "securityProfile": {
          "securityType": "trustedLaunch",
          "encryptionAtHost": true,
          "uefiSettings": {
            "vTpmEnabled": false
          }
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-06-14T07:03:58.3231917Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Tags

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "tags": {
    "TagName1": "TagValue1",
    "TagName2": "TagValue2"
  },
  "properties": {
    "vmSize": "Standard_d4s_v3",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "0001-com-ubuntu-server-jammy",
          "sku": "22_04-lts",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 22.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8DB554F8E08BCF4"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB554F8E08BCF4\"",
  "properties": {
    "lastModified": "2023-06-14T07:03:58.3231917Z",
    "creationTime": "2023-06-14T07:03:58.3231917Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "vmSize": "STANDARD_D4S_V3",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "0001-com-ubuntu-server-jammy",
          "sku": "22_04-lts",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 22.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-09-27T07:33:13.0625789Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  },
  "tags": {
    "TagName1": "TagValue1",
    "TagName2": "TagValue2"
  }
}

CreatePool - UpgradePolicy

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "Standard_d4s_v3",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0
      }
    },
    "upgradePolicy": {
      "mode": "automatic",
      "automaticOSUpgradePolicy": {
        "disableAutomaticRollback": true,
        "enableAutomaticOSUpgrade": true,
        "useRollingUpgradePolicy": true,
        "osRollingUpgradeDeferral": true
      },
      "rollingUpgradePolicy": {
        "enableCrossZoneUpgrade": true,
        "maxBatchInstancePercent": 20,
        "maxUnhealthyInstancePercent": 20,
        "maxUnhealthyUpgradedInstancePercent": 20,
        "pauseTimeBetweenBatches": "PT0S",
        "prioritizeUnhealthyInstances": false,
        "rollbackFailedInstancesOnPolicyBreach": false
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8DB51E64D3C3B69"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB51E64D3C3B69\"",
  "properties": {
    "lastModified": "2023-05-11T06:16:44.2372184Z",
    "creationTime": "2023-05-11T06:16:44.2372184Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-05-11T06:16:44.2372184Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-05-11T06:16:44.2372184Z",
    "vmSize": "STANDARD_D4S_V3",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 2,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-05-11T06:16:44.2372184Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "upgradePolicy": {
      "mode": "automatic",
      "automaticOSUpgradePolicy": {
        "disableAutomaticRollback": true,
        "enableAutomaticOSUpgrade": true,
        "useRollingUpgradePolicy": true,
        "osRollingUpgradeDeferral": true
      },
      "rollingUpgradePolicy": {
        "enableCrossZoneUpgrade": true,
        "maxBatchInstancePercent": 20,
        "maxUnhealthyInstancePercent": 20,
        "maxUnhealthyUpgradedInstancePercent": 20,
        "pauseTimeBetweenBatches": "PT0S",
        "prioritizeUnhealthyInstances": false,
        "rollbackFailedInstancesOnPolicyBreach": false
      }
    }
  }
}

CreatePool - UserAssignedIdentities

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {}
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2020-10-01T10:22:55.9407275Z",
    "creationTime": "2020-10-01T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2020-10-01T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2020-10-01T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "principalId1",
        "clientId": "clientId1"
      },
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "principalId": "principalId2",
        "clientId": "clientId2"
      }
    }
  }
}

CreatePool - VirtualMachineConfiguration Extensions

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "0001-com-ubuntu-server-focal",
          "sku": "20_04-lts"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 20.04",
        "extensions": [
          {
            "name": "batchextension1",
            "type": "KeyVaultForLinux",
            "publisher": "Microsoft.Azure.KeyVault",
            "typeHandlerVersion": "2.0",
            "autoUpgradeMinorVersion": true,
            "enableAutomaticUpgrade": true,
            "settings": {
              "secretsManagementSettingsKey": "secretsManagementSettingsValue",
              "authenticationSettingsKey": "authenticationSettingsValue"
            }
          }
        ]
      }
    },
    "targetNodeCommunicationMode": "Default"
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "0001-com-ubuntu-server-focal",
          "sku": "20_04-lts"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 20.04",
        "extensions": [
          {
            "name": "batchextension1",
            "type": "KeyVaultForLinux",
            "publisher": "Microsoft.Azure.KeyVault",
            "typeHandlerVersion": "2.0",
            "autoUpgradeMinorVersion": true,
            "enableAutomaticUpgrade": true,
            "settings": {
              "secretsManagementSettingsKey": "secretsManagementSettingsValue",
              "authenticationSettingsKey": "authenticationSettingsValue"
            }
          }
        ]
      }
    },
    "targetNodeCommunicationMode": "Default"
  }
}

CreatePool - VirtualMachineConfiguration OSDisk

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "Standard_d2s_v3",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "microsoftwindowsserver",
          "offer": "windowsserver",
          "sku": "2022-datacenter-smalldisk"
        },
        "osDisk": {
          "diskSizeGB": 100,
          "managedDisk": {
            "storageAccountType": "StandardSSD_LRS"
          },
          "caching": "ReadWrite",
          "writeAcceleratorEnabled": false
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8DB51F14DC1A8AD"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB51F396992B8D\"",
  "properties": {
    "lastModified": "2023-08-24T02:12:27.7527697Z",
    "creationTime": "2023-08-24T02:12:27.7527697Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-08-24T02:12:27.7527697Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-08-24T02:12:27.7527697Z",
    "vmSize": "STANDARD_D2_V3",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "microsoftwindowsserver",
          "offer": "windowsserver",
          "sku": "2022-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "osDisk": {
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "StandardSSD_LRS"
          },
          "diskSizeGB": 100,
          "writeAcceleratorEnabled": false
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-08-24T02:12:27.7527697Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - VirtualMachineConfiguration ServiceArtifactReference

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "vmSize": "Standard_d4s_v3",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "serviceArtifactReference": {
          "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0
      }
    },
    "upgradePolicy": {
      "mode": "automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": true
      }
    }
  }
}

Respuesta de muestra

status code:
200 
ETag: W/"0x8DB51F14DC1A8AD"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "mypool41",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB51F396992B8D\"",
  "properties": {
    "lastModified": "2023-05-11T07:44:44.8580493Z",
    "creationTime": "2023-05-11T07:44:44.8580493Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-05-11T07:44:44.8580493Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-05-11T07:44:44.8580493Z",
    "vmSize": "STANDARD_D4S_V3",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "serviceArtifactReference": {
          "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 2,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-05-11T07:44:44.8580493Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "upgradePolicy": {
      "mode": "automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": true
      }
    }
  }
}

Definiciones

Nombre Description
AllocationState

Indica si el grupo está cambiar el tamaño.
ApplicationPackageReference

Vínculo a un paquete de aplicación dentro de la cuenta de batch
AutomaticOSUpgradePolicy

Los parámetros de configuración que se usan para realizar la actualización automática del sistema operativo.
AutoScaleRun

Los resultados y errores de una ejecución de una fórmula de escalado automático del grupo.
AutoScaleRunError

Error que se produjo al escalar automáticamente un grupo.
AutoScaleSettings

Configuración de escalado automático para el grupo.
AutoUserScope

Ámbito del usuario automático
AutoUserSpecification

Especifica los parámetros del usuario automático que ejecuta una tarea en el servicio Batch.
AzureBlobFileSystemConfiguration

Información que se usa para conectarse a un contenedor de Azure Storage mediante Blobfuse.
AzureFileShareConfiguration

Información que se usa para conectarse a un recurso compartido de archivos de Azure.
BatchPoolIdentity

Identidad del grupo de Batch, si está configurada. Si la identidad del grupo se actualiza durante la actualización de un grupo existente, solo las nuevas máquinas virtuales que se crean después de que el grupo se reduzca a 0 tendrán las identidades actualizadas.
CachingType

Tipo de almacenamiento en caché que se va a habilitar para el disco.
CertificateReference

Referencia a un certificado que se va a instalar en los nodos de proceso de un grupo. Debe existir dentro de la misma cuenta que el grupo.
CertificateStoreLocation

Ubicación del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado.
CertificateVisibility

Qué cuentas de usuario del nodo de proceso deben tener acceso a los datos privados del certificado.
CIFSMountConfiguration

Información usada para conectarse a un sistema de archivos CIFS.
CloudError

Respuesta de error del servicio Batch.
CloudErrorBody

Respuesta de error del servicio Batch.
ComputeNodeDeallocationOption

Determina qué hacer con un nodo y sus tareas en ejecución después de que se haya seleccionado para la desasignación.
ComputeNodeFillType

Cómo se deben distribuir las tareas entre nodos de proceso.
ComputeNodeIdentityReference

Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.
ContainerConfiguration

Configuración de grupos habilitados para contenedores.
ContainerHostBatchBindMountEntry

La entrada de la ruta de acceso y el modo de montaje que desea montar en el contenedor de tareas.
ContainerHostDataPath

Rutas de acceso que se montarán en el contenedor de la tarea de contenedor.
ContainerRegistry

Un registro de contenedor privado.
ContainerType

Tecnología de contenedor que se va a usar.
ContainerWorkingDirectory

Marca para indicar dónde está el directorio de trabajo de la tarea de contenedor. El valor predeterminado es "taskWorkingDirectory".
DataDisk

Configuración que usarán los discos de datos asociados a los nodos de proceso del grupo. Al usar discos de datos conectados, debe montar y dar formato a los discos desde una máquina virtual para usarlos.
DeploymentConfiguration

Propiedades de configuración de implementación.
DiffDiskPlacement

Especifica la colocación de disco efímero para el disco del sistema operativo para todas las máquinas virtuales del grupo.
DiffDiskSettings

Especifica la configuración de disco efímero para el disco del sistema operativo utilizado por la máquina virtual.
DiskEncryptionConfiguration

La configuración de cifrado de disco aplicada en los nodos de proceso del grupo. No se admite la configuración de cifrado de disco en el grupo de Linux creado con la imagen de máquina virtual o la imagen de Azure Compute Gallery.
DiskEncryptionTarget

La lista de destinos de disco que el servicio Batch cifrará en el nodo de proceso.
DynamicVNetAssignmentScope

Ámbito de la asignación dinámica de red virtual.
ElevationLevel

Nivel de elevación del usuario.
EnvironmentSetting

Variable de entorno que se va a establecer en un proceso de tarea.
FixedScaleSettings

Se ha corregido la configuración de escala para el grupo.
ImageReference

Referencia a una imagen de Marketplace de Azure Virtual Machines o al recurso De imagen de Azure de una máquina virtual personalizada. Para obtener la lista de todas las imageReferences verificadas por Azure Batch, consulte la operación "Enumeración de SKU de agente de nodo compatibles".
InboundEndpointProtocol

Protocolo del punto de conexión.
InboundNatPool

Un grupo NAT de entrada que se puede usar para abordar puertos específicos en nodos de proceso de un grupo de Batch externamente.
InterNodeCommunicationState

Si el grupo permite la comunicación directa entre nodos.
IPAddressProvisioningType

Tipo de aprovisionamiento para direcciones IP públicas para el grupo de lotes.
LinuxUserConfiguration

Propiedades usadas para crear una cuenta de usuario en un nodo de Linux.
LoginMode

Modo de inicio de sesión para el usuario
ManagedDisk
MetadataItem

Par nombre-valor asociado a un recurso de servicio de Batch.
MountConfiguration

Sistema de archivos que se va a montar en cada nodo.
NetworkConfiguration

Configuración de red de un grupo.
NetworkSecurityGroupRule

Una regla de grupo de seguridad de red que se va a aplicar a un punto de conexión de entrada.
NetworkSecurityGroupRuleAccess

Acción que se debe realizar para una dirección IP, un intervalo de subred o una etiqueta especificados.
NFSMountConfiguration

Información utilizada para conectarse a un sistema de archivos NFS.
NodeCommunicationMode

Determina cómo se comunica un grupo con el servicio Batch.
NodePlacementConfiguration

Configuración de ubicación de nodo para grupos de lotes.
NodePlacementPolicyType

Directiva de selección de ubicación para asignar nodos en el grupo.
OSDisk

Configuración del disco del sistema operativo de la máquina virtual.
Pool

Contiene información sobre un grupo.
PoolEndpointConfiguration

Configuración del punto de conexión de un grupo.
PoolIdentityType

Tipo de identidad que se usa para el grupo de Batch.
PoolProvisioningState

Estado actual del grupo.
PublicIPAddressConfiguration

Configuración de dirección IP pública de la configuración de red de un grupo.
ResizeError

Error que se produjo al cambiar el tamaño de un grupo.
ResizeOperationStatus

Detalles sobre la operación de cambio de tamaño actual o última completada.
ResourceFile

Un único archivo o varios archivos que se van a descargar en un nodo de proceso.
RollingUpgradePolicy

Los parámetros de configuración usados al realizar una actualización gradual.
ScaleSettings

Configuración de escalado para el grupo
SecurityEncryptionTypes

Especifica encryptionType del disco administrado. Se establece en VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: solo se puede establecer para máquinas virtuales confidenciales y necesarias al usar máquinas virtuales confidenciales.
SecurityProfile

Especifica la configuración del perfil de seguridad para la máquina virtual o el conjunto de escalado de máquinas virtuales.
SecurityTypes

Especifica securityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings.
ServiceArtifactReference

Especifica el identificador de referencia del artefacto de servicio que se usa para establecer la misma versión de imagen para todas las máquinas virtuales del conjunto de escalado cuando se usa la versión de imagen "más reciente".
StartTask

Tarea que se ejecuta cuando un nodo de proceso se une a un grupo en el servicio Azure Batch, o cuando el nodo de proceso se reinicia o se vuelve a crear una imagen de imagen.
StorageAccountType

Tipo de cuenta de almacenamiento para su uso en la creación de discos de datos o disco del sistema operativo.
TaskContainerSettings

Configuración del contenedor de una tarea.
TaskSchedulingPolicy

Especifica cómo se deben distribuir las tareas entre los nodos de proceso.
UefiSettings

Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual.
UpgradeMode

Especifica el modo de una actualización a las máquinas virtuales del conjunto de escalado.

Los valores posibles son:

manual: controla la aplicación de actualizaciones en las máquinas virtuales del conjunto de escalado. Para ello, use la acción manualUpgrade.

Automático: todas las máquinas virtuales del conjunto de escalado se actualizan automáticamente al mismo tiempo.

rolling: el conjunto de escalado realiza actualizaciones en lotes con un tiempo de pausa opcional entre sí.
UpgradePolicy

Describe una directiva de actualización: automática, manual o gradual.
UserAccount

Propiedades usadas para crear un usuario en un nodo de Azure Batch.
UserAssignedIdentities

Lista de identidades de usuario asociadas.
UserIdentity

Definición de la identidad de usuario en la que se ejecuta la tarea.
VirtualMachineConfiguration

Configuración de nodos de proceso en un grupo basado en la infraestructura de Azure Virtual Machines.
VMDiskSecurityProfile

Especifica la configuración del perfil de seguridad para el disco administrado. Nota: solo se puede establecer para máquinas virtuales confidenciales y se requiere cuando se usan máquinas virtuales confidenciales.
VMExtension

Configuración de extensiones de máquina virtual.
WindowsConfiguration

Configuración del sistema operativo Windows que se aplicará a la máquina virtual.
WindowsUserConfiguration

Propiedades usadas para crear una cuenta de usuario en un nodo de Windows.

AllocationState

Indica si el grupo está cambiar el tamaño.

Nombre Tipo Description
Resizing

string

El grupo está cambiar el tamaño; es decir, los nodos de proceso se agregan o quitan del grupo.
Steady

string

El grupo no cambia el tamaño. No hay ningún cambio en el número de nodos del grupo en curso. Un grupo entra en este estado cuando se crea y cuando no se realiza ninguna operación en el grupo para cambiar el número de nodos.
Stopping

string

El grupo estaba cambiando el tamaño, pero el usuario ha solicitado que se detenga el cambio de tamaño, pero la solicitud de detención aún no se ha completado.

ApplicationPackageReference

Vínculo a un paquete de aplicación dentro de la cuenta de batch

Nombre Tipo Description
id

string

Identificador del paquete de aplicación que se va a instalar. Debe estar dentro de la misma cuenta por lotes que el grupo. Puede ser una referencia a una versión específica o a la versión predeterminada si existe una.
version

string

Versión de la aplicación que se va a implementar. Si se omite, se implementa la versión predeterminada.
Si se omite y no se especifica ninguna versión predeterminada para esta aplicación, se produce un error en la solicitud con el código de error InvalidApplicationPackageReferences. Si llama directamente a la API REST, el código de estado HTTP es 409.

AutomaticOSUpgradePolicy

Los parámetros de configuración que se usan para realizar la actualización automática del sistema operativo.

Nombre Tipo Description
disableAutomaticRollback

boolean

Indica si se debe deshabilitar la característica de reversión de imágenes del sistema operativo.
enableAutomaticOSUpgrade

boolean

Indica si las actualizaciones del sistema operativo se deben aplicar automáticamente a las instancias del conjunto de escalado de forma gradual cuando esté disponible una versión más reciente de la imagen del sistema operativo.

Si se establece en true para los grupos basados en Windows, WindowsConfiguration.enableAutomaticUpdates no se puede establecer en true.
osRollingUpgradeDeferral

boolean

Aplazar las actualizaciones del sistema operativo en los TELEVISORes si están ejecutando tareas.
useRollingUpgradePolicy

boolean

Indica si se debe usar la directiva de actualización gradual durante la actualización automática del sistema operativo. La actualización automática del sistema operativo se revertirá a la directiva predeterminada si no se define ninguna directiva en VMSS.

AutoScaleRun

Los resultados y errores de una ejecución de una fórmula de escalado automático del grupo.

Nombre Tipo Description
error

AutoScaleRunError

Detalles del error encontrado al evaluar la fórmula de escalado automático en el grupo, si la evaluación no se realizó correctamente.
evaluationTime

string

Hora a la que se evaluó por última vez la fórmula de escalado automático.
results

string

Los valores finales de todas las variables usadas en la evaluación de la fórmula de escalado automático.
Cada valor de variable se devuelve en el formato $variable=value y las variables se separan por punto y coma.

AutoScaleRunError

Error que se produjo al escalar automáticamente un grupo.

Nombre Tipo Description
code

string

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

AutoScaleRunError[]

Detalles adicionales sobre el error.
message

string

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

AutoScaleSettings

Configuración de escalado automático para el grupo.

Nombre Tipo Description
evaluationInterval

string

Intervalo de tiempo en el que se ajusta automáticamente el tamaño del grupo según la fórmula de escalado automático.
Si se omite, el valor predeterminado es 15 minutos (PT15M).
formula

string

Fórmula para el número deseado de nodos de proceso en el grupo.

AutoUserScope

Ámbito del usuario automático

Nombre Tipo Description
Pool

string

Especifica que la tarea se ejecuta como la cuenta de usuario automática común que se crea en cada nodo de un grupo.
Task

string

Especifica que el servicio debe crear un nuevo usuario para la tarea.

AutoUserSpecification

Especifica los parámetros del usuario automático que ejecuta una tarea en el servicio Batch.

Nombre Tipo Description
elevationLevel

ElevationLevel

Nivel de elevación del usuario automático.
El valor predeterminado es nonAdmin.
scope

AutoUserScope

Ámbito del usuario automático
El valor predeterminado es Pool. Si el grupo ejecuta Windows, se debe especificar un valor de Task si se requiere un aislamiento más estricto entre las tareas. Por ejemplo, si la tarea muta el Registro de una manera que podría afectar a otras tareas, o si se han especificado certificados en el grupo que no deben ser accesibles por tareas normales, pero que deben ser accesibles por tareas iniciales.

AzureBlobFileSystemConfiguration

Información que se usa para conectarse a un contenedor de Azure Storage mediante Blobfuse.

Nombre Tipo Description
accountKey

string

La clave de la cuenta de Azure Storage.
Esta propiedad es mutuamente excluyente con sasKey e identidad; exactamente uno debe especificarse.
accountName

string

Nombre de la cuenta de Azure Storage.
blobfuseOptions

string

Opciones de línea de comandos adicionales para pasar al comando de montaje.
Estas son opciones de "net use" en Windows y opciones de "montaje" en Linux.
containerName

string

Nombre del contenedor de Azure Blob Storage.
identityReference

ComputeNodeIdentityReference

Referencia a la identidad asignada por el usuario que se va a usar para acceder a containerName
Esta propiedad es mutuamente excluyente con accountKey y sasKey; exactamente uno debe especificarse.
relativeMountPath

string

Ruta de acceso relativa en el nodo de proceso donde se montará el sistema de archivos.
Todos los sistemas de archivos se montan en relación con el directorio de montajes de Batch, accesibles a través de la variable de entorno AZ_BATCH_NODE_MOUNTS_DIR.
sasKey

string

Token de SAS de Azure Storage.
Esta propiedad es mutuamente excluyente tanto con accountKey como con la identidad; exactamente uno debe especificarse.

AzureFileShareConfiguration

Información que se usa para conectarse a un recurso compartido de archivos de Azure.

Nombre Tipo Description
accountKey

string

Clave de cuenta de Azure Storage.
accountName

string

Nombre de la cuenta de Azure Storage.
azureFileUrl

string

Dirección URL de Azure Files.
Este es el formato "https://{account}.file.core.windows.net/".
mountOptions

string

Opciones de línea de comandos adicionales para pasar al comando de montaje.
Estas son opciones de "net use" en Windows y opciones de "montaje" en Linux.
relativeMountPath

string

Ruta de acceso relativa en el nodo de proceso donde se montará el sistema de archivos.
Todos los sistemas de archivos se montan en relación con el directorio de montajes de Batch, accesibles a través de la variable de entorno AZ_BATCH_NODE_MOUNTS_DIR.

BatchPoolIdentity

Identidad del grupo de Batch, si está configurada. Si la identidad del grupo se actualiza durante la actualización de un grupo existente, solo las nuevas máquinas virtuales que se crean después de que el grupo se reduzca a 0 tendrán las identidades actualizadas.

Nombre Tipo Description
type

PoolIdentityType

Tipo de identidad que se usa para el grupo de Batch.
userAssignedIdentities

<string,  UserAssignedIdentities>

Lista de identidades de usuario asociadas al grupo de Batch.

CachingType

Tipo de almacenamiento en caché que se va a habilitar para el disco.

Nombre Tipo Description
None

string

El modo de almacenamiento en caché del disco no está habilitado.
ReadOnly

string

El modo de almacenamiento en caché del disco es de solo lectura.
ReadWrite

string

El modo de almacenamiento en caché del disco es de lectura y escritura.

CertificateReference

Referencia a un certificado que se va a instalar en los nodos de proceso de un grupo. Debe existir dentro de la misma cuenta que el grupo.

Nombre Tipo Description
id

string

Identificador completo del certificado que se va a instalar en el grupo. Debe estar dentro de la misma cuenta por lotes que el grupo.
storeLocation

CertificateStoreLocation

Ubicación del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado.
El valor predeterminado es currentUser. Esta propiedad solo es aplicable a los grupos configurados con nodos de proceso de Windows. En el caso de los nodos de proceso de Linux, los certificados se almacenan en un directorio dentro del directorio de trabajo de la tarea y se proporciona una variable de entorno AZ_BATCH_CERTIFICATES_DIR a la tarea para consultar esta ubicación. Para los certificados con visibilidad de "remoteUser", se crea un directorio "certs" en el directorio principal del usuario (por ejemplo, /home/{user-name}/certs) y los certificados se colocan en ese directorio.
storeName

string

Nombre del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado.
Esta propiedad solo es aplicable a los grupos configurados con nodos de proceso de Windows. Los nombres de almacén comunes incluyen: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, pero también se puede usar cualquier nombre de almacén personalizado. El valor predeterminado es My.
visibility

CertificateVisibility[]

Qué cuentas de usuario del nodo de proceso deben tener acceso a los datos privados del certificado.

CertificateStoreLocation

Ubicación del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado.

Nombre Tipo Description
CurrentUser

string

Los certificados deben instalarse en el almacén de certificados CurrentUser.
LocalMachine

string

Los certificados deben instalarse en el almacén de certificados LocalMachine.

CertificateVisibility

Qué cuentas de usuario del nodo de proceso deben tener acceso a los datos privados del certificado.

Nombre Tipo Description
RemoteUser

string

El certificado debe ser visible para las cuentas de usuario en las que los usuarios acceden de forma remota al nodo.
StartTask

string

El certificado debe estar visible para la cuenta de usuario en la que se ejecuta la tarea de inicio. Tenga en cuenta que si El ámbito de autousuario es Pool para StartTask y una tarea, este certificado también será visible para la tarea.
Task

string

El certificado debe ser visible para las cuentas de usuario en las que se ejecutan las tareas de trabajo.

CIFSMountConfiguration

Información usada para conectarse a un sistema de archivos CIFS.

Nombre Tipo Description
mountOptions

string

Opciones de línea de comandos adicionales para pasar al comando de montaje.
Estas son opciones de "net use" en Windows y opciones de "montaje" en Linux.
password

string

Contraseña que se va a usar para la autenticación en el sistema de archivos CIFS.
relativeMountPath

string

Ruta de acceso relativa en el nodo de proceso donde se montará el sistema de archivos.
Todos los sistemas de archivos se montan en relación con el directorio de montajes de Batch, accesibles a través de la variable de entorno AZ_BATCH_NODE_MOUNTS_DIR.
source

string

URI del sistema de archivos que se va a montar.
userName

string

El usuario que se va a usar para la autenticación en el sistema de archivos CIFS.

CloudError

Respuesta de error del servicio Batch.

Nombre Tipo Description
error

CloudErrorBody

Cuerpo de la respuesta de error.

CloudErrorBody

Respuesta de error del servicio Batch.

Nombre Tipo Description
code

string

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

CloudErrorBody[]

Lista de detalles adicionales sobre el error.
message

string

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

string

Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

ComputeNodeDeallocationOption

Determina qué hacer con un nodo y sus tareas en ejecución después de que se haya seleccionado para la desasignación.

Nombre Tipo Description
Requeue

string

Finalice los procesos de tareas en ejecución y vuelva a poner en cola las tareas. Las tareas se ejecutarán de nuevo cuando haya un nodo disponible. Quite los nodos tan pronto como se hayan terminado las tareas.
RetainedData

string

Permitir que las tareas en ejecución se completen actualmente y espere a que expiren todos los períodos de retención de datos de tareas. Programe ninguna tarea nueva mientras espera. Quite nodos cuando hayan expirado todos los períodos de retención de tareas.
TaskCompletion

string

Permitir que las tareas en ejecución se completen actualmente. Programe ninguna tarea nueva mientras espera. Quite los nodos cuando se hayan completado todas las tareas.
Terminate

string

Finalizar las tareas en ejecución. Las tareas se completarán con failureInfo que indica que finalizaron y no se volverán a ejecutar. Quite los nodos tan pronto como se hayan terminado las tareas.

ComputeNodeFillType

Cómo se deben distribuir las tareas entre nodos de proceso.

Nombre Tipo Description
Pack

string

Se deben asignar tantas tareas como sea posible (taskSlotsPerNode) a cada nodo del grupo antes de que se asignen tareas al siguiente nodo del grupo.
Spread

string

Las tareas se deben asignar uniformemente en todos los nodos del grupo.

ComputeNodeIdentityReference

Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.

Nombre Tipo Description
resourceId

string

Identificador de recurso de ARM de la identidad asignada por el usuario.

ContainerConfiguration

Configuración de grupos habilitados para contenedores.

Nombre Tipo Description
containerImageNames

string[]

Colección de nombres de imagen de contenedor.
Esta es la referencia de imagen completa, como se especificaría en "docker pull". Se generará una imagen del registro de Docker predeterminado a menos que la imagen esté completa con un registro alternativo.
containerRegistries

ContainerRegistry[]

Registros privados adicionales desde los que se pueden extraer contenedores.
Si se deben descargar imágenes de un registro privado que requiera credenciales, esas credenciales deben proporcionarse aquí.
type

ContainerType

Tecnología de contenedor que se va a usar.

ContainerHostBatchBindMountEntry

La entrada de la ruta de acceso y el modo de montaje que desea montar en el contenedor de tareas.

Nombre Tipo Description
isReadOnly

boolean

Monte esta ruta de acceso de origen como modo de solo lectura o no. El valor predeterminado es false (modo de lectura y escritura).
Para Linux, si monta esta ruta de acceso como modo de lectura y escritura, esto no significa que todos los usuarios del contenedor tengan acceso de lectura y escritura para la ruta de acceso, depende del acceso en la máquina virtual host. Si esta ruta de acceso está montada de solo lectura, todos los usuarios del contenedor no podrán modificar la ruta de acceso.
source

ContainerHostDataPath

La ruta de acceso que se va a montar en el cliente contenedor puede seleccionar.

ContainerHostDataPath

Rutas de acceso que se montarán en el contenedor de la tarea de contenedor.

Nombre Tipo Description
Applications

string

Ruta de acceso de las aplicaciones.
JobPrep

string

Ruta de acceso de la tarea de preparación del trabajo.
Shared

string

Ruta de acceso de la tarea de varias instancias para compartir sus archivos.
Startup

string

Ruta de acceso para la tarea de inicio.
Task

string

Ruta de acceso de la tarea.
VfsMounts

string

La ruta de acceso contiene todos los sistemas de archivos virtuales que se montan en este nodo.

ContainerRegistry

Un registro de contenedor privado.

Nombre Tipo Description
identityReference

ComputeNodeIdentityReference

Referencia a la identidad asignada por el usuario que se va a usar para acceder a una instancia de Azure Container Registry en lugar de un nombre de usuario y una contraseña.
Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.
password

string

Contraseña que se va a iniciar sesión en el servidor del Registro.
registryServer

string

Dirección URL del Registro.
Si se omite, el valor predeterminado es "docker.io".
username

string

Nombre de usuario que se va a iniciar sesión en el servidor del Registro.

ContainerType

Tecnología de contenedor que se va a usar.

Nombre Tipo Description
CriCompatible

string

Se usará una tecnología basada en CRI para iniciar los contenedores.
DockerCompatible

string

Se usará una tecnología de contenedor compatible con Docker para iniciar los contenedores.

ContainerWorkingDirectory

Marca para indicar dónde está el directorio de trabajo de la tarea de contenedor. El valor predeterminado es "taskWorkingDirectory".

Nombre Tipo Description
ContainerImageDefault

string

Uso del directorio de trabajo definido por la imagen de contenedor. Tenga en cuenta que este directorio no contendrá los archivos de recursos descargados por Batch.
TaskWorkingDirectory

string

Use el directorio de trabajo de la tarea servicio Batch estándar, que contendrá los archivos de recursos de tarea rellenados por Batch.

DataDisk

Configuración que usarán los discos de datos asociados a los nodos de proceso del grupo. Al usar discos de datos conectados, debe montar y dar formato a los discos desde una máquina virtual para usarlos.

Nombre Tipo Description
caching

CachingType

Tipo de almacenamiento en caché que se va a habilitar para los discos de datos.
Los valores son:

none: el modo de almacenamiento en caché del disco no está habilitado. readOnly: el modo de almacenamiento en caché del disco es de solo lectura. readWrite: el modo de almacenamiento en caché del disco es de lectura y escritura.

El valor predeterminado para el almacenamiento en caché no es ninguno. Para obtener información sobre las opciones de almacenamiento en caché, consulte: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB

integer

Tamaño de disco inicial en GB al crear un nuevo disco de datos.
lun

integer

Número de unidad lógica.
El lun se usa para identificar de forma única cada disco de datos. Si conecta varios discos, cada uno debe tener un lun distinto. El valor debe estar comprendido entre 0 y 63, ambos incluidos.
storageAccountType

StorageAccountType

Tipo de cuenta de almacenamiento que se va a usar para el disco de datos.
Si se omite, el valor predeterminado es "Standard_LRS". Los valores son:

Standard_LRS: el disco de datos debe usar el almacenamiento con redundancia local estándar. Premium_LRS: el disco de datos debe usar el almacenamiento con redundancia local Premium.

DeploymentConfiguration

Propiedades de configuración de implementación.

Nombre Tipo Description
virtualMachineConfiguration

VirtualMachineConfiguration

Configuración de la máquina virtual para el grupo.

DiffDiskPlacement

Especifica la colocación de disco efímero para el disco del sistema operativo para todas las máquinas virtuales del grupo.

Nombre Tipo Description
CacheDisk

string

El disco del sistema operativo efímero se almacena en la memoria caché de la máquina virtual.

DiffDiskSettings

Especifica la configuración de disco efímero para el disco del sistema operativo utilizado por la máquina virtual.

Nombre Tipo Description
placement

DiffDiskPlacement

Especifica la colocación de disco efímero para el disco del sistema operativo para todas las máquinas virtuales del grupo.
El usuario puede usar esta propiedad en la solicitud para elegir en qué ubicación debe estar el sistema operativo. Por ejemplo, el espacio en disco de caché para el aprovisionamiento de discos del sistema operativo efímero. Para obtener más información sobre los requisitos de tamaño de disco del sistema operativo efímero, consulte Requisitos de tamaño de disco del sistema operativo efímero para máquinas virtuales Windows en https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements y máquinas virtuales Linux en https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

La configuración de cifrado de disco aplicada en los nodos de proceso del grupo. No se admite la configuración de cifrado de disco en el grupo de Linux creado con la imagen de máquina virtual o la imagen de Azure Compute Gallery.

Nombre Tipo Description
targets

DiskEncryptionTarget[]

La lista de destinos de disco que el servicio Batch cifrará en el nodo de proceso.
En el grupo de Linux, solo se admite "TemporaryDisk"; en el grupo de Windows, se debe especificar "OsDisk" y "TemporaryDisk".

DiskEncryptionTarget

La lista de destinos de disco que el servicio Batch cifrará en el nodo de proceso.

Nombre Tipo Description
OsDisk

string

El disco del sistema operativo en el nodo de proceso está cifrado.
TemporaryDisk

string

El disco temporal del nodo de proceso está cifrado. En Linux, este cifrado se aplica a otras particiones (como las de discos de datos montados) cuando se produce el cifrado en tiempo de arranque.

DynamicVNetAssignmentScope

Ámbito de la asignación dinámica de red virtual.

Nombre Tipo Description
job

string

La asignación de red virtual dinámica se realiza por trabajo. Si se establece este valor, también se debe establecer el identificador de subred de configuración de red. Esta característica requiere aprobación antes de su uso, póngase en contacto con el soporte técnico.
none

string

No hay ninguna asignación de red virtual dinámica habilitada.

ElevationLevel

Nivel de elevación del usuario.

Nombre Tipo Description
Admin

string

El usuario es un usuario con acceso elevado y funciona con permisos de administrador completos.
NonAdmin

string

El usuario es un usuario estándar sin acceso elevado.

EnvironmentSetting

Variable de entorno que se va a establecer en un proceso de tarea.

Nombre Tipo Description
name

string

Nombre de la variable de entorno.
value

string

Valor de la variable de entorno.

FixedScaleSettings

Se ha corregido la configuración de escala para el grupo.

Nombre Tipo Valor predeterminado Description
nodeDeallocationOption

ComputeNodeDeallocationOption

Determina qué hacer con un nodo y sus tareas en ejecución si el tamaño del grupo está disminuyendo.
Si se omite, el valor predeterminado es Requeue.
resizeTimeout

string

PT15M

Tiempo de espera para la asignación de nodos de proceso al grupo.
El valor predeterminado es de 15 minutos. Los valores de tiempo de espera usan el formato ISO 8601. Por ejemplo, use PT10M durante 10 minutos. El valor mínimo es de 5 minutos. Si especifica un valor inferior a 5 minutos, el servicio Batch rechaza la solicitud con un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).
targetDedicatedNodes

integer

Número deseado de nodos de proceso dedicados en el grupo.
Al menos uno de targetDedicatedNodes, se deben establecer targetLowPriorityNodes.
targetLowPriorityNodes

integer

Número deseado de nodos de proceso de spot o prioridad baja en el grupo.
Al menos uno de targetDedicatedNodes, se deben establecer targetLowPriorityNodes.

ImageReference

Referencia a una imagen de Marketplace de Azure Virtual Machines o al recurso De imagen de Azure de una máquina virtual personalizada. Para obtener la lista de todas las imageReferences verificadas por Azure Batch, consulte la operación "Enumeración de SKU de agente de nodo compatibles".

Nombre Tipo Description
communityGalleryImageId

string

Identificador único de la imagen de la galería de la comunidad
Esta propiedad es mutuamente excluyente con otras propiedades y se puede capturar desde la llamada GET de imagen de la galería de la comunidad.
id

string

Identificador de recursos de ARM de la imagen de Azure Compute Gallery. Los nodos de proceso del grupo se crearán con este identificador de imagen. Este es el formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.
Esta propiedad es mutuamente excluyente con otras propiedades. La imagen de Azure Compute Gallery debe tener réplicas en la misma región que la cuenta de Azure Batch. Para obtener información sobre la configuración del firewall para que el agente de nodo de Batch se comunique con el servicio Batch, consulte https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
offer

string

Tipo de oferta de la imagen de Marketplace de Azure Virtual Machines.
Por ejemplo, UbuntuServer o WindowsServer.
publisher

string

Publicador de la imagen de Marketplace de Azure Virtual Machines.
Por ejemplo, Canonical o MicrosoftWindowsServer.
sharedGalleryImageId

string

Identificador único de la imagen de la galería compartida
Esta propiedad es mutuamente excluyente con otras propiedades y se puede capturar desde la llamada GET de imagen de galería compartida.
sku

string

SKU de la imagen de Marketplace de Azure Virtual Machines.
Por ejemplo, 18.04-LTS o 2022-datacenter.
version

string

Versión de la imagen de Marketplace de Azure Virtual Machines.
Se puede especificar un valor de "latest" para seleccionar la versión más reciente de una imagen. Si se omite, el valor predeterminado es "latest".

InboundEndpointProtocol

Protocolo del punto de conexión.

Nombre Tipo Description
TCP

string

Use TCP para el punto de conexión.
UDP

string

Use UDP para el punto de conexión.

InboundNatPool

Un grupo NAT de entrada que se puede usar para abordar puertos específicos en nodos de proceso de un grupo de Batch externamente.

Nombre Tipo Description
backendPort

integer

Número de puerto en el nodo de proceso.
Debe ser único dentro de un grupo de Batch. Los valores aceptables están comprendidos entre 1 y 65535, excepto para 29876 y 29877, ya que están reservados. Si se proporcionan valores reservados, se produce un error en la solicitud con el código de estado HTTP 400.
frontendPortRangeEnd

integer

El último número de puerto del intervalo de puertos externos que se usarán para proporcionar acceso entrante a backendPort en nodos de proceso individuales.
Los valores aceptables oscilan entre 1 y 65534, excepto los puertos de 50000 a 55000 que están reservados por el servicio Batch. Todos los intervalos de un grupo deben ser distintos y no se pueden superponer. Si se proporcionan valores reservados o superpuestos, se produce un error en la solicitud con el código de estado HTTP 400.
frontendPortRangeStart

integer

Primer número de puerto del intervalo de puertos externos que se usarán para proporcionar acceso entrante a backendPort en nodos de proceso individuales.
Los valores aceptables oscilan entre 1 y 65534, excepto los puertos de 50000 a 55000 que están reservados. Todos los intervalos de un grupo deben ser distintos y no se pueden superponer. Si se proporcionan valores reservados o superpuestos, se produce un error en la solicitud con el código de estado HTTP 400.
name

string

Nombre del punto de conexión.
El nombre debe ser único dentro de un grupo de Batch, puede contener letras, números, caracteres de subrayado, puntos y guiones. Los nombres deben comenzar con una letra o un número, deben terminar con una letra, un número o un carácter de subrayado, y no pueden superar los 77 caracteres. Si se proporcionan valores no válidos, se produce un error en la solicitud con el código de estado HTTP 400.
networkSecurityGroupRules

NetworkSecurityGroupRule[]

Lista de reglas de grupo de seguridad de red que se aplicarán al punto de conexión.
El número máximo de reglas que se pueden especificar en todos los puntos de conexión de un grupo de Batch es 25. Si no se especifica ninguna regla de grupo de seguridad de red, se creará una regla predeterminada para permitir el acceso entrante a backendPort especificado. Si se supera el número máximo de reglas de grupo de seguridad de red, se produce un error en la solicitud con el código de estado HTTP 400.
protocol

InboundEndpointProtocol

Protocolo del punto de conexión.

InterNodeCommunicationState

Si el grupo permite la comunicación directa entre nodos.

Nombre Tipo Description
Disabled

string

Deshabilite la comunicación de red entre máquinas virtuales.
Enabled

string

Habilite la comunicación de red entre máquinas virtuales.

IPAddressProvisioningType

Tipo de aprovisionamiento para direcciones IP públicas para el grupo de lotes.

Nombre Tipo Description
BatchManaged

string

Batch creará y administrará una dirección IP pública. Puede haber varias direcciones IP públicas en función del tamaño del grupo.
NoPublicIPAddresses

string

No se creará ninguna dirección IP pública para los nodos de proceso del grupo.
UserManaged

string

El usuario proporciona direcciones IP públicas y se usará para aprovisionar los nodos de proceso.

LinuxUserConfiguration

Propiedades usadas para crear una cuenta de usuario en un nodo de Linux.

Nombre Tipo Description
gid

integer

Identificador de grupo de la cuenta de usuario.
Las propiedades uid y gid deben especificarse juntas o no en absoluto. Si no se especifica, el sistema operativo subyacente elige el gid.
sshPrivateKey

string

Clave privada SSH para la cuenta de usuario.
La clave privada no debe estar protegida con contraseña. La clave privada se usa para configurar automáticamente la autenticación basada en claves asimétricas para SSH entre nodos de un grupo de Linux cuando la propiedad enableInterNodeCommunication del grupo es true (se omite si enableInterNodeCommunication es false). Para ello, coloca el par de claves en el directorio .ssh del usuario. Si no se especifica, SSH sin contraseña no está configurado entre nodos (no se realiza ninguna modificación del directorio .ssh del usuario).
uid

integer

Identificador de usuario de la cuenta de usuario.
Las propiedades uid y gid deben especificarse juntas o no en absoluto. Si no se especifica, el sistema operativo subyacente elige el uid.

LoginMode

Modo de inicio de sesión para el usuario

Nombre Tipo Description
Batch

string

El modo de inicio de sesión de Win32 LOGON32_LOGON_BATCH. Se recomienda el modo de inicio de sesión por lotes para procesos paralelos de larga duración.
Interactive

string

El modo de inicio de sesión de Win32 LOGON32_LOGON_INTERACTIVE. Algunas aplicaciones requieren tener permisos asociados al modo de inicio de sesión interactivo. Si este es el caso de una aplicación que se usa en la tarea, se recomienda esta opción.

ManagedDisk

Nombre Tipo Description
securityProfile

VMDiskSecurityProfile

Especifica el perfil de seguridad del disco administrado.
Especifica la configuración del perfil de seguridad para el disco administrado. Nota: solo se puede establecer para máquinas virtuales confidenciales y se requiere cuando se usan máquinas virtuales confidenciales.
storageAccountType

StorageAccountType

Tipo de cuenta de almacenamiento para el disco administrado.

MetadataItem

Par nombre-valor asociado a un recurso de servicio de Batch.

Nombre Tipo Description
name

string

Nombre del elemento de metadatos.
value

string

Valor del elemento de metadatos.

MountConfiguration

Sistema de archivos que se va a montar en cada nodo.

Nombre Tipo Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

Contenedor de Azure Storage que se va a montar mediante BLOB FUSE en cada nodo.
Esta propiedad es mutuamente excluyente con todas las demás propiedades.
azureFileShareConfiguration

AzureFileShareConfiguration

Recurso compartido de archivos de Azure que se va a montar en cada nodo.
Esta propiedad es mutuamente excluyente con todas las demás propiedades.
cifsMountConfiguration

CIFSMountConfiguration

Sistema de archivos CIFS/SMB que se va a montar en cada nodo.
Esta propiedad es mutuamente excluyente con todas las demás propiedades.
nfsMountConfiguration

NFSMountConfiguration

Sistema de archivos NFS que se va a montar en cada nodo.
Esta propiedad es mutuamente excluyente con todas las demás propiedades.

NetworkConfiguration

Configuración de red de un grupo.

Nombre Tipo Valor predeterminado Description
dynamicVnetAssignmentScope

DynamicVNetAssignmentScope

none

Ámbito de la asignación dinámica de red virtual.
enableAcceleratedNetworking

boolean

Si este grupo debe habilitar las redes aceleradas.
Las redes aceleradas permiten la virtualización de E/S raíz única (SR-IOV) a una máquina virtual, lo que puede dar lugar a un rendimiento de red mejorado. Para obtener más información, consulte: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration

PoolEndpointConfiguration

Configuración de puntos de conexión en nodos de proceso en el grupo de Batch.
publicIPAddressConfiguration

PublicIPAddressConfiguration

Configuración de IP PúblicaAddress para nodos de proceso en el grupo de lotes.
Configuración de dirección IP pública de la configuración de red de un grupo.
subnetId

string

Identificador de recurso de ARM de la subred de red virtual a la que se unirán los nodos de proceso del grupo. Este es el formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
La red virtual debe estar en la misma región y suscripción que la cuenta de Azure Batch. La subred especificada debe tener suficientes direcciones IP libres para dar cabida al número de nodos del grupo. Si la subred no tiene suficientes direcciones IP libres, el grupo asignará parcialmente nodos de proceso y se producirá un error de cambio de tamaño. La entidad de servicio "MicrosoftAzureBatch" debe tener el rol "Colaborador de máquina virtual clásica" Role-Based Control de acceso (RBAC) para la red virtual especificada. La subred especificada debe permitir la comunicación desde el servicio Azure Batch para poder programar tareas en los nodos de proceso. Para comprobarlo, compruebe si la red virtual especificada tiene algún grupo de seguridad de red (NSG) asociado. Si un NSG deniega la comunicación con los nodos de proceso de la subred especificada, el servicio Batch establecerá el estado de los nodos de proceso en inutilizable. Si la red virtual especificada tiene algún grupo de seguridad de red (NSG) asociado, se deben habilitar algunos puertos del sistema reservados para la comunicación entrante, incluidos los puertos 29876 y 29877. Habilite también las conexiones salientes a Azure Storage en el puerto 443. Para obtener más información, consulte: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Una regla de grupo de seguridad de red que se va a aplicar a un punto de conexión de entrada.

Nombre Tipo Description
access

NetworkSecurityGroupRuleAccess

Acción que se debe realizar para una dirección IP, un intervalo de subred o una etiqueta especificados.
priority

integer

Prioridad de esta regla.
Las prioridades dentro de un grupo deben ser únicas y se evalúan en orden de prioridad. Cuanto menor sea el número, mayor será la prioridad. Por ejemplo, se podrían especificar reglas con números de orden de 150, 250 y 350. La regla con el número de orden de 150 tiene prioridad sobre la regla que tiene un orden de 250. Las prioridades permitidas son de 150 a 4096. Si se proporcionan valores reservados o duplicados, se produce un error en la solicitud con el código de estado HTTP 400.
sourceAddressPrefix

string

Prefijo o etiqueta de dirección de origen que debe coincidir con la regla.
Los valores válidos son una sola dirección IP (es decir, 10.10.10.10), subred IP (es decir, 192.168.1.0/24), etiqueta predeterminada o * (para todas las direcciones). Si se proporcionan otros valores, se produce un error en la solicitud con el código de estado HTTP 400.
sourcePortRanges

string[]

Intervalos de puertos de origen que coincidirán con la regla.
Los valores válidos son '*' (para todos los puertos 0 - 65535) o matrices de puertos o intervalos de puertos (es decir, 100-200). Los puertos deben estar comprendidos entre 0 y 65535 y los intervalos de puertos o puertos no se pueden superponer. Si se proporcionan otros valores, se produce un error en la solicitud con el código de estado HTTP 400. El valor predeterminado será *.

NetworkSecurityGroupRuleAccess

Acción que se debe realizar para una dirección IP, un intervalo de subred o una etiqueta especificados.

Nombre Tipo Description
Allow

string

Permitir el acceso.
Deny

string

Denegar el acceso.

NFSMountConfiguration

Información utilizada para conectarse a un sistema de archivos NFS.

Nombre Tipo Description
mountOptions

string

Opciones de línea de comandos adicionales para pasar al comando de montaje.
Estas son opciones de "net use" en Windows y opciones de "montaje" en Linux.
relativeMountPath

string

Ruta de acceso relativa en el nodo de proceso donde se montará el sistema de archivos.
Todos los sistemas de archivos se montan en relación con el directorio de montajes de Batch, accesibles a través de la variable de entorno AZ_BATCH_NODE_MOUNTS_DIR.
source

string

URI del sistema de archivos que se va a montar.

NodeCommunicationMode

Determina cómo se comunica un grupo con el servicio Batch.

Nombre Tipo Description
Classic

string

Los nodos que usan el modo de comunicación clásica requieren la comunicación TCP entrante en los puertos 29876 y 29877 de BatchNodeManagement. {region}" etiqueta de servicio y comunicación TCP saliente en el puerto 443 a "Storage.region" y "BatchNodeManagement". Etiquetas de servicio {region}".
Default

string

El servicio Batch establece automáticamente el modo de comunicación de nodo.
Simplified

string

Los nodos que usan el modo de comunicación simplificada requieren la comunicación TCP saliente en el puerto 443 a "BatchNodeManagement. Etiqueta de servicio {region}". No se requieren puertos de entrada abiertos.

NodePlacementConfiguration

Configuración de ubicación de nodo para grupos de lotes.

Nombre Tipo Description
policy

NodePlacementPolicyType

Tipo de directiva de selección de ubicación de nodo en grupos de lotes.
Directiva de asignación que usa Batch Service para aprovisionar los nodos. Si no se especifica, Batch usará la directiva regional.

NodePlacementPolicyType

Directiva de selección de ubicación para asignar nodos en el grupo.

Nombre Tipo Description
Regional

string

Todos los nodos del grupo se asignarán en la misma región.
Zonal

string

Los nodos del grupo se distribuirán entre diferentes zonas con el mejor equilibrio de esfuerzo.

OSDisk

Configuración del disco del sistema operativo de la máquina virtual.

Nombre Tipo Description
caching

CachingType

Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None, ReadOnly, ReadWrite. Los valores predeterminados son: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.
diskSizeGB

integer

Tamaño de disco inicial en GB al crear un nuevo disco del sistema operativo.
ephemeralOSDiskSettings

DiffDiskSettings

Especifica la configuración de disco efímero para el disco del sistema operativo utilizado por la máquina virtual.
managedDisk

ManagedDisk

Parámetros de disco administrado.
writeAcceleratorEnabled

boolean

Especifica si writeAccelerator debe estar habilitado o deshabilitado en el disco.

Pool

Contiene información sobre un grupo.

Nombre Tipo Valor predeterminado Description
etag

string

ETag del recurso, que se usa para las instrucciones de simultaneidad.
id

string

Identificador del recurso.
identity

BatchPoolIdentity

Tipo de identidad que se usa para el grupo de Batch.
Tipo de identidad que se usa para el grupo de Batch.
name

string

Nombre del recurso.
properties.allocationState

AllocationState

Indica si el grupo está cambiar el tamaño.
properties.allocationStateTransitionTime

string

Hora en la que el grupo entró en su estado de asignación actual.
properties.applicationLicenses

string[]

La lista de licencias de aplicación que el servicio Batch pondrá a disposición en cada nodo de proceso del grupo.
La lista de licencias de aplicación debe ser un subconjunto de licencias de aplicaciones de servicio de Batch disponibles. Si se solicita una licencia que no se admite, se producirá un error en la creación del grupo.
properties.applicationPackages

ApplicationPackageReference[]

Lista de paquetes de aplicación que se van a instalar en cada nodo de proceso del grupo.
Los cambios en las referencias del paquete de aplicación afectan a todos los nodos de proceso nuevos que se unen al grupo, pero no afectan a los nodos de proceso que ya están en el grupo hasta que se reinician o se vuelven a crear imágenes. Hay un máximo de 10 referencias de paquete de aplicación en cualquier grupo determinado.
properties.autoScaleRun

AutoScaleRun

Resultados y errores de la última ejecución de la fórmula de escalado automático.
Esta propiedad solo se establece si el grupo se escala automáticamente, es decir, se usan autoScaleSettings.
properties.certificates

CertificateReference[]

Lista de certificados que se van a instalar en cada nodo de proceso del grupo.
En el caso de los nodos de proceso de Windows, el servicio Batch instala los certificados en el almacén de certificados y la ubicación especificados. En el caso de los nodos de proceso de Linux, los certificados se almacenan en un directorio dentro del directorio de trabajo de la tarea y se proporciona una variable de entorno AZ_BATCH_CERTIFICATES_DIR a la tarea para consultar esta ubicación. Para los certificados con visibilidad de "remoteUser", se crea un directorio "certs" en el directorio principal del usuario (por ejemplo, /home/{user-name}/certs) y los certificados se colocan en ese directorio.

Advertencia: esta propiedad está en desuso y se quitará después de febrero de 2024. Use el de extensión de Azure KeyVault de .
properties.creationTime

string

Hora de creación del grupo.
properties.currentDedicatedNodes

integer

Número de nodos de proceso dedicados actualmente en el grupo.
properties.currentLowPriorityNodes

integer

Número de nodos de proceso de prioridad baja o de acceso puntual actualmente en el grupo.
properties.currentNodeCommunicationMode

NodeCommunicationMode

Estado actual del modo de comunicación del grupo.
properties.deploymentConfiguration

DeploymentConfiguration

Esta propiedad describe las máquinas virtuales en las que se implementarán los nodos del grupo.
properties.displayName

string

Nombre para mostrar del grupo.
El nombre para mostrar no debe ser único y puede contener caracteres Unicode de hasta una longitud máxima de 1024.
properties.interNodeCommunication

InterNodeCommunicationState

Si el grupo permite la comunicación directa entre nodos.
Esto impone restricciones en las que se pueden asignar nodos al grupo. La habilitación de este valor puede reducir la posibilidad de asignar el número solicitado de nodos en el grupo. Si no se especifica, este valor tiene como valor predeterminado "Disabled".
properties.lastModified

string

Hora de la última modificación del grupo.
Esta es la última vez en la que cambian los datos de nivel de grupo, como targetDedicatedNodes o autoScaleSettings. No tiene en cuenta los cambios de nivel de nodo, como un estado de cambio de nodo de proceso.
properties.metadata

MetadataItem[]

Lista de pares nombre-valor asociados al grupo como metadatos.
El servicio Batch no asigna ningún significado a los metadatos; es únicamente para el uso del código de usuario.
properties.mountConfiguration

MountConfiguration[]

Lista de sistemas de archivos que se van a montar en cada nodo del grupo.
Esto admite Azure Files, NFS, CIFS/SMB y Blobfuse.
properties.networkConfiguration

NetworkConfiguration

Configuración de red del grupo.
Configuración de red de un grupo.
properties.provisioningState

PoolProvisioningState

Estado actual del grupo.
properties.provisioningStateTransitionTime

string

Hora en la que el grupo entró en su estado actual.
properties.resizeOperationStatus

ResizeOperationStatus

Contiene detalles sobre la operación de cambio de tamaño actual o última completada.
Describe la operación actual (si el valor de AllocationState del grupo es Cambiar el tamaño) o la operación completada anteriormente (si AllocationState es Estable).
properties.resourceTags

object

Etiquetas especificadas por el usuario asociadas al grupo.
Etiquetas definidas por el usuario que se van a asociar al grupo de Azure Batch. Cuando se especifica, estas etiquetas se propagan a los recursos de Azure de respaldo asociados al grupo. Esta propiedad solo se puede especificar cuando se creó la cuenta de Batch con la propiedad poolAllocationMode establecida en "UserSubscription".
properties.scaleSettings

ScaleSettings

Valores que configuran el número de nodos del grupo.
Define el tamaño deseado del grupo. Esto puede ser "fixedScale" donde se especifica targetDedicatedNodes solicitado o "autoScale", que define una fórmula que se vuelve a evaluar periódicamente. Si no se especifica esta propiedad, el grupo tendrá una escala fija con 0 targetDedicatedNodes.
properties.startTask

StartTask

Tarea especificada para ejecutarse en cada nodo de proceso a medida que se une al grupo.
En una operación PATCH (actualización), esta propiedad se puede establecer en un objeto vacío para quitar la tarea de inicio del grupo.
properties.targetNodeCommunicationMode

NodeCommunicationMode

Modo de comunicación de nodo deseado para el grupo.
Si se omite, el valor predeterminado es Default.
properties.taskSchedulingPolicy

TaskSchedulingPolicy

Cómo se distribuyen las tareas entre los nodos de proceso de un grupo.
Si no se especifica, el valor predeterminado se propaga.
properties.taskSlotsPerNode

integer

1

Número de ranuras de tareas que se pueden usar para ejecutar tareas simultáneas en un único nodo de proceso del grupo.
El valor predeterminado es 1. El valor máximo es el menor de 4 veces el número de núcleos de vmSize del grupo o 256.
properties.upgradePolicy

UpgradePolicy

Directiva de actualización del grupo.
Describe una directiva de actualización: automática, manual o gradual.
properties.userAccounts

UserAccount[]

Lista de cuentas de usuario que se van a crear en cada nodo del grupo.
properties.vmSize

string

Tamaño de las máquinas virtuales del grupo. Todas las máquinas virtuales de un grupo tienen el mismo tamaño.
Para obtener información sobre los tamaños de máquina virtual disponibles, consulte Tamaños de máquinas virtuales (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) o Tamaños de máquinas virtuales (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch admite todos los tamaños de máquina virtual de Azure, excepto STANDARD_A0 y aquellos con premium Storage (STANDARD_GS, STANDARD_DS y serie STANDARD_DSV2).
tags

object

Etiquetas del recurso.
type

string

Tipo del recurso.

PoolEndpointConfiguration

Configuración del punto de conexión de un grupo.

Nombre Tipo Description
inboundNatPools

InboundNatPool[]

Lista de grupos NAT de entrada que se pueden usar para abordar puertos específicos en un nodo de proceso individual externamente.
El número máximo de grupos NAT entrantes por grupo de Batch es 5. Si se supera el número máximo de grupos NAT de entrada, se produce un error en la solicitud con el código de estado HTTP 400. No se puede especificar si IPAddressProvisioningType es NoPublicIPAddresses.

PoolIdentityType

Tipo de identidad que se usa para el grupo de Batch.

Nombre Tipo Description
None

string

El grupo de Batch no tiene ninguna identidad asociada. Al establecer None en el grupo de actualizaciones se quitarán las identidades existentes.
UserAssigned

string

El grupo de Batch tiene identidades asignadas por el usuario con ella.

PoolProvisioningState

Estado actual del grupo.

Nombre Tipo Description
Deleting

string

El usuario ha solicitado que el grupo se elimine, pero la operación de eliminación aún no se ha completado.
Succeeded

string

El grupo está disponible para ejecutar tareas sujetas a la disponibilidad de los nodos de proceso.

PublicIPAddressConfiguration

Configuración de dirección IP pública de la configuración de red de un grupo.

Nombre Tipo Description
ipAddressIds

string[]

Lista de direcciones IP públicas que usará el servicio Batch al aprovisionar nodos de proceso.
El número de direcciones IP especificadas aquí limita el tamaño máximo del grupo: 100 nodos dedicados o 100 nodos de spot o prioridad baja se pueden asignar para cada dirección IP pública. Por ejemplo, un grupo que necesita 250 máquinas virtuales dedicadas necesitaría al menos 3 direcciones IP públicas especificadas. Cada elemento de esta colección tiene el formato : /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
provision

IPAddressProvisioningType

Tipo de aprovisionamiento para direcciones IP públicas para el grupo
El valor predeterminado es BatchManaged.

ResizeError

Error que se produjo al cambiar el tamaño de un grupo.

Nombre Tipo Description
code

string

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

ResizeError[]

Detalles adicionales sobre el error.
message

string

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

ResizeOperationStatus

Detalles sobre la operación de cambio de tamaño actual o última completada.

Nombre Tipo Description
errors

ResizeError[]

Detalles de los errores detectados al realizar el último cambio de tamaño en el grupo.
Esta propiedad solo se establece si se produjo un error durante el último cambio de tamaño del grupo y solo cuando el valor de allocationState del grupo es Estable.
nodeDeallocationOption

ComputeNodeDeallocationOption

Determina qué hacer con un nodo y sus tareas en ejecución si el tamaño del grupo está disminuyendo.
El valor predeterminado es requeue.
resizeTimeout

string

Tiempo de espera para la asignación de nodos de proceso al grupo o eliminación de nodos de proceso del grupo.
El valor predeterminado es de 15 minutos. El valor mínimo es de 5 minutos. Si especifica un valor inferior a 5 minutos, el servicio Batch devuelve un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).
startTime

string

Hora en que se inició esta operación de cambio de tamaño.
targetDedicatedNodes

integer

Número deseado de nodos de proceso dedicados en el grupo.
targetLowPriorityNodes

integer

Número deseado de nodos de proceso de spot o prioridad baja en el grupo.

ResourceFile

Un único archivo o varios archivos que se van a descargar en un nodo de proceso.

Nombre Tipo Description
autoStorageContainerName

string

Nombre del contenedor de almacenamiento en la cuenta de almacenamiento automática.
Las propiedades autoStorageContainerName, storageContainerUrl y httpUrl son mutuamente excluyentes y se debe especificar una de ellas.
blobPrefix

string

Prefijo de blob que se va a usar al descargar blobs de un contenedor de Azure Storage. Solo se descargarán los blobs cuyos nombres comienzan por el prefijo especificado.
La propiedad solo es válida cuando se usa autoStorageContainerName o storageContainerUrl. Este prefijo puede ser un nombre de archivo parcial o un subdirectorio. Si no se especifica un prefijo, se descargarán todos los archivos del contenedor.
fileMode

string

Atributo del modo de permiso de archivo en formato octal.
Esta propiedad solo se aplica a los archivos que se descargan en los nodos de proceso de Linux. Se omitirá si se especifica para un resourceFile que se descargará en un nodo de Windows. Si no se especifica esta propiedad para un nodo de Linux, se aplica un valor predeterminado de 0770 al archivo.
filePath

string

Ubicación en el nodo de proceso al que se va a descargar el archivo, en relación con el directorio de trabajo de la tarea.
Si se especifica la propiedad httpUrl, se requiere filePath y describe la ruta de acceso a la que se descargará el archivo, incluido el nombre de archivo. De lo contrario, si se especifica la propiedad autoStorageContainerName o storageContainerUrl, filePath es opcional y es el directorio al que descargar los archivos. En el caso de que filePath se use como directorio, cualquier estructura de directorios que ya esté asociada a los datos de entrada se conservará en su totalidad y se anexará al directorio filePath especificado. La ruta de acceso relativa especificada no puede dividirse en el directorio de trabajo de la tarea (por ejemplo, mediante '..').
httpUrl

string

Dirección URL del archivo que se va a descargar.
Las propiedades autoStorageContainerName, storageContainerUrl y httpUrl son mutuamente excluyentes y se debe especificar una de ellas. Si la dirección URL apunta a Azure Blob Storage, debe ser legible desde los nodos de proceso. Hay tres maneras de obtener esta dirección URL para un blob en Azure Storage: incluya una firma de acceso compartido (SAS) que conceda permisos de lectura en el blob, use una identidad administrada con permiso de lectura o establezca la ACL para el blob o su contenedor para permitir el acceso público.
identityReference

ComputeNodeIdentityReference

Referencia a la identidad asignada por el usuario que se va a usar para acceder a Azure Blob Storage especificado por storageContainerUrl o httpUrl
Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.
storageContainerUrl

string

Dirección URL del contenedor de blobs en Azure Blob Storage.
Las propiedades autoStorageContainerName, storageContainerUrl y httpUrl son mutuamente excluyentes y se debe especificar una de ellas. Esta dirección URL debe ser legible y enumerable desde los nodos de proceso. Hay tres maneras de obtener esta dirección URL para un contenedor en Azure Storage: incluya una firma de acceso compartido (SAS) que conceda permisos de lectura y lista en el contenedor, use una identidad administrada con permisos de lectura y lista, o establezca la ACL para que el contenedor permita el acceso público.

RollingUpgradePolicy

Los parámetros de configuración usados al realizar una actualización gradual.

Nombre Tipo Description
enableCrossZoneUpgrade

boolean

Permitir que VMSS omita los límites de AZ al construir lotes de actualización. Tenga en cuenta el dominio de actualización y maxBatchInstancePercent para determinar el tamaño del lote. Si no se establece este campo, Azure Batch no establecerá su valor predeterminado. El valor de enableCrossZoneUpgrade en el objeto VirtualMachineScaleSet creado se decidirá mediante las configuraciones predeterminadas en VirtualMachineScaleSet. Este campo solo se puede establecer en true o false cuando se usa NodePlacementConfiguration como zonal.
maxBatchInstancePercent

integer

Porcentaje máximo de instancias de máquina virtual totales que se actualizarán simultáneamente mediante la actualización gradual en un lote. Dado que se trata de un número máximo de instancias incorrectas en lotes anteriores o futuros, puede provocar que el porcentaje de instancias de un lote disminuya para garantizar una mayor confiabilidad. El valor de este campo debe estar comprendido entre 5 y 100, ambos incluidos. Si se asignan maxBatchInstancePercent y maxUnhealthyInstancePercent con el valor , el valor de maxBatchInstancePercent no debe ser mayor que maxUnhealthyInstancePercent.
maxUnhealthyInstancePercent

integer

El porcentaje máximo de las instancias de máquina virtual totales del conjunto de escalado que pueden estar en mal estado simultáneamente, ya sea como resultado de la actualización o si se encuentra en un estado incorrecto por parte de las comprobaciones de estado de la máquina virtual antes de que se anule la actualización gradual. Esta restricción se comprobará antes de iniciar cualquier lote. El valor de este campo debe estar comprendido entre 5 y 100, ambos incluidos. Si se asignan maxBatchInstancePercent y maxUnhealthyInstancePercent con el valor , el valor de maxBatchInstancePercent no debe ser mayor que maxUnhealthyInstancePercent.
maxUnhealthyUpgradedInstancePercent

integer

Porcentaje máximo de instancias de máquina virtual actualizadas que se pueden encontrar en un estado incorrecto. Esta comprobación se realizará después de actualizar cada lote. Si se supera este porcentaje alguna vez, se anula la actualización gradual. El valor de este campo debe estar comprendido entre 0 y 100, ambos incluidos.
pauseTimeBetweenBatches

string

Tiempo de espera entre completar la actualización de todas las máquinas virtuales de un lote e iniciar el siguiente lote. La duración del tiempo debe especificarse en formato ISO 8601.
prioritizeUnhealthyInstances

boolean

Actualice todas las instancias incorrectas de un conjunto de escalado antes de cualquier instancia correcta.
rollbackFailedInstancesOnPolicyBreach

boolean

Las instancias con error de reversión en el modelo anterior si se infringe la directiva de actualización gradual.

ScaleSettings

Configuración de escalado para el grupo

Nombre Tipo Description
autoScale

AutoScaleSettings

Configuración de escalado automático para el grupo.
Esta propiedad y fixedScale son mutuamente excluyentes y se debe especificar una de las propiedades.
fixedScale

FixedScaleSettings

Se ha corregido la configuración de escala para el grupo.
Esta propiedad y autoScale son mutuamente excluyentes y se debe especificar una de las propiedades.

SecurityEncryptionTypes

Especifica encryptionType del disco administrado. Se establece en VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: solo se puede establecer para máquinas virtuales confidenciales y necesarias al usar máquinas virtuales confidenciales.

Nombre Tipo Description
NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

Especifica la configuración del perfil de seguridad para la máquina virtual o el conjunto de escalado de máquinas virtuales.

Nombre Tipo Description
encryptionAtHost

boolean

El usuario puede usar esta propiedad en la solicitud para habilitar o deshabilitar el cifrado de host para la máquina virtual o el conjunto de escalado de máquinas virtuales. Esto habilitará el cifrado para todos los discos, incluido el recurso o el disco temporal en el propio host.
securityType

SecurityTypes

Especifica securityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings.
uefiSettings

UefiSettings

Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual.
Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual.

SecurityTypes

Especifica securityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings.

Nombre Tipo Description
confidentialVM

string

La informática confidencial de Azure ofrece máquinas virtuales confidenciales para los inquilinos con requisitos de alta seguridad y confidencialidad. Estas máquinas virtuales proporcionan un límite seguro y aplicado por hardware para ayudar a satisfacer sus necesidades de seguridad. Puede usar máquinas virtuales confidenciales para migraciones sin realizar cambios en el código, con la plataforma que protege el estado de la máquina virtual para que se lea o modifique.
trustedLaunch

string

El inicio de confianza protege contra técnicas de ataque avanzadas y persistentes.

ServiceArtifactReference

Especifica el identificador de referencia del artefacto de servicio que se usa para establecer la misma versión de imagen para todas las máquinas virtuales del conjunto de escalado cuando se usa la versión de imagen "más reciente".

Nombre Tipo Description
id

string

Identificador de referencia del artefacto de servicio de ServiceArtifactReference
Identificador de referencia del artefacto de servicio en forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

Tarea que se ejecuta cuando un nodo de proceso se une a un grupo en el servicio Azure Batch, o cuando el nodo de proceso se reinicia o se vuelve a crear una imagen de imagen.

Nombre Tipo Valor predeterminado Description
commandLine

string

Línea de comandos de la tarea de inicio.
La línea de comandos no se ejecuta en un shell y, por tanto, no puede aprovechar las características del shell, como la expansión de variables de entorno. Si desea aprovechar estas características, debe invocar el shell en la línea de comandos, por ejemplo, con "cmd /c MyCommand" en Windows o "/bin/sh -c MyCommand" en Linux. Obligatorio si se especifican otras propiedades de startTask.
containerSettings

TaskContainerSettings

Configuración del contenedor en el que se ejecuta la tarea de inicio.
Cuando se especifica esto, todos los directorios se asignan de forma recursiva debajo del AZ_BATCH_NODE_ROOT_DIR (la raíz de los directorios de Azure Batch en el nodo) se asignan al contenedor, todas las variables de entorno de tareas se asignan al contenedor y la línea de comandos de la tarea se ejecuta en el contenedor.
environmentSettings

EnvironmentSetting[]

Lista de opciones de configuración de variables de entorno para la tarea de inicio.
maxTaskRetryCount

integer

0

Número máximo de veces que se puede reintentar la tarea.
El servicio Batch reintenta una tarea si su código de salida es distinto de cero. Tenga en cuenta que este valor controla específicamente el número de reintentos. El servicio Batch probará la tarea una vez y, a continuación, volverá a intentarlo hasta este límite. Por ejemplo, si el número máximo de reintentos es 3, Batch intenta la tarea hasta 4 veces (un intento inicial y 3 reintentos). Si el número máximo de reintentos es 0, el servicio Batch no vuelve a intentar la tarea. Si el número máximo de reintentos es -1, el servicio Batch reintenta la tarea sin límite. El valor predeterminado es 0
resourceFiles

ResourceFile[]

Lista de archivos que el servicio Batch descargará en el nodo de proceso antes de ejecutar la línea de comandos.
userIdentity

UserIdentity

Identidad de usuario en la que se ejecuta la tarea de inicio.
Si se omite, la tarea se ejecuta como un usuario no administrativo único para la tarea.
waitForSuccess

boolean

Si el servicio Batch debe esperar a que la tarea de inicio se complete correctamente (es decir, salir con el código de salida 0) antes de programar las tareas en el nodo de proceso.
Si es true y la tarea de inicio produce un error en un nodo de proceso, el servicio Batch reintenta la tarea de inicio hasta su recuento máximo de reintentos (maxTaskRetryCount). Si la tarea todavía no se ha completado correctamente después de todos los reintentos, el servicio Batch marca el nodo de proceso inutilizable y no programará tareas en él. Esta condición se puede detectar mediante el estado del nodo y los detalles del error de programación. Si es false, el servicio Batch no esperará a que se complete la tarea de inicio. En este caso, otras tareas pueden empezar a ejecutarse en el nodo de proceso mientras la tarea de inicio todavía se está ejecutando; e incluso si se produce un error en la tarea de inicio, las nuevas tareas seguirán programando en el nodo. El valor predeterminado es true.

StorageAccountType

Tipo de cuenta de almacenamiento para su uso en la creación de discos de datos o disco del sistema operativo.

Nombre Tipo Description
Premium_LRS

string

El disco de datos o el disco del sistema operativo debe usar el almacenamiento con redundancia local Premium.
StandardSSD_LRS

string

El disco de datos o el disco del sistema operativo debe usar el almacenamiento estándar con redundancia local de SSD.
Standard_LRS

string

El disco de datos o el disco del sistema operativo debe usar el almacenamiento estándar con redundancia local.

TaskContainerSettings

Configuración del contenedor de una tarea.

Nombre Tipo Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Las rutas de acceso que desea montar en la tarea contenedora.
Si esta matriz es nula o no está presente, la tarea de contenedor montará toda la unidad de disco temporal en windows (o AZ_BATCH_NODE_ROOT_DIR en Linux). No montará ninguna ruta de acceso de datos en el contenedor si esta matriz está establecida como vacía.
containerRunOptions

string

Opciones adicionales para el comando container create.
Estas opciones adicionales se proporcionan como argumentos para el comando "docker create", además de las controladas por el servicio Batch.
imageName

string

Imagen que se va a usar para crear el contenedor en el que se ejecutará la tarea.
Esta es la referencia de imagen completa, como se especificaría en "docker pull". Si no se proporciona ninguna etiqueta como parte del nombre de la imagen, la etiqueta ":latest" se usa como valor predeterminado.
registry

ContainerRegistry

Registro privado que contiene la imagen de contenedor.
Esta configuración se puede omitir si ya se proporcionó en la creación del grupo.
workingDirectory

ContainerWorkingDirectory

Marca para indicar dónde está el directorio de trabajo de la tarea de contenedor. El valor predeterminado es "taskWorkingDirectory".

TaskSchedulingPolicy

Especifica cómo se deben distribuir las tareas entre los nodos de proceso.

Nombre Tipo Valor predeterminado Description
nodeFillType

ComputeNodeFillType

Spread

Cómo se deben distribuir las tareas entre nodos de proceso.

UefiSettings

Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual.

Nombre Tipo Description
secureBootEnabled

boolean

Especifica si se debe habilitar el arranque seguro en la máquina virtual.
vTpmEnabled

boolean

Especifica si vTPM debe estar habilitado en la máquina virtual.

UpgradeMode

Especifica el modo de una actualización a las máquinas virtuales del conjunto de escalado.

Los valores posibles son:

manual: controla la aplicación de actualizaciones en las máquinas virtuales del conjunto de escalado. Para ello, use la acción manualUpgrade.

Automático: todas las máquinas virtuales del conjunto de escalado se actualizan automáticamente al mismo tiempo.

rolling: el conjunto de escalado realiza actualizaciones en lotes con un tiempo de pausa opcional entre sí.

Nombre Tipo Description
automatic

string

Todas las máquinas virtuales del conjunto de escalado se actualizan automáticamente al mismo tiempo.
manual

string

Puede controlar la aplicación de actualizaciones en máquinas virtuales del conjunto de escalado. Para ello, use la acción manualUpgrade.
rolling

string

Las instancias existentes de un conjunto de escalado se reducen en lotes que se van a actualizar. Una vez completado el lote actualizado, las instancias comenzarán a tomar el tráfico de nuevo y se iniciará el siguiente lote. Esto continúa hasta que todas las instancias han traído up-to-date.

UpgradePolicy

Describe una directiva de actualización: automática, manual o gradual.

Nombre Tipo Description
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

Parámetros de configuración usados para realizar la actualización automática del sistema operativo.
Los parámetros de configuración que se usan para realizar la actualización automática del sistema operativo.
mode

UpgradeMode

Especifica el modo de una actualización a las máquinas virtuales del conjunto de escalado.

Los valores posibles son:

manual: controla la aplicación de actualizaciones en las máquinas virtuales del conjunto de escalado. Para ello, use la acción manualUpgrade.

Automático: todas las máquinas virtuales del conjunto de escalado se actualizan automáticamente al mismo tiempo.

rolling: el conjunto de escalado realiza actualizaciones en lotes con un tiempo de pausa opcional entre sí.
rollingUpgradePolicy

RollingUpgradePolicy

Los parámetros de configuración usados al realizar una actualización gradual.
Los parámetros de configuración usados al realizar una actualización gradual.

UserAccount

Propiedades usadas para crear un usuario en un nodo de Azure Batch.

Nombre Tipo Description
elevationLevel

ElevationLevel

Nivel de elevación de la cuenta de usuario.
nonAdmin: el usuario automático es un usuario estándar sin acceso elevado. admin: el usuario automático es un usuario con acceso elevado y funciona con permisos de administrador completos. El valor predeterminado es nonAdmin.
linuxUserConfiguration

LinuxUserConfiguration

Configuración de usuario específica de Linux para la cuenta de usuario.
Esta propiedad se omite si se especifica en un grupo de Windows. Si no se especifica, el usuario se crea con las opciones predeterminadas.
name

string

Nombre de la cuenta de usuario. Los nombres pueden contener caracteres Unicode de hasta una longitud máxima de 20.
password

string

Contraseña de la cuenta de usuario.
windowsUserConfiguration

WindowsUserConfiguration

Configuración de usuario específica de Windows para la cuenta de usuario.
Esta propiedad solo se puede especificar si el usuario está en un grupo de Windows. Si no se especifica y en un grupo de Windows, el usuario se crea con las opciones predeterminadas.

UserAssignedIdentities

Lista de identidades de usuario asociadas.

Nombre Tipo Description
clientId

string

Identificador de cliente de la identidad asignada por el usuario.
principalId

string

Identificador principal de la identidad asignada por el usuario.

UserIdentity

Definición de la identidad de usuario en la que se ejecuta la tarea.

Nombre Tipo Description
autoUser

AutoUserSpecification

Usuario automático en el que se ejecuta la tarea.
Las propiedades userName y autoUser son mutuamente excluyentes; debe especificar uno pero no ambos.
userName

string

Nombre de la identidad de usuario en la que se ejecuta la tarea.
Las propiedades userName y autoUser son mutuamente excluyentes; debe especificar uno pero no ambos.

VirtualMachineConfiguration

Configuración de nodos de proceso en un grupo basado en la infraestructura de Azure Virtual Machines.

Nombre Tipo Description
containerConfiguration

ContainerConfiguration

Configuración del contenedor para el grupo.
Si se especifica, la instalación se realiza en cada nodo del grupo para permitir que las tareas se ejecuten en contenedores. Todas las tareas normales y las tareas del administrador de trabajos que se ejecutan en este grupo deben especificar la propiedad containerSettings y todas las demás tareas pueden especificarla.
dataDisks

DataDisk[]

Configuración de discos de datos conectados a los nodos de proceso del grupo.
Esta propiedad debe especificarse si los nodos de proceso del grupo deben tener discos de datos vacíos conectados a ellos.
diskEncryptionConfiguration

DiskEncryptionConfiguration

Configuración de cifrado de disco para el grupo.
Si se especifica, el cifrado se realiza en cada nodo del grupo durante el aprovisionamiento de nodos.
extensions

VMExtension[]

Extensión de máquina virtual para el grupo.
Si se especifica, las extensiones mencionadas en esta configuración se instalarán en cada nodo.
imageReference

ImageReference

Referencia a la imagen de Marketplace de Azure Virtual Machines o a la imagen de máquina virtual personalizada que se va a usar.
licenseType

string

Tipo de licencia local que se va a usar al implementar el sistema operativo.
Esto solo se aplica a las imágenes que contienen el sistema operativo Windows y solo se deben usar cuando contenga licencias locales válidas para los nodos que se implementarán. Si se omite, no se aplica ningún descuento de licencia local. Los valores son:

Windows_Server: la licencia local es para Windows Server. Windows_Client: la licencia local es para el cliente de Windows.
nodeAgentSkuId

string

SKU del agente de nodo de Batch que se va a aprovisionar en los nodos de proceso del grupo.
El agente de nodo de Batch es un programa que se ejecuta en cada nodo del grupo y proporciona la interfaz de comando y control entre el nodo y el servicio Batch. Hay diferentes implementaciones del agente de nodo, conocidas como SKU, para diferentes sistemas operativos. Debe especificar una SKU del agente de nodo que coincida con la referencia de imagen seleccionada. Para obtener la lista de SKU de agente de nodo compatibles junto con su lista de referencias de imágenes verificadas, consulte la operación "Enumerar SKU de agente de nodo compatibles".
nodePlacementConfiguration

NodePlacementConfiguration

Configuración de ubicación del nodo para el grupo.
Esta configuración especificará reglas sobre cómo se asignarán físicamente los nodos del grupo.
osDisk

OSDisk

Configuración del disco del sistema operativo de la máquina virtual.
Contiene la configuración de los valores de OSDisk efímeros.
securityProfile

SecurityProfile

Especifica la configuración del perfil de seguridad para la máquina virtual o el conjunto de escalado de máquinas virtuales.
Especifica la configuración del perfil de seguridad para la máquina virtual o el conjunto de escalado de máquinas virtuales.
serviceArtifactReference

ServiceArtifactReference

Especifica el identificador de referencia del artefacto de servicio que se usa para establecer la misma versión de imagen para todas las máquinas virtuales del conjunto de escalado cuando se usa la versión de imagen "más reciente".
Identificador de referencia del artefacto de servicio en forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration

WindowsConfiguration

Configuración del sistema operativo Windows en la máquina virtual.
Esta propiedad no se debe especificar si imageReference especifica una imagen del sistema operativo Linux.

VMDiskSecurityProfile

Especifica la configuración del perfil de seguridad para el disco administrado. Nota: solo se puede establecer para máquinas virtuales confidenciales y se requiere cuando se usan máquinas virtuales confidenciales.

Nombre Tipo Description
securityEncryptionType

SecurityEncryptionTypes

Especifica encryptionType del disco administrado. Se establece en VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: solo se puede establecer para máquinas virtuales confidenciales y necesarias al usar máquinas virtuales confidenciales.

VMExtension

Configuración de extensiones de máquina virtual.

Nombre Tipo Description
autoUpgradeMinorVersion

boolean

Indica si la extensión debe usar una versión secundaria más reciente si está disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true.
enableAutomaticUpgrade

boolean

Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente de la extensión disponible.
name

string

Nombre de la extensión de máquina virtual.
protectedSettings

object

La extensión puede contener protectedSettings o protectedSettingsFromKeyVault o ninguna configuración protegida.
provisionAfterExtensions

string[]

Colección de nombres de extensión.
Colección de nombres de extensión después de los cuales se debe aprovisionar esta extensión.
publisher

string

Nombre del publicador de controladores de extensión.
settings

object

Configuración pública con formato JSON para la extensión.
type

string

Tipo de las extensiones.
typeHandlerVersion

string

Versión del controlador de script.

WindowsConfiguration

Configuración del sistema operativo Windows que se aplicará a la máquina virtual.

Nombre Tipo Description
enableAutomaticUpdates

boolean

Si las actualizaciones automáticas están habilitadas en la máquina virtual.
Si se omite, el valor predeterminado es true.

WindowsUserConfiguration

Propiedades usadas para crear una cuenta de usuario en un nodo de Windows.

Nombre Tipo Description
loginMode

LoginMode

Modo de inicio de sesión para el usuario
Especifica el modo de inicio de sesión para el usuario. El valor predeterminado es Interactivo.