Partilhar via


Pools - Create Pool

Cria um Pool para a Conta especificada.
Ao nomear Pools, evite incluir informações confidenciais, como nomes de usuários ou nomes de projetos secretos. Essas informações podem aparecer em logs de telemetria acessíveis aos engenheiros de suporte da Microsoft.

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

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string (uri)

Ponto de extremidade da conta em lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

timeOut
query

integer (int32)

O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for superior a 30, será usado o padrão em vez disso.".

Cabeçalho do Pedido

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

Name Necessário Tipo Description
client-request-id

string

A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Se o servidor deve retornar o client-request-id na resposta.

ocp-date

string (date-time-rfc7231)

A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Corpo do Pedido

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

Name Necessário Tipo Description
id True

string

Uma cadeia de caracteres que identifica exclusivamente o Pool dentro da Conta. O ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes e sublinhados, e não pode conter mais de 64 caracteres. O ID preserva maiúsculas e minúsculas e não diferencia maiúsculas de minúsculas (ou seja, você não pode ter dois IDs de Pool em uma Conta que diferem apenas por maiúsculas e minúsculas).

vmSize True

string

O tamanho das máquinas virtuais no Pool. Todas as máquinas virtuais em um Pool têm o mesmo tamanho. Para obter informações sobre tamanhos de VM disponíveis para pools usando imagens do Virtual Machines Marketplace (pools criados com virtualMachineConfiguration), consulte Tamanhos para máquinas virtuais no Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). O Batch dá suporte a todos os tamanhos de VM do Azure, exceto STANDARD_A0 e aqueles com armazenamento premium (STANDARD_GS, STANDARD_DS e STANDARD_DSV2 séries).

applicationPackageReferences

BatchApplicationPackageReference[]

A lista de pacotes a serem instalados em cada nó de computação no pool. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). As alterações nas referências de Pacote afetam todos os novos Nós que ingressam no Pool, mas não afetam os Nós de Computação que já estão no Pool até que sejam reinicializados ou recriados com imagem. Há um máximo de 10 referências de pacote em qualquer pool.

autoScaleEvaluationInterval

string (duration)

O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático. O valor padrão é 15 minutos. O valor mínimo e máximo são de 5 minutos e 168 horas, respectivamente. Se você especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço em lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta).

autoScaleFormula

string

Uma fórmula para o número desejado de nós de computação no pool. Essa propriedade não deve ser especificada se enableAutoScale estiver definido como false. É necessário se enableAutoScale estiver definido como true. A validade da fórmula é verificada antes da criação do Pool. Se a fórmula não for válida, o serviço Lote rejeitará a solicitação com informações de erro detalhadas. Para obter mais informações sobre como especificar essa fórmula, consulte 'Dimensionar automaticamente nós de computação em um pool de lotes do Azure' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

displayName

string

O nome para exibição do Pool. O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.

enableAutoScale

boolean

Se o tamanho do Pool deve ser ajustado automaticamente ao longo do tempo. Se false, pelo menos um dos targetDedicatedNodes e targetLowPriorityNodes deve ser especificado. Se true, a propriedade autoScaleFormula é necessária e o Pool é redimensionado automaticamente de acordo com a fórmula. O valor predefinido é false.

enableInterNodeCommunication

boolean

Se o Pool permite a comunicação direta entre nós de computação. Habilitar a comunicação entre nós limita o tamanho máximo do Pool devido a restrições de implantação nos Nós de Computação do Pool. Isto pode fazer com que a Piscina não atinja o tamanho desejado. O valor predefinido é false.

metadata

BatchMetadataItem[]

Uma lista de pares nome-valor associados ao Pool como metadados. O serviço Batch não atribui qualquer significado aos metadados; é exclusivamente para o uso do código de usuário.

mountConfiguration

MountConfiguration[]

Monte o armazenamento usando o sistema de arquivos especificado durante toda a vida útil do pool. Monte o armazenamento usando o sistema de arquivos baseado em compartilhamento de arquivos, NFS, CIFS ou Blobfuse do Azure.

networkConfiguration

NetworkConfiguration

A configuração de rede para o Pool.

resizeTimeout

string (duration)

O tempo limite para alocação de nós de computação para o pool. Este tempo limite aplica-se apenas ao dimensionamento manual; ele não tem efeito quando enableAutoScale é definido como true. O valor padrão é 15 minutos. O valor mínimo é de 5 minutos. Se você especificar um valor inferior a 5 minutos, o serviço de lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta).

startTask

BatchStartTask

Uma Tarefa especificada para ser executada em cada Nó de Computação à medida que se junta ao Pool. A Tarefa é executada quando o Nó de Computação é adicionado ao Pool ou quando o Nó de Computação é reiniciado.

targetDedicatedNodes

integer (int32)

O número desejado de nós de computação dedicados no pool. Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale estiver definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes, ou ambos.

targetLowPriorityNodes

integer (int32)

O número desejado de nós de computação spot/de baixa prioridade no pool. Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale estiver definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes, ou ambos.

taskSchedulingPolicy

BatchTaskSchedulingPolicy

Como as tarefas são distribuídas entre nós de computação em um pool. Se não for especificado, o padrão será spread.

taskSlotsPerNode

integer (int32)

O número de slots de tarefas que podem ser usados para executar tarefas simultâneas em um único nó de computação no pool. O valor padrão é 1. O valor máximo é o menor de 4 vezes o número de núcleos do vmSize do pool ou 256.

upgradePolicy

UpgradePolicy

A política de atualização para o Pool. Descreve uma política de atualização - automática, manual ou rolante.

userAccounts

UserAccount[]

A lista de Contas de usuário a serem criadas em cada Nó de Computação no Pool.

virtualMachineConfiguration

VirtualMachineConfiguration

A configuração da máquina virtual para o Pool. Esta propriedade deve ser especificada.

Respostas

Name Tipo Description
201 Created

O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.

Cabeçalhos

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

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

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

Exemplos

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

Pedido de amostra

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
  }
}

Resposta da amostra

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

Pedido de amostra

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
}

Resposta da amostra

Creates a pool with disk encryption set for user subscription accounts

Pedido de amostra

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
}

Resposta da amostra

Creates a pool with dual stack networking

Pedido de amostra

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
}

Resposta da amostra

Creates a pool with mount drive specified

Pedido de amostra

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
}

Resposta da amostra

Creates a pool with SecurityProfile

Pedido de amostra

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
}

Resposta da amostra

Creates a VirtualMachineConfiguration pool

Pedido de amostra

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"
    }
  ]
}

Resposta da amostra

Creates a VirtualMachineConfiguration pool with containers

Pedido de amostra

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
}

Resposta da amostra

Creates a VirtualMachineConfiguration pool with extensions

Pedido de amostra

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"
    }
  ]
}

Resposta da amostra

Creates a VirtualMachineConfiguration pool with OS disk

Pedido de amostra

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
}

Resposta da amostra

Creates a VirtualMachineConfiguration pool with ServiceArtifactReference

Pedido de amostra

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
}

Resposta da amostra

Definições

Name Description
AutomaticOsUpgradePolicy

Os parâmetros de configuração usados para executar a atualização automática do sistema operacional.

AutoUserScope

Enums AutoUserScope

AutoUserSpecification

Especifica as opções para o usuário automático que executa uma Tarefa em Lote do Azure.

AzureBlobFileSystemConfiguration

Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando Blobfuse.

AzureFileShareConfiguration

Informações usadas para se conectar a um compartilhamento de arquivos do Azure.

BatchApplicationPackageReference

Uma referência a um pacote a ser implantado em nós de computação.

BatchContainerConfiguration

A configuração para pools habilitados para contêiner.

BatchDiffDiskSettings

Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pelo nó de computação (VM).

BatchError

Uma resposta de erro recebida do serviço Batch do Azure.

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

BatchErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

BatchInboundNatPool

Um pool NAT de entrada que pode ser usado para endereçar portas específicas em nós de computação em um pool de lotes externamente.

BatchJobDefaultOrder

BatchJobDefaultOrder enums

BatchMetadataItem

O serviço Batch não atribui qualquer significado a estes metadados; é exclusivamente para o uso do código de usuário.

BatchNodeFillType

Enums BatchNodeFillType

BatchNodeIdentityReference

A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.

BatchNodePlacementConfiguration

Para posicionamento regional, os nós no pool serão alocados na mesma região. Para o posicionamento zonal, os nós no pool serão distribuídos por diferentes zonas com o melhor balanceamento de esforço.

BatchNodePlacementPolicyType

Enums BatchNodePlacementPolicyType

BatchOsDisk

Configurações para o disco do sistema operacional do nó de computação (VM).

BatchPoolCreateOptions

Parâmetros para criar um Pool de Lotes do Azure.

BatchPoolEndpointConfiguration

A configuração do ponto de extremidade para um Pool.

BatchPoolIdentityReference

A referência de uma das identidades do pool para criptografar o disco. Essa identidade será usada para acessar o cofre de chaves.

BatchPublicIpAddressConfiguration

A configuração de endereço IP público da configuração de rede de um pool.

BatchStartTask

O lote tentará novamente Tarefas quando uma operação de recuperação for acionada em um nó. Exemplos de operações de recuperação incluem (mas não estão limitados a) quando um nó não íntegro é reinicializado ou um nó de computação desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode ocorrer uma nova tentativa interna devido a uma operação de recuperação. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente mesmo que o nó de computação não tenha sido reinicializado. Cuidado especial deve ser tomado para evitar StartTasks que criam processos separatistas ou instalam/iniciam serviços a partir do diretório de trabalho StartTask, pois isso impedirá que o Batch possa executar novamente o StartTask.

BatchTaskContainerSettings

As configurações de contêiner para uma Tarefa.

BatchTaskSchedulingPolicy

Especifica como as tarefas devem ser distribuídas entre nós de computação.

BatchUefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual.

BatchVmDiskSecurityProfile

Especifica as configurações de perfil de segurança para o disco gerenciado. Nota: Ele só pode ser definido para VMs confidenciais e necessário ao usar VMs confidenciais.

BatchVmImageReference

Uma referência a uma Imagem do Azure Virtual Machines Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas pelo Azure Batch, consulte a operação ' Listar Imagens Suportadas '.

CachingType

Enums CachingType

CifsMountConfiguration

Informações usadas para se conectar a um sistema de arquivos CIFS.

ContainerHostBatchBindMountEntry

A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.

ContainerHostDataPath

Os caminhos que serão montados no contêiner da tarefa do contêiner.

ContainerRegistryReference

Um registro de contêiner privado.

ContainerType

Enums ContainerType

ContainerWorkingDirectory

ContainerWorkingDirectory enums

DataDisk

Configurações que serão usadas pelos discos de dados associados aos nós de computação no pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los.

DiffDiskPlacement

Especifica a colocação efémera do disco do sistema operativo para todos os nós de computação (VMs) do pool. Essa propriedade pode ser usada pelo usuário na solicitação para escolher em qual local o sistema operacional deve estar. por exemplo, espaço em disco de cache para provisionamento de disco do sistema operacional efêmero. Para mais informações sobre os requisitos de tamanho do disco do Sistema Operacional Efémero, consulte os requisitos de tamanho do disco do Sistema Operacional Efemérico para VMs Windows em https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs Linux em https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

DiskCustomerManagedKey

A referência de chave gerenciada pelo cliente para criptografar o disco.

DiskEncryptionConfiguration

A configuração de criptografia de disco aplicada em nós de computação no pool. A configuração de criptografia de disco não é suportada no pool Linux criado com a Imagem da Galeria de Computação do Azure.

DiskEncryptionSetParameters

A ID do recurso ARM do conjunto de criptografia de disco.

DiskEncryptionTarget

Enums DiskEncryptionTarget

DynamicVNetAssignmentScope

DynamicVNetAssignmentScope enums

ElevationLevel

Enums ElevationLevel

EnvironmentSetting

Uma variável de ambiente a ser definida em um processo Task.

HostEndpointSettings

Especifica configurações específicas do ponto de extremidade do host.

HostEndpointSettingsModeTypes

HostEndpointSettingsModeTypes enums

InboundEndpointProtocol

InboundEndpointProtocol enums

IpAddressProvisioningType

IPAddressProvisioningType enums

IPFamily

As famílias IP usadas para especificar as versões IP disponíveis para o pool.

IPTag

Contém a marca IP associada ao endereço IP público.

LinuxUserConfiguration

Propriedades usadas para criar uma conta de usuário em um nó de computação Linux.

LoginMode

LoginMode enums

ManagedDisk

Os parâmetros do disco gerenciado.

MountConfiguration

O sistema de arquivos a ser montado em cada nó.

NetworkConfiguration

A configuração de rede para um Pool.

NetworkSecurityGroupRule

Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada.

NetworkSecurityGroupRuleAccess

NetworkSecurityGroupRuleAccess enums

NfsMountConfiguration

Informações usadas para se conectar a um sistema de arquivos NFS.

ProxyAgentSettings

Especifica as configurações do ProxyAgent ao criar a máquina virtual.

ResourceFile

Um único arquivo ou vários arquivos a serem baixados para um nó de computação.

RollingUpgradePolicy

Os parâmetros de configuração usados durante a execução de uma atualização contínua.

SecurityEncryptionTypes

SecurityEncryptionTypes enums

SecurityProfile

Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquina virtual.

SecurityTypes

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings.

ServiceArtifactReference

Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de escala ao usar a versão de imagem 'mais recente'.

StorageAccountType

Enums StorageAccountType

UpgradeMode

Enums UpgradeMode

UpgradePolicy

Descreve uma política de atualização - automática, manual ou rolante.

UserAccount

Propriedades usadas para criar um usuário usado para executar Tarefas em um Nó de Computação em Lote do Azure.

UserIdentity

A definição da identidade do usuário sob a qual a Tarefa é executada. Especifique a propriedade userName ou autoUser, mas não ambas.

VirtualMachineConfiguration

A configuração para nós de computação em um pool com base na infraestrutura de máquinas virtuais do Azure.

VMExtension

A configuração para extensões de máquina virtual.

WindowsConfiguration

Configurações do sistema operacional Windows a serem aplicadas à máquina virtual.

WindowsUserConfiguration

Propriedades usadas para criar uma conta de usuário em um nó de computação do Windows.

AutomaticOsUpgradePolicy

Os parâmetros de configuração usados para executar a atualização automática do sistema operacional.

Name Tipo Description
disableAutomaticRollback

boolean

Se o recurso de reversão de imagem do sistema operacional deve ser desativado.

enableAutomaticOSUpgrade

boolean

Indica se as atualizações do sistema operacional devem ser aplicadas automaticamente para dimensionar instâncias do conjunto de forma contínua quando uma versão mais recente da imagem do sistema operacional estiver disponível.

Se isso for definido como true para pools baseados no Windows, WindowsConfiguration.enableAutomaticUpdates não pode ser definido como true.

osRollingUpgradeDeferral

boolean

Adie as atualizações do sistema operacional nos TVMs se eles estiverem executando tarefas.

useRollingUpgradePolicy

boolean

Indica se a política de atualização contínua deve ser usada durante a Atualização Automática do SO. A Atualização Automática do SO retornará à política padrão se nenhuma política for definida no VMSS.

AutoUserScope

Enums AutoUserScope

Valor Description
task

Especifica que o serviço deve criar um novo utilizador para a Tarefa.

pool

Especifica que a Tarefa corre como a Conta de utilizador automática comum, criada em cada Nó de Computação de um Pool.

AutoUserSpecification

Especifica as opções para o usuário automático que executa uma Tarefa em Lote do Azure.

Name Tipo Description
elevationLevel

ElevationLevel

O nível de elevação do usuário automático. O valor padrão é nonAdmin.

scope

AutoUserScope

O escopo para o usuário automático. O valor padrão é pool. Se o pool estiver executando o Windows, um valor de Task deverá ser especificado se for necessário um isolamento mais rigoroso entre as tarefas. Por exemplo, se a tarefa muta o registro de uma forma que pode afetar outras tarefas.

AzureBlobFileSystemConfiguration

Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando Blobfuse.

Name Tipo Description
accountKey

string (password)

A chave da Conta de Armazenamento do Azure. Esta propriedade é mutuamente exclusiva com sasKey e identidade; exatamente um deve ser especificado.

accountName

string

O nome da Conta de Armazenamento do Azure.

blobfuseOptions

string

Opções de linha de comando adicionais para passar para o comando mount. Estas são opções de 'net use' no Windows e opções de 'mount' no Linux.

containerName

string

O nome do Contêiner de Armazenamento de Blob do Azure.

identityReference

BatchNodeIdentityReference

A referência à identidade atribuída pelo utilizador para aceder a ContainerName. Esta propriedade é mutuamente exclusiva com accountKey e sasKey; exatamente um deve ser especificado.

relativeMountPath

string

O caminho relativo no nó de computação onde o sistema de ficheiros será montado. Todos os sistemas de arquivos são montados em relação ao diretório Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

sasKey

string (password)

O token SAS do Armazenamento do Azure. Esta propriedade é mutuamente exclusiva com accountKey e identity; exatamente um deve ser especificado.

AzureFileShareConfiguration

Informações usadas para se conectar a um compartilhamento de arquivos do Azure.

Name Tipo Description
accountKey

string (password)

A chave da conta do Armazenamento do Azure.

accountName

string

O nome da conta de Armazenamento do Azure.

azureFileUrl

string (uri)

A URL dos Arquivos do Azure. Este é o formato 'https://{account}.file.core.windows.net/'.

mountOptions

string

Opções de linha de comando adicionais para passar para o comando mount. Estas são opções de 'net use' no Windows e opções de 'mount' no Linux.

relativeMountPath

string

O caminho relativo no nó de computação onde o sistema de ficheiros será montado. Todos os sistemas de arquivos são montados em relação ao diretório Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

BatchApplicationPackageReference

Uma referência a um pacote a ser implantado em nós de computação.

Name Tipo Description
applicationId

string

O ID da aplicação a implementar. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada. Se isto for omitido num Pool e não for especificada uma versão padrão para esta aplicação, o pedido falha com o código de erro InvalidApplicationPackageReferences e o código de estado HTTP 409. Se isto for omitido numa Tarefa, e não for especificada uma versão padrão para esta aplicação, a Tarefa falha com um erro de pré-processamento.

BatchContainerConfiguration

A configuração para pools habilitados para contêiner.

Name Tipo Description
containerImageNames

string[]

A coleção de nomes de imagens de contentores. Esta é a referência completa da Imagem, conforme especificado para "docker pull". Uma Imagem será obtida a partir do registo Docker padrão, a menos que a Imagem esteja totalmente qualificada com um registo alternativo.

containerRegistries

ContainerRegistryReference[]

Registos privados adicionais dos quais os contentores podem ser retirados. Se alguma Imagem tiver de ser descarregada de um registo privado que exija credenciais, então essas credenciais devem ser fornecidas aqui.

type

ContainerType

A tecnologia de contentores a utilizar.

BatchDiffDiskSettings

Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pelo nó de computação (VM).

Name Tipo Description
placement

DiffDiskPlacement

Especifica o posicionamento efêmero do disco do sistema operacional para todas as VMs no pool. Essa propriedade pode ser usada pelo usuário na solicitação para escolher o local, por exemplo, espaço em disco de cache para provisionamento de disco do sistema operacional efêmero. Para obter mais informações sobre os requisitos de tamanho de disco do sistema operacional efêmero, consulte Requisitos de tamanho de disco do sistema operacional efêmero para VMs do Windows em https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs do Linux em https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

BatchError

Uma resposta de erro recebida do serviço Batch do Azure.

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

message

BatchErrorMessage

Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.

values

BatchErrorDetail[]

Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.

value

string

As informações adicionais incluídas com a resposta de erro.

BatchErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

Name Tipo Description
lang

string

O código da linguagem da mensagem de erro.

value

string

O texto da mensagem.

BatchInboundNatPool

Um pool NAT de entrada que pode ser usado para endereçar portas específicas em nós de computação em um pool de lotes externamente.

Name Tipo Description
backendPort

integer (int32)

O número de porta no Nó de Computação. Isto deve ser único dentro de um Batch Pool. Os valores aceitáveis situam-se entre 1 e 65535, exceto para 29876 e 29877, uma vez que estes são reservados. Se algum valor reservado for fornecido, a solicitação falhará com o código de status HTTP 400.

frontendPortRangeEnd

integer (int32)

O último número de porta no intervalo de portas externas que serão usadas para fornecer acesso de entrada ao backendPort em nós de computação individuais. Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas pelo serviço de lote. Todos os intervalos dentro de um Pool devem ser distintos e não podem sobrepor-se. Cada gama deve conter pelo menos 40 portas. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400.

frontendPortRangeStart

integer (int32)

O primeiro número de porta na gama de portas externas que serão usadas para fornecer acesso de entrada ao backendPort em nós de computação individuais. Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas. Todos os intervalos dentro de um Pool devem ser distintos e não podem sobrepor-se. Cada gama deve conter pelo menos 40 portas. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400.

name

string

O nome do ponto de extremidade. O nome deve ser único dentro de um Batch Pool, podendo conter letras, números, sublinhas, pontos e hífenes. Os nomes devem começar com uma letra ou número, devem terminar com uma letra, número ou sublinhado e não podem exceder 77 caracteres. Se algum valor inválido for fornecido, a solicitação falhará com o código de status HTTP 400.

networkSecurityGroupRules

NetworkSecurityGroupRule[]

Uma lista de regras de grupo de segurança de rede que serão aplicadas ao ponto de extremidade. O número máximo de regras que podem ser especificadas em todos os endpoints de um Batch Pool é 25. Se nenhuma regra de grupo de segurança de rede for especificada, uma regra padrão será criada para permitir o acesso de entrada à porta de back-end especificada. Se o número máximo de regras de grupo de segurança de rede for excedido, a solicitação falhará com o código de status HTTP 400.

protocol

InboundEndpointProtocol

O protocolo do ponto de extremidade.

BatchJobDefaultOrder

BatchJobDefaultOrder enums

Valor Description
none

As tarefas devem ser agendadas uniformemente a partir de todas as tarefas de igual prioridade para o pool.

creationtime

Se os trabalhos tiverem prioridade igual, as tarefas de empregos criados anteriormente devem ser agendadas primeiro.

BatchMetadataItem

O serviço Batch não atribui qualquer significado a estes metadados; é exclusivamente para o uso do código de usuário.

Name Tipo Description
name

string

O nome do item de metadados.

value

string

O valor do item de metadados.

BatchNodeFillType

Enums BatchNodeFillType

Valor Description
spread

As tarefas devem ser distribuídas de forma uniforme entre todos os Nós de Computação do Pool.

pack

O maior número possível de Tarefas (taskSlotsPerNode) deve ser atribuído a cada Nó de Computação do Pool antes de quaisquer Tarefas serem atribuídas ao próximo Nó de Computação do Pool.

BatchNodeIdentityReference

A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.

Name Tipo Description
resourceId

string (arm-id)

O ID de recurso ARM da identidade atribuída ao usuário.

BatchNodePlacementConfiguration

Para posicionamento regional, os nós no pool serão alocados na mesma região. Para o posicionamento zonal, os nós no pool serão distribuídos por diferentes zonas com o melhor balanceamento de esforço.

Name Tipo Description
policy

BatchNodePlacementPolicyType

Tipo de política de posicionamento de nó em Batch Pools. Política de alocação usada pelo Batch Service para provisionar os nós. Se não for especificado, o Batch usará a política regional.

BatchNodePlacementPolicyType

Enums BatchNodePlacementPolicyType

Valor Description
regional

Todos os nós no pool serão alocados na mesma região.

zonal

Os nós do pool estarão espalhados por diferentes zonas de disponibilidade com melhor equilíbrio de esforço.

BatchOsDisk

Configurações para o disco do sistema operacional do nó de computação (VM).

Name Tipo Description
caching

CachingType

Especifica os requisitos de cache. Os valores possíveis são: None, ReadOnly, ReadWrite. Os valores padrão são: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium.

diskSizeGB

integer (int32)

O tamanho inicial do disco em GB ao criar um novo disco do sistema operacional.

ephemeralOSDiskSettings

BatchDiffDiskSettings

Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pelo nó de computação (VM).

managedDisk

ManagedDisk

Os parâmetros do disco gerenciado.

writeAcceleratorEnabled

boolean

Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

BatchPoolCreateOptions

Parâmetros para criar um Pool de Lotes do Azure.

Name Tipo Description
applicationPackageReferences

BatchApplicationPackageReference[]

A lista de pacotes a serem instalados em cada nó de computação no pool. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). As alterações nas referências de Pacote afetam todos os novos Nós que ingressam no Pool, mas não afetam os Nós de Computação que já estão no Pool até que sejam reinicializados ou recriados com imagem. Há um máximo de 10 referências de pacote em qualquer pool.

autoScaleEvaluationInterval

string (duration)

O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático. O valor padrão é 15 minutos. O valor mínimo e máximo são de 5 minutos e 168 horas, respectivamente. Se você especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço em lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta).

autoScaleFormula

string

Uma fórmula para o número desejado de nós de computação no pool. Essa propriedade não deve ser especificada se enableAutoScale estiver definido como false. É necessário se enableAutoScale estiver definido como true. A validade da fórmula é verificada antes da criação do Pool. Se a fórmula não for válida, o serviço Lote rejeitará a solicitação com informações de erro detalhadas. Para obter mais informações sobre como especificar essa fórmula, consulte 'Dimensionar automaticamente nós de computação em um pool de lotes do Azure' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

displayName

string

O nome para exibição do Pool. O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.

enableAutoScale

boolean

Se o tamanho do Pool deve ser ajustado automaticamente ao longo do tempo. Se false, pelo menos um dos targetDedicatedNodes e targetLowPriorityNodes deve ser especificado. Se true, a propriedade autoScaleFormula é necessária e o Pool é redimensionado automaticamente de acordo com a fórmula. O valor predefinido é false.

enableInterNodeCommunication

boolean

Se o Pool permite a comunicação direta entre nós de computação. Habilitar a comunicação entre nós limita o tamanho máximo do Pool devido a restrições de implantação nos Nós de Computação do Pool. Isto pode fazer com que a Piscina não atinja o tamanho desejado. O valor predefinido é false.

id

string

Uma cadeia de caracteres que identifica exclusivamente o Pool dentro da Conta. O ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes e sublinhados, e não pode conter mais de 64 caracteres. O ID preserva maiúsculas e minúsculas e não diferencia maiúsculas de minúsculas (ou seja, você não pode ter dois IDs de Pool em uma Conta que diferem apenas por maiúsculas e minúsculas).

metadata

BatchMetadataItem[]

Uma lista de pares nome-valor associados ao Pool como metadados. O serviço Batch não atribui qualquer significado aos metadados; é exclusivamente para o uso do código de usuário.

mountConfiguration

MountConfiguration[]

Monte o armazenamento usando o sistema de arquivos especificado durante toda a vida útil do pool. Monte o armazenamento usando o sistema de arquivos baseado em compartilhamento de arquivos, NFS, CIFS ou Blobfuse do Azure.

networkConfiguration

NetworkConfiguration

A configuração de rede para o Pool.

resizeTimeout

string (duration)

O tempo limite para alocação de nós de computação para o pool. Este tempo limite aplica-se apenas ao dimensionamento manual; ele não tem efeito quando enableAutoScale é definido como true. O valor padrão é 15 minutos. O valor mínimo é de 5 minutos. Se você especificar um valor inferior a 5 minutos, o serviço de lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta).

startTask

BatchStartTask

Uma Tarefa especificada para ser executada em cada Nó de Computação à medida que se junta ao Pool. A Tarefa é executada quando o Nó de Computação é adicionado ao Pool ou quando o Nó de Computação é reiniciado.

targetDedicatedNodes

integer (int32)

O número desejado de nós de computação dedicados no pool. Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale estiver definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes, ou ambos.

targetLowPriorityNodes

integer (int32)

O número desejado de nós de computação spot/de baixa prioridade no pool. Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale estiver definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes, ou ambos.

taskSchedulingPolicy

BatchTaskSchedulingPolicy

Como as tarefas são distribuídas entre nós de computação em um pool. Se não for especificado, o padrão será spread.

taskSlotsPerNode

integer (int32)

O número de slots de tarefas que podem ser usados para executar tarefas simultâneas em um único nó de computação no pool. O valor padrão é 1. O valor máximo é o menor de 4 vezes o número de núcleos do vmSize do pool ou 256.

upgradePolicy

UpgradePolicy

A política de atualização para o Pool. Descreve uma política de atualização - automática, manual ou rolante.

userAccounts

UserAccount[]

A lista de Contas de usuário a serem criadas em cada Nó de Computação no Pool.

virtualMachineConfiguration

VirtualMachineConfiguration

A configuração da máquina virtual para o Pool. Esta propriedade deve ser especificada.

vmSize

string

O tamanho das máquinas virtuais no Pool. Todas as máquinas virtuais em um Pool têm o mesmo tamanho. Para obter informações sobre tamanhos de VM disponíveis para pools usando imagens do Virtual Machines Marketplace (pools criados com virtualMachineConfiguration), consulte Tamanhos para máquinas virtuais no Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). O Batch dá suporte a todos os tamanhos de VM do Azure, exceto STANDARD_A0 e aqueles com armazenamento premium (STANDARD_GS, STANDARD_DS e STANDARD_DSV2 séries).

BatchPoolEndpointConfiguration

A configuração do ponto de extremidade para um Pool.

Name Tipo Description
inboundNATPools

BatchInboundNatPool[]

Uma lista de NAT Pools de entrada que podem ser usados para endereçar portas específicas num Nó de Computação individual externamente. O número máximo de NAT Pools de entrada por Batch Pool é 5. Se o número máximo de NAT Pools de entrada for ultrapassado, o pedido falha com o código de estado HTTP 400. Isso não pode ser especificado se o IPAddressProvisioningType for NoPublicIPAddresses.

BatchPoolIdentityReference

A referência de uma das identidades do pool para criptografar o disco. Essa identidade será usada para acessar o cofre de chaves.

Name Tipo Description
resourceId

string (arm-id)

O ID de recurso ARM da identidade atribuída ao usuário. Essa referência deve ser incluída nas identidades do pool.

BatchPublicIpAddressConfiguration

A configuração de endereço IP público da configuração de rede de um pool.

Name Tipo Description
ipAddressIds

string[] (arm-id)

A lista de IPs públicos que o serviço de lote usará ao provisionar nós de computação. O número de IPs especificado aqui limita o tamanho máximo do Pool - 100 nós dedicados ou 100 nós Spot/Low-priority podem ser alocados para cada IP público. Por exemplo, um pool que precisa de 250 VMs dedicadas precisaria de pelo menos 3 IPs públicos especificados. Cada elemento desta coleção tem o formato: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

ipFamilies

IPFamily[]

As famílias IP usadas para especificar as versões IP disponíveis para o pool. As famílias IP são usadas para determinar pools de pilha única ou de pilha dupla. Para pilha única, o valor esperado é IPv4. Para dual-stack, os valores esperados são IPv4 e IPv6.

ipTags

IPTag[]

Uma lista de marcas IP associadas aos endereços IP públicos do Pool. As tags IP são usadas para categorizar e filtrar endereços IP públicos para fins de faturamento e gerenciamento.

provision

IpAddressProvisioningType

O tipo de provisionamento para endereços IP públicos para o pool. O valor padrão é BatchManaged.

BatchStartTask

O lote tentará novamente Tarefas quando uma operação de recuperação for acionada em um nó. Exemplos de operações de recuperação incluem (mas não estão limitados a) quando um nó não íntegro é reinicializado ou um nó de computação desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode ocorrer uma nova tentativa interna devido a uma operação de recuperação. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente mesmo que o nó de computação não tenha sido reinicializado. Cuidado especial deve ser tomado para evitar StartTasks que criam processos separatistas ou instalam/iniciam serviços a partir do diretório de trabalho StartTask, pois isso impedirá que o Batch possa executar novamente o StartTask.

Name Tipo Description
commandLine

string

A linha de comando do StartTask. A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho Tarefa) ou usar a variável de ambiente Batch provided (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

BatchTaskContainerSettings

As definições do contentor sob o qual a StartTask é executada. Quando isto é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Batch do Azure no nó) são mapeados para o contentor, todas as variáveis do ambiente Task são mapeadas para o contentor e a linha de comando Task é executada no contentor. Ficheiros produzidos no contentor fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos para o disco anfitrião, o que significa que as APIs de ficheiros Batch não poderão aceder a esses ficheiros.

environmentSettings

EnvironmentSetting[]

Uma lista de configurações de variáveis de ambiente para o StartTask.

maxTaskRetryCount

integer (int32)

O número máximo de vezes que a Tarefa pode ser repetida. O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. Observe que esse valor controla especificamente o número de tentativas. O serviço de lote tentará a tarefa uma vez e, em seguida, poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de tentativas for 3, o Batch tentará a Tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se a contagem máxima de tentativas for 0, o serviço Batch não repetirá a Tarefa. Se a contagem máxima de tentativas for -1, o serviço em lote repetirá a tarefa sem limite, no entanto, isso não é recomendado para uma tarefa inicial ou qualquer tarefa. O valor padrão é 0 (sem tentativas).

resourceFiles

ResourceFile[]

Uma lista de arquivos que o serviço em lote baixará para o nó de computação antes de executar a linha de comando. Há um tamanho máximo para a lista de arquivos de recursos. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deve ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker. Os arquivos listados sob este elemento estão localizados no diretório de trabalho da tarefa.

userIdentity

UserIdentity

A identidade do utilizador sob a qual o StartTask é executado. Se omitida, a Tarefa é executada como um utilizador não administrativo único da Tarefa.

waitForSuccess

boolean

Se o serviço em lote deve aguardar a conclusão bem-sucedida do StartTask (ou seja, sair com o código de saída 0) antes de agendar quaisquer tarefas no nó de computação. Se true e o StartTask falhar em um nó, o serviço Batch tentará novamente o StartTask até sua contagem máxima de tentativas (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as tentativas, o serviço Lote marcará o Nó como inutilizável e não agendará Tarefas para ele. Esta condição pode ser detetada através do estado do nó de computação e detalhes de informações de falha. Se false, o serviço Batch não aguardará a conclusão do StartTask. Nesse caso, outras tarefas podem começar a ser executadas no nó de computação enquanto o StartTask ainda está em execução; e mesmo que o StartTask falhe, novas tarefas continuarão a ser agendadas no nó de computação. O padrão é verdadeiro.

BatchTaskContainerSettings

As configurações de contêiner para uma Tarefa.

Name Tipo Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Os caminhos que você deseja montar para a tarefa de contêiner. Se essa matriz for nula ou não estiver presente, a tarefa de contêiner montará toda a unidade de disco temporária no Windows (ou AZ_BATCH_NODE_ROOT_DIR no Linux). Ele não montará nenhum caminho de dados no contêiner se essa matriz estiver definida como vazia.

containerRunOptions

string

Opções adicionais para o comando container create. Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além daquelas controladas pelo Batch Service.

imageName

string

A imagem a usar para criar o contentor onde a tarefa será executada. Esta é a referência completa da Imagem, conforme especificado para "docker pull". Se não for fornecida uma etiqueta como parte do nome da Imagem, a etiqueta ":latest" é usada como padrão.

registry

ContainerRegistryReference

O registo privado que contém a imagem do contentor. Esta definição pode ser omitida se já foi fornecida na criação do Pool.

workingDirectory

ContainerWorkingDirectory

A localização do diretório de trabalho da Tarefa do contentor. O padrão é 'taskWorkingDirectory'.

BatchTaskSchedulingPolicy

Especifica como as tarefas devem ser distribuídas entre nós de computação.

Name Tipo Default value Description
jobDefaultOrder

BatchJobDefaultOrder

none

A ordem para agendar tarefas de diferentes trabalhos com a mesma prioridade. Se não for especificado, o padrão será nenhum.

nodeFillType

BatchNodeFillType

Como as tarefas são distribuídas entre nós de computação em um pool. Se não for especificado, o padrão será spread.

BatchUefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual.

Name Tipo Description
secureBootEnabled

boolean

Especifica se a inicialização segura deve ser habilitada na máquina virtual.

vTpmEnabled

boolean

Especifica se o vTPM deve ser habilitado na máquina virtual.

BatchVmDiskSecurityProfile

Especifica as configurações de perfil de segurança para o disco gerenciado. Nota: Ele só pode ser definido para VMs confidenciais e necessário ao usar VMs confidenciais.

Name Tipo Description
securityEncryptionType

SecurityEncryptionTypes

Especifica o EncryptionType do disco gerenciado. Ele é definido como VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState. Nota: Ele pode ser definido apenas para VMs Confidenciais e é necessário ao usar VMs Confidenciais.

BatchVmImageReference

Uma referência a uma Imagem do Azure Virtual Machines Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas pelo Azure Batch, consulte a operação ' Listar Imagens Suportadas '.

Name Tipo Description
communityGalleryImageId

string

A imagem da galeria comunitária identificador único. Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida na chamada GET da galeria da comunidade.

exactVersion

string

A versão específica da imagem da plataforma ou da imagem do marketplace usada para criar o nó. Este campo de apenas leitura difere de 'versão' apenas se o valor especificado para 'versão' quando o pool foi criado for 'mais recente'.

offer

string

O tipo de oferta da Imagem do Marketplace de Máquinas Virtuais Azure. Por exemplo, UbuntuServer ou WindowsServer.

publisher

string

O editor da Azure Virtual Machines Marketplace Image. Por exemplo, Canonical ou MicrosoftWindowsServer.

sharedGalleryImageId

string

Identificador único da imagem da galeria partilhada. Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida a partir da chamada GET da imagem da galeria partilhada.

sku

string

O SKU da Imagem Azure Virtual Machines Marketplace. Por exemplo, 18.04-LTS ou 2019-Datacenter.

version

string

A versão da Imagem do Azure Virtual Machines Marketplace. Pode ser especificado um valor de 'mais recente' para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão é 'mais recente'.

virtualMachineImageId

string (arm-id)

O identificador de recurso ARM da Imagem da Galeria de Computação do Azure. Os Nós de Computação no Pool serão criados usando este ID de Imagem. Isto é da forma /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para usar sempre a versão mais recente da imagem. Esta propriedade é mutuamente exclusiva com outras propriedades do ImageReference. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região e deve estar na mesma subscrição da conta Batch do Azure. Se a versão da imagem não for especificada no imageId, será usada a versão mais recente. Para informações sobre as definições do firewall do agente Batch Compute Node para comunicar com o serviço Batch, veja https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

CachingType

Enums CachingType

Valor Description
none

O modo de cache para o disco não está habilitado.

readonly

O modo de cache para o disco é somente leitura.

readwrite

O modo de cache para o disco é leitura e gravação.

CifsMountConfiguration

Informações usadas para se conectar a um sistema de arquivos CIFS.

Name Tipo Description
mountOptions

string

Opções de linha de comando adicionais para passar para o comando mount. Estas são opções de 'net use' no Windows e opções de 'mount' no Linux.

password

string (password)

A senha a ser usada para autenticação no sistema de arquivos CIFS.

relativeMountPath

string

O caminho relativo no nó de computação onde o sistema de ficheiros será montado. Todos os sistemas de arquivos são montados em relação ao diretório Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

source

string

O URI do sistema de arquivos a ser montado.

username

string

O usuário a ser usado para autenticação no sistema de arquivos CIFS.

ContainerHostBatchBindMountEntry

A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.

Name Tipo Description
isReadOnly

boolean

Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é false (modo de leitura/gravação). Para Linux, se você montar esse caminho como um modo de leitura/gravação, isso não significa que todos os usuários no contêiner tenham o acesso de leitura/gravação para o caminho, depende do acesso na VM do host. Se esse caminho for montado somente leitura, todos os usuários dentro do contêiner não poderão modificá-lo.

source

ContainerHostDataPath

O caminho que ser montado para o cliente de contêiner pode selecionar.

ContainerHostDataPath

Os caminhos que serão montados no contêiner da tarefa do contêiner.

Valor Description
Shared

O caminho para a tarefa de várias instâncias compartilhar seus arquivos.

Startup

O caminho para iniciar a tarefa.

VfsMounts

O caminho contém todos os sistemas de arquivos virtuais montados neste nó.

Task

O caminho da tarefa.

JobPrep

O caminho da tarefa de preparação para o trabalho.

Applications

O caminho dos aplicativos.

ContainerRegistryReference

Um registro de contêiner privado.

Name Tipo Description
identityReference

BatchNodeIdentityReference

A referência à identidade atribuída ao usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha.

password

string (password)

A palavra-passe para iniciar sessão no servidor de registo.

registryServer

string (uri)

O URL do registo. Se omitido, o padrão é "docker.io".

username

string

O nome de utilizador para iniciar sessão no servidor de registo.

ContainerType

Enums ContainerType

Valor Description
dockerCompatible

Uma tecnologia de contêiner compatível com Docker será usada para iniciar os contêineres.

criCompatible

Uma tecnologia baseada em CRI será usada para lançar os contêineres.

ContainerWorkingDirectory

ContainerWorkingDirectory enums

Valor Description
taskWorkingDirectory

Use o diretório de trabalho padrão de Tarefas do serviço Batch, que conterá os Ficheiros de Recursos da Tarefa preenchidos por Batch.

containerImageDefault

Use o diretório de trabalho definido na imagem do contentor. Atenção que este diretório não conterá os Ficheiros de Recursos descarregados pelo Batch.

DataDisk

Configurações que serão usadas pelos discos de dados associados aos nós de computação no pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los.

Name Tipo Description
caching

CachingType

O tipo de cache a ser habilitado para os discos de dados. O valor padrão para cache é readwrite. Para obter informações sobre as opções de cache, consulte: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer (int32)

O tamanho inicial do disco em gigabytes.

lun

integer (int32)

O número da unidade lógica. O logicalUnitNumber é usado para identificar exclusivamente cada disco de dados. Se anexar vários discos, cada um deve ter um logicalUnitNumber distinto. O valor deve estar entre 0 e 63, inclusive.

managedDisk

ManagedDisk

Os parâmetros do disco gerenciado.

storageAccountType

StorageAccountType

O tipo de conta de armazenamento a ser usado para o disco de dados. Se omitido, o padrão é "standard_lrs".

DiffDiskPlacement

Especifica a colocação efémera do disco do sistema operativo para todos os nós de computação (VMs) do pool. Essa propriedade pode ser usada pelo usuário na solicitação para escolher em qual local o sistema operacional deve estar. por exemplo, espaço em disco de cache para provisionamento de disco do sistema operacional efêmero. Para mais informações sobre os requisitos de tamanho do disco do Sistema Operacional Efémero, consulte os requisitos de tamanho do disco do Sistema Operacional Efemérico para VMs Windows em https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs Linux em https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

Valor Description
cachedisk

O disco do sistema operacional efêmero é armazenado no cache da VM.

DiskCustomerManagedKey

A referência de chave gerenciada pelo cliente para criptografar o disco.

Name Tipo Description
identityReference

BatchPoolIdentityReference

A referência de uma das identidades do pool para criptografar o disco. Essa identidade será usada para acessar o KeyVault.

keyUrl

string

URL de chave totalmente versionada apontando para uma chave no KeyVault. O segmento de versão da URL é necessário independentemente do valor rotationToLatestKeyVersionEnabled.

rotationToLatestKeyVersionEnabled

boolean

Defina esse sinalizador como true para habilitar a atualização automática da criptografia de disco para a versão de chave mais recente. O valor padrão é falso.

DiskEncryptionConfiguration

A configuração de criptografia de disco aplicada em nós de computação no pool. A configuração de criptografia de disco não é suportada no pool Linux criado com a Imagem da Galeria de Computação do Azure.

Name Tipo Description
customerManagedKey

DiskCustomerManagedKey

A referência de chave gerenciada pelo cliente para criptografar o disco do sistema operacional. A Chave Gerenciada pelo Cliente criptografará o disco do sistema operacional por EncryptionAtRest e, por padrão, criptografaremos o disco de dados também. Ele pode ser usado somente quando o pool é configurado com uma identidade e o OsDisk é definido como um dos destinos do DiskEncryption.

targets

DiskEncryptionTarget[]

A lista de destinos de disco do Serviço em Lote será criptografada no nó de computação. A lista de destinos de disco do Serviço em Lote será criptografada no nó de computação.

DiskEncryptionSetParameters

A ID do recurso ARM do conjunto de criptografia de disco.

Name Tipo Description
id

string (arm-id)

A ID do recurso ARM do conjunto de criptografia de disco. O recurso deve estar na mesma assinatura que a conta Batch.

DiskEncryptionTarget

Enums DiskEncryptionTarget

Valor Description
osdisk

O disco do sistema operacional no nó de computação é criptografado.

temporarydisk

O disco temporário no nó de computação é criptografado. No Linux, essa criptografia se aplica a outras partições (como aquelas em discos de dados montados) quando a criptografia ocorre no momento da inicialização.

DynamicVNetAssignmentScope

DynamicVNetAssignmentScope enums

Valor Description
none

Nenhuma atribuição de VNet dinâmica está habilitada.

job

A atribuição de VNet dinâmica é feita por trabalho.

ElevationLevel

Enums ElevationLevel

Valor Description
nonadmin

O usuário é um usuário padrão sem acesso elevado.

admin

O usuário é um usuário com acesso elevado e opera com permissões completas de administrador.

EnvironmentSetting

Uma variável de ambiente a ser definida em um processo Task.

Name Tipo Description
name

string

O nome da variável de ambiente.

value

string

O valor da variável de ambiente.

HostEndpointSettings

Especifica configurações específicas do ponto de extremidade do host.

Name Tipo Description
inVMAccessControlProfileReferenceId

string

Especifica a referência à id do recurso InVMAccessControlProfileVersion na forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}.

mode

HostEndpointSettingsModeTypes

Especifica o modo de execução da política de controle de acesso.

HostEndpointSettingsModeTypes

HostEndpointSettingsModeTypes enums

Valor Description
Audit

No modo de auditoria, o sistema age como se estivesse aplicando a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas na verdade não nega nenhuma solicitação para hospedar pontos de extremidade.

Enforce

O modo de aplicação é o modo de operação recomendado e o sistema irá aplicar a política de controlo de acesso. Esta propriedade não pode ser usada juntamente com 'inVMAccessControlControlProfileReferenceId'.

InboundEndpointProtocol

InboundEndpointProtocol enums

Valor Description
tcp

Use TCP para o ponto de extremidade.

udp

Use UDP para o ponto de extremidade.

IpAddressProvisioningType

IPAddressProvisioningType enums

Valor Description
batchmanaged

Um IP público será criado e gerenciado pelo Batch. Pode haver vários IPs públicos, dependendo do tamanho do Pool.

usermanaged

IPs públicos são fornecidos pelo usuário e serão usados para provisionar os nós de computação.

nopublicipaddresses

Não será criado nenhum endereço IP público.

IPFamily

As famílias IP usadas para especificar as versões IP disponíveis para o pool.

Valor Description
IPv4

IPv4 está disponível para o pool.

IPv6

IPv6 está disponível para o pool.

IPTag

Contém a marca IP associada ao endereço IP público.

Name Tipo Description
ipTagType

string

O tipo de tag IP. Exemplo: FirstPartyUsage.

tag

string

O valor da tag IP associada ao IP público. Exemplo: SQL.

LinuxUserConfiguration

Propriedades usadas para criar uma conta de usuário em um nó de computação Linux.

Name Tipo Description
gid

integer (int32)

O ID do grupo para a conta do utilizador. As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o gid.

sshPrivateKey

string (password)

A chave privada SSH para a conta do utilizador. A chave privada não deve ser protegida por senha. A chave privada é usada para configurar automaticamente a autenticação baseada em chave assimétrica para SSH entre Compute Nodes num Linux Pool quando a propriedade enableInterNodeCommunication do Pool é verdadeira (é ignorada se o enableInterNodeCommunication for falso). Ele faz isso colocando o par de chaves no diretório .ssh do usuário. Se não especificado, o SSH sem palavra-passe não é configurado entre os Nós de Computação (não é feita qualquer modificação do diretório .ssh do utilizador).

uid

integer (int32)

O ID de utilizador da conta de utilizador. As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o uid.

LoginMode

LoginMode enums

Valor Description
batch

O LOGON32_LOGON_BATCH modo de login do Win32. O modo de login em lote é recomendado para processos paralelos de longa execução.

interactive

O LOGON32_LOGON_INTERACTIVE modo de login do Win32. O UAC está ativado nos Pools de Configuração de Máquinas Virtuais do Windows. Se esta opção for usada com uma identidade de utilizador elevada num PoolVirtualMachineConfiguration do Windows, a sessão do utilizador não será elevada a menos que a aplicação executada pela linha de comandos Task esteja configurada para exigir sempre privilégio administrativo ou para exigir sempre privilégio máximo.

ManagedDisk

Os parâmetros do disco gerenciado.

Name Tipo Description
diskEncryptionSet

DiskEncryptionSetParameters

Especifica a id do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado. Ele só pode ser definido no modo UserSubscription.

securityProfile

BatchVmDiskSecurityProfile

Especifica as configurações de perfil de segurança para o disco gerenciado.

storageAccountType

StorageAccountType

O tipo de conta de armazenamento para disco gerenciado.

MountConfiguration

O sistema de arquivos a ser montado em cada nó.

Name Tipo Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

O Contêiner de Armazenamento do Azure a ser montado usando o blob FUSE em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.

azureFileShareConfiguration

AzureFileShareConfiguration

O Compartilhamento de Arquivos do Azure a ser montado em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.

cifsMountConfiguration

CifsMountConfiguration

O sistema de arquivos CIFS/SMB a ser montado em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.

nfsMountConfiguration

NfsMountConfiguration

O sistema de arquivos NFS a ser montado em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.

NetworkConfiguration

A configuração de rede para um Pool.

Name Tipo Description
dynamicVNetAssignmentScope

DynamicVNetAssignmentScope

O escopo da atribuição dinâmica de vnet.

enableAcceleratedNetworking

boolean

Se esse pool deve permitir a rede acelerada. A rede acelerada permite a virtualização de E/S de raiz única (SR-IOV) para uma VM, o que pode levar a um melhor desempenho de rede. Para mais informações, consultar: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.

endpointConfiguration

BatchPoolEndpointConfiguration

A configuração para endpoints nos Nós de Computação no Batch Pool.

publicIPAddressConfiguration

BatchPublicIpAddressConfiguration

A configuração de endereço IPAddress público para nós de computação no pool de lotes.

subnetId

string

O identificador de recurso ARM da sub-rede virtual que os Nós de Computação do Pool irão juntar. Este é o formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. A rede virtual deve estar na mesma região e assinatura que a Conta em Lote do Azure. A sub-rede especificada deve ter endereços IP livres suficientes para acomodar o número de Nós de Computação no Pool. Se a sub-rede não tiver endereços IP livres suficientes, o Pool aloca parcialmente os Nós e ocorre um erro de redimensionamento. A entidade de serviço 'MicrosoftAzureBatch' deve ter a função 'Colaborador de Máquina Virtual Clássica' Role-Based Controle de Acesso (RBAC) para a VNet especificada. A sub-rede especificada deve permitir a comunicação do serviço Batch Azure para poder agendar Tarefas nos Nós. Isso pode ser verificado verificando se a rede virtual especificada tem algum NSG (Network Security Groups) associado. Se a comunicação com os nós na sub-rede especificada for negada por um NSG, o serviço em lote definirá o estado dos nós de computação como inutilizável. Apenas as redes virtuais ARM ('Microsoft.Network/virtualNetworks') são suportadas. Se o VNet especificado tiver quaisquer Grupos de Segurança de Rede (NSG) associados, então algumas portas de sistema reservadas devem ser ativadas para comunicação de entrada, incluindo as portas 29876 e 29877. Habilite também as conexões de saída para o Armazenamento do Azure na porta 443. Para mais pormenores, consultar: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada.

Name Tipo Description
access

NetworkSecurityGroupRuleAccess

A ação que deve ser tomada para um endereço IP, intervalo de sub-rede ou tag especificado.

priority

integer (int32)

A prioridade para esta regra. As prioridades dentro de um Pool devem ser únicas e avaliadas por ordem de prioridade. Quanto menor o número, maior a prioridade. Por exemplo, as regras podem ser especificadas com números de ordem de 150, 250 e 350. A regra com o número de ordem 150 tem precedência sobre a regra que tem uma ordem de 250. As prioridades permitidas são de 150 a 4096. Se algum valor reservado ou duplicado for fornecido, a solicitação falhará com o código de status HTTP 400.

sourceAddressPrefix

string

O prefixo do endereço de origem ou a tag a ser correspondida para a regra. Os valores válidos são um único endereço IP (ou seja, 10.10.10.10), sub-rede IP (ou seja, 192.168.1.0/24), tag padrão ou * (para todos os endereços). Se quaisquer outros valores forem fornecidos, a solicitação falhará com o código de status HTTP 400.

sourcePortRanges

string[]

A porta de origem varia para corresponder à regra. Os valores válidos são '' (para todas as portas 0 - 65535), uma porta específica (ou seja, 22) ou um intervalo de portas (ou seja, 100-200). As portas devem estar na faixa de 0 a 65535. Cada entrada desta coleção não deve sobrepor-se a nenhuma outra entrada (seja um intervalo ou uma porta individual). Se forem fornecidos outros valores, o pedido falha com o código de estado HTTP 400. O valor padrão é ''.

NetworkSecurityGroupRuleAccess

NetworkSecurityGroupRuleAccess enums

Valor Description
allow

Permitir acesso.

deny

Negar acesso.

NfsMountConfiguration

Informações usadas para se conectar a um sistema de arquivos NFS.

Name Tipo Description
mountOptions

string

Opções de linha de comando adicionais para passar para o comando mount. Estas são opções de 'net use' no Windows e opções de 'mount' no Linux.

relativeMountPath

string

O caminho relativo no nó de computação onde o sistema de ficheiros será montado. Todos os sistemas de arquivos são montados em relação ao diretório Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

source

string

O URI do sistema de arquivos a ser montado.

ProxyAgentSettings

Especifica as configurações do ProxyAgent ao criar a máquina virtual.

Name Tipo Description
enabled

boolean

Especifica se o recurso Protocolo de Segurança de Metadados deve ser habilitado na máquina virtual ou no conjunto de dimensionamento de máquina virtual. O padrão é False.

imds

HostEndpointSettings

Configurações para o ponto de extremidade IMDS.

wireServer

HostEndpointSettings

Configurações para o endpoint do WireServer.

ResourceFile

Um único arquivo ou vários arquivos a serem baixados para um nó de computação.

Name Tipo Description
autoStorageContainerName

string

O nome do contentor de armazenamento na conta de armazenamento automático. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada.

blobPrefix

string

O prefixo de blob a ser usado ao baixar blobs de um contêiner de Armazenamento do Azure. Somente os blobs cujos nomes começam com o prefixo especificado serão baixados. A propriedade é válida somente quando autoStorageContainerName ou storageContainerUrl é usado. Esse prefixo pode ser um nome de arquivo parcial ou um subdiretório. Se um prefixo não for especificado, todos os arquivos no contêiner serão baixados.

fileMode

string

O atributo file permission mode em formato octal. Esta propriedade aplica-se apenas a ficheiros descarregados para os Nós de Computação Linux. Será ignorado se for especificado para um resourceFile que será descarregado para um Nó de Computação do Windows. Se esta propriedade não for especificada para um Nó de Computação Linux, então é aplicado um valor padrão de 0770 ao ficheiro.

filePath

string

A localização no Nó de Computação para onde descarregar o(s) ficheiro(s), relativa ao diretório de trabalho da Tarefa. Se a propriedade httpUrl for especificada, o filePath será necessário e descreverá o caminho para o qual o arquivo será baixado, incluindo o nome do arquivo. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath será opcional e será o diretório para o qual os arquivos serão baixados. No caso em que filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na íntegra e anexada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da Tarefa (por exemplo, usando '..').

httpUrl

string (uri)

O URL do ficheiro a transferir. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL apontar para o Armazenamento de Blobs do Azure, ela deverá ser legível a partir dos nós de computação. Há três maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Compartilhado (SAS) concedendo permissões de leitura no blob, usar uma identidade gerenciada com permissão de leitura ou definir a ACL para o blob ou seu contêiner para permitir acesso público.

identityReference

BatchNodeIdentityReference

A referência à identidade atribuída pelo utilizador para aceder ao Azure Blob Storage especificada por storageContainerUrl ou httpUrl.

storageContainerUrl

string (uri)

A URL do contêiner de blob no Armazenamento de Blob do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Este URL deve ser legível e listável a partir de nós de computação. Há três maneiras de obter essa URL para um contêiner no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura e lista no contêiner, usar uma identidade gerenciada com permissões de leitura e lista ou definir a ACL do contêiner para permitir acesso público.

RollingUpgradePolicy

Os parâmetros de configuração usados durante a execução de uma atualização contínua.

Name Tipo Description
enableCrossZoneUpgrade

boolean

Permita que o VMSS ignore os limites AZ ao construir lotes de atualização. Leve em consideração o Domínio de Atualização e maxBatchInstancePercent para determinar o tamanho do lote. Este campo pode ser definido como true ou false somente ao usar NodePlacementConfiguration como Zonal.

maxBatchInstancePercent

integer (int32)

A porcentagem máxima do total de instâncias de máquina virtual que serão atualizadas simultaneamente pela atualização sem interrupção em um lote. Como isso é máximo, instâncias não íntegras em lotes anteriores ou futuros podem fazer com que a porcentagem de instâncias em um lote diminua para garantir maior confiabilidade. O valor deste campo deve estar entre 5 e 100, inclusive. Se maxBatchInstancePercent e maxUnhealthyInstancePercent forem atribuídos com valor, o valor de maxBatchInstancePercent não deverá ser superior a maxUnhealthyInstancePercent.

maxUnhealthyInstancePercent

integer (int32)

A porcentagem máxima do total de instâncias de máquina virtual no conjunto de escala que pode estar simultaneamente não íntegra, seja como resultado de ser atualizada ou por ser encontrada em um estado não íntegro pelas verificações de integridade da máquina virtual antes que a atualização contínua seja abortada. Esta restrição será verificada antes de iniciar qualquer lote. O valor deste campo deve estar entre 5 e 100, inclusive. Se maxBatchInstancePercent e maxUnhealthyInstancePercent forem atribuídos com valor, o valor de maxBatchInstancePercent não deverá ser superior a maxUnhealthyInstancePercent.

maxUnhealthyUpgradedInstancePercent

integer (int32)

A porcentagem máxima de instâncias de máquina virtual atualizadas que podem ser encontradas em um estado não íntegro. Essa verificação acontecerá depois que cada lote for atualizado. Se essa porcentagem for excedida, a atualização contínua será anulada. O valor deste campo deve estar entre 0 e 100, inclusive.

pauseTimeBetweenBatches

string (duration)

O tempo de espera entre a conclusão da atualização para todas as máquinas virtuais em um lote e o início do próximo lote. A duração do tempo deve ser especificada no formato ISO 8601..

prioritizeUnhealthyInstances

boolean

Atualize todas as instâncias não íntegras em um conjunto de escala antes de quaisquer instâncias íntegras.

rollbackFailedInstancesOnPolicyBreach

boolean

Reversão de instâncias com falha para o modelo anterior se a política de Atualização Contínua for violada.

SecurityEncryptionTypes

SecurityEncryptionTypes enums

Valor Description
DiskWithVMGuestState

EncryptionType do disco gerenciado é definido como DiskWithVMGuestState para criptografia do disco gerenciado junto com o blob VMGuestState. Não é suportado em discos de dados.

NonPersistedTPM

EncryptionType do disco gerenciado é definido como NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState.

VMGuestStateOnly

EncryptionType do disco gerenciado é definido como VMGuestStateOnly para criptografia apenas do blob VMGuestState.

SecurityProfile

Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquina virtual.

Name Tipo Description
encryptionAtHost

boolean

Essa propriedade pode ser usada pelo usuário na solicitação para habilitar ou desabilitar a Criptografia de Host para a máquina virtual ou o conjunto de dimensionamento de máquina virtual. Isso habilitará a criptografia para todos os discos, incluindo o disco Resource/Temp no próprio host. Para obter mais informações sobre criptografia nos requisitos do host, consulte https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.

proxyAgentSettings

ProxyAgentSettings

Especifica as configurações do ProxyAgent ao criar a máquina virtual.

securityType

SecurityTypes

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings.

uefiSettings

BatchUefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual.

SecurityTypes

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings.

Valor Description
trustedLaunch

O lançamento confiável protege contra técnicas de ataque avançadas e persistentes.

confidentialvm

A computação confidencial do Azure oferece VMs confidenciais para locatários com altos requisitos de segurança e confidencialidade. Essas VMs fornecem um limite forte e imposto por hardware para ajudar a atender às suas necessidades de segurança. Você pode usar VMs confidenciais para migrações sem fazer alterações no código, com a plataforma protegendo o estado da VM de ser lido ou modificado.

ServiceArtifactReference

Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de escala ao usar a versão de imagem 'mais recente'.

Name Tipo Description
id

string

O ID de referência do artefacto de serviço de ServiceArtifactReference. A ID de referência do artefato de serviço na forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StorageAccountType

Enums StorageAccountType

Valor Description
standard_lrs

O disco de dados deve usar armazenamento padrão localmente redundante.

premium_lrs

O disco de dados deve usar armazenamento redundante local premium.

standardssd_lrs

O disco de dados / disco do sistema operacional deve usar armazenamento padrão SSD localmente redundante.

UpgradeMode

Enums UpgradeMode

Valor Description
automatic

Todas as máquinas virtuais no conjunto de escala são atualizadas automaticamente ao mesmo tempo.

manual

Você controla a aplicação de atualizações para máquinas virtuais no conjunto de escala. Para fazer isso, use a ação manualUpgrade.

rolling

As instâncias existentes em um conjunto de escala são reduzidas em lotes a serem atualizados. Quando o lote atualizado estiver concluído, as instâncias começarão a receber tráfego novamente e o próximo lote começará. Isso continua até que todas as instâncias sejam trazidas up-todata.

UpgradePolicy

Descreve uma política de atualização - automática, manual ou rolante.

Name Tipo Description
automaticOSUpgradePolicy

AutomaticOsUpgradePolicy

Parâmetros de configuração usados para executar a atualização automática do sistema operacional. Os parâmetros de configuração usados para executar a atualização automática do sistema operacional.

mode

UpgradeMode

Especifica o modo de uma atualização para máquinas virtuais no conjunto de escala.

Os valores possíveis são:

Manual - Você controla a aplicação de atualizações para máquinas virtuais no conjunto de escala. Para fazer isso, use a ação manualUpgrade.

automático - Todas as máquinas virtuais no conjunto de escala são atualizadas automaticamente ao mesmo tempo.

Rolling - O conjunto de escalas executa atualizações em lotes com um tempo de pausa opcional no meio.

rollingUpgradePolicy

RollingUpgradePolicy

Os parâmetros de configuração usados durante a execução de uma atualização contínua.

UserAccount

Propriedades usadas para criar um usuário usado para executar Tarefas em um Nó de Computação em Lote do Azure.

Name Tipo Description
elevationLevel

ElevationLevel

O nível de elevação da conta do utilizador. O valor padrão é nonAdmin.

linuxUserConfiguration

LinuxUserConfiguration

A configuração de utilizador específica para Linux para a Conta de utilizador. Esta propriedade é ignorada se especificada num Windows Pool. Se não for especificado, o usuário será criado com as opções padrão.

name

string

O nome da conta de utilizador. Os nomes podem conter caracteres Unicode até um comprimento máximo de 20.

password

string (password)

A palavra-passe da conta de utilizador.

windowsUserConfiguration

WindowsUserConfiguration

A configuração de utilizador específica do Windows para a Conta de utilizador. Esta propriedade só pode ser especificada se o utilizador estiver num Windows Pool. Se não for especificado e estiver num Windows Pool, o utilizador é criado com as opções padrão.

UserIdentity

A definição da identidade do usuário sob a qual a Tarefa é executada. Especifique a propriedade userName ou autoUser, mas não ambas.

Name Tipo Description
autoUser

AutoUserSpecification

O utilizador automático sob o qual a Tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.

username

string

O nome da identidade do utilizador sob a qual a Tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.

VirtualMachineConfiguration

A configuração para nós de computação em um pool com base na infraestrutura de máquinas virtuais do Azure.

Name Tipo Description
containerConfiguration

BatchContainerConfiguration

A configuração do contentor para o Pool. Se especificado, a configuração é feita em cada Nó de Computação do Pool para permitir que as Tarefas sejam executadas em contentores. Todas as Tarefas normais e Tarefas do Gestor de Tarefas que correm neste Pool devem especificar a propriedade ContainerSettings, e todas as outras Tarefas podem especificá-la.

dataDisks

DataDisk[]

A configuração para discos de dados ligados aos Nós de Computação no Pool. Esta propriedade deve ser especificada se os Nós de Computação no Pool precisarem de ter discos de dados vazios ligados a eles. Isso não pode ser atualizado. Cada Pó de Computação recebe o seu próprio disco (o disco não é uma partilha de ficheiros). Os discos existentes não podem ser ligados, cada disco ligado está vazio. Quando o Nó de Computação é removido do Pool, o disco e todos os dados a ele associados também são eliminados. O disco não é formatado depois de ser ligado, deve ser formatado antes de ser utilizado – para mais informações, veja https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux e https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

DiskEncryptionConfiguration

A configuração de criptografia de disco para o pool. Se especificado, a criptografia é executada em cada nó do pool durante o provisionamento do nó.

extensions

VMExtension[]

A extensão de máquina virtual para o pool. Se especificado, as extensões mencionadas nesta configuração serão instaladas em cada nó.

imageReference

BatchVmImageReference

Uma referência à Imagem do Azure Virtual Machines Marketplace ou à Imagem de Máquina Virtual personalizada a ser usada.

licenseType

string

Isto aplica-se apenas a Imagens que contenham o sistema operativo Windows e só deve ser usado quando tiver licenças válidas on-premises para os Nós de Computação que serão implementados. Se omitido, nenhum desconto de licenciamento local será aplicado. Os valores são:

Windows_Server - A licença local é para o Windows Server. Windows_Client - A licença local é para o Windows Client.

nodeAgentSKUId

string

A SKU do agente do Nó de Computação em Lote a ser provisionado em Nós de Computação no Pool. O agente Batch Compute Node é um programa que é executado em cada Nó de Computação no Pool e fornece a interface de comando e controle entre o Nó de Computação e o serviço Batch. Existem diferentes implementações do agente Compute Node, conhecido como SKUs, para diferentes sistemas operacionais. Você deve especificar uma SKU do agente do Nó de Computação que corresponda à referência de Imagem selecionada. Para obter a lista de SKUs de agente de nó de computação suportados, juntamente com sua lista de referências de imagem verificadas, consulte a operação 'Listar SKUs de agente de nó de computação suportados'.

nodePlacementConfiguration

BatchNodePlacementConfiguration

A configuração de posicionamento do nó para o pool. Essa configuração especificará regras sobre como os nós no pool serão fisicamente alocados.

osDisk

BatchOsDisk

Configurações para o disco do sistema operacional da máquina virtual.

securityProfile

SecurityProfile

Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquina virtual.

serviceArtifactReference

ServiceArtifactReference

Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de escala ao usar a versão de imagem 'mais recente'. A ID de referência do artefato de serviço na forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

windowsConfiguration

WindowsConfiguration

Configurações do sistema operacional Windows na máquina virtual. Esta propriedade não deve ser especificada se a propriedade imageReference especificar uma imagem do sistema operativo Linux.

VMExtension

A configuração para extensões de máquina virtual.

Name Tipo Description
autoUpgradeMinorVersion

boolean

Indica se a extensão deve usar uma versão secundária mais recente, se uma estiver disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true.

enableAutomaticUpgrade

boolean

Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível.

name

string

O nome da extensão da máquina virtual.

protectedSettings

object

A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida.

provisionAfterExtensions

string[]

A coleção de nomes de extensão. Coleção de nomes de extensão após a qual essa extensão precisa ser provisionada.

publisher

string

O nome do editor do manipulador de extensão.

settings

object

Configurações públicas formatadas em JSON para a extensão.

type

string

O tipo da extensão.

typeHandlerVersion

string

A versão do manipulador de script.

WindowsConfiguration

Configurações do sistema operacional Windows a serem aplicadas à máquina virtual.

Name Tipo Description
enableAutomaticUpdates

boolean

Se as atualizações automáticas estão habilitadas na máquina virtual. Se omitido, o valor padrão é true.

WindowsUserConfiguration

Propriedades usadas para criar uma conta de usuário em um nó de computação do Windows.

Name Tipo Description
loginMode

LoginMode

O modo de login para o utilizador. O padrão é 'batch'.