Compartir a través de


Pools - Create Pool

Crea un pool para la cuenta especificada.
Al asignar nombres a grupos, evite incluir información confidencial, como nombres de usuario o nombres de proyecto secretos. Esta información puede aparecer en los registros de telemetría accesibles para los ingenieros de soporte técnico de Microsoft.

POST {endpoint}/pools?api-version=2025-06-01
POST {endpoint}/pools?api-version=2025-06-01&timeOut={timeOut}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
path True

string (uri)

Punto de conexión de la cuenta de Batch (por ejemplo: https://batchaccount.eastus2.batch.azure.com).

api-version
query True

string

minLength: 1

La versión de API que se va a utilizar para esta operación.

timeOut
query

integer (int32)

Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Si el valor es mayor que 30, se usará el valor predeterminado en su lugar.".

Encabezado de la solicitud

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

Nombre Requerido Tipo Description
client-request-id

string

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

return-client-request-id

boolean

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

ocp-date

string (date-time-rfc7231)

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

Cuerpo de la solicitud

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

Nombre Requerido Tipo Description
id True

string

Cadena que identifica de forma única el grupo dentro de la cuenta. El identificador puede contener cualquier combinación de caracteres alfanuméricos, incluidos guiones y caracteres de subrayado, y no puede contener más de 64 caracteres. El identificador se conserva entre mayúsculas y minúsculas y no distingue mayúsculas de minúsculas (es decir, es posible que no tenga dos identificadores de grupo dentro de una cuenta que solo sea diferente por caso).

vmSize True

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 para grupos mediante imágenes de Virtual Machines Marketplace (grupos creados con virtualMachineConfiguration), consulte Tamaños de máquinas virtuales en Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). 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).

applicationPackageReferences

BatchApplicationPackageReference[]

Lista de paquetes que se van a instalar en cada nodo de proceso del grupo. Al crear un grupo, el identificador de aplicación del paquete debe estar completo (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Los cambios en las referencias de paquete afectan a todos los nodos 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 en cualquier grupo determinado.

autoScaleEvaluationInterval

string (duration)

Intervalo de tiempo en el que se ajusta automáticamente el tamaño del grupo según la fórmula de escalado automático. El valor predeterminado es 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch devuelve un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

autoScaleFormula

string

Fórmula para el número deseado de nodos de proceso en el grupo. Esta propiedad no se debe especificar si enableAutoScale está establecido en false. Es necesario si enableAutoScale está establecido en true. La fórmula se comprueba si hay validez antes de crear el grupo. Si la fórmula no es válida, el servicio Batch rechaza la solicitud con información de error detallada. Para más información sobre cómo especificar esta fórmula, consulte "Escalado automático de nodos de proceso en un grupo de Azure Batch" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

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.

enableAutoScale

boolean

Si el tamaño del grupo se debe ajustar automáticamente con el tiempo. Si es false, se debe especificar al menos uno de targetDedicatedNodes y targetLowPriorityNodes. Si es true, se requiere la propiedad autoScaleFormula y el grupo cambia automáticamente el tamaño según la fórmula. El valor predeterminado es false.

enableInterNodeCommunication

boolean

Si el grupo permite la comunicación directa entre nodos de proceso. Habilitar la comunicación entre nodos limita el tamaño máximo del grupo debido a restricciones de implementación en los nodos de proceso del grupo. Esto puede dar lugar a que el grupo no alcance su tamaño deseado. El valor predeterminado es false.

metadata

BatchMetadataItem[]

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.

mountConfiguration

MountConfiguration[]

Monte el almacenamiento utilizando el sistema de archivos especificado durante toda la vida útil del grupo. Monte el almacenamiento mediante el sistema de archivos basado en Azure fileshare, NFS, CIFS o Blobfuse.

networkConfiguration

NetworkConfiguration

Configuración de red para el grupo.

resizeTimeout

string (duration)

Tiempo de espera para la asignación de nodos de proceso al grupo. Este tiempo de espera solo se aplica al escalado manual; no tiene ningún efecto cuando enableAutoScale se establece en true. El valor predeterminado es 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).

startTask

BatchStartTask

Tarea especificada para ejecutarse en cada nodo de proceso a medida que se une al grupo. La tarea se ejecuta cuando se agrega el nodo de proceso al grupo o cuando se reinicia el nodo de proceso.

targetDedicatedNodes

integer (int32)

Número deseado de nodos de proceso dedicados en el grupo. Esta propiedad no debe especificarse si enableAutoScale está establecido en true. Si enableAutoScale se establece en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.

targetLowPriorityNodes

integer (int32)

Número deseado de nodos de proceso de prioridad baja o de acceso puntual en el grupo. Esta propiedad no debe especificarse si enableAutoScale está establecido en true. Si enableAutoScale se establece en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.

taskSchedulingPolicy

BatchTaskSchedulingPolicy

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

taskSlotsPerNode

integer (int32)

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.

upgradePolicy

UpgradePolicy

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

userAccounts

UserAccount[]

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

virtualMachineConfiguration

VirtualMachineConfiguration

Configuración de la máquina virtual para el grupo. Es necesario especificar esta propiedad.

Respuestas

Nombre Tipo Description
201 Created

La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Encabezados

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

BatchError

Una respuesta de error inesperada.

Seguridad

OAuth2Auth

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

Ámbitos

Nombre Description
https://batch.core.windows.net//.default

Ejemplos

Creates a pool with accelerated networking
Creates a pool with confidential disk encryption set for user subscription accounts
Creates a pool with disk encryption set for user subscription accounts
Creates a pool with dual stack networking
Creates a pool with mount drive specified
Creates a pool with SecurityProfile
Creates a VirtualMachineConfiguration pool
Creates a VirtualMachineConfiguration pool with containers
Creates a VirtualMachineConfiguration pool with extensions
Creates a VirtualMachineConfiguration pool with OS disk
Creates a VirtualMachineConfiguration pool with ServiceArtifactReference

Creates a pool with accelerated networking

Solicitud de ejemplo

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool01",
  "vmSize": "Standard_D1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2025-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "networkConfiguration": {
    "enableAcceleratedNetworking": true
  }
}

Respuesta de muestra

Creates a pool with confidential disk encryption set for user subscription accounts

Solicitud de ejemplo

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool",
  "vmSize": "Standard_DC2as_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2019-datacenter-core-g2",
      "version": "latest"
    },
    "osDisk": {
      "managedDisk": {
        "storageAccountType": "standard_lrs",
        "diskEncryptionSet": {
          "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
        },
        "securityProfile": {
          "securityEncryptionType": "DiskWithVMGuestState"
        }
      }
    },
    "dataDisks": [
      {
        "lun": 0,
        "diskSizeGB": 1024,
        "managedDisk": {
          "storageAccountType": "standard_lrs",
          "diskEncryptionSet": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
          }
        }
      }
    ],
    "securityProfile": {
      "securityType": "confidentialvm",
      "uefiSettings": {
        "vTpmEnabled": true,
        "secureBootEnabled": true
      }
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 1
}

Respuesta de muestra

Creates a pool with disk encryption set for user subscription accounts

Solicitud de ejemplo

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2019-datacenter-core-g2",
      "version": "latest"
    },
    "osDisk": {
      "managedDisk": {
        "storageAccountType": "standard_lrs",
        "diskEncryptionSet": {
          "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
        }
      }
    },
    "dataDisks": [
      {
        "lun": 0,
        "diskSizeGB": 1024,
        "managedDisk": {
          "storageAccountType": "standard_lrs",
          "diskEncryptionSet": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
          }
        }
      }
    ],
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 1
}

Respuesta de muestra

Creates a pool with dual stack networking

Solicitud de ejemplo

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "dualstackpool",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "networkConfiguration": {
    "publicIPAddressConfiguration": {
      "ipFamilies": [
        "IPv4",
        "IPv6"
      ]
    },
    "endpointConfiguration": {
      "inboundNATPools": [
        {
          "backendPort": 22,
          "frontendPortRangeStart": 40000,
          "frontendPortRangeEnd": 40500,
          "name": "sshpool",
          "protocol": "tcp",
          "networkSecurityGroupRules": [
            {
              "access": "allow",
              "priority": 1000,
              "sourceAddressPrefix": "*",
              "sourcePortRanges": [
                "*"
              ]
            }
          ]
        }
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

Respuesta de muestra

Creates a pool with mount drive specified

Solicitud de ejemplo

POST {endpoint}/pools?api-version=2025-06-01


{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "mountConfiguration": [
    {
      "azureBlobFileSystemConfiguration": {
        "accountName": "accountName",
        "containerName": "blobContainerName",
        "accountKey": "accountKey",
        "relativeMountPath": "bfusepath"
      }
    },
    {
      "azureFileShareConfiguration": {
        "accountName": "accountName",
        "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare",
        "accountKey": "accountKey",
        "relativeMountPath": "filesharepath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "nfsMountConfiguration": {
        "source": "somesource nfs url",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "cifsMountConfiguration": {
        "username": "accountName",
        "password": "password",
        "source": "//myaccount.file.core.windows.net/file",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    }
  ],
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Respuesta de muestra

Creates a pool with SecurityProfile

Solicitud de ejemplo

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04",
    "securityProfile": {
      "securityType": "trustedLaunch",
      "encryptionAtHost": true,
      "uefiSettings": {
        "secureBootEnabled": false,
        "vTpmEnabled": null
      }
    }
  },
  "targetDedicatedNodes": 1
}

Respuesta de muestra

Creates a VirtualMachineConfiguration pool

Solicitud de ejemplo

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Respuesta de muestra

Creates a VirtualMachineConfiguration pool with containers

Solicitud de ejemplo

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "120_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "containerConfiguration": {
      "type": "dockerCompatible",
      "containerImageNames": [
        "busybox"
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Respuesta de muestra

Creates a VirtualMachineConfiguration pool with extensions

Solicitud de ejemplo

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "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"
        }
      }
    ]
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Respuesta de muestra

Creates a VirtualMachineConfiguration pool with OS disk

Solicitud de ejemplo

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool001",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "osDisk": {
      "diskSizeGB": 100,
      "managedDisk": {
        "storageAccountType": "standardssd_lrs"
      },
      "caching": "readwrite",
      "ephemeralOSDiskSettings": {
        "placement": "cachedisk"
      }
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 1,
  "enableAutoScale": false
}

Respuesta de muestra

Creates a VirtualMachineConfiguration pool with ServiceArtifactReference

Solicitud de ejemplo

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool002",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2025-datacenter-smalldisk",
      "version": "latest"
    },
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "serviceArtifactReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2
}

Respuesta de muestra

Definiciones

Nombre Description
AutomaticOsUpgradePolicy

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

AutoUserScope

Enums de AutoUserScope

AutoUserSpecification

Especifica las opciones del usuario automático que ejecuta una tarea de Azure 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.

BatchApplicationPackageReference

Referencia a un paquete que se va a implementar en nodos de proceso.

BatchContainerConfiguration

Configuración de grupos habilitados para contenedores.

BatchDiffDiskSettings

Especifica la configuración de disco efímero para el disco del sistema operativo usado por el nodo de proceso (VM).

BatchError

Respuesta de error recibida del servicio Azure Batch.

BatchErrorDetail

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

BatchErrorMessage

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

BatchInboundNatPool

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

BatchJobDefaultOrder

Emums de BatchJobDefaultOrder

BatchMetadataItem

El servicio Batch no asigna ningún significado a estos metadatos; es únicamente para el uso del código de usuario.

BatchNodeFillType

Enums BatchNodeFillType

BatchNodeIdentityReference

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

BatchNodePlacementConfiguration

Para la ubicación regional, los nodos del grupo se asignarán en la misma región. En el caso de la ubicación zonal, los nodos del grupo se distribuirán entre diferentes zonas con el mejor equilibrio de esfuerzo.

BatchNodePlacementPolicyType

Eums de BatchNodePlacementPolicyPolicy

BatchOsDisk

Configuración del disco del sistema operativo del nodo de proceso (VM).

BatchPoolCreateOptions

Parámetros para crear un grupo de Azure Batch.

BatchPoolEndpointConfiguration

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

BatchPoolIdentityReference

Referencia de una de las identidades de grupo para cifrar el disco. Esta identidad se usará para acceder al almacén de claves.

BatchPublicIpAddressConfiguration

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

BatchStartTask

Batch volverá a intentar tareas cuando se desencadene una operación de recuperación en un nodo. Algunos ejemplos de operaciones de recuperación son (pero no están limitados a) cuando se reinicia un nodo incorrecto o un nodo de proceso desaparece debido a un error de host. Los reintentos debido a las operaciones de recuperación son independientes de y no se cuentan con maxTaskRetryCount. Incluso si maxTaskRetryCount es 0, puede producirse un reintento interno debido a una operación de recuperación. Por este motivo, todas las tareas deben ser idempotentes. Esto significa que las tareas deben tolerar que se interrumpan y se reinicien sin causar daños ni datos duplicados. El procedimiento recomendado para tareas de larga duración es usar algún tipo de punto de control. En algunos casos, startTask puede volver a ejecutarse aunque no se haya reiniciado el nodo de proceso. Se debe tener especial cuidado para evitar startTasks que creen servicios de interrupción o instalación o inicio desde el directorio de trabajo startTask, ya que esto impedirá que Batch pueda volver a ejecutar StartTask.

BatchTaskContainerSettings

Configuración del contenedor de una tarea.

BatchTaskSchedulingPolicy

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

BatchUefiSettings

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

BatchVmDiskSecurityProfile

Especifica la configuración del perfil de seguridad para el disco administrado. Nota: Solo se puede configurar para máquinas virtuales confidenciales y es necesario cuando se utilizan máquinas virtuales confidenciales.

BatchVmImageReference

Referencia a una imagen de Marketplace de Azure Virtual Machines o a una imagen de Azure Compute Gallery. Para obtener la lista de todas las referencias de imágenes de Azure Marketplace verificadas por Azure Batch, consulte la operación "Enumerar imágenes admitidas".

CachingType

Enums CachingType

CifsMountConfiguration

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

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.

ContainerRegistryReference

Un registro de contenedor privado.

ContainerType

Enums ContainerType

ContainerWorkingDirectory

ContainerWorkingDirectory enums

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.

DiffDiskPlacement

Especifica la ubicación efímera del disco del sistema operativo para todos los nodos de cómputo (VMs) del pool. 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 más información sobre los requisitos de tamaño de disco de Ephemeral OS, consulte los requisitos de tamaño de disco de Ephemeral OS para máquinas virtuales de Windows en https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements y para máquinas virtuales de Linux en https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

DiskCustomerManagedKey

La referencia de clave administrada por el cliente para cifrar el disco.

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 Azure Compute Gallery.

DiskEncryptionSetParameters

El identificador de recurso de ARM del conjunto de cifrado de disco.

DiskEncryptionTarget

Enums DiskEncryptionTarget

DynamicVNetAssignmentScope

DynamicVNetAssignmentScope enums

ElevationLevel

Enums de ElevationLevel

EnvironmentSetting

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

HostEndpointSettings

Especifica una configuración de extremo de host determinada.

HostEndpointSettingsModeTypes

HostEndpointSettingsModeTypes enums

InboundEndpointProtocol

InboundEndpointProtocol enums

IpAddressProvisioningType

IPAddressProvisioningType enums

IPFamily

Las familias de IP utilizadas para especificar las versiones de IP disponibles para el grupo.

IPTag

Contiene la etiqueta IP asociada a la dirección IP pública.

LinuxUserConfiguration

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

LoginMode

Enums de LoginMode

ManagedDisk

Parámetros de disco administrado.

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

NetworkSecurityGroupRuleAccess enums

NfsMountConfiguration

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

ProxyAgentSettings

Especifica la configuración de ProxyAgent al crear la máquina virtual.

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.

SecurityEncryptionTypes

Enums de SecurityEncryptionTypes

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

StorageAccountType

Enumeraciones de StorageAccountType

UpgradeMode

Enums de UpgradeMode

UpgradePolicy

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

UserAccount

Propiedades usadas para crear un usuario que se usa para ejecutar tareas en un nodo de proceso de Azure Batch.

UserIdentity

Definición de la identidad de usuario en la que se ejecuta la tarea. Especifique la propiedad userName o autoUser, pero no ambas.

VirtualMachineConfiguration

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

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 proceso de Windows.

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.

AutoUserScope

Enums de AutoUserScope

Valor Description
task

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

pool

Especifica que la tarea se ejecuta como la cuenta de usuario automática común, que se crea en cada nodo de cómputo de un pool.

AutoUserSpecification

Especifica las opciones del usuario automático que ejecuta una tarea de Azure 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.

AzureBlobFileSystemConfiguration

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

Nombre Tipo Description
accountKey

string (password)

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

BatchNodeIdentityReference

La referencia a la identidad asignada por el usuario para acceder a NombreContenedor. Esta propiedad es mutuamente excluyente con accountKey y sasKey; exactamente uno debe especificarse.

relativeMountPath

string

El camino relativo en el nodo de cómputo 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 (password)

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 (password)

Clave de cuenta de Azure Storage.

accountName

string

Nombre de la cuenta de Azure Storage.

azureFileUrl

string (uri)

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

El camino relativo en el nodo de cómputo 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.

BatchApplicationPackageReference

Referencia a un paquete que se va a implementar en nodos de proceso.

Nombre Tipo Description
applicationId

string

El ID de la aplicación a desplegar. Al crear un grupo, el identificador de aplicación del paquete debe estar completo (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

Versión de la aplicación que se va a implementar. Si se omite, se implementa la versión predeterminada. Si esto se omite en un Pool y no se especifica una versión predeterminada para esta aplicación, la solicitud falla con el código de error InvalidApplicationPackageReferences y el código de estado HTTP 409. Si esto se omite en una tarea y no se especifica una versión predeterminada para esta aplicación, la tarea falla con un error de preprocesamiento.

BatchContainerConfiguration

Configuración de grupos habilitados para contenedores.

Nombre Tipo Description
containerImageNames

string[]

La colección de nombres de imágenes de contenedores. Esta es la referencia completa de Image, tal como se especificaría en "docker pull". Una imagen se obtendrá del registro Docker predeterminado a menos que la imagen esté completamente cualificada con un registro alternativo.

containerRegistries

ContainerRegistryReference[]

Registros privados adicionales desde los que se pueden extraer contenedores. Si alguna Imagen debe descargarse de un registro privado que requiera credenciales, entonces esas credenciales deben proporcionarse aquí.

type

ContainerType

Tecnología de contenedor que se va a usar.

BatchDiffDiskSettings

Especifica la configuración de disco efímero para el disco del sistema operativo usado por el nodo de proceso (VM).

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 la ubicación, 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://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements y máquinas virtuales Linux en https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Nombre Tipo Description
code

string

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

message

BatchErrorMessage

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

values

BatchErrorDetail[]

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

BatchErrorDetail

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

Nombre Tipo Description
key

string

Identificador que especifica el significado de la propiedad Value.

value

string

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

BatchErrorMessage

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

Nombre Tipo Description
lang

string

El código de idioma del mensaje de error.

value

string

El texto del mensaje.

BatchInboundNatPool

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

Nombre Tipo Description
backendPort

integer (int32)

El número de puerto en el Nodo de Cálculo. Esto debe ser único dentro de un lote. 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 (int32)

El último número de puerto en el rango de puertos externos que se usarán para proporcionar acceso entrante al backendPort en nodos de cómputo 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 rangos dentro de un grupo deben ser distintos y no pueden solaparse. Cada gama debe contener al menos 40 puertos. Si se proporcionan valores reservados o superpuestos, se produce un error en la solicitud con el código de estado HTTP 400.

frontendPortRangeStart

integer (int32)

El primer número de puerto dentro del rango de puertos externos que se usarán para proporcionar acceso entrante al backendPort en nodos de cómputo individuales. Los valores aceptables oscilan entre 1 y 65534, excepto los puertos de 50000 a 55000 que están reservados. Todos los rangos dentro de un grupo deben ser distintos y no pueden solaparse. Cada gama debe contener al menos 40 puertos. 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 Batch Pool, puede contener letras, números, guiones bajos, 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 finales de un Batch Pool 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.

BatchJobDefaultOrder

Emums de BatchJobDefaultOrder

Valor Description
none

Las tareas deben programarse de forma uniforme entre todos los trabajos de igual prioridad del grupo.

creationtime

Si los trabajos tienen la misma prioridad, las tareas de trabajos creados antes deberían programarse primero.

BatchMetadataItem

El servicio Batch no asigna ningún significado a estos metadatos; es únicamente para el uso del código de usuario.

Nombre Tipo Description
name

string

Nombre del elemento de metadatos.

value

string

Valor del elemento de metadatos.

BatchNodeFillType

Enums BatchNodeFillType

Valor Description
spread

Las tareas deben asignarse de forma equitativa entre todos los Nodos de Cómputo del Pool.

pack

Se deben asignar tantas tareas como sea posible (taskSlotsPerNode) a cada nodo de cómputo del pool antes de asignar cualquier tarea al siguiente nodo de cómputo del pool.

BatchNodeIdentityReference

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

Nombre Tipo Description
resourceId

string (arm-id)

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

BatchNodePlacementConfiguration

Para la ubicación regional, los nodos del grupo se asignarán en la misma región. En el caso de la ubicación zonal, los nodos del grupo se distribuirán entre diferentes zonas con el mejor equilibrio de esfuerzo.

Nombre Tipo Description
policy

BatchNodePlacementPolicyType

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.

BatchNodePlacementPolicyType

Eums de BatchNodePlacementPolicyPolicy

Valor Description
regional

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

zonal

Los nodos del pool estarán repartidos en diferentes zonas de disponibilidad con el mejor equilibrio de esfuerzo.

BatchOsDisk

Configuración del disco del sistema operativo del nodo de proceso (VM).

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 (int32)

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

ephemeralOSDiskSettings

BatchDiffDiskSettings

Especifica la configuración de disco efímero para el disco del sistema operativo usado por el nodo de proceso (VM).

managedDisk

ManagedDisk

Parámetros de disco administrado.

writeAcceleratorEnabled

boolean

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

BatchPoolCreateOptions

Parámetros para crear un grupo de Azure Batch.

Nombre Tipo Description
applicationPackageReferences

BatchApplicationPackageReference[]

Lista de paquetes que se van a instalar en cada nodo de proceso del grupo. Al crear un grupo, el identificador de aplicación del paquete debe estar completo (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Los cambios en las referencias de paquete afectan a todos los nodos 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 en cualquier grupo determinado.

autoScaleEvaluationInterval

string (duration)

Intervalo de tiempo en el que se ajusta automáticamente el tamaño del grupo según la fórmula de escalado automático. El valor predeterminado es 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch devuelve un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

autoScaleFormula

string

Fórmula para el número deseado de nodos de proceso en el grupo. Esta propiedad no se debe especificar si enableAutoScale está establecido en false. Es necesario si enableAutoScale está establecido en true. La fórmula se comprueba si hay validez antes de crear el grupo. Si la fórmula no es válida, el servicio Batch rechaza la solicitud con información de error detallada. Para más información sobre cómo especificar esta fórmula, consulte "Escalado automático de nodos de proceso en un grupo de Azure Batch" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

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.

enableAutoScale

boolean

Si el tamaño del grupo se debe ajustar automáticamente con el tiempo. Si es false, se debe especificar al menos uno de targetDedicatedNodes y targetLowPriorityNodes. Si es true, se requiere la propiedad autoScaleFormula y el grupo cambia automáticamente el tamaño según la fórmula. El valor predeterminado es false.

enableInterNodeCommunication

boolean

Si el grupo permite la comunicación directa entre nodos de proceso. Habilitar la comunicación entre nodos limita el tamaño máximo del grupo debido a restricciones de implementación en los nodos de proceso del grupo. Esto puede dar lugar a que el grupo no alcance su tamaño deseado. El valor predeterminado es false.

id

string

Cadena que identifica de forma única el grupo dentro de la cuenta. El identificador puede contener cualquier combinación de caracteres alfanuméricos, incluidos guiones y caracteres de subrayado, y no puede contener más de 64 caracteres. El identificador se conserva entre mayúsculas y minúsculas y no distingue mayúsculas de minúsculas (es decir, es posible que no tenga dos identificadores de grupo dentro de una cuenta que solo sea diferente por caso).

metadata

BatchMetadataItem[]

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.

mountConfiguration

MountConfiguration[]

Monte el almacenamiento utilizando el sistema de archivos especificado durante toda la vida útil del grupo. Monte el almacenamiento mediante el sistema de archivos basado en Azure fileshare, NFS, CIFS o Blobfuse.

networkConfiguration

NetworkConfiguration

Configuración de red para el grupo.

resizeTimeout

string (duration)

Tiempo de espera para la asignación de nodos de proceso al grupo. Este tiempo de espera solo se aplica al escalado manual; no tiene ningún efecto cuando enableAutoScale se establece en true. El valor predeterminado es 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).

startTask

BatchStartTask

Tarea especificada para ejecutarse en cada nodo de proceso a medida que se une al grupo. La tarea se ejecuta cuando se agrega el nodo de proceso al grupo o cuando se reinicia el nodo de proceso.

targetDedicatedNodes

integer (int32)

Número deseado de nodos de proceso dedicados en el grupo. Esta propiedad no debe especificarse si enableAutoScale está establecido en true. Si enableAutoScale se establece en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.

targetLowPriorityNodes

integer (int32)

Número deseado de nodos de proceso de prioridad baja o de acceso puntual en el grupo. Esta propiedad no debe especificarse si enableAutoScale está establecido en true. Si enableAutoScale se establece en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.

taskSchedulingPolicy

BatchTaskSchedulingPolicy

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

taskSlotsPerNode

integer (int32)

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.

upgradePolicy

UpgradePolicy

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

userAccounts

UserAccount[]

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

virtualMachineConfiguration

VirtualMachineConfiguration

Configuración de la máquina virtual para el grupo. Es necesario especificar esta propiedad.

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 para grupos mediante imágenes de Virtual Machines Marketplace (grupos creados con virtualMachineConfiguration), consulte Tamaños de máquinas virtuales en Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). 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).

BatchPoolEndpointConfiguration

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

Nombre Tipo Description
inboundNATPools

BatchInboundNatPool[]

Una lista de Pools de NAT entrantes que pueden usarse para direccionar puertos específicos en un Nodo de Cómputo individual externamente. El número máximo de pools de NAT entrantes por lote es 5. Si se supera el número máximo de pools de NAT entrantes, la solicitud falla con el código de estado HTTP 400. No se puede especificar si IPAddressProvisioningType es NoPublicIPAddresses.

BatchPoolIdentityReference

Referencia de una de las identidades de grupo para cifrar el disco. Esta identidad se usará para acceder al almacén de claves.

Nombre Tipo Description
resourceId

string (arm-id)

Identificador de recurso de ARM de la identidad asignada por el usuario. Esta referencia debe incluirse en las identidades del grupo.

BatchPublicIpAddressConfiguration

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

Nombre Tipo Description
ipAddressIds

string[] (arm-id)

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 prioridad baja o de acceso puntual 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}.

ipFamilies

IPFamily[]

Las familias de IP utilizadas para especificar las versiones de IP disponibles para el grupo. Las familias IP se utilizan para determinar grupos de pila única o doble. Para una sola pila, el valor esperado es IPv4. En el caso de la pila doble, los valores esperados son IPv4 e IPv6.

ipTags

IPTag[]

Una lista de etiquetas IP asociadas con las direcciones IP públicas del grupo. Las etiquetas IP se utilizan para categorizar y filtrar direcciones IP públicas con fines de facturación y administración.

provision

IpAddressProvisioningType

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

BatchStartTask

Batch volverá a intentar tareas cuando se desencadene una operación de recuperación en un nodo. Algunos ejemplos de operaciones de recuperación son (pero no están limitados a) cuando se reinicia un nodo incorrecto o un nodo de proceso desaparece debido a un error de host. Los reintentos debido a las operaciones de recuperación son independientes de y no se cuentan con maxTaskRetryCount. Incluso si maxTaskRetryCount es 0, puede producirse un reintento interno debido a una operación de recuperación. Por este motivo, todas las tareas deben ser idempotentes. Esto significa que las tareas deben tolerar que se interrumpan y se reinicien sin causar daños ni datos duplicados. El procedimiento recomendado para tareas de larga duración es usar algún tipo de punto de control. En algunos casos, startTask puede volver a ejecutarse aunque no se haya reiniciado el nodo de proceso. Se debe tener especial cuidado para evitar startTasks que creen servicios de interrupción o instalación o inicio desde el directorio de trabajo startTask, ya que esto impedirá que Batch pueda volver a ejecutar StartTask.

Nombre Tipo Description
commandLine

string

Línea de comandos de StartTask. 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. Si la línea de comandos hace referencia a rutas de acceso de archivo, debe usar una ruta de acceso relativa (relativa al directorio de trabajo de la tarea) o usar la variable de entorno proporcionada por Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

BatchTaskContainerSettings

La configuración del contenedor bajo el cual se ejecuta la Tarea de Iniciar. Cuando esto se especifica, todos los directorios recursivamente por debajo del AZ_BATCH_NODE_ROOT_DIR (la raíz de los directorios de Azure Batch en el nodo) se mapean en el contenedor, todas las variables del entorno de Tarea se mapean en el contenedor y la línea de comandos de Tarea se ejecuta en el contenedor. Los archivos producidos en el contenedor fuera de AZ_BATCH_NODE_ROOT_DIR pueden no reflejarse en el disco anfitrión, lo que significa que las APIs de archivos por lotes no podrán acceder a esos archivos.

environmentSettings

EnvironmentSetting[]

Lista de opciones de configuración de variables de entorno para StartTask.

maxTaskRetryCount

integer (int32)

Número máximo de veces que se puede reintentar la tarea. El servicio Batch vuelve a intentar 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, podrá 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, pero esto no se recomienda para una tarea de inicio ni para ninguna tarea. El valor predeterminado es 0 (sin reintentos).

resourceFiles

ResourceFile[]

Lista de archivos que el servicio Batch descargará en el nodo de proceso antes de ejecutar la línea de comandos. Hay un tamaño máximo para la lista de archivos de recursos. Cuando se supera el tamaño máximo, se producirá un error en la solicitud y el código de error de respuesta será RequestEntityTooLarge. Si esto ocurre, la colección de ResourceFiles debe reducirse en tamaño. Esto se puede lograr mediante archivos de .zip, paquetes de aplicación o contenedores de Docker. Los archivos enumerados en este elemento se encuentran en el directorio de trabajo de la tarea.

userIdentity

UserIdentity

La identidad de usuario bajo la cual se ejecuta la Tarea de Inicio. Si se omite, la tarea se ejecuta como un usuario no administrativo único de la tarea.

waitForSuccess

boolean

Si el servicio Batch debe esperar a que StartTask se complete correctamente (es decir, salir con el código de salida 0) antes de programar cualquier tarea en el nodo de proceso. Si es true y StartTask se produce un error en un nodo, el servicio Batch reintenta startTask hasta su número 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 inutilizable y no programará tareas en él. Esta condición se puede detectar a través del estado del nodo de proceso y los detalles de información de error. Si es false, el servicio Batch no esperará a que se complete StartTask. En este caso, otras tareas pueden empezar a ejecutarse en el nodo de proceso mientras startTask todavía se está ejecutando; e incluso si se produce un error en StartTask, las nuevas tareas seguirán programando en el nodo de proceso. El valor predeterminado es true.

BatchTaskContainerSettings

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

La imagen que se usará para crear el contenedor en el que se ejecutará la tarea. Esta es la referencia completa de Image, tal 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 predeterminada.

registry

ContainerRegistryReference

El registro privado que contiene la imagen del contenedor. Esta configuración puede omitirse si ya se proporcionó en la creación del Pool.

workingDirectory

ContainerWorkingDirectory

La ubicación del directorio de trabajo de tareas del contenedor. El valor predeterminado es "taskWorkingDirectory".

BatchTaskSchedulingPolicy

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

Nombre Tipo Valor predeterminado Description
jobDefaultOrder

BatchJobDefaultOrder

none

El orden para programar tareas de diferentes trabajos con la misma prioridad. Si no se especifica, el valor predeterminado es ninguno.

nodeFillType

BatchNodeFillType

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

BatchUefiSettings

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.

BatchVmDiskSecurityProfile

Especifica la configuración del perfil de seguridad para el disco administrado. Nota: Solo se puede configurar para máquinas virtuales confidenciales y es necesario cuando se utilizan 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 configurar para máquinas virtuales confidenciales y es necesario cuando se utilizan máquinas virtuales confidenciales.

BatchVmImageReference

Referencia a una imagen de Marketplace de Azure Virtual Machines o a una imagen de Azure Compute Gallery. Para obtener la lista de todas las referencias de imágenes de Azure Marketplace verificadas por Azure Batch, consulte la operación "Enumerar imágenes admitidas".

Nombre Tipo Description
communityGalleryImageId

string

La imagen de la galería comunitaria identifica únicamente. 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.

exactVersion

string

La versión específica de la imagen de plataforma o de marketplace utilizada para crear el nodo. Este campo de solo lectura difiere de 'versión' solo si el valor especificado para 'versión' cuando se creó el pool era 'más reciente'.

offer

string

El tipo de oferta de la imagen Azure Virtual Machines Marketplace. Por ejemplo, UbuntuServer o WindowsServer.

publisher

string

El editor de la imagen Azure Virtual Machines Marketplace. Por ejemplo, Canonical o MicrosoftWindowsServer.

sharedGalleryImageId

string

Identificador único de la imagen de 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

El SKU de la imagen Azure Virtual Machines Marketplace. Por ejemplo, 18.04-LTS o 2019-Datacenter.

version

string

La versión de la Imagen del Marketplace de Máquinas Virtuales de Azure. Se puede especificar un valor de 'más reciente' para seleccionar la última versión de una Imagen. Si se omite, el valor predeterminado es "latest".

virtualMachineImageId

string (arm-id)

Identificador de recursos de ARM de la imagen de Azure Compute Gallery. Los nodos de cómputo en el Pool se crearán usando este ID de Imagen. Esto es del tipo /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} o /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para siempre usar por defecto la última versión de la imagen. Esta propiedad es mutuamente excluyente con otras propiedades de ImageReference. La Imagen de la Galería de Computación de Azure debe tener réplicas en la misma región y debe estar en la misma suscripción que la cuenta de lotes de Azure. Si la versión de la imagen no se especifica en el imageId, se utilizará la versión más reciente. Para información sobre la configuración del cortafuegos del agente del Nodo de Cómputo por Lotes para comunicarse con el servicio por lotes, véase https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

CachingType

Enums CachingType

Valor Description
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.

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 (password)

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

relativeMountPath

string

El camino relativo en el nodo de cómputo 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.

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.

Valor Description
Shared

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

Startup

Ruta de acceso para la tarea de inicio.

VfsMounts

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

Task

Ruta de acceso de la tarea.

JobPrep

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

Applications

Ruta de acceso de las aplicaciones.

ContainerRegistryReference

Un registro de contenedor privado.

Nombre Tipo Description
identityReference

BatchNodeIdentityReference

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.

password

string (password)

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

registryServer

string (uri)

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

Enums ContainerType

Valor Description
dockerCompatible

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

criCompatible

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

ContainerWorkingDirectory

ContainerWorkingDirectory enums

Valor Description
taskWorkingDirectory

Utiliza el directorio estándar de trabajo de tareas de servicio por lotes, que contendrá los archivos de recursos de la tarea rellenados por lote.

containerImageDefault

Utiliza el directorio de trabajo definido en la imagen del contenedor. Ten en cuenta que este directorio no contendrá los archivos de recursos descargados 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. El valor predeterminado para el almacenamiento en caché es readwrite. 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 (int32)

Tamaño inicial del disco en gigabytes.

lun

integer (int32)

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

managedDisk

ManagedDisk

Parámetros de disco administrado.

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

DiffDiskPlacement

Especifica la ubicación efímera del disco del sistema operativo para todos los nodos de cómputo (VMs) del pool. 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 más información sobre los requisitos de tamaño de disco de Ephemeral OS, consulte los requisitos de tamaño de disco de Ephemeral OS para máquinas virtuales de Windows en https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements y para máquinas virtuales de Linux en https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

Valor Description
cachedisk

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

DiskCustomerManagedKey

La referencia de clave administrada por el cliente para cifrar el disco.

Nombre Tipo Description
identityReference

BatchPoolIdentityReference

Referencia de una de las identidades de grupo para cifrar el disco. Esta identidad se usará para acceder a KeyVault.

keyUrl

string

Dirección URL de clave totalmente versionada que apunta a una clave en KeyVault. El segmento de versión de la dirección URL es necesario independientemente del valor rotationToLatestKeyVersionEnabled.

rotationToLatestKeyVersionEnabled

boolean

Establezca esta marca en true para habilitar la actualización automática de Disk Encryption a la última versión de clave. El valor predeterminado es False.

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 Azure Compute Gallery.

Nombre Tipo Description
customerManagedKey

DiskCustomerManagedKey

La referencia de clave administrada por el cliente para cifrar el disco del sistema operativo. La clave administrada por el cliente cifrará el disco del sistema operativo mediante EncryptionAtRest y, de forma predeterminada, también cifraremos el disco de datos. Solo se puede usar cuando el grupo está configurado con una identidad y OsDisk está establecido como uno de los destinos de DiskEncryption.

targets

DiskEncryptionTarget[]

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

DiskEncryptionSetParameters

El identificador de recurso de ARM del conjunto de cifrado de disco.

Nombre Tipo Description
id

string (arm-id)

El identificador de recurso de ARM del conjunto de cifrado de disco. El recurso debe estar en la misma suscripción que la cuenta de Batch.

DiskEncryptionTarget

Enums DiskEncryptionTarget

Valor Description
osdisk

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

temporarydisk

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

DynamicVNetAssignmentScope enums

Valor Description
none

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

job

La asignación de red virtual dinámica se realiza por trabajo.

ElevationLevel

Enums de ElevationLevel

Valor Description
nonadmin

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

admin

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

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.

HostEndpointSettings

Especifica una configuración de extremo de host determinada.

Nombre Tipo Description
inVMAccessControlProfileReferenceId

string

Especifica la referencia al identificador de recurso InVMAccessControlProfileVersion en forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}.

mode

HostEndpointSettingsModeTypes

Especifica el modo de ejecución de la directiva de control de acceso.

HostEndpointSettingsModeTypes

HostEndpointSettingsModeTypes enums

Valor Description
Audit

En el modo auditoría, el sistema actúa como si aplicara la directiva de control de acceso, incluida la emisión de entradas de denegación de acceso en los registros, pero no deniega realmente ninguna solicitud a los puntos de conexión de host.

Enforce

El modo de aplicación es el modo de operación recomendado y el sistema hará cumplir la política de control de acceso. Esta propiedad no puede usarse junto con 'inVMAccessControlControlProfileReferenceId'.

InboundEndpointProtocol

InboundEndpointProtocol enums

Valor Description
tcp

Use TCP para el punto de conexión.

udp

Use UDP para el punto de conexión.

IpAddressProvisioningType

IPAddressProvisioningType enums

Valor Description
batchmanaged

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.

usermanaged

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

nopublicipaddresses

No se creará ninguna dirección IP pública.

IPFamily

Las familias de IP utilizadas para especificar las versiones de IP disponibles para el grupo.

Valor Description
IPv4

IPv4 está disponible para el pool.

IPv6

IPv6 está disponible para el pool.

IPTag

Contiene la etiqueta IP asociada a la dirección IP pública.

Nombre Tipo Description
ipTagType

string

El tipo de etiqueta IP. Ejemplo: FirstPartyUsage.

tag

string

Valor de la etiqueta IP asociada a la dirección IP pública. Ejemplo: SQL.

LinuxUserConfiguration

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

Nombre Tipo Description
gid

integer (int32)

El ID del grupo para 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 (password)

La clave privada SSH para la cuenta de usuario. La clave privada no debe estar protegida con contraseña. La clave privada se utiliza para configurar automáticamente la autenticación basada en clave asimétrica para SSH entre Nodos de Cálculo en un Pool Linux cuando la propiedad enableInterNodeCommunication del Pool es cierta (se ignora si enableInterNodeCommunication es falsa). Para ello, coloca el par de claves en el directorio .ssh del usuario. Si no se especifica, el SSH sin contraseña no está configurado entre los Nodos de Cómputo (no se modifica el directorio .ssh del usuario).

uid

integer (int32)

El ID 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

Enums de LoginMode

Valor Description
batch

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

El modo de inicio de sesión de Win32 LOGON32_LOGON_INTERACTIVE. UAC está habilitado en los pools de configuración de máquinas virtuales de Windows. Si esta opción se utiliza con una identidad de usuario elevada en un Pool de Configuración de Máquina VirtualMáquina de Windows, la sesión de usuario no se elevará a menos que la aplicación ejecutada por la línea de comandos de Tarea esté configurada para requerir siempre privilegio de administrador o para requerir siempre privilegio máximo.

ManagedDisk

Parámetros de disco administrado.

Nombre Tipo Description
diskEncryptionSet

DiskEncryptionSetParameters

Especifica el identificador de recurso del conjunto de cifrado de disco administrado del cliente para el disco administrado. Solo se puede establecer en el modo UserSubscription.

securityProfile

BatchVmDiskSecurityProfile

Especifica la configuración del perfil de seguridad para el disco administrado.

storageAccountType

StorageAccountType

Tipo de cuenta de almacenamiento para el disco administrado.

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 Description
dynamicVNetAssignmentScope

DynamicVNetAssignmentScope

Á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

BatchPoolEndpointConfiguration

La configuración para los endpoints en los Nodos de Cómputo en el Batch Pool.

publicIPAddressConfiguration

BatchPublicIpAddressConfiguration

Configuración de IP PúblicaAddress para nodos de proceso en el grupo de lotes.

subnetId

string

El identificador de recurso ARM de la subred de red virtual a la que se unirán los Nodos de Cómputo del Pool. 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 acomodar el número de Nodos de Cómputo en el Pool. Si la subred no tiene suficientes direcciones IP libres, el Pool asignará parcialmente nodos y se producirá un error de redimensionamiento. 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 Batch de Azure para poder programar tareas en los Nodos. Para comprobarlo, compruebe si la red virtual especificada tiene algún grupo de seguridad de red (NSG) asociado. Si una NSG deniega la comunicación con los nodos de la subred especificada, el servicio Batch establecerá el estado de los nodos de proceso en inutilizables. Solo se soportan redes virtuales ARM ('Microsoft.Network/virtualNetworks'). Si el VNet especificado tiene algún Grupo de Seguridad de Red (NSG) asociado, entonces se deben habilitar algunos puertos reservados para la comunicación entrante, incluyendo 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://learn.microsoft.com/azure/batch/nodes-and-pools#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 (int32)

Prioridad de esta regla. Las prioridades dentro de un grupo deben ser únicas y evaluarse 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), un puerto específico (es decir, 22) o un rango de puertos (es decir, 100-200). Los puertos deben estar en el rango de 0 a 65535. Cada entrada de esta colección no debe solaparse con ninguna otra entrada (ni un rango ni un puerto individual). Si se proporcionan otros valores, la solicitud falla con el código de estado HTTP 400. El valor predeterminado es ''.

NetworkSecurityGroupRuleAccess

NetworkSecurityGroupRuleAccess enums

Valor Description
allow

Permitir el acceso.

deny

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

El camino relativo en el nodo de cómputo 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.

ProxyAgentSettings

Especifica la configuración de ProxyAgent al crear la máquina virtual.

Nombre Tipo Description
enabled

boolean

Especifica si la característica Protocolo de seguridad de metadatos debe habilitarse en la máquina virtual o en el conjunto de escalado de máquinas virtuales. El valor predeterminado es False.

imds

HostEndpointSettings

Configuración para el punto de conexión de IMDS.

wireServer

HostEndpointSettings

Configuración del punto de conexión de WireServer.

ResourceFile

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

Nombre Tipo Description
autoStorageContainerName

string

El nombre del contenedor de almacenamiento está en la cuenta de almacenamiento automático. 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 se aplica únicamente a archivos que se descargan en nodos de cómputo de Linux. Se ignorará si se especifica para un archivo de recurso que se descargará en un Nodo de Cómputo de Windows. Si esta propiedad no se especifica para un nodo de cálculo de Linux, entonces se aplica un valor por defecto de 0770 al archivo.

filePath

string

La ubicación en el Nodo de Cómputo donde descargar el(los) archivo(s), 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 relativa especificada no puede salir del directorio de trabajo de la Tarea (por ejemplo, usando '..').

httpUrl

string (uri)

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

BatchNodeIdentityReference

La referencia a la identidad asignada por el usuario para acceder a Azure Blob Storage especificada por storageContainerUrl o httpUrl.

storageContainerUrl

string (uri)

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. Este campo solo se puede establecer en true o false cuando se usa NodePlacementConfiguration como zonal.

maxBatchInstancePercent

integer (int32)

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 (int32)

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 (int32)

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 (duration)

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.

SecurityEncryptionTypes

Enums de SecurityEncryptionTypes

Valor Description
DiskWithVMGuestState

EncryptionType del disco administrado se establece en DiskWithVMGuestState para el cifrado del disco administrado junto con el blob VMGuestState. No está soportado en discos de datos.

NonPersistedTPM

EncryptionType del disco administrado se establece en NonPersistedTPM para no conservar el estado del firmware en el blob VMGuestState.

VMGuestStateOnly

EncryptionType del disco administrado se establece en VMGuestStateOnly para el cifrado solo del blob VMGuestState.

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. Para obtener más información sobre el cifrado en los requisitos de host, consulte https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.

proxyAgentSettings

ProxyAgentSettings

Especifica la configuración de ProxyAgent al crear la máquina virtual.

securityType

SecurityTypes

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

uefiSettings

BatchUefiSettings

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.

Valor Description
trustedLaunch

El inicio seguro protege frente a técnicas de ataque persistentes y avanzadas.

confidentialvm

La informática confidencial de Azure ofrece máquinas virtuales confidenciales para los inquilinos con requisitos de alta seguridad y confidencialidad. Estas VM proporcionan un límite sólidos reforzado por hardware para 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.

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

El ID de referencia de 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}

StorageAccountType

Enumeraciones de StorageAccountType

Valor Description
standard_lrs

El disco de datos debe usar almacenamiento estándar con redundancia local.

premium_lrs

El disco de datos debe usar almacenamiento premium con redundancia local.

standardssd_lrs

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

UpgradeMode

Enums de UpgradeMode

Valor Description
automatic

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

manual

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

rolling

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.

UserAccount

Propiedades usadas para crear un usuario que se usa para ejecutar tareas en un nodo de proceso de Azure Batch.

Nombre Tipo Description
elevationLevel

ElevationLevel

El nivel de elevación de la cuenta de usuario. El valor predeterminado es nonAdmin.

linuxUserConfiguration

LinuxUserConfiguration

La configuración de usuario específica de Linux para la cuenta de usuario. Esta propiedad se ignora si se especifica en un Windows Pool. Si no se especifica, el usuario se crea con las opciones predeterminadas.

name

string

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

password

string (password)

La contraseña de la cuenta de usuario.

windowsUserConfiguration

WindowsUserConfiguration

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

UserIdentity

Definición de la identidad de usuario en la que se ejecuta la tarea. Especifique la propiedad userName o autoUser, pero no ambas.

Nombre Tipo Description
autoUser

AutoUserSpecification

El usuario automático bajo el cual se ejecuta la Tarea. Las propiedades userName y autoUser son mutuamente excluyentes; debe especificar uno pero no ambos.

username

string

El nombre de la identidad de usuario bajo la cual 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

BatchContainerConfiguration

La configuración del contenedor para el Pool. Si se especifica, la configuración se realiza en cada Nodo de Cómputo del Pool para permitir que las tareas se ejecuten en contenedores. Todas las tareas normales y las tareas del gestor de trabajos que se ejecutan en este Pool deben especificar la propiedad containerSettings, y todas las demás tareas pueden especificarla.

dataDisks

DataDisk[]

La configuración para los discos de datos conectados a los Nodos de Cómputo en el Pool. Esta propiedad debe especificarse si los Nodos de Cómputo en el Pool necesitan tener discos de datos vacíos conectados a ellos. No se puede actualizar. Cada Nodo de Cómputo tiene su propio disco (el disco no es un recurso compartido de archivos). No se pueden conectar discos existentes, cada disco conectado está vacío. Cuando el Nodo de Cómputo se elimina del Pool, el disco y todos los datos asociados a él también se eliminan. El disco no se formatea después de ser conectado, debe ser formateado antes de su uso; para más información, véase https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux y https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

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

BatchVmImageReference

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

Esto solo se aplica a las Imágenes que contienen el sistema operativo Windows, y solo debe usarse cuando tengas licencias válidas locales para los Nodos de Cómputo que se desplegará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 proceso por lotes que se va a aprovisionar en los nodos de proceso del grupo. El agente de Batch Compute Node es un programa que se ejecuta en cada nodo de proceso del grupo y proporciona la interfaz de comando y control entre el nodo de proceso y el servicio Batch. Hay diferentes implementaciones del agente de Nodo de proceso, conocidas como SKU, para diferentes sistemas operativos. Debe especificar una SKU del agente de nodo de proceso que coincida con la referencia de imagen seleccionada. Para obtener la lista de SKU de agente de nodo de proceso compatibles junto con su lista de referencias de imágenes comprobadas, consulte la operación "Enumerar SKU de agente de nodo de proceso compatibles".

nodePlacementConfiguration

BatchNodePlacementConfiguration

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

BatchOsDisk

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

securityProfile

SecurityProfile

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 debe especificarse si la propiedad imageReference especifica una imagen del sistema operativo de Linux.

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

El tipo de extensión.

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 proceso de Windows.

Nombre Tipo Description
loginMode

LoginMode

El modo de inicio de sesión para el usuario. El valor predeterminado es 'batch'.