Partilhar via

Pool - Create

  • Referência
Serviço:
Batch Management
Versão da API:
2024-07-01

Cria um novo pool dentro da conta especificada.

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

Parâmetros do URI

Name Em Necessário Tipo Description
accountName
 path True

string

O nome da conta Batch.

Padrão Regex: ^[a-zA-Z0-9]+$
poolName
 path True

string

O nome do pool. Isso deve ser exclusivo dentro da conta.

Padrão Regex: ^[a-zA-Z0-9_-]+$
resourceGroupName
 path True

string

O nome do grupo de recursos que contém a conta Batch.
subscriptionId
 path True

string

A ID de assinatura do Azure. Esta é uma cadeia de caracteres formatada em GUID (por exemplo, 00000000-0000-0000-0000-00000000000000)
api-version
 query True

string

A versão da API a ser usada com a solicitação HTTP.

Cabeçalho do Pedido

Name Necessário Tipo Description
If-Match

string

A versão do estado da entidade (ETag) do pool a ser atualizado. Um valor de "*" pode ser usado para aplicar a operação somente se o pool já existir. Se omitida, esta operação será sempre aplicada.
If-None-Match

string

Defina como '*' para permitir que um novo pool seja criado, mas para impedir a atualização de um pool existente. Outros valores serão ignorados.

Corpo do Pedido

Name Tipo Description
identity

BatchPoolIdentity

O tipo de identidade usado para o pool de lotes.
O tipo de identidade usado para o pool de lotes.
properties.applicationLicenses

string[]

A lista de licenças de aplicativo que o serviço Batch disponibilizará em cada nó de computação no pool.
A lista de licenças de aplicativo deve ser um subconjunto de licenças de aplicativo de serviço em lote disponíveis. Se for solicitada uma licença que não é suportada, a criação do pool falhará.
properties.applicationPackages

ApplicationPackageReference[]

A lista de pacotes de aplicativos a serem instalados em cada nó de computação no pool.
As alterações nas referências do pacote de aplicativos afetam todos os novos nós de computação 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 pacotes de aplicativos em um determinado pool.
properties.certificates

CertificateReference[]

A lista de certificados a serem instalados em cada nó de computação no pool.
Para nós de computação do Windows, o serviço Batch instala os certificados no armazenamento de certificados e no local especificados. Para nós de computação do Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho da tarefa e uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR é fornecida à tarefa para consultar esse local. Para certificados com visibilidade de 'remoteUser', um diretório 'certs' é criado no diretório inicial do usuário (por exemplo, /home/{user-name}/certs) e os certificados são colocados nesse diretório.

Aviso: Esta propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use o Azure KeyVault Extension.
properties.deploymentConfiguration

DeploymentConfiguration

Esta propriedade descreve as máquinas virtuais nas quais os nós do pool serão implantados.
properties.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.
properties.interNodeCommunication

InterNodeCommunicationState

Se o pool permite a comunicação direta entre nós.
Isso impõe restrições sobre quais nós podem ser atribuídos ao pool. Habilitar esse valor pode reduzir a chance de o número solicitado de nós ser alocado no pool. Se não for especificado, o padrão desse valor será 'Desativado'.
properties.metadata

MetadataItem[]

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.
properties.mountConfiguration

MountConfiguration[]

Uma lista de sistemas de arquivos a serem montados em cada nó do pool.
Isso dá suporte a Arquivos do Azure, NFS, CIFS/SMB e Blobfuse.
properties.networkConfiguration

NetworkConfiguration

A configuração de rede para o pool.
A configuração de rede para um pool.
properties.resourceTags

object

As tags especificadas pelo usuário associadas ao pool.
As marcas definidas pelo usuário a serem associadas ao Pool de Lotes do Azure. Quando especificadas, essas marcas são propagadas para os recursos do Azure de suporte associados ao pool. Essa propriedade só pode ser especificada quando a conta Batch foi criada com a propriedade poolAllocationMode definida como 'UserSubscription'.
properties.scaleSettings

ScaleSettings

Configurações que configuram o número de nós no pool.
Define o tamanho desejado do pool. Isso pode ser 'fixedScale', onde o targetDedicatedNodes solicitado é especificado, ou 'autoScale', que define uma fórmula que é reavaliada periodicamente. Se essa propriedade não for especificada, o pool terá uma escala fixa com 0 targetDedicatedNodes.
properties.startTask

StartTask

Uma tarefa especificada para ser executada em cada nó de computação à medida que se junta ao pool.
Em uma operação PATCH (atualização), essa propriedade pode ser definida como um objeto vazio para remover a tarefa inicial do pool.
properties.targetNodeCommunicationMode

NodeCommunicationMode

O modo de comunicação de nó desejado para o pool.
Se omitido, o valor padrão é Default.
properties.taskSchedulingPolicy

TaskSchedulingPolicy

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.
properties.taskSlotsPerNode

integer

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.
properties.upgradePolicy

UpgradePolicy

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

UserAccount[]

A lista de contas de usuário a serem criadas em cada nó do pool.
properties.vmSize

string

O tamanho das máquinas virtuais no pool. Todas as VMs em um pool têm o mesmo tamanho.
Para obter informações sobre tamanhos de VM disponíveis, consulte Tamanhos para máquinas virtuais (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou Tamanhos para máquinas virtuais (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). 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).
tags

object

As tags do recurso.

Respostas

Name Tipo Description
200 OK

Pool

A operação foi bem sucedida. A resposta contém a entidade do pool.

Cabeçalhos

ETag: string
Other Status Codes

CloudError

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo de código de autenticação do Microsoft Entra OAuth 2.0

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

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

CreatePool - accelerated networking

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - Custom Image

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - Full VirtualMachineConfiguration

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - Minimal VirtualMachineConfiguration

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - No public IP

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - Public IPs

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - ResourceTags

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - SecurityProfile

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - Tags

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - UpgradePolicy

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - UserAssignedIdentities

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - VirtualMachineConfiguration Extensions

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - VirtualMachineConfiguration OSDisk

Pedido de amostra

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

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

Resposta da amostra

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

CreatePool - VirtualMachineConfiguration ServiceArtifactReference

Pedido de amostra

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

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

Resposta da amostra

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

Definições

Name Description
AllocationState

Se a piscina está a redimensionar.
ApplicationPackageReference

Link para um pacote de aplicativo dentro da conta de lote
AutomaticOSUpgradePolicy

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

Os resultados e erros de uma execução de uma fórmula de dimensionamento automático de pool.
AutoScaleRunError

Um erro que ocorreu ao dimensionar automaticamente um pool.
AutoScaleSettings

Configurações de AutoScale para o pool.
AutoUserScope

O escopo para o usuário automático
AutoUserSpecification

Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço de lote.
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.
BatchPoolIdentity

A identidade do pool de lotes, se configurado. Se a identidade do pool for atualizada durante a atualização de um pool existente, somente as novas vms criadas após a redução do pool para 0 terão as identidades atualizadas
CachingType

O tipo de cache a ser habilitado para o disco.
CertificateReference

Uma referência a um certificado a ser instalado em nós de computação em um pool. Isso deve existir dentro da mesma conta que o pool.
CertificateStoreLocation

O local do armazenamento de certificados no nó de computação no qual instalar o certificado.
CertificateVisibility

Quais contas de usuário no nó de computação devem ter acesso aos dados privados do certificado.
CIFSMountConfiguration

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

Uma resposta de erro do serviço em lote.
CloudErrorBody

Uma resposta de erro do serviço em lote.
ComputeNodeDeallocationOption

Determina o que fazer com um nó e sua(s) tarefa(s) em execução depois que ele tiver sido selecionado para deallocation.
ComputeNodeFillType

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

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

A configuração para pools habilitados para contêiner.
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.
ContainerRegistry

Um registro de contêiner privado.
ContainerType

A tecnologia de contentores a utilizar.
ContainerWorkingDirectory

Um sinalizador para indicar onde está o diretório de trabalho da tarefa de contêiner. O padrão é 'taskWorkingDirectory'.
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.
DeploymentConfiguration

Propriedades de configuração de implantação.
DiffDiskPlacement

Especifica o posicionamento efêmero do disco do sistema operacional para todas as VMs no pool.
DiffDiskSettings

Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pela máquina virtual.
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 Imagem de Máquina Virtual ou Imagem da Galeria de Computação do Azure.
DiskEncryptionTarget

A lista de destinos de disco que o Serviço em Lote criptografará no nó de computação
DynamicVNetAssignmentScope

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

O nível de elevação do usuário.
EnvironmentSetting

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

Configurações de escala fixas para o pool.
ImageReference

Uma referência a uma imagem do Azure Virtual Machines Marketplace ou ao recurso Azure Image de uma Máquina Virtual personalizada. Para obter a lista de todas as imageReferences verificadas pelo Lote do Azure, consulte a operação 'Listar SKUs de agente de nó suportado'.
InboundEndpointProtocol

O protocolo do ponto de extremidade.
InboundNatPool

Um pool de 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.
InterNodeCommunicationState

Se o pool permite a comunicação direta entre nós.
IPAddressProvisioningType

O tipo de provisionamento para endereços IP públicos para o pool de lotes.
LinuxUserConfiguration

Propriedades usadas para criar uma conta de usuário em um nó Linux.
LoginMode

Modo de login para o usuário
ManagedDisk
MetadataItem

Um par nome-valor associado a um recurso de serviço em lote.
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

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

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

Determina como um pool se comunica com o serviço de lote.
NodePlacementConfiguration

Configuração de posicionamento de nó para pools de lotes.
NodePlacementPolicyType

A política de posicionamento para alocar nós no pool.
OSDisk

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

Contém informações sobre um pool.
PoolEndpointConfiguration

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

O tipo de identidade usado para o pool de lotes.
PoolProvisioningState

O estado atual do pool.
PublicIPAddressConfiguration

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

Um erro que ocorreu ao redimensionar um pool.
ResizeOperationStatus

Detalhes sobre a operação de redimensionamento atual ou concluída pela última vez.
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.
ScaleSettings

Configurações de escala para o pool
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.
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'.
StartTask

Uma tarefa que é executada quando um nó de computação se junta a um pool no serviço de Lote do Azure ou quando o nó de computação é reinicializado ou recriado.
StorageAccountType

O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional.
TaskContainerSettings

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

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

Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual.
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.
UpgradePolicy

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

Propriedades usadas para criar um usuário em um nó do Lote do Azure.
UserAssignedIdentities

A lista de identidades de usuário associadas.
UserIdentity

A definição da identidade do usuário sob a qual a tarefa é executada.
VirtualMachineConfiguration

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

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.
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ó do Windows.

AllocationState

Se a piscina está a redimensionar.

Name Tipo Description
Resizing

string

A piscina está a redimensionar; ou seja, nós de computação estão sendo adicionados ou removidos do pool.
Steady

string

A piscina não está redimensionando. Não há alterações no número de nós no pool em andamento. Um pool entra nesse estado quando é criado e quando nenhuma operação está sendo executada no pool para alterar o número de nós.
Stopping

string

O pool estava redimensionando, mas o usuário solicitou que o redimensionamento fosse interrompido, mas a solicitação de parada ainda não foi concluída.

ApplicationPackageReference

Link para um pacote de aplicativo dentro da conta de lote

Name Tipo Description
id

string

A ID do pacote de aplicativo a ser instalado. Isso deve estar dentro da mesma conta de lote que o pool. Isso pode ser uma referência a uma versão específica ou a versão padrão, se existir.
version

string

A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada.
Se isso for omitido e nenhuma versão padrão for especificada para este aplicativo, a solicitação falhará com o código de erro InvalidApplicationPackageReferences. Se você estiver chamando a API REST diretamente, o código de status HTTP será 409.

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.

AutoScaleRun

Os resultados e erros de uma execução de uma fórmula de dimensionamento automático de pool.

Name Tipo Description
error

AutoScaleRunError

Detalhes do erro encontrado ao avaliar a fórmula de escala automática no pool, se a avaliação não foi bem-sucedida.
evaluationTime

string

O momento em que a fórmula em escala automática foi avaliada pela última vez.
results

string

Os valores finais de todas as variáveis utilizadas na avaliação da fórmula de autoescala.
Cada valor de variável é retornado na forma $variable=valor, e as variáveis são separadas por ponto-e-vírgula.

AutoScaleRunError

Um erro que ocorreu ao dimensionar automaticamente um pool.

Name Tipo Description
code

string

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

AutoScaleRunError[]

Detalhes adicionais sobre o erro.
message

string

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

AutoScaleSettings

Configurações de AutoScale para o pool.

Name Tipo Description
evaluationInterval

string

O intervalo de tempo no qual ajustar automaticamente o tamanho do pool de acordo com a fórmula de escala automática.
Se omitido, o valor padrão é 15 minutos (PT15M).
formula

string

Uma fórmula para o número desejado de nós de computação no pool.

AutoUserScope

O escopo para o usuário automático

Name Tipo Description
Pool

string

Especifica que a tarefa é executada como a conta de usuário automático comum que é criada em cada nó de um pool.
Task

string

Especifica que o serviço deve criar um novo usuário para a tarefa.

AutoUserSpecification

Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço de lote.

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, ou se certificados foram especificados no pool que não deve ser acessível por tarefas normais, mas deve ser acessível por tarefas iniciais.

AzureBlobFileSystemConfiguration

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

Name Tipo Description
accountKey

string

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

ComputeNodeIdentityReference

A referência à identidade atribuída ao usuário a ser usada para acessar 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 arquivos 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

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

A chave da conta do Armazenamento do Azure.
accountName

string

O nome da conta de Armazenamento do Azure.
azureFileUrl

string

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

BatchPoolIdentity

A identidade do pool de lotes, se configurado. Se a identidade do pool for atualizada durante a atualização de um pool existente, somente as novas vms criadas após a redução do pool para 0 terão as identidades atualizadas

Name Tipo Description
type

PoolIdentityType

O tipo de identidade usado para o pool de lotes.
userAssignedIdentities

<string,  UserAssignedIdentities>

A lista de identidades de usuário associadas ao pool de lotes.

CachingType

O tipo de cache a ser habilitado para o disco.

Name Tipo Description
None

string

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

string

O modo de cache para o disco é somente leitura.
ReadWrite

string

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

CertificateReference

Uma referência a um certificado a ser instalado em nós de computação em um pool. Isso deve existir dentro da mesma conta que o pool.

Name Tipo Description
id

string

A ID totalmente qualificada do certificado a ser instalado no pool. Isso deve estar dentro da mesma conta de lote que o pool.
storeLocation

CertificateStoreLocation

O local do armazenamento de certificados no nó de computação no qual instalar o certificado.
O valor padrão é currentUser. Esta propriedade é aplicável somente para pools configurados com nós de computação do Windows. Para nós de computação do Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho da tarefa e uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR é fornecida à tarefa para consultar esse local. Para certificados com visibilidade de 'remoteUser', um diretório 'certs' é criado no diretório inicial do usuário (por exemplo, /home/{user-name}/certs) e os certificados são colocados nesse diretório.
storeName

string

O nome do armazenamento de certificados no nó de computação no qual instalar o certificado.
Esta propriedade é aplicável somente para pools configurados com nós de computação do Windows. Os nomes de armazenamento comuns incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas qualquer nome de loja personalizado também pode ser usado. O valor padrão é My.
visibility

CertificateVisibility[]

Quais contas de usuário no nó de computação devem ter acesso aos dados privados do certificado.

CertificateStoreLocation

O local do armazenamento de certificados no nó de computação no qual instalar o certificado.

Name Tipo Description
CurrentUser

string

Os certificados devem ser instalados no repositório de certificados CurrentUser.
LocalMachine

string

Os certificados devem ser instalados no armazenamento de certificados LocalMachine.

CertificateVisibility

Quais contas de usuário no nó de computação devem ter acesso aos dados privados do certificado.

Name Tipo Description
RemoteUser

string

O certificado deve ser visível para as contas de usuário sob as quais os usuários acessam remotamente o nó.
StartTask

string

O certificado deve estar visível para a conta de usuário sob a qual a tarefa inicial é executada. Observe que, se o Escopo do Usuário Automático for Pool para StartTask e uma Tarefa, esse certificado também ficará visível para a Tarefa.
Task

string

O certificado deve estar visível para as contas de usuário sob as quais as tarefas de trabalho são executadas.

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

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

CloudError

Uma resposta de erro do serviço em lote.

Name Tipo Description
error

CloudErrorBody

O corpo da resposta de erro.

CloudErrorBody

Uma resposta de erro do serviço em lote.

Name Tipo Description
code

string

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

CloudErrorBody[]

Uma lista de detalhes adicionais sobre o erro.
message

string

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

string

O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

ComputeNodeDeallocationOption

Determina o que fazer com um nó e sua(s) tarefa(s) em execução depois que ele tiver sido selecionado para deallocation.

Name Tipo Description
Requeue

string

Encerre os processos de tarefas em execução e coloque novamente as tarefas na fila. As tarefas serão executadas novamente quando um nó estiver disponível. Remova os nós assim que as tarefas forem encerradas.
RetainedData

string

Permita que as tarefas atualmente em execução sejam concluídas e, em seguida, aguarde até que todos os períodos de retenção de dados da tarefa expirem. Não agende novas tarefas enquanto espera. Remova nós quando todos os períodos de retenção de tarefas tiverem expirado.
TaskCompletion

string

Permitir a conclusão de tarefas em execução no momento. Não agende novas tarefas enquanto espera. Remova os nós quando todas as tarefas forem concluídas.
Terminate

string

Encerrar tarefas em execução. As tarefas serão concluídas com failureInfo indicando que foram encerradas e não serão executadas novamente. Remova os nós assim que as tarefas forem encerradas.

ComputeNodeFillType

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

Name Tipo Description
Pack

string

O maior número possível de tarefas (taskSlotsPerNode) deve ser atribuído a cada nó do pool antes que qualquer tarefa seja atribuída ao próximo nó do pool.
Spread

string

As tarefas devem ser atribuídas uniformemente em todos os nós do pool.

ComputeNodeIdentityReference

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

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

ContainerConfiguration

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

Name Tipo Description
containerImageNames

string[]

A coleção de nomes de imagens de contêiner.
Esta é a referência de imagem completa, como seria especificado para "docker pull". Uma imagem será originada do registro padrão do Docker, a menos que a imagem seja totalmente qualificada com um registro alternativo.
containerRegistries

ContainerRegistry[]

Registos privados adicionais dos quais os contentores podem ser retirados.
Se alguma imagem deve ser baixada de um registro privado que requer credenciais, então essas credenciais devem ser fornecidas aqui.
type

ContainerType

A tecnologia de contentores a utilizar.

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.

Name Tipo Description
Applications

string

O caminho dos aplicativos.
JobPrep

string

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

string

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

string

O caminho para iniciar a tarefa.
Task

string

O caminho da tarefa.
VfsMounts

string

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

ContainerRegistry

Um registro de contêiner privado.

Name Tipo Description
identityReference

ComputeNodeIdentityReference

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.
A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
password

string

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

string

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

A tecnologia de contentores a utilizar.

Name Tipo Description
CriCompatible

string

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

string

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

ContainerWorkingDirectory

Um sinalizador para indicar onde está o diretório de trabalho da tarefa de contêiner. O padrão é 'taskWorkingDirectory'.

Name Tipo Description
ContainerImageDefault

string

Usando o diretório de trabalho definido pela imagem do contêiner. Cuidado que este diretório não conterá os arquivos de recursos baixados pelo Batch.
TaskWorkingDirectory

string

Use o diretório de trabalho de tarefa de serviço de lote padrão, que conterá os arquivos de recurso de tarefa preenchidos por lote.

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.
Os valores são:

none - O modo de cache para o disco não está ativado. readOnly - O modo de cache do disco é somente leitura. readWrite - O modo de cache para o disco é leitura e gravação.

O valor padrão para cache é none. 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

O tamanho inicial do disco em GB ao criar um novo disco de dados.
lun

integer

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

StorageAccountType

O tipo de conta de armazenamento a ser usado para o disco de dados.
Se omitido, o padrão é "Standard_LRS". Os valores são:

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.

DeploymentConfiguration

Propriedades de configuração de implantação.

Name Tipo Description
virtualMachineConfiguration

VirtualMachineConfiguration

A configuração da máquina virtual para o pool.

DiffDiskPlacement

Especifica o posicionamento efêmero do disco do sistema operacional para todas as VMs no pool.

Name Tipo Description
CacheDisk

string

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

DiffDiskSettings

Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pela máquina virtual.

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 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 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://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs do Linux em https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

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 Imagem de Máquina Virtual ou Imagem da Galeria de Computação do Azure.

Name Tipo Description
targets

DiskEncryptionTarget[]

A lista de destinos de disco que o Serviço em Lote criptografará no nó de computação
No pool Linux, apenas "TemporaryDisk" é suportado; no pool do Windows, "OsDisk" e "TemporaryDisk" devem ser especificados.

DiskEncryptionTarget

A lista de destinos de disco que o Serviço em Lote criptografará no nó de computação

Name Tipo Description
OsDisk

string

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

string

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

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

Name Tipo Description
job

string

A atribuição de VNet dinâmica é feita por trabalho. Se esse valor for definido, o ID da sub-rede de configuração de rede também deverá ser definido. Este recurso requer aprovação antes de usar, entre em contato com o suporte
none

string

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

ElevationLevel

O nível de elevação do usuário.

Name Tipo Description
Admin

string

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

string

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

EnvironmentSetting

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

Name Tipo Description
name

string

O nome da variável de ambiente.
value

string

O valor da variável de ambiente.

FixedScaleSettings

Configurações de escala fixas para o pool.

Name Tipo Default value Description
nodeDeallocationOption

ComputeNodeDeallocationOption

Determina o que fazer com um nó e sua(s) tarefa(s) em execução se o tamanho do pool estiver diminuindo.
Se omitido, o valor padrão é Requeue.
resizeTimeout

string

PT15M

O tempo limite para alocação de nós de computação para o pool.
O valor padrão é 15 minutos. Os valores de tempo limite usam o formato ISO 8601. Por exemplo, use PT10M por 10 minutos. O valor mínimo é de 5 minutos. Se você especificar um valor inferior a 5 minutos, o serviço em lote rejeitará a solicitação com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta).
targetDedicatedNodes

integer

O número desejado de nós de computação dedicados no pool.
Pelo menos um dos targetDedicatedNodes, targetLowPriorityNodes deve ser definido.
targetLowPriorityNodes

integer

O número desejado de nós de computação Spot/de baixa prioridade no pool.
Pelo menos um dos targetDedicatedNodes, targetLowPriorityNodes deve ser definido.

ImageReference

Uma referência a uma imagem do Azure Virtual Machines Marketplace ou ao recurso Azure Image de uma Máquina Virtual personalizada. Para obter a lista de todas as imageReferences verificadas pelo Lote do Azure, consulte a operação 'Listar SKUs de agente de nó suportado'.

Name Tipo Description
communityGalleryImageId

string

O identificador exclusivo da imagem da galeria da comunidade
Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida na chamada GET da galeria da comunidade.
id

string

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 essa ID de imagem. Este é o formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.
Esta propriedade é mutuamente exclusiva com outras propriedades. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região que a conta do Lote do Azure. Para obter informações sobre as configurações de firewall para o agente do nó Batch se comunicar com o serviço Batch, consulte https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
offer

string

O tipo de oferta da imagem do Azure Virtual Machines Marketplace.
Por exemplo, UbuntuServer ou WindowsServer.
publisher

string

O editor da imagem do Azure Virtual Machines Marketplace.
Por exemplo, Canonical ou MicrosoftWindowsServer.
sharedGalleryImageId

string

O identificador exclusivo da imagem da galeria compartilhada
Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida a partir da chamada GET da imagem da galeria partilhada.
sku

string

A SKU da imagem do Azure Virtual Machines Marketplace.
Por exemplo, 18.04-LTS ou 2022-datacenter.
version

string

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

InboundEndpointProtocol

O protocolo do ponto de extremidade.

Name Tipo Description
TCP

string

Use TCP para o ponto de extremidade.
UDP

string

Use UDP para o ponto de extremidade.

InboundNatPool

Um pool de 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

O número da porta no nó de computação.
Isso deve ser exclusivo dentro de um pool de lotes. 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

O último número de porta no intervalo de portas externas que serão usadas para fornecer acesso de entrada à 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 se sobrepor. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400.
frontendPortRangeStart

integer

O primeiro número de porta no intervalo de portas externas que serão usadas para fornecer acesso de entrada à porta de back-end 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 se sobrepor. 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 exclusivo dentro de um pool de lotes, pode conter letras, números, sublinhados, 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 pontos de extremidade em um pool de lotes é 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.

InterNodeCommunicationState

Se o pool permite a comunicação direta entre nós.

Name Tipo Description
Disabled

string

Desative a comunicação de rede entre máquinas virtuais.
Enabled

string

Habilite a comunicação de rede entre máquinas virtuais.

IPAddressProvisioningType

O tipo de provisionamento para endereços IP públicos para o pool de lotes.

Name Tipo Description
BatchManaged

string

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

string

Nenhum endereço IP público será criado para os nós de computação no pool.
UserManaged

string

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

LinuxUserConfiguration

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

Name Tipo Description
gid

integer

A ID de grupo da conta de usuário.
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

A chave privada SSH para a conta de usuário.
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 nós em um pool Linux quando a propriedade enableInterNodeCommunication do pool é true (ela é ignorada se enableInterNodeCommunication for false). Ele faz isso colocando o par de chaves no diretório .ssh do usuário. Se não for especificado, o SSH sem senha não será configurado entre nós (nenhuma modificação do diretório .ssh do usuário será feita).
uid

integer

O ID de usuário da conta de usuário.
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

Modo de login para o usuário

Name Tipo Description
Batch

string

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

string

O LOGON32_LOGON_INTERACTIVE modo de login do Win32. Alguns aplicativos exigem ter permissões associadas ao modo de login interativo. Se este for o caso de um aplicativo usado em sua tarefa, essa opção é recomendada.

ManagedDisk

Name Tipo Description
securityProfile

VMDiskSecurityProfile

Especifica o perfil de segurança para o disco gerenciado.
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.
storageAccountType

StorageAccountType

O tipo de conta de armazenamento para disco gerenciado.

MetadataItem

Um par nome-valor associado a um recurso de serviço em lote.

Name Tipo Description
name

string

O nome do item de metadados.
value

string

O valor do item de metadados.

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 Default value Description
dynamicVnetAssignmentScope

DynamicVNetAssignmentScope

none

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

PoolEndpointConfiguration

A configuração para pontos de extremidade em nós de computação no pool de lotes.
publicIPAddressConfiguration

PublicIPAddressConfiguration

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

string

O identificador de recurso ARM da sub-rede de rede virtual à qual os nós de computação do pool se juntarão. 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 do Lote do Azure. A sub-rede especificada deve ter endereços IP livres suficientes para acomodar o número de nós no pool. Se a sub-rede não tiver endereços IP livres suficientes, o pool alocará parcialmente os nós de computação e ocorrerá 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 Lote do Azure para poder agendar tarefas nos nós de computação. 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 de computação 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. Se a rede virtual especificada tiver algum NSG (Network Security Groups) associado, algumas portas reservadas do sistema deverão ser habilitadas 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://docs.microsoft.com/en-us/azure/batch/batch-api-basics#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

A prioridade para esta regra.
As prioridades dentro de um pool devem ser únicas e são 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) ou matrizes de portas ou intervalos de portas (ou seja, 100-200). As portas devem estar no intervalo de 0 a 65535 e os intervalos de portas ou portas não podem se sobrepor. Se quaisquer outros valores forem fornecidos, a solicitação falhará com o código de status HTTP 400. O valor padrão será *.

NetworkSecurityGroupRuleAccess

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

Name Tipo Description
Allow

string

Permitir acesso.
Deny

string

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

NodeCommunicationMode

Determina como um pool se comunica com o serviço de lote.

Name Tipo Description
Classic

string

Os nós que usam o modo de comunicação clássico exigem comunicação TCP de entrada nas portas 29876 e 29877 do "BatchNodeManagement. {region}" e comunicação TCP de saída na porta 443 para "Storage.region" e "BatchNodeManagement. {region}" tags de serviço.
Default

string

O modo de comunicação do nó é definido automaticamente pelo serviço Batch.
Simplified

string

Os nós que usam o modo de comunicação simplificado exigem comunicação TCP de saída na porta 443 para o "BatchNodeManagement. {region}" etiqueta de serviço. Não são necessárias portas de entrada abertas.

NodePlacementConfiguration

Configuração de posicionamento de nó para pools de lotes.

Name Tipo Description
policy

NodePlacementPolicyType

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.

NodePlacementPolicyType

A política de posicionamento para alocar nós no pool.

Name Tipo Description
Regional

string

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

string

Os nós no pool serão distribuídos por diferentes zonas com o melhor balanceamento de esforço.

OSDisk

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

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

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

DiffDiskSettings

Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pela máquina virtual.
managedDisk

ManagedDisk

Os parâmetros do disco gerenciado.
writeAcceleratorEnabled

boolean

Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

Pool

Contém informações sobre um pool.

Name Tipo Default value Description
etag

string

O ETag do recurso, usado para instruções de simultaneidade.
id

string

A ID do recurso.
identity

BatchPoolIdentity

O tipo de identidade usado para o pool de lotes.
O tipo de identidade usado para o pool de lotes.
name

string

O nome do recurso.
properties.allocationState

AllocationState

Se a piscina está a redimensionar.
properties.allocationStateTransitionTime

string

O momento em que o pool entrou em seu estado de alocação atual.
properties.applicationLicenses

string[]

A lista de licenças de aplicativo que o serviço Batch disponibilizará em cada nó de computação no pool.
A lista de licenças de aplicativo deve ser um subconjunto de licenças de aplicativo de serviço em lote disponíveis. Se for solicitada uma licença que não é suportada, a criação do pool falhará.
properties.applicationPackages

ApplicationPackageReference[]

A lista de pacotes de aplicativos a serem instalados em cada nó de computação no pool.
As alterações nas referências do pacote de aplicativos afetam todos os novos nós de computação 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 pacotes de aplicativos em um determinado pool.
properties.autoScaleRun

AutoScaleRun

Os resultados e erros da última execução da fórmula de escala automática.
Essa propriedade é definida somente se o pool for dimensionado automaticamente, ou seja, autoScaleSettings for usado.
properties.certificates

CertificateReference[]

A lista de certificados a serem instalados em cada nó de computação no pool.
Para nós de computação do Windows, o serviço Batch instala os certificados no armazenamento de certificados e no local especificados. Para nós de computação do Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho da tarefa e uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR é fornecida à tarefa para consultar esse local. Para certificados com visibilidade de 'remoteUser', um diretório 'certs' é criado no diretório inicial do usuário (por exemplo, /home/{user-name}/certs) e os certificados são colocados nesse diretório.

Aviso: Esta propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use o Azure KeyVault Extension.
properties.creationTime

string

O tempo de criação da piscina.
properties.currentDedicatedNodes

integer

O número de nós de computação dedicados atualmente no pool.
properties.currentLowPriorityNodes

integer

O número de nós de computação spot/de baixa prioridade atualmente no pool.
properties.currentNodeCommunicationMode

NodeCommunicationMode

O estado atual do modo de comunicação do pool.
properties.deploymentConfiguration

DeploymentConfiguration

Esta propriedade descreve as máquinas virtuais nas quais os nós do pool serão implantados.
properties.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.
properties.interNodeCommunication

InterNodeCommunicationState

Se o pool permite a comunicação direta entre nós.
Isso impõe restrições sobre quais nós podem ser atribuídos ao pool. Habilitar esse valor pode reduzir a chance de o número solicitado de nós ser alocado no pool. Se não for especificado, o padrão desse valor será 'Desativado'.
properties.lastModified

string

A última hora modificada da piscina.
Esta é a última vez em que os dados no nível do pool, como targetDedicatedNodes ou autoScaleSettings, foram alterados. Ele não leva em consideração alterações no nível do nó, como um nó de computação alterando o estado.
properties.metadata

MetadataItem[]

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.
properties.mountConfiguration

MountConfiguration[]

Uma lista de sistemas de arquivos a serem montados em cada nó do pool.
Isso dá suporte a Arquivos do Azure, NFS, CIFS/SMB e Blobfuse.
properties.networkConfiguration

NetworkConfiguration

A configuração de rede para o pool.
A configuração de rede para um pool.
properties.provisioningState

PoolProvisioningState

O estado atual do pool.
properties.provisioningStateTransitionTime

string

A hora em que o pool entrou em seu estado atual.
properties.resizeOperationStatus

ResizeOperationStatus

Contém detalhes sobre a operação de redimensionamento atual ou concluída pela última vez.
Descreve a operação atual (se o pool AllocationState for Resizing) ou a operação concluída anteriormente (se o AllocationState for Steady).
properties.resourceTags

object

As tags especificadas pelo usuário associadas ao pool.
As marcas definidas pelo usuário a serem associadas ao Pool de Lotes do Azure. Quando especificadas, essas marcas são propagadas para os recursos do Azure de suporte associados ao pool. Essa propriedade só pode ser especificada quando a conta Batch foi criada com a propriedade poolAllocationMode definida como 'UserSubscription'.
properties.scaleSettings

ScaleSettings

Configurações que configuram o número de nós no pool.
Define o tamanho desejado do pool. Isso pode ser 'fixedScale', onde o targetDedicatedNodes solicitado é especificado, ou 'autoScale', que define uma fórmula que é reavaliada periodicamente. Se essa propriedade não for especificada, o pool terá uma escala fixa com 0 targetDedicatedNodes.
properties.startTask

StartTask

Uma tarefa especificada para ser executada em cada nó de computação à medida que se junta ao pool.
Em uma operação PATCH (atualização), essa propriedade pode ser definida como um objeto vazio para remover a tarefa inicial do pool.
properties.targetNodeCommunicationMode

NodeCommunicationMode

O modo de comunicação de nó desejado para o pool.
Se omitido, o valor padrão é Default.
properties.taskSchedulingPolicy

TaskSchedulingPolicy

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.
properties.taskSlotsPerNode

integer

1

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.
properties.upgradePolicy

UpgradePolicy

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

UserAccount[]

A lista de contas de usuário a serem criadas em cada nó do pool.
properties.vmSize

string

O tamanho das máquinas virtuais no pool. Todas as VMs em um pool têm o mesmo tamanho.
Para obter informações sobre tamanhos de VM disponíveis, consulte Tamanhos para máquinas virtuais (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou Tamanhos para máquinas virtuais (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). 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).
tags

object

As tags do recurso.
type

string

O tipo do recurso.

PoolEndpointConfiguration

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

Name Tipo Description
inboundNatPools

InboundNatPool[]

Uma lista de pools NAT de entrada que podem ser usados para endereçar portas específicas em um nó de computação individual externamente.
O número máximo de pools de NAT de entrada por pool de lotes é 5. Se o número máximo de pools NAT de entrada for excedido, a solicitação falhará com o código de status HTTP 400. Isso não pode ser especificado se o IPAddressProvisioningType for NoPublicIPAddresses.

PoolIdentityType

O tipo de identidade usado para o pool de lotes.

Name Tipo Description
None

string

O pool de lotes não tem nenhuma identidade associada a ele. Definir None no pool de atualizações removerá as identidades existentes.
UserAssigned

string

O pool de lotes tem identidades atribuídas ao usuário.

PoolProvisioningState

O estado atual do pool.

Name Tipo Description
Deleting

string

O usuário solicitou que o pool fosse excluído, mas a operação de exclusão ainda não foi concluída.
Succeeded

string

O pool está disponível para executar tarefas sujeitas à disponibilidade de nós de computação.

PublicIPAddressConfiguration

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

Name Tipo Description
ipAddressIds

string[]

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/de baixa prioridade 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}.
provision

IPAddressProvisioningType

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

ResizeError

Um erro que ocorreu ao redimensionar um pool.

Name Tipo Description
code

string

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

ResizeError[]

Detalhes adicionais sobre o erro.
message

string

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

ResizeOperationStatus

Detalhes sobre a operação de redimensionamento atual ou concluída pela última vez.

Name Tipo Description
errors

ResizeError[]

Detalhes de quaisquer erros encontrados durante a execução do último redimensionamento no pool.
Essa propriedade é definida somente se ocorrer um erro durante o último redimensionamento do pool e somente quando o pool allocationState for Steady.
nodeDeallocationOption

ComputeNodeDeallocationOption

Determina o que fazer com um nó e sua(s) tarefa(s) em execução se o tamanho do pool estiver diminuindo.
O valor padrão é requeue.
resizeTimeout

string

O tempo limite para alocação de nós de computação para o pool ou remoção de nós de computação do pool.
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).
startTime

string

A hora em que essa operação de redimensionamento foi iniciada.
targetDedicatedNodes

integer

O número desejado de nós de computação dedicados no pool.
targetLowPriorityNodes

integer

O número desejado de nós de computação Spot/de baixa prioridade no pool.

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 contêiner 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 arquivos que estão sendo baixados para nós de computação do Linux. Ele será ignorado se for especificado para um resourceFile que será baixado para um nó do Windows. Se essa propriedade não for especificada para um nó Linux, um valor padrão de 0770 será aplicado ao arquivo.
filePath

string

O local no nó de computação para o qual baixar o arquivo, relativo 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

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

ComputeNodeIdentityReference

A referência à identidade atribuída ao usuário a ser usada para acessar o Armazenamento de Blob do Azure especificado por storageContainerUrl ou httpUrl
A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
storageContainerUrl

string

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. Se esse campo não estiver definido, o Lote do Azure Azure não definirá seu valor padrão. O valor de enableCrossZoneUpgrade no VirtualMachineScaleSet criado será decidido pelas configurações padrão em VirtualMachineScaleSet. Este campo pode ser definido como true ou false somente ao usar NodePlacementConfiguration como Zonal.
maxBatchInstancePercent

integer

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

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

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

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.

ScaleSettings

Configurações de escala para o pool

Name Tipo Description
autoScale

AutoScaleSettings

Configurações de AutoScale para o pool.
Esta propriedade e fixedScale são mutuamente exclusivas e uma das propriedades deve ser especificada.
fixedScale

FixedScaleSettings

Configurações de escala fixas para o pool.
Esta propriedade e autoScale são mutuamente exclusivas e uma das propriedades deve ser especificada.

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.

Name Tipo Description
NonPersistedTPM

string

VMGuestStateOnly

string

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

SecurityTypes

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

UefiSettings

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.

Name Tipo Description
confidentialVM

string

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

string

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

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

A ID de referência de artefato 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}

StartTask

Uma tarefa que é executada quando um nó de computação se junta a um pool no serviço de Lote do Azure ou quando o nó de computação é reinicializado ou recriado.

Name Tipo Default value Description
commandLine

string

A linha de comando da tarefa iniciar.
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. Obrigatório se quaisquer outras propriedades do startTask forem especificadas.
containerSettings

TaskContainerSettings

As configurações do contêiner sob o qual a tarefa inicial é executada.
Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios do Lote do Azure no nó) são mapeados no contêiner, todas as variáveis de ambiente de tarefa são mapeadas no contêiner e a linha de comando da tarefa é executada no contêiner.
environmentSettings

EnvironmentSetting[]

Uma lista de configurações de variáveis de ambiente para a tarefa iniciar.
maxTaskRetryCount

integer

0

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. O padrão é 0
resourceFiles

ResourceFile[]

Uma lista de arquivos que o serviço Batch baixará para o nó de computação antes de executar a linha de comando.
userIdentity

UserIdentity

A identidade do usuário sob a qual a tarefa inicial é executada.
Se omitida, a tarefa é executada como um usuário não administrativo exclusivo para a tarefa.
waitForSuccess

boolean

Se o serviço em lote deve aguardar a conclusão bem-sucedida da tarefa de início (ou seja, sair com o código de saída 0) antes de agendar quaisquer tarefas no nó de computação.
Se true e a tarefa inicial falhar em um nó de computação, o serviço Batch tentará novamente a tarefa inicial 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 em lote marcará o nó de computação como inutilizável e não agendará tarefas para ele. Esta condição pode ser detetada através do estado do nó e detalhes do erro de agendamento. Se false, o serviço Batch não aguardará a conclusão da tarefa inicial. Nesse caso, outras tarefas podem começar a ser executadas no nó de computação enquanto a tarefa inicial ainda está em execução; E mesmo que a tarefa Iniciar falhe, novas tarefas continuarão a ser agendadas no nó. O padrão é true.

StorageAccountType

O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional.

Name Tipo Description
Premium_LRS

string

O disco de dados / disco do sistema operacional deve usar armazenamento premium localmente redundante.
StandardSSD_LRS

string

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

string

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

TaskContainerSettings

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 ser usada para criar o contêiner no qual a tarefa será executada.
Esta é a referência de imagem completa, como seria especificado para "docker pull". Se nenhuma tag for fornecida como parte do nome da imagem, a tag ":latest" será usada como padrão.
registry

ContainerRegistry

O registro privado que contém a imagem do contêiner.
Essa configuração pode ser omitida se já tiver sido fornecida na criação do pool.
workingDirectory

ContainerWorkingDirectory

Um sinalizador para indicar onde está o diretório de trabalho da tarefa de contêiner. O padrão é 'taskWorkingDirectory'.

TaskSchedulingPolicy

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

Name Tipo Default value Description
nodeFillType

ComputeNodeFillType

Spread

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

UefiSettings

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.

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.

Name Tipo Description
automatic

string

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

string

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

string

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.
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 em um nó do Lote do Azure.

Name Tipo Description
elevationLevel

ElevationLevel

O nível de elevação da conta de usuário.
nonAdmin - O usuário automático é um usuário padrão sem acesso elevado. admin - O usuário automático é um usuário com acesso elevado e opera com permissões totais de administrador. O valor padrão é nonAdmin.
linuxUserConfiguration

LinuxUserConfiguration

A configuração de usuário específica do Linux para a conta de usuário.
Esta propriedade é ignorada se especificada em um pool do Windows. Se não for especificado, o usuário será criado com as opções padrão.
name

string

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

string

A senha da conta de usuário.
windowsUserConfiguration

WindowsUserConfiguration

A configuração de usuário específica do Windows para a conta de usuário.
Essa propriedade só pode ser especificada se o usuário estiver em um pool do Windows. Se não especificado e em um pool do Windows, o usuário é criado com as opções padrão.

UserAssignedIdentities

A lista de identidades de usuário associadas.

Name Tipo Description
clientId

string

O ID do cliente da identidade atribuída ao usuário.
principalId

string

O id principal da identidade atribuída ao usuário.

UserIdentity

A definição da identidade do usuário sob a qual a tarefa é executada.

Name Tipo Description
autoUser

AutoUserSpecification

O usuário 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 usuário 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

ContainerConfiguration

A configuração do contêiner para o pool.
Se especificado, a configuração é executada em cada nó do pool para permitir que as tarefas sejam executadas em contêineres. Todas as tarefas regulares e tarefas do gerenciador de tarefas executadas nesse pool devem especificar a propriedade containerSettings e todas as outras tarefas podem especificá-la.
dataDisks

DataDisk[]

A configuração para discos de dados anexados aos nós de computação no pool.
Essa propriedade deve ser especificada se os nós de computação no pool precisarem ter discos de dados vazios conectados a eles.
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

ImageReference

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

string

O tipo de licença local a ser usada ao implantar o sistema operacional.
Isso só se aplica a imagens que contêm o sistema operacional Windows e só deve ser usado quando você possui licenças locais válidas para os nós que serão implantados. 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ó Batch a ser provisionado em nós de computação no pool.
O agente do nó Batch é um programa executado em cada nó do pool e fornece a interface de comando e controle entre o nó e o serviço Batch. Existem diferentes implementações do agente de nó, conhecido como SKUs, para diferentes sistemas operacionais. Você deve especificar uma SKU do agente de nó que corresponda à referência de imagem selecionada. Para obter a lista de SKUs de agente de nó suportados, juntamente com sua lista de referências de imagem verificadas, consulte a operação 'Listar SKUs de agente de nó suportados'.
nodePlacementConfiguration

NodePlacementConfiguration

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

OSDisk

Configurações para o disco do sistema operacional da máquina virtual.
Contém configuração para configurações efêmeras do OSDisk.
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.
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.
Essa propriedade não deve ser especificada se imageReference especificar uma imagem do sistema operacional Linux.

VMDiskSecurityProfile

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.

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 de extensões.
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ó do Windows.

Name Tipo Description
loginMode

LoginMode

Modo de login para o usuário
Especifica o modo de login para o usuário. O valor padrão é Interativo.