Share via

Pool - Create

  • 참조
Service:
Batch Management
API Version:
2024-02-01

지정된 계정 내에 새 풀을 만듭니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
accountName
 path True

string

Batch 계정의 이름입니다.

Regex pattern: ^[a-zA-Z0-9]+$
poolName
 path True

string

풀 이름입니다. 계정 내에서 고유해야 합니다.

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

string

Batch 계정을 포함하는 리소스 그룹의 이름입니다.
subscriptionId
 path True

string

Azure 구독 ID입니다. GUID 형식 문자열입니다(예: 000000000-0000-0000-0000-0000-000000000000).
api-version
 query True

string

HTTP 요청과 함께 사용할 API 버전입니다.

요청 헤더

Name 필수 형식 Description
If-Match

string

업데이트할 풀의 ETag(엔터티 상태) 버전입니다. 풀이 이미 있는 경우에만 "*" 값을 사용하여 작업을 적용할 수 있습니다. 생략하면 이 작업이 항상 적용됩니다.
If-None-Match

string

새 풀을 만들 수 있지만 기존 풀을 업데이트하지 않도록 하려면 '*'로 설정합니다. 다른 값은 무시됩니다.

요청 본문

Name 형식 Description
identity

BatchPoolIdentity

Batch 풀에 사용되는 ID 유형입니다.
Batch 풀에 사용되는 ID 유형입니다.
properties.applicationLicenses

string[]

Batch 서비스가 풀의 각 컴퓨팅 노드에서 사용할 수 있도록 하는 애플리케이션 라이선스 목록입니다.
애플리케이션 라이선스 목록은 사용 가능한 Batch 서비스 애플리케이션 라이선스의 하위 집합이어야 합니다. 지원되지 않는 라이선스가 요청되면 풀 만들기가 실패합니다.
properties.applicationPackages

ApplicationPackageReference[]

풀의 각 컴퓨팅 노드에 설치할 애플리케이션 패키지 목록입니다.
애플리케이션 패키지 참조에 대한 변경 내용은 풀에 조인하는 모든 새 컴퓨팅 노드에 영향을 주지만 다시 부팅되거나 이미지로 다시 설치될 때까지 풀에 이미 있는 컴퓨팅 노드에는 영향을 미치지 않습니다. 지정된 풀에는 최대 10개의 애플리케이션 패키지 참조가 있습니다.
properties.certificates

CertificateReference[]

풀의 각 컴퓨팅 노드에 설치할 인증서 목록입니다.
Windows 컴퓨팅 노드의 경우 Batch 서비스는 지정된 인증서 저장소 및 위치에 인증서를 설치합니다. Linux 컴퓨팅 노드의 경우 인증서는 작업 작업 디렉터리 내의 디렉터리에 저장되고 AZ_BATCH_CERTIFICATES_DIR 환경 변수는 이 위치를 쿼리하기 위해 태스크에 제공됩니다. 'remoteUser'의 표시 유형이 있는 인증서의 경우 사용자의 홈 디렉터리(예: /home/{user-name}/certs)에 'certs' 디렉터리가 만들어지고 인증서가 해당 디렉터리에 배치됩니다.

경고: 이 속성은 더 이상 사용되지 않으며 2024년 2월 이후에 제거됩니다. 대신 Azure KeyVault 확장을 사용하세요.
properties.deploymentConfiguration

DeploymentConfiguration

이 속성은 Cloud Services 또는 Virtual Machines 사용하여 풀 노드를 배포하는 방법을 설명합니다.
CloudServiceConfiguration을 사용하면 노드가 Azure Cloud Services(PaaS)를 사용하여 만들어야 하는 반면 VirtualMachineConfiguration은 Azure Virtual Machines(IaaS)를 사용합니다.
properties.displayName

string

풀의 표시 이름입니다.
표시 이름은 고유할 필요가 없으며 최대 길이 1024까지 유니코드 문자를 포함할 수 있습니다.
properties.interNodeCommunication

InterNodeCommunicationState

풀이 노드 간의 직접 통신을 허용하는지 여부입니다.
이렇게 하면 풀에 할당할 수 있는 노드가 제한됩니다. 이 값을 사용하도록 설정하면 요청된 노드 수가 풀에 할당될 가능성을 줄일 수 있습니다. 지정하지 않으면 이 값은 기본적으로 '사용 안 함'으로 설정됩니다.
properties.metadata

MetadataItem[]

풀과 메타데이터로 연결된 이름-값 쌍의 목록입니다.
Batch 서비스는 메타데이터에 의미를 할당하지 않습니다. 사용자 코드를 사용하기 위한 것입니다.
properties.mountConfiguration

MountConfiguration[]

풀의 각 노드에 탑재할 파일 시스템 목록입니다.
Azure Files, NFS, CIFS/SMB 및 Blobfuse를 지원합니다.
properties.networkConfiguration

NetworkConfiguration

풀의 네트워크 구성입니다.
풀에 대한 네트워크 구성입니다.
properties.resourceTags

object

풀과 연결된 사용자 지정 태그입니다.
Azure Batch 풀과 연결할 사용자 정의 태그입니다. 지정된 경우 이러한 태그는 풀과 연결된 지원 Azure 리소스로 전파됩니다. 이 속성은 PoolAllocationMode 속성이 'UserSubscription'으로 설정된 Batch 계정을 만든 경우에만 지정할 수 있습니다.
properties.scaleSettings

ScaleSettings

풀의 노드 수를 구성하는 설정입니다.
풀의 원하는 크기를 정의합니다. 요청된 targetDedicatedNodes가 지정된 'fixedScale' 또는 주기적으로 다시 평가되는 수식을 정의하는 'autoScale'일 수 있습니다. 이 속성을 지정하지 않으면 풀은 targetDedicatedNodes가 0인 고정 배율을 갖습니다.
properties.startTask

StartTask

풀에 조인할 때 각 컴퓨팅 노드에서 실행되도록 지정된 작업입니다.
PATCH(업데이트) 작업에서 이 속성을 빈 개체로 설정하여 풀에서 시작 작업을 제거할 수 있습니다.
properties.targetNodeCommunicationMode

NodeCommunicationMode

풀에 대해 원하는 노드 통신 모드입니다.
생략하면 기본값은 Default입니다.
properties.taskSchedulingPolicy

TaskSchedulingPolicy

풀의 컴퓨팅 노드에 태스크를 분산하는 방법
지정하지 않으면 기본값이 분산됩니다.
properties.taskSlotsPerNode

integer

풀의 단일 컴퓨팅 노드에서 동시 태스크를 실행하는 데 사용할 수 있는 태스크 슬롯의 수입니다.
기본값은 1입니다. 최대값은 풀의 vmSize 코어 수의 4배 또는 256의 작은 값입니다.
properties.upgradePolicy

UpgradePolicy

풀에 대한 업그레이드 정책입니다.
자동, 수동 또는 롤링 업그레이드 정책에 대해 설명합니다.
properties.userAccounts

UserAccount[]

풀의 각 노드에서 만들 사용자 계정 목록입니다.
properties.vmSize

string

풀에 있는 가상 머신의 크기입니다. 풀의 모든 VM 크기는 동일합니다.
Cloud Services 풀에 사용 가능한 가상 머신 크기(cloudServiceConfiguration으로 만든 풀)에 대한 자세한 내용은 Cloud Services 크기(https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/)를 참조하세요. Batch는 ExtraSmall을 제외한 모든 Cloud Services VM 크기를 지원합니다. Virtual Machines Marketplace의 이미지를 사용하여 풀에 사용할 수 있는 VM 크기(virtualMachineConfiguration으로 만든 풀)에 대한 자세한 내용은 Virtual Machines 크기(Linux) 또는 Virtual Machines 크기(https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/Windows)(https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)를 참조하세요. Batch는 STANDARD_A0 및 Premium Storage(STANDARD_GS, STANDARD_DS 및 STANDARD_DSV2 시리즈)를 제외한 모든 Azure VM 크기를 지원합니다.

응답

Name 형식 Description
200 OK

Pool

작업이 완료되었습니다. 응답에는 풀 엔터티가 포함됩니다.

Headers

ETag: string
Other Status Codes

CloudError

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

OAuth 2.0 인증 코드 흐름 Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

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

CreatePool - accelerated networking

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8DB46CB72A227E2"
Response Body
{
  "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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "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 CloudServiceConfiguration

Sample Request

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

{
  "properties": {
    "displayName": "my-pool-name",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Enabled",
    "taskSlotsPerNode": 13,
    "taskSchedulingPolicy": {
      "nodeFillType": "Pack"
    },
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "4",
        "osVersion": "WA-GUEST-OS-4.45_201708-01"
      }
    },
    "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",
          "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268"
        ]
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 6,
        "targetLowPriorityNodes": 28,
        "resizeTimeout": "PT8M",
        "nodeDeallocationOption": "TaskCompletion"
      }
    },
    "metadata": [
      {
        "name": "metadata-1",
        "value": "value-1"
      },
      {
        "name": "metadata-2",
        "value": "value-2"
      }
    ],
    "startTask": {
      "commandLine": "cmd /c SET",
      "resourceFiles": [
        {
          "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file",
          "filePath": "c:\\temp\\gohere",
          "fileMode": "777"
        }
      ],
      "environmentSettings": [
        {
          "name": "MYSET",
          "value": "1234"
        }
      ],
      "userIdentity": {
        "autoUser": {
          "scope": "Pool",
          "elevationLevel": "Admin"
        }
      },
      "maxTaskRetryCount": 6,
      "waitForSuccess": true
    },
    "userAccounts": [
      {
        "name": "username1",
        "password": "<ExamplePassword>",
        "elevationLevel": "Admin",
        "linuxUserConfiguration": {
          "sshPrivateKey": "sshprivatekeyvalue",
          "uid": 1234,
          "gid": 4567
        }
      }
    ],
    "applicationPackages": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234",
        "version": "asdf"
      }
    ],
    "certificates": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
        "storeLocation": "LocalMachine",
        "storeName": "MY",
        "visibility": [
          "RemoteUser"
        ]
      }
    ],
    "applicationLicenses": [
      "app-license0",
      "app-license1"
    ]
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "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": "Enabled",
    "taskSlotsPerNode": 13,
    "taskSchedulingPolicy": {
      "nodeFillType": "Pack"
    },
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "4",
        "osVersion": "WA-GUEST-OS-4.45_201708-01"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 6,
        "targetLowPriorityNodes": 28,
        "resizeTimeout": "PT8M",
        "nodeDeallocationOption": "TaskCompletion"
      }
    },
    "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",
          "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268"
        ]
      }
    },
    "metadata": [
      {
        "name": "metadata-1",
        "value": "value-1"
      },
      {
        "name": "metadata-2",
        "value": "value-2"
      }
    ],
    "startTask": {
      "commandLine": "cmd /c SET",
      "resourceFiles": [
        {
          "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file",
          "filePath": "c:\\temp\\gohere",
          "fileMode": "777"
        }
      ],
      "environmentSettings": [
        {
          "name": "MYSET",
          "value": "1234"
        }
      ],
      "userIdentity": {
        "autoUser": {
          "scope": "Pool",
          "elevationLevel": "Admin"
        }
      },
      "maxTaskRetryCount": 6,
      "waitForSuccess": true
    },
    "userAccounts": [
      {
        "name": "username1",
        "elevationLevel": "Admin",
        "linuxUserConfiguration": {
          "uid": 1234,
          "gid": 4567
        }
      }
    ],
    "applicationPackages": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234",
        "version": "asdf"
      }
    ],
    "certificates": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
        "storeLocation": "LocalMachine",
        "storeName": "MY",
        "visibility": [
          "RemoteUser"
        ]
      }
    ],
    "applicationLicenses": [
      "app-license0",
      "app-license1"
    ],
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Full VirtualMachineConfiguration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "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 CloudServiceConfiguration

Sample Request

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

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "5"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 3
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "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": {
      "cloudServiceConfiguration": {
        "osFamily": "5",
        "osVersion": "*"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 3,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "resizeOperationStatus": {
      "startTime": "2017-08-28T10:22:55.9407275Z",
      "targetDedicatedNodes": 3,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M"
    }
  }
}

CreatePool - Minimal VirtualMachineConfiguration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8DB554F8E08BCF4"
Response Body
{
  "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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8DB554F8E08BCF4"
Response Body
{
  "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 - UpgradePolicy

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8DB51E64D3C3B69"
Response Body
{
  "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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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": {}
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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"
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8DB51F14DC1A8AD"
Response Body
{
  "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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-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
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8DB51F14DC1A8AD"
Response Body
{
  "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
      }
    }
  }
}

정의

Name Description
AllocationState

풀의 크기 조정 여부입니다.
ApplicationPackageReference

일괄 처리 계정 내의 애플리케이션 패키지에 연결
AutomaticOSUpgradePolicy

자동 OS 업그레이드를 수행하는 데 사용되는 구성 매개 변수입니다.
AutoScaleRun

풀 자동 크기 조정 수식 실행의 결과 및 오류입니다.
AutoScaleRunError

풀을 자동 크기 조정할 때 발생한 오류입니다.
AutoScaleSettings

풀에 대한 자동 크기 조정 설정입니다.
AutoUserScope

자동 사용자에 대한 scope
AutoUserSpecification

Batch 서비스에서 작업을 실행하는 자동 사용자에 대한 매개 변수를 지정합니다.
AzureBlobFileSystemConfiguration

Blobfuse를 사용하여 Azure Storage 컨테이너에 연결하는 데 사용되는 정보입니다.
AzureFileShareConfiguration

Azure Fileshare에 연결하는 데 사용되는 정보입니다.
BatchPoolIdentity

구성된 경우 Batch 풀의 ID입니다. 기존 풀을 업데이트하는 동안 풀 ID가 업데이트되는 경우 풀이 0으로 축소된 후 생성된 새 vm만 업데이트된 ID를 갖게 됩니다.
CachingType

디스크에 사용할 캐싱 유형입니다.
CertificateReference

풀의 컴퓨팅 노드에 설치할 인증서에 대한 참조입니다. 풀과 동일한 계정 내에 있어야 합니다.
CertificateStoreLocation

인증서를 설치할 컴퓨팅 노드의 인증서 저장소 위치입니다.
CertificateVisibility

컴퓨팅 노드의 사용자 계정이 인증서의 프라이빗 데이터에 액세스할 수 있어야 합니다.
CIFSMountConfiguration

CIFS 파일 시스템에 연결하는 데 사용되는 정보입니다.
CloudError

Batch 서비스의 오류 응답입니다.
CloudErrorBody

Batch 서비스의 오류 응답입니다.
CloudServiceConfiguration

Azure Cloud Services 플랫폼을 기반으로 풀의 노드에 대한 구성입니다.
ComputeNodeDeallocationOption

할당 취소를 위해 선택한 후 노드 및 실행 중인 작업으로 수행할 작업을 결정합니다.
ComputeNodeFillType

태스크를 컴퓨팅 노드에 분산하는 방법
ComputeNodeIdentityReference

컴퓨팅 노드에서 사용할 Batch 풀과 연결된 사용자 할당 ID에 대한 참조입니다.
ContainerConfiguration

컨테이너 사용 풀에 대한 구성입니다.
ContainerRegistry

프라이빗 컨테이너 레지스트리.
ContainerType

사용할 컨테이너 기술입니다.
ContainerWorkingDirectory

컨테이너 작업 디렉터리의 위치를 나타내는 플래그입니다. 기본값은 'taskWorkingDirectory'입니다.
DataDisk

풀의 컴퓨팅 노드에 연결된 데이터 디스크에서 사용할 설정입니다. 연결된 데이터 디스크를 사용하는 경우 VM 내에서 디스크를 탑재하고 포맷하여 사용해야 합니다.
DeploymentConfiguration

배포 구성 속성.
DiffDiskPlacement

풀의 모든 VM에 대한 운영 체제 디스크의 임시 디스크 배치를 지정합니다.
DiffDiskSettings

가상 머신에서 사용하는 운영 체제 디스크에 대한 임시 디스크 설정을 지정합니다.
DiskEncryptionConfiguration

풀의 컴퓨팅 노드에 적용되는 디스크 암호화 구성입니다. Virtual Machine 이미지 또는 Azure Compute Gallery 이미지로 만든 Linux 풀에서는 디스크 암호화 구성이 지원되지 않습니다.
DiskEncryptionTarget

Batch 서비스가 컴퓨팅 노드에서 암호화할 디스크 대상 목록
DynamicVNetAssignmentScope

동적 vnet 할당의 scope.
ElevationLevel

사용자의 권한 상승 수준입니다.
EnvironmentSetting

작업 프로세스에서 설정할 환경 변수입니다.
FixedScaleSettings

풀에 대한 크기 조정 설정을 수정했습니다.
ImageReference

Azure Virtual Machines Marketplace 이미지 또는 사용자 지정 Virtual Machine의 Azure 이미지 리소스에 대한 참조입니다. Azure Batch 확인된 모든 imageReferences 목록을 얻으려면 '지원되는 노드 에이전트 SKU 나열' 작업을 참조하세요.
InboundEndpointProtocol

엔드포인트의 프로토콜입니다.
InboundNatPool

외부적으로 Batch 풀의 컴퓨팅 노드에서 특정 포트를 처리하는 데 사용할 수 있는 인바운드 NAT 풀입니다.
InterNodeCommunicationState

풀이 노드 간의 직접 통신을 허용하는지 여부입니다.
IPAddressProvisioningType

Batch 풀의 공용 IP 주소에 대한 프로비저닝 유형입니다.
LinuxUserConfiguration

Linux 노드에서 사용자 계정을 만드는 데 사용되는 속성입니다.
LoginMode

사용자에 대한 로그인 모드
ManagedDisk
MetadataItem

Batch 서비스 리소스와 연결된 이름-값 쌍입니다.
MountConfiguration

각 노드에 탑재할 파일 시스템입니다.
NetworkConfiguration

풀에 대한 네트워크 구성입니다.
NetworkSecurityGroupRule

인바운드 엔드포인트에 적용할 네트워크 보안 그룹 규칙입니다.
NetworkSecurityGroupRuleAccess

지정된 IP 주소, 서브넷 범위 또는 태그에 대해 수행해야 하는 작업입니다.
NFSMountConfiguration

NFS 파일 시스템에 연결하는 데 사용되는 정보입니다.
NodeCommunicationMode

풀이 Batch 서비스와 통신하는 방법을 결정합니다.
NodePlacementConfiguration

일괄 처리 풀에 대한 노드 배치 구성입니다.
NodePlacementPolicyType

풀에서 노드를 할당하기 위한 배치 정책입니다.
OSDisk

가상 머신의 운영 체제 디스크에 대한 설정입니다.
Pool

풀에 대한 정보를 포함합니다.
PoolEndpointConfiguration

풀에 대한 엔드포인트 구성입니다.
PoolIdentityType

Batch 풀에 사용되는 ID 유형입니다.
PoolProvisioningState

풀의 현재 상태입니다.
PublicIPAddressConfiguration

풀의 네트워킹 구성에 대한 공용 IP 주소 구성입니다.
ResizeError

풀 크기를 조정할 때 발생한 오류입니다.
ResizeOperationStatus

현재 또는 마지막으로 완료된 크기 조정 작업에 대한 세부 정보입니다.
ResourceFile

컴퓨팅 노드에 다운로드할 단일 파일 또는 여러 파일입니다.
RollingUpgradePolicy

롤링 업그레이드를 수행하는 동안 사용되는 구성 매개 변수입니다.
ScaleSettings

풀에 대한 크기 조정 설정
SecurityProfile

가상 머신 또는 가상 머신 확장 집합에 대한 보안 프로필 설정을 지정합니다.
SecurityTypes

가상 머신의 SecurityType을 지정합니다. UefiSettings를 사용하도록 설정하려면 지정된 값으로 설정해야 합니다.
ServiceArtifactReference

'최신' 이미지 버전을 사용할 때 확장 집합의 모든 가상 머신에 대해 동일한 이미지 버전을 설정하는 데 사용되는 서비스 아티팩트 참조 ID를 지정합니다.
StartTask

컴퓨팅 노드가 Azure Batch 서비스의 풀에 조인하거나 컴퓨팅 노드를 다시 부팅하거나 이미지로 다시 설치할 때 실행되는 작업입니다.
StorageAccountType

데이터 디스크 또는 OS 디스크를 만드는 데 사용할 스토리지 계정 유형입니다.
TaskContainerSettings

작업에 대한 컨테이너 설정입니다.
TaskSchedulingPolicy

태스크를 컴퓨팅 노드에 분산하는 방법을 지정합니다.
UefiSettings

가상 머신을 만드는 동안 사용되는 보안 부팅 및 vTPM과 같은 보안 설정을 지정합니다.
UpgradeMode

확장 집합에서 가상 머신으로 업그레이드하는 모드를 지정합니다.

가능한 값은 다음과 같습니다.

수동 - 확장 집합에서 가상 머신에 대한 업데이트 애플리케이션을 제어합니다. manualUpgrade 작업을 사용하여 이 작업을 수행합니다.

자동 - 확장 집합의 모든 가상 머신이 동시에 자동으로 업데이트됩니다.

롤링 - 확장 집합은 선택적 일시 중지 시간을 사용하여 일괄 처리로 업데이트를 수행합니다.
UpgradePolicy

자동, 수동 또는 롤링 업그레이드 정책에 대해 설명합니다.
UserAccount

Azure Batch 노드에서 사용자를 만드는 데 사용되는 속성입니다.
UserAssignedIdentities

연결된 사용자 ID 목록입니다.
UserIdentity

작업이 실행되는 사용자 ID의 정의입니다.
VirtualMachineConfiguration

Azure Virtual Machines 인프라를 기반으로 풀의 컴퓨팅 노드에 대한 구성입니다.
VMExtension

가상 머신 확장에 대한 구성입니다.
WindowsConfiguration

가상 머신에 적용할 Windows 운영 체제 설정입니다.
WindowsUserConfiguration

Windows 노드에서 사용자 계정을 만드는 데 사용되는 속성입니다.

AllocationState

풀의 크기 조정 여부입니다.

Name 형식 Description
Resizing

string

풀의 크기가 조정되고, 즉, 컴퓨팅 노드가 풀에 추가되거나 풀에서 제거됩니다.
Steady

string

풀의 크기가 조정되지 않습니다. 진행 중인 풀의 노드 수는 변경되지 않습니다. 풀이 만들어지고 풀에서 노드 수를 변경하는 작업이 수행되지 않을 때 이 상태가 됩니다.
Stopping

string

풀의 크기가 조정되었지만 사용자가 크기 조정을 중지하도록 요청했지만 중지 요청이 아직 완료되지 않았습니다.

ApplicationPackageReference

일괄 처리 계정 내의 애플리케이션 패키지에 연결

Name 형식 Description
id

string

설치할 애플리케이션 패키지의 ID입니다. 풀과 동일한 일괄 처리 계정 내에 있어야 합니다. 특정 버전에 대한 참조이거나 기본 버전(있는 경우)일 수 있습니다.
version

string

배포할 애플리케이션의 버전입니다. 생략하면 기본 버전이 배포됩니다.
이 버전을 생략하고 이 애플리케이션에 대해 기본 버전을 지정하지 않으면 잘못된ApplicationPackageReferences 오류 코드와 함께 요청이 실패합니다. REST API를 직접 호출하는 경우 HTTP 상태 코드는 409입니다.

AutomaticOSUpgradePolicy

자동 OS 업그레이드를 수행하는 데 사용되는 구성 매개 변수입니다.

Name 형식 Description
disableAutomaticRollback

boolean

OS 이미지 롤백 기능을 사용하지 않도록 설정해야 하는지 여부입니다.
enableAutomaticOSUpgrade

boolean

최신 버전의 OS 이미지를 사용할 수 있게 되면 확장 집합 인스턴스에 OS 업그레이드를 롤링 방식으로 자동으로 적용해야 하는지 여부를 나타냅니다.

Windows 기반 풀에 대해 true로 설정된 경우 WindowsConfiguration.enableAutomaticUpdates를 true로 설정할 수 없습니다.
osRollingUpgradeDeferral

boolean

작업을 실행하는 경우 TVM에서 OS 업그레이드를 연기합니다.
useRollingUpgradePolicy

boolean

자동 OS 업그레이드 중에 롤링 업그레이드 정책을 사용해야 하는지 여부를 나타냅니다. VMSS에 정책이 정의되어 있지 않으면 자동 OS 업그레이드가 기본 정책으로 대체됩니다.

AutoScaleRun

풀 자동 크기 조정 수식 실행의 결과 및 오류입니다.

Name 형식 Description
error

AutoScaleRunError

평가에 실패한 경우 풀에서 자동 크기 조정 수식을 평가하는 동안 발생한 오류에 대한 세부 정보입니다.
evaluationTime

string

자동 크기 조정 수식이 마지막으로 평가된 시간입니다.
results

string

자동 크기 조정 수식의 계산에 사용되는 모든 변수의 최종 값입니다.
각 변수 값은 $variable=value 형식으로 반환되고 변수는 세미콜론으로 구분됩니다.

AutoScaleRunError

풀을 자동 크기 조정할 때 발생한 오류입니다.

Name 형식 Description
code

string

오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details

AutoScaleRunError[]

오류에 대한 추가 세부 정보입니다.
message

string

사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.

AutoScaleSettings

풀에 대한 자동 크기 조정 설정입니다.

Name 형식 Description
evaluationInterval

string

자동 크기 조정 수식에 따라 풀 크기를 자동으로 조정할 시간 간격입니다.
생략하면 기본값은 15분(PT15M)입니다.
formula

string

풀에서 원하는 수의 컴퓨팅 노드에 대한 수식입니다.

AutoUserScope

자동 사용자에 대한 scope

Name 형식 Description
Pool

string

작업이 풀의 모든 노드에서 만들어지는 공통 자동 사용자 계정으로 실행되도록 지정합니다.
Task

string

서비스에서 작업에 대한 새 사용자를 만들어야 한다고 지정합니다.

AutoUserSpecification

Batch 서비스에서 작업을 실행하는 자동 사용자에 대한 매개 변수를 지정합니다.

Name 형식 Description
elevationLevel

ElevationLevel

자동 사용자의 권한 상승 수준입니다.
기본값은 nonAdmin입니다.
scope

AutoUserScope

자동 사용자에 대한 scope
기본값은 풀입니다. 풀이 Windows를 실행하는 경우 작업 간에 더 엄격한 격리가 필요한 경우 Task 값을 지정해야 합니다. 예를 들어 태스크가 다른 작업에 영향을 미칠 수 있는 방식으로 레지스트리를 변경하거나 일반 태스크에서 액세스할 수 없지만 시작 태스크에서 액세스할 수 있어야 하는 풀에 인증서를 지정한 경우입니다.

AzureBlobFileSystemConfiguration

Blobfuse를 사용하여 Azure Storage 컨테이너에 연결하는 데 사용되는 정보입니다.

Name 형식 Description
accountKey

string

Azure Storage 계정 키입니다.
이 속성은 sasKey 및 ID와 함께 사용할 수 없습니다. 정확히 하나를 지정해야 합니다.
accountName

string

Azure Storage 계정 이름입니다.
blobfuseOptions

string

탑재 명령에 전달할 추가 명령줄 옵션입니다.
Windows의 '순 사용' 옵션과 Linux의 '탑재' 옵션입니다.
containerName

string

Azure Blob Storage 컨테이너 이름입니다.
identityReference

ComputeNodeIdentityReference

containerName에 액세스하는 데 사용할 사용자 할당 ID에 대한 참조
이 속성은 accountKey 및 sasKey와 함께 사용할 수 없습니다. 정확히 하나를 지정해야 합니다.
relativeMountPath

string

파일 시스템이 탑재될 컴퓨팅 노드의 상대 경로
모든 파일 시스템은 Batch 탑재 디렉터리를 기준으로 탑재되며 AZ_BATCH_NODE_MOUNTS_DIR 환경 변수를 통해 액세스할 수 있습니다.
sasKey

string

Azure Storage SAS 토큰입니다.
이 속성은 accountKey 및 ID와 함께 사용할 수 없습니다. 정확히 하나를 지정해야 합니다.

AzureFileShareConfiguration

Azure Fileshare에 연결하는 데 사용되는 정보입니다.

Name 형식 Description
accountKey

string

Azure Storage 계정 키입니다.
accountName

string

Azure Storage 계정 이름입니다.
azureFileUrl

string

Azure Files URL입니다.
'https://{account}.file.core.windows.net/' 형식입니다.
mountOptions

string

탑재 명령에 전달할 추가 명령줄 옵션입니다.
Windows의 '순 사용' 옵션과 Linux의 '탑재' 옵션입니다.
relativeMountPath

string

파일 시스템이 탑재될 컴퓨팅 노드의 상대 경로
모든 파일 시스템은 Batch 탑재 디렉터리를 기준으로 탑재되며 AZ_BATCH_NODE_MOUNTS_DIR 환경 변수를 통해 액세스할 수 있습니다.

BatchPoolIdentity

구성된 경우 Batch 풀의 ID입니다. 기존 풀을 업데이트하는 동안 풀 ID가 업데이트되는 경우 풀이 0으로 축소된 후 생성된 새 vm만 업데이트된 ID를 갖게 됩니다.

Name 형식 Description
type

PoolIdentityType

Batch 풀에 사용되는 ID 유형입니다.
userAssignedIdentities

object

Batch 풀과 연결된 사용자 ID 목록입니다.

CachingType

디스크에 사용할 캐싱 유형입니다.

Name 형식 Description
None

string

디스크에 대한 캐싱 모드를 사용할 수 없습니다.
ReadOnly

string

디스크의 캐싱 모드는 읽기 전용입니다.
ReadWrite

string

디스크의 캐싱 모드는 읽고 씁니다.

CertificateReference

풀의 컴퓨팅 노드에 설치할 인증서에 대한 참조입니다. 풀과 동일한 계정 내에 있어야 합니다.

Name 형식 Description
id

string

풀에 설치할 인증서의 정규화된 ID입니다. 풀과 동일한 일괄 처리 계정 내에 있어야 합니다.
storeLocation

CertificateStoreLocation

인증서를 설치할 컴퓨팅 노드의 인증서 저장소 위치입니다.
기본값은 currentUser입니다. 이 속성은 Windows 노드로 구성된 풀(즉, cloudServiceConfiguration으로 생성되거나 Windows 이미지 참조를 사용하여 virtualMachineConfiguration을 사용하여 만든)에만 적용됩니다. Linux 컴퓨팅 노드의 경우 인증서는 작업 디렉터리 내의 디렉터리에 저장되고 환경 변수 AZ_BATCH_CERTIFICATES_DIR 이 위치를 쿼리하기 위해 태스크에 제공됩니다. 'remoteUser'의 표시 유형이 있는 인증서의 경우 사용자의 홈 디렉터리(예: /home/{user-name}/certs)에 'certs' 디렉터리가 만들어지고 인증서가 해당 디렉터리에 배치됩니다.
storeName

string

인증서를 설치할 컴퓨팅 노드의 인증서 저장소 이름입니다.
이 속성은 Windows 노드로 구성된 풀(즉, cloudServiceConfiguration을 사용하여 만들거나 Windows 이미지 참조를 사용하여 virtualMachineConfiguration을 사용하여 만든)에만 적용됩니다. 일반적인 저장소 이름은 My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook을 포함하지만 사용자 지정 저장소 이름도 사용할 수 있습니다. 기본값은 My입니다.
visibility

CertificateVisibility[]

컴퓨팅 노드의 사용자 계정이 인증서의 프라이빗 데이터에 액세스할 수 있어야 합니다.

CertificateStoreLocation

인증서를 설치할 컴퓨팅 노드의 인증서 저장소 위치입니다.

Name 형식 Description
CurrentUser

string

인증서는 CurrentUser 인증서 저장소에 설치해야 합니다.
LocalMachine

string

인증서는 LocalMachine 인증서 저장소에 설치해야 합니다.

CertificateVisibility

컴퓨팅 노드의 사용자 계정이 인증서의 프라이빗 데이터에 액세스할 수 있어야 합니다.

Name 형식 Description
RemoteUser

string

인증서는 사용자가 노드에 원격으로 액세스하는 사용자 계정에 표시되어야 합니다.
StartTask

string

인증서는 시작 작업이 실행되는 사용자 계정에 표시되어야 합니다. AutoUser 범위가 StartTask 및 작업 모두에 대한 풀인 경우 이 인증서도 작업에 표시됩니다.
Task

string

인증서는 작업 작업이 실행되는 사용자 계정에 표시되어야 합니다.

CIFSMountConfiguration

CIFS 파일 시스템에 연결하는 데 사용되는 정보입니다.

Name 형식 Description
mountOptions

string

탑재 명령에 전달할 추가 명령줄 옵션입니다.
Windows의 '순 사용' 옵션과 Linux의 '탑재' 옵션입니다.
password

string

CIFS 파일 시스템에 대한 인증에 사용할 암호입니다.
relativeMountPath

string

파일 시스템이 탑재될 컴퓨팅 노드의 상대 경로
모든 파일 시스템은 Batch 탑재 디렉터리를 기준으로 탑재되며 AZ_BATCH_NODE_MOUNTS_DIR 환경 변수를 통해 액세스할 수 있습니다.
source

string

탑재할 파일 시스템의 URI입니다.
userName

string

CIFS 파일 시스템에 대한 인증에 사용할 사용자입니다.

CloudError

Batch 서비스의 오류 응답입니다.

Name 형식 Description
error

CloudErrorBody

오류 응답의 본문입니다.

CloudErrorBody

Batch 서비스의 오류 응답입니다.

Name 형식 Description
code

string

오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details

CloudErrorBody[]

오류에 대한 추가 세부 정보 목록입니다.
message

string

사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
target

string

특정 오류의 대상입니다. 예를 들어 오류에 있는 속성의 이름입니다.

CloudServiceConfiguration

Azure Cloud Services 플랫폼을 기반으로 풀의 노드에 대한 구성입니다.

Name 형식 Description
osFamily

string

풀의 가상 머신에 설치할 Azure 게스트 OS 제품군입니다.
가능한 값은 Windows Server 2008 R2 SP1과 동일한 2 - OS 제품군 2입니다. 3 - OS 제품군 3, Windows Server 2012 해당. 4 - OS 제품군 4, Windows Server 2012 R2와 동일합니다. 5 - OS 제품군 5, Windows Server 2016 해당. 6 - OS 제품군 6, Windows Server 2019와 동일합니다. 자세한 내용은 Azure 게스트 OS 릴리스(https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases)를 참조하세요.
osVersion

string

풀의 가상 머신에 설치할 Azure 게스트 OS 버전입니다.
기본값은 지정된 OS 제품군의 최신 운영 체제 버전을 지정하는 *입니다.

ComputeNodeDeallocationOption

할당 취소를 위해 선택한 후 노드 및 실행 중인 작업으로 수행할 작업을 결정합니다.

Name 형식 Description
Requeue

string

실행 중인 작업 프로세스를 종료하고 작업을 다시 큐에 추가합니다. 노드를 사용할 수 있으면 태스크가 다시 실행됩니다. 태스크가 종료되는 즉시 노드를 제거합니다.
RetainedData

string

현재 실행 중인 작업이 완료되도록 허용한 다음 모든 작업 데이터 보존 기간이 만료되기를 기다립니다. 대기하는 동안 새 태스크를 예약하지 않습니다. 모든 태스크 보존 기간이 만료되면 노드를 제거합니다.
TaskCompletion

string

현재 실행 중인 작업이 완료되도록 허용합니다. 대기하는 동안 새 태스크를 예약하지 않습니다. 모든 태스크가 완료되면 노드를 제거합니다.
Terminate

string

실행 중인 작업을 종료합니다. 작업이 종료되었음을 나타내는 failureInfo로 완료되고 다시 실행되지 않습니다. 태스크가 종료되는 즉시 노드를 제거합니다.

ComputeNodeFillType

태스크를 컴퓨팅 노드에 분산하는 방법

Name 형식 Description
Pack

string

풀의 다음 노드에 태스크가 할당되기 전에 가능한 한 많은 작업(taskSlotsPerNode)을 풀의 각 노드에 할당해야 합니다.
Spread

string

풀의 모든 노드에서 태스크를 균등하게 할당해야 합니다.

ComputeNodeIdentityReference

컴퓨팅 노드에서 사용할 Batch 풀과 연결된 사용자 할당 ID에 대한 참조입니다.

Name 형식 Description
resourceId

string

사용자 할당 ID의 ARM 리소스 ID입니다.

ContainerConfiguration

컨테이너 사용 풀에 대한 구성입니다.

Name 형식 Description
containerImageNames

string[]

컨테이너 이미지 이름의 컬렉션입니다.
"docker pull"에 지정된 대로 전체 이미지 참조입니다. 이미지가 대체 레지스트리로 정규화되지 않는 한 이미지는 기본 Docker 레지스트리에서 원본이 됩니다.
containerRegistries

ContainerRegistry[]

컨테이너를 끌어올 수 있는 추가 프라이빗 레지스트리입니다.
자격 증명이 필요한 프라이빗 레지스트리에서 이미지를 다운로드해야 하는 경우 해당 자격 증명을 여기에 제공해야 합니다.
type

ContainerType

사용할 컨테이너 기술입니다.

ContainerRegistry

프라이빗 컨테이너 레지스트리.

Name 형식 Description
identityReference

ComputeNodeIdentityReference

사용자 이름 및 암호 대신 Azure Container Registry 액세스하는 데 사용할 사용자 할당 ID에 대한 참조입니다.
컴퓨팅 노드에서 사용할 Batch 풀과 연결된 사용자 할당 ID에 대한 참조입니다.
password

string

레지스트리 서버에 로그인할 암호입니다.
registryServer

string

레지스트리 URL입니다.
생략하면 기본값은 "docker.io"입니다.
username

string

레지스트리 서버에 로그인할 사용자 이름입니다.

ContainerType

사용할 컨테이너 기술입니다.

Name 형식 Description
CriCompatible

string

CRI 기반 기술은 컨테이너를 시작하는 데 사용됩니다.
DockerCompatible

string

Docker 호환 컨테이너 기술을 사용하여 컨테이너를 시작합니다.

ContainerWorkingDirectory

컨테이너 작업 디렉터리의 위치를 나타내는 플래그입니다. 기본값은 'taskWorkingDirectory'입니다.

Name 형식 Description
ContainerImageDefault

string

컨테이너 이미지 정의 작업 디렉터리 사용. 이 디렉터리에 Batch에서 다운로드한 리소스 파일이 포함되지 않도록 주의하세요.
TaskWorkingDirectory

string

Batch로 채워진 작업 리소스 파일을 포함하는 표준 Batch 서비스 작업 디렉터리를 사용합니다.

DataDisk

풀의 컴퓨팅 노드에 연결된 데이터 디스크에서 사용할 설정입니다. 연결된 데이터 디스크를 사용하는 경우 VM 내에서 디스크를 탑재하고 포맷하여 사용해야 합니다.

Name 형식 Description
caching

CachingType

데이터 디스크에 사용할 캐싱 유형입니다.
값은 다음과 같습니다.

none - 디스크에 대한 캐싱 모드를 사용할 수 없습니다. readOnly - 디스크의 캐싱 모드는 읽기 전용입니다. readWrite - 디스크의 캐싱 모드를 읽고 씁니다.

캐싱의 기본값은 none입니다. 캐싱 옵션에 대한 자세한 내용은 을 참조하세요 https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB

integer

새 데이터 디스크를 만들 때의 초기 디스크 크기(GB)입니다.
lun

integer

논리 단위 번호입니다.
lun은 각 데이터 디스크를 고유하게 식별하는 데 사용됩니다. 여러 디스크를 연결하는 경우 각 디스크에는 고유한 lun이 있어야 합니다. 값은 0에서 63 사이여야 합니다( 포함).
storageAccountType

StorageAccountType

데이터 디스크에 사용할 스토리지 계정 유형입니다.
생략하면 기본값은 "Standard_LRS"입니다. 값은 다음과 같습니다.

Standard_LRS - 데이터 디스크는 표준 로컬 중복 스토리지를 사용해야 합니다. Premium_LRS - 데이터 디스크는 프리미엄 로컬 중복 스토리지를 사용해야 합니다.

DeploymentConfiguration

배포 구성 속성.

Name 형식 Description
cloudServiceConfiguration

CloudServiceConfiguration

풀의 클라우드 서비스 구성입니다.
이 속성과 virtualMachineConfiguration은 상호 배타적이며 속성 중 하나를 지정해야 합니다. Batch 계정이 poolAllocationMode 속성을 'UserSubscription'으로 설정하여 만든 경우 이 속성을 지정할 수 없습니다.
virtualMachineConfiguration

VirtualMachineConfiguration

풀의 가상 머신 구성입니다.
이 속성과 cloudServiceConfiguration은 상호 배타적이며 속성 중 하나를 지정해야 합니다.

DiffDiskPlacement

풀의 모든 VM에 대한 운영 체제 디스크의 임시 디스크 배치를 지정합니다.

Name 형식 Description
CacheDisk

string

임시 OS 디스크는 VM 캐시에 저장됩니다.

DiffDiskSettings

가상 머신에서 사용하는 운영 체제 디스크에 대한 임시 디스크 설정을 지정합니다.

Name 형식 Description
placement

DiffDiskPlacement

풀의 모든 VM에 대한 운영 체제 디스크의 임시 디스크 배치를 지정합니다.
이 속성은 사용자가 요청에서 운영 체제가 있어야 하는 위치를 선택하는 데 사용할 수 있습니다. 예를 들어 임시 OS 디스크 프로비저닝을 위한 디스크 공간을 캐시합니다. 임시 OS 디스크 크기 요구 사항에 대한 자세한 내용은 의 Windows VM 및 Linux VM https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirementshttps://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements에 대한 임시 OS 디스크 크기 요구 사항을 참조하세요.

DiskEncryptionConfiguration

풀의 컴퓨팅 노드에 적용되는 디스크 암호화 구성입니다. Virtual Machine 이미지 또는 Azure Compute Gallery 이미지로 만든 Linux 풀에서는 디스크 암호화 구성이 지원되지 않습니다.

Name 형식 Description
targets

DiskEncryptionTarget[]

Batch 서비스가 컴퓨팅 노드에서 암호화할 디스크 대상 목록
Linux 풀에서는 "TemporaryDisk"만 지원됩니다. Windows 풀에서 "OsDisk" 및 "TemporaryDisk"를 지정해야 합니다.

DiskEncryptionTarget

Batch 서비스가 컴퓨팅 노드에서 암호화할 디스크 대상 목록

Name 형식 Description
OsDisk

string

컴퓨팅 노드의 OS 디스크가 암호화됩니다.
TemporaryDisk

string

컴퓨팅 노드의 임시 디스크가 암호화됩니다. Linux에서 이 암호화는 부팅 시 암호화가 발생할 때 다른 파티션(예: 탑재된 데이터 디스크의 파티션)에 적용됩니다.

DynamicVNetAssignmentScope

동적 vnet 할당의 scope.

Name 형식 Description
job

string

동적 VNet 할당은 작업별로 수행됩니다. 이 값을 설정하면 네트워크 구성 서브넷 ID도 설정해야 합니다. 이 기능을 사용하려면 사용 전에 승인이 필요합니다. 지원팀에 문의하세요.
none

string

동적 VNet 할당을 사용할 수 없습니다.

ElevationLevel

사용자의 권한 상승 수준입니다.

Name 형식 Description
Admin

string

사용자는 상승된 액세스 권한이 있는 사용자이며 전체 관리자 권한으로 작동합니다.
NonAdmin

string

사용자는 상승된 액세스 권한이 없는 표준 사용자입니다.

EnvironmentSetting

작업 프로세스에서 설정할 환경 변수입니다.

Name 형식 Description
name

string

환경 변수의 이름입니다.
value

string

환경 변수의 값입니다.

FixedScaleSettings

풀에 대한 크기 조정 설정을 수정했습니다.

Name 형식 기본값 Description
nodeDeallocationOption

ComputeNodeDeallocationOption

풀 크기가 감소하는 경우 노드 및 실행 중인 작업으로 수행할 작업을 결정합니다.
생략하면 기본값은 Requeue입니다.
resizeTimeout

string

PT15M

풀에 컴퓨팅 노드를 할당하기 위한 시간 제한입니다.
기본값은 15분입니다. 시간 제한 값은 ISO 8601 형식을 사용합니다. 예를 들어 10분 동안 PT10M을 사용합니다. 최소값은 5분입니다. 5분 미만의 값을 지정하면 Batch 서비스는 오류와 함께 요청을 거부합니다. REST API를 직접 호출하는 경우 HTTP 상태 코드는 400(잘못된 요청)입니다.
targetDedicatedNodes

integer

풀에서 원하는 전용 컴퓨팅 노드 수입니다.
targetDedicatedNodes 중 하나 이상인 targetLowPriorityNodes를 설정해야 합니다.
targetLowPriorityNodes

integer

풀에서 원하는 스폿/우선 순위가 낮은 컴퓨팅 노드 수입니다.
targetDedicatedNodes 중 하나 이상인 targetLowPriorityNodes를 설정해야 합니다.

ImageReference

Azure Virtual Machines Marketplace 이미지 또는 사용자 지정 Virtual Machine의 Azure 이미지 리소스에 대한 참조입니다. Azure Batch 확인된 모든 imageReferences 목록을 얻으려면 '지원되는 노드 에이전트 SKU 나열' 작업을 참조하세요.

Name 형식 Description
id

string

Azure Compute Gallery 이미지의 ARM 리소스 식별자입니다. 풀의 컴퓨팅 노드는 이 이미지 ID를 사용하여 만들어집니다. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{versionId}형식입니다.
이 속성은 다른 속성과 함께 사용할 수 없습니다. Azure Compute Gallery 이미지에는 Azure Batch 계정과 동일한 지역에 복제본이 있어야 합니다. Batch 노드 에이전트가 Batch 서비스와 통신하는 방화벽 설정에 대한 자세한 내용은 을 참조하세요 https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
offer

string

Azure Virtual Machines Marketplace 이미지의 제품 유형입니다.
예를 들어 UbuntuServer 또는 WindowsServer입니다.
publisher

string

Azure Virtual Machines Marketplace 이미지의 게시자입니다.
예를 들어 Canonical 또는 MicrosoftWindowsServer입니다.
sku

string

Azure Virtual Machines Marketplace 이미지의 SKU입니다.
예를 들어 18.04-LTS 또는 2022-datacenter입니다.
version

string

Azure Virtual Machines Marketplace 이미지의 버전입니다.
'latest' 값을 지정하여 최신 버전의 이미지를 선택할 수 있습니다. 생략하면 기본값은 'latest'입니다.

InboundEndpointProtocol

엔드포인트의 프로토콜입니다.

Name 형식 Description
TCP

string

엔드포인트에 TCP를 사용합니다.
UDP

string

엔드포인트에 UDP를 사용합니다.

InboundNatPool

외부적으로 Batch 풀의 컴퓨팅 노드에서 특정 포트를 처리하는 데 사용할 수 있는 인바운드 NAT 풀입니다.

Name 형식 Description
backendPort

integer

컴퓨팅 노드의 포트 번호입니다.
Batch 풀 내에서 고유해야 합니다. 허용되는 값은 22, 3389, 29876 및 29877을 제외하고 1에서 65535 사이입니다. 예약된 값이 제공되면 요청이 HTTP 상태 코드 400으로 실패합니다.
frontendPortRangeEnd

integer

개별 컴퓨팅 노드에서 backendPort에 대한 인바운드 액세스를 제공하는 데 사용할 외부 포트 범위의 마지막 포트 번호입니다.
허용되는 값은 Batch 서비스에서 예약한 포트 50000에서 55000을 제외하고 1에서 65534 사이입니다. 풀 내의 모든 범위는 고유해야 하며 겹칠 수 없습니다. 예약되거나 겹치는 값이 제공되면 요청이 HTTP 상태 코드 400으로 실패합니다.
frontendPortRangeStart

integer

개별 컴퓨팅 노드의 backendPort에 대한 인바운드 액세스를 제공하는 데 사용할 외부 포트 범위의 첫 번째 포트 번호입니다.
허용되는 값은 예약된 포트 50000에서 55000을 제외하고 1에서 65534 사이입니다. 풀 내의 모든 범위는 고유해야 하며 겹칠 수 없습니다. 예약되거나 겹치는 값이 제공되면 요청이 HTTP 상태 코드 400으로 실패합니다.
name

string

엔드포인트의 이름입니다.
이름은 Batch 풀 내에서 고유해야 하며 문자, 숫자, 밑줄, 마침표 및 하이픈을 포함할 수 있습니다. 이름은 문자 또는 숫자로 시작해야 하고 문자, 숫자 또는 밑줄로 끝나야 하며 77자를 초과할 수 없습니다. 잘못된 값이 제공되면 요청이 HTTP 상태 코드 400으로 실패합니다.
networkSecurityGroupRules

NetworkSecurityGroupRule[]

엔드포인트에 적용할 네트워크 보안 그룹 규칙 목록입니다.
Batch 풀의 모든 엔드포인트에서 지정할 수 있는 최대 규칙 수는 25개입니다. 네트워크 보안 그룹 규칙을 지정하지 않으면 지정된 backendPort에 대한 인바운드 액세스를 허용하는 기본 규칙이 만들어집니다. 최대 네트워크 보안 그룹 규칙 수를 초과하는 경우 HTTP 상태 코드 400으로 인해 요청이 실패합니다.
protocol

InboundEndpointProtocol

엔드포인트의 프로토콜입니다.

InterNodeCommunicationState

풀이 노드 간의 직접 통신을 허용하는지 여부입니다.

Name 형식 Description
Disabled

string

가상 머신 간의 네트워크 통신을 사용하지 않도록 설정합니다.
Enabled

string

가상 머신 간의 네트워크 통신을 사용하도록 설정합니다.

IPAddressProvisioningType

Batch 풀의 공용 IP 주소에 대한 프로비저닝 유형입니다.

Name 형식 Description
BatchManaged

string

공용 IP는 Batch에서 만들고 관리합니다. 풀의 크기에 따라 여러 공용 IP가 있을 수 있습니다.
NoPublicIPAddresses

string

풀의 컴퓨팅 노드에 대한 공용 IP 주소는 만들어지지 않습니다.
UserManaged

string

공용 IP는 사용자가 제공하며 컴퓨팅 노드를 프로비전하는 데 사용됩니다.

LinuxUserConfiguration

Linux 노드에서 사용자 계정을 만드는 데 사용되는 속성입니다.

Name 형식 Description
gid

integer

사용자 계정의 그룹 ID입니다.
uid 및 gid 속성은 함께 지정하거나 지정하지 않아야 합니다. 지정하지 않으면 기본 운영 체제가 gid를 선택합니다.
sshPrivateKey

string

사용자 계정에 대한 SSH 프라이빗 키입니다.
프라이빗 키는 암호로 보호되어서는 안 됩니다. 프라이빗 키는 풀의 enableInterNodeCommunication 속성이 true일 때 Linux 풀의 노드 간에 SSH에 대한 비대칭 키 기반 인증을 자동으로 구성하는 데 사용됩니다(enableInterNodeCommunication이 false이면 무시됨). 이 작업은 키 쌍을 사용자의 .ssh 디렉터리에 배치하여 수행합니다. 지정하지 않으면 암호 없는 SSH가 노드 간에 구성되지 않습니다(사용자의 .ssh 디렉터리를 수정하지 않음).
uid

integer

사용자 계정의 사용자 ID입니다.
uid 및 gid 속성은 함께 지정하거나 지정하지 않아야 합니다. 지정하지 않으면 기본 운영 체제가 uid를 선택합니다.

LoginMode

사용자에 대한 로그인 모드

Name 형식 Description
Batch

string

LOGON32_LOGON_BATCH Win32 로그인 모드입니다. 일괄 처리 로그인 모드는 장기 실행 병렬 프로세스에 권장됩니다.
Interactive

string

LOGON32_LOGON_INTERACTIVE Win32 로그인 모드입니다. 일부 애플리케이션에는 대화형 로그인 모드와 연결된 권한이 필요합니다. 작업에서 사용되는 애플리케이션의 경우 이 옵션을 사용하는 것이 좋습니다.

ManagedDisk

Name 형식 Description
storageAccountType

StorageAccountType

관리 디스크의 스토리지 계정 유형입니다.

MetadataItem

Batch 서비스 리소스와 연결된 이름-값 쌍입니다.

Name 형식 Description
name

string

메타데이터 항목의 이름입니다.
value

string

메타데이터 항목의 값입니다.

MountConfiguration

각 노드에 탑재할 파일 시스템입니다.

Name 형식 Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

각 노드에서 Blob FUSE를 사용하여 탑재할 Azure Storage 컨테이너입니다.
이 속성은 다른 모든 속성과 함께 사용할 수 없습니다.
azureFileShareConfiguration

AzureFileShareConfiguration

각 노드에 탑재할 Azure 파일 공유입니다.
이 속성은 다른 모든 속성과 함께 사용할 수 없습니다.
cifsMountConfiguration

CIFSMountConfiguration

각 노드에 탑재할 CIFS/SMB 파일 시스템입니다.
이 속성은 다른 모든 속성과 함께 사용할 수 없습니다.
nfsMountConfiguration

NFSMountConfiguration

각 노드에 탑재할 NFS 파일 시스템입니다.
이 속성은 다른 모든 속성과 함께 사용할 수 없습니다.

NetworkConfiguration

풀에 대한 네트워크 구성입니다.

Name 형식 기본값 Description
dynamicVnetAssignmentScope

DynamicVNetAssignmentScope

none

동적 vnet 할당의 scope.
enableAcceleratedNetworking

boolean

이 풀이 가속화된 네트워킹을 사용하도록 설정해야 하는지 여부입니다.
가속화된 네트워킹을 사용하면 VM에 대한 SR-IOV(단일 루트 I/O 가상화)가 가능하므로 네트워킹 성능이 향상될 수 있습니다. 자세한 내용은 https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview 를 참조하세요.
endpointConfiguration

PoolEndpointConfiguration

Batch 풀의 컴퓨팅 노드에 있는 엔드포인트에 대한 구성입니다.
풀 엔드포인트 구성은 virtualMachineConfiguration 속성이 있는 풀에서만 지원됩니다.
publicIPAddressConfiguration

PublicIPAddressConfiguration

Batch 풀의 컴퓨팅 노드에 대한 공용 IPAddress 구성입니다.
이 속성은 virtualMachineConfiguration 속성이 있는 풀에서만 지원됩니다.
subnetId

string

풀의 컴퓨팅 노드가 조인할 가상 네트워크 서브넷의 ARM 리소스 식별자입니다. /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}형식입니다.
가상 네트워크는 Azure Batch 계정과 동일한 지역 및 구독에 있어야 합니다. 지정된 서브넷에는 풀의 노드 수를 수용할 수 있는 충분한 사용 가능한 IP 주소가 있어야 합니다. 서브넷에 사용 가능한 IP 주소가 충분하지 않으면 풀이 컴퓨팅 노드를 부분적으로 할당하고 크기 조정 오류가 발생합니다. 'MicrosoftAzureBatch' 서비스 주체에는 지정된 VNet에 대한 '클래식 가상 머신 기여자' Role-Based Access Control(RBAC) 역할이 있어야 합니다. 지정된 서브넷은 컴퓨팅 노드에서 작업을 예약할 수 있도록 Azure Batch 서비스의 통신을 허용해야 합니다. 지정된 VNet에 연결된 NSG(네트워크 보안 그룹)가 있는지 확인하여 확인할 수 있습니다. 지정된 서브넷의 컴퓨팅 노드에 대한 통신이 NSG에 의해 거부되면 Batch 서비스는 컴퓨팅 노드의 상태를 사용할 수 없도록 설정합니다. 지정된 VNet에 연결된 NSG(네트워크 보안 그룹)가 있는 경우 인바운드 통신에 대해 몇 개의 예약된 시스템 포트를 사용할 수 있어야 합니다. 가상 머신 구성을 사용하여 만든 풀의 경우 포트 29876 및 29877을 사용하도록 설정하고 , Linux의 경우 포트 22, Windows의 경우 포트 3389를 사용하도록 설정합니다. 클라우드 서비스 구성을 사용하여 만든 풀의 경우 포트 10100, 20100 및 30100을 사용하도록 설정합니다. 또한 포트 443에서 Azure Storage에 대한 아웃바운드 연결을 사용하도록 설정합니다. cloudServiceConfiguration 풀의 경우 '클래식' VNET만 지원됩니다. 자세한 내용은 다음을 참조하세요. https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

인바운드 엔드포인트에 적용할 네트워크 보안 그룹 규칙입니다.

Name 형식 Description
access

NetworkSecurityGroupRuleAccess

지정된 IP 주소, 서브넷 범위 또는 태그에 대해 수행해야 하는 작업입니다.
priority

integer

이 규칙의 우선 순위입니다.
풀 내의 우선 순위는 고유해야 하며 우선 순위 순서대로 평가됩니다. 번호가 낮을수록 우선순위가 높습니다. 예를 들어 순서 번호가 150, 250 및 350인 규칙을 지정할 수 있습니다. 순서 번호가 150인 규칙이 순서가 250인 규칙보다 우선합니다. 허용되는 우선 순위는 150~4096입니다. 예약된 값 또는 중복 값이 제공되면 요청이 HTTP 상태 코드 400으로 실패합니다.
sourceAddressPrefix

string

규칙에 일치시킬 원본 주소 접두사 또는 태그입니다.
유효한 값은 단일 IP 주소(예: 10.10.10.10), IP 서브넷(예: 192.168.1.0/24), 기본 태그 또는 *(모든 주소의 경우)입니다. 다른 값이 제공되면 요청이 HTTP 상태 코드 400으로 실패합니다.
sourcePortRanges

string[]

규칙과 일치할 원본 포트 범위입니다.
유효한 값은 '*'(모든 포트 0 - 65535) 또는 포트 또는 포트 범위 배열(예: 100-200)입니다. 포트는 0에서 65535 범위여야 하며 포트 범위 또는 포트는 겹칠 수 없습니다. 다른 값이 제공되면 요청이 HTTP 상태 코드 400으로 실패합니다. 기본값은 *입니다.

NetworkSecurityGroupRuleAccess

지정된 IP 주소, 서브넷 범위 또는 태그에 대해 수행해야 하는 작업입니다.

Name 형식 Description
Allow

string

액세스를 허용합니다.
Deny

string

액세스를 거부합니다.

NFSMountConfiguration

NFS 파일 시스템에 연결하는 데 사용되는 정보입니다.

Name 형식 Description
mountOptions

string

탑재 명령에 전달할 추가 명령줄 옵션입니다.
Windows의 '순 사용' 옵션과 Linux의 '탑재' 옵션입니다.
relativeMountPath

string

파일 시스템이 탑재될 컴퓨팅 노드의 상대 경로
모든 파일 시스템은 Batch 탑재 디렉터리를 기준으로 탑재되며 AZ_BATCH_NODE_MOUNTS_DIR 환경 변수를 통해 액세스할 수 있습니다.
source

string

탑재할 파일 시스템의 URI입니다.

NodeCommunicationMode

풀이 Batch 서비스와 통신하는 방법을 결정합니다.

Name 형식 Description
Classic

string

클래식 통신 모드를 사용하는 노드에는 "BatchNodeManagement"의 포트 29876 및 29877에서 인바운드 TCP 통신이 필요합니다. {region}" 서비스 태그 및 포트 443에서 "Storage.region" 및 "BatchNodeManagement"로의 아웃바운드 TCP 통신 {region}" 서비스 태그.
Default

string

노드 통신 모드는 Batch 서비스에 의해 자동으로 설정됩니다.
Simplified

string

간소화된 통신 모드를 사용하는 노드에는 포트 443에서 "BatchNodeManagement"로의 아웃바운드 TCP 통신이 필요합니다. {region}" 서비스 태그. 열려 있는 인바운드 포트는 필요하지 않습니다.

NodePlacementConfiguration

일괄 처리 풀에 대한 노드 배치 구성입니다.

Name 형식 Description
policy

NodePlacementPolicyType

Batch 풀의 노드 배치 정책 유형입니다.
Batch 서비스에서 노드를 프로비전하는 데 사용하는 할당 정책입니다. 지정하지 않으면 Batch는 지역 정책을 사용합니다.

NodePlacementPolicyType

풀에서 노드를 할당하기 위한 배치 정책입니다.

Name 형식 Description
Regional

string

풀의 모든 노드는 동일한 지역에 할당됩니다.
Zonal

string

풀의 노드는 최상의 분산을 통해 여러 영역에 분산됩니다.

OSDisk

가상 머신의 운영 체제 디스크에 대한 설정입니다.

Name 형식 Description
caching

CachingType

캐싱 요구 사항을 지정합니다. 가능한 값은 None, ReadOnly, ReadWrite입니다. 기본값은 표준 스토리지의 경우 없음입니다. Premium Storage용 ReadOnly.
diskSizeGB

integer

새 OS 디스크를 만들 때의 초기 디스크 크기(GB)입니다.
ephemeralOSDiskSettings

DiffDiskSettings

가상 머신에서 사용하는 운영 체제 디스크에 대한 임시 디스크 설정을 지정합니다.
managedDisk

ManagedDisk

관리 디스크 매개 변수입니다.
writeAcceleratorEnabled

boolean

디스크에서 writeAccelerator를 사용하도록 설정하거나 사용하지 않도록 설정할지 여부를 지정합니다.

Pool

풀에 대한 정보를 포함합니다.

Name 형식 기본값 Description
etag

string

동시성 문에 사용되는 리소스의 ETag입니다.
id

string

리소스의 ID입니다.
identity

BatchPoolIdentity

Batch 풀에 사용되는 ID 유형입니다.
Batch 풀에 사용되는 ID 유형입니다.
name

string

리소스의 이름입니다.
properties.allocationState

AllocationState

풀의 크기 조정 여부입니다.
properties.allocationStateTransitionTime

string

풀이 현재 할당 상태로 설정된 시간입니다.
properties.applicationLicenses

string[]

Batch 서비스가 풀의 각 컴퓨팅 노드에서 사용할 수 있도록 하는 애플리케이션 라이선스 목록입니다.
애플리케이션 라이선스 목록은 사용 가능한 Batch 서비스 애플리케이션 라이선스의 하위 집합이어야 합니다. 지원되지 않는 라이선스가 요청되면 풀 만들기가 실패합니다.
properties.applicationPackages

ApplicationPackageReference[]

풀의 각 컴퓨팅 노드에 설치할 애플리케이션 패키지 목록입니다.
애플리케이션 패키지 참조에 대한 변경 내용은 풀에 조인하는 모든 새 컴퓨팅 노드에 영향을 주지만 다시 부팅되거나 이미지로 다시 설치될 때까지 풀에 이미 있는 컴퓨팅 노드에는 영향을 미치지 않습니다. 지정된 풀에는 최대 10개의 애플리케이션 패키지 참조가 있습니다.
properties.autoScaleRun

AutoScaleRun

자동 크기 조정 수식의 마지막 실행 결과 및 오류입니다.
이 속성은 풀이 자동으로 크기 조정되는 경우에만 설정됩니다(예: autoScaleSettings가 사용되는 경우).
properties.certificates

CertificateReference[]

풀의 각 컴퓨팅 노드에 설치할 인증서 목록입니다.
Windows 컴퓨팅 노드의 경우 Batch 서비스는 지정된 인증서 저장소 및 위치에 인증서를 설치합니다. Linux 컴퓨팅 노드의 경우 인증서는 작업 작업 디렉터리 내의 디렉터리에 저장되고 AZ_BATCH_CERTIFICATES_DIR 환경 변수는 이 위치를 쿼리하기 위해 태스크에 제공됩니다. 'remoteUser'의 표시 유형이 있는 인증서의 경우 사용자의 홈 디렉터리(예: /home/{user-name}/certs)에 'certs' 디렉터리가 만들어지고 인증서가 해당 디렉터리에 배치됩니다.

경고: 이 속성은 더 이상 사용되지 않으며 2024년 2월 이후에 제거됩니다. 대신 Azure KeyVault 확장을 사용하세요.
properties.creationTime

string

풀을 만든 시간입니다.
properties.currentDedicatedNodes

integer

현재 풀에 있는 전용 컴퓨팅 노드 수입니다.
properties.currentLowPriorityNodes

integer

현재 풀에 있는 스폿/우선 순위가 낮은 컴퓨팅 노드의 수입니다.
properties.currentNodeCommunicationMode

NodeCommunicationMode

풀 통신 모드의 현재 상태입니다.
properties.deploymentConfiguration

DeploymentConfiguration

이 속성은 Cloud Services 또는 Virtual Machines 사용하여 풀 노드를 배포하는 방법을 설명합니다.
CloudServiceConfiguration을 사용하면 노드가 Azure Cloud Services(PaaS)를 사용하여 만들어야 하는 반면 VirtualMachineConfiguration은 Azure Virtual Machines(IaaS)를 사용합니다.
properties.displayName

string

풀의 표시 이름입니다.
표시 이름은 고유할 필요가 없으며 최대 길이 1024까지 유니코드 문자를 포함할 수 있습니다.
properties.interNodeCommunication

InterNodeCommunicationState

풀이 노드 간의 직접 통신을 허용하는지 여부입니다.
이렇게 하면 풀에 할당할 수 있는 노드가 제한됩니다. 이 값을 사용하도록 설정하면 요청된 노드 수가 풀에 할당될 가능성을 줄일 수 있습니다. 지정하지 않으면 이 값은 기본적으로 '사용 안 함'으로 설정됩니다.
properties.lastModified

string

풀을 마지막으로 수정한 시간입니다.
targetDedicatedNodes 또는 autoScaleSettings와 같은 풀 수준 데이터가 마지막으로 변경된 시간입니다. 컴퓨팅 노드 변경 상태와 같은 노드 수준 변경은 고려하지 않습니다.
properties.metadata

MetadataItem[]

풀과 메타데이터로 연결된 이름-값 쌍의 목록입니다.
Batch 서비스는 메타데이터에 의미를 할당하지 않습니다. 사용자 코드를 사용하기 위한 것입니다.
properties.mountConfiguration

MountConfiguration[]

풀의 각 노드에 탑재할 파일 시스템 목록입니다.
Azure Files, NFS, CIFS/SMB 및 Blobfuse를 지원합니다.
properties.networkConfiguration

NetworkConfiguration

풀의 네트워크 구성입니다.
풀에 대한 네트워크 구성입니다.
properties.provisioningState

PoolProvisioningState

풀의 현재 상태입니다.
properties.provisioningStateTransitionTime

string

풀이 현재 상태로 설정된 시간입니다.
properties.resizeOperationStatus

ResizeOperationStatus

현재 또는 마지막으로 완료된 크기 조정 작업에 대한 세부 정보를 포함합니다.
현재 작업(풀 AllocationState가 크기 조정 중인 경우) 또는 이전에 완료된 작업(AllocationState가 Steady인 경우)에 대해 설명합니다.
properties.resourceTags

object

풀과 연결된 사용자 지정 태그입니다.
Azure Batch 풀과 연결할 사용자 정의 태그입니다. 지정된 경우 이러한 태그는 풀과 연결된 지원 Azure 리소스로 전파됩니다. 이 속성은 PoolAllocationMode 속성이 'UserSubscription'으로 설정된 Batch 계정을 만든 경우에만 지정할 수 있습니다.
properties.scaleSettings

ScaleSettings

풀의 노드 수를 구성하는 설정입니다.
풀의 원하는 크기를 정의합니다. 요청된 targetDedicatedNodes가 지정된 'fixedScale' 또는 주기적으로 다시 평가되는 수식을 정의하는 'autoScale'일 수 있습니다. 이 속성을 지정하지 않으면 풀은 targetDedicatedNodes가 0인 고정 배율을 갖습니다.
properties.startTask

StartTask

풀에 조인할 때 각 컴퓨팅 노드에서 실행되도록 지정된 작업입니다.
PATCH(업데이트) 작업에서 이 속성을 빈 개체로 설정하여 풀에서 시작 작업을 제거할 수 있습니다.
properties.targetNodeCommunicationMode

NodeCommunicationMode

풀에 대해 원하는 노드 통신 모드입니다.
생략하면 기본값은 Default입니다.
properties.taskSchedulingPolicy

TaskSchedulingPolicy

풀의 컴퓨팅 노드에 태스크를 분산하는 방법
지정하지 않으면 기본값이 분산됩니다.
properties.taskSlotsPerNode

integer

1

풀의 단일 컴퓨팅 노드에서 동시 태스크를 실행하는 데 사용할 수 있는 태스크 슬롯의 수입니다.
기본값은 1입니다. 최대값은 풀의 vmSize 코어 수의 4배 또는 256의 작은 값입니다.
properties.upgradePolicy

UpgradePolicy

풀에 대한 업그레이드 정책입니다.
자동, 수동 또는 롤링과 같은 업그레이드 정책에 대해 설명합니다.
properties.userAccounts

UserAccount[]

풀의 각 노드에서 만들 사용자 계정 목록입니다.
properties.vmSize

string

풀에 있는 가상 머신의 크기입니다. 풀의 모든 VM 크기는 동일합니다.
Cloud Services 풀에 사용 가능한 가상 머신 크기(cloudServiceConfiguration으로 만든 풀)에 대한 자세한 내용은 Cloud Services 크기(https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/)를 참조하세요. Batch는 ExtraSmall을 제외한 모든 Cloud Services VM 크기를 지원합니다. Virtual Machines Marketplace의 이미지를 사용하여 풀에 사용할 수 있는 VM 크기(virtualMachineConfiguration으로 만든 풀)에 대한 자세한 내용은 Virtual Machines 크기(Linux) 또는 Virtual Machines 크기(https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/Windows)(https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)를 참조하세요. Batch는 STANDARD_A0 및 Premium Storage(STANDARD_GS, STANDARD_DS 및 STANDARD_DSV2 시리즈)를 제외한 모든 Azure VM 크기를 지원합니다.
type

string

리소스 형식입니다.

PoolEndpointConfiguration

풀에 대한 엔드포인트 구성입니다.

Name 형식 Description
inboundNatPools

InboundNatPool[]

개별 컴퓨팅 노드의 특정 포트를 외부에서 처리하는 데 사용할 수 있는 인바운드 NAT 풀 목록입니다.
Batch 풀당 최대 인바운드 NAT 풀 수는 5개입니다. 최대 인바운드 NAT 풀 수를 초과하는 경우 HTTP 상태 코드 400으로 인해 요청이 실패합니다. IPAddressProvisioningType이 NoPublicIPAddresses이면 지정할 수 없습니다.

PoolIdentityType

Batch 풀에 사용되는 ID 유형입니다.

Name 형식 Description
None

string

Batch 풀에는 연결된 ID가 없습니다. 업데이트 풀에서 를 설정 None 하면 기존 ID가 제거됩니다.
UserAssigned

string

Batch 풀에는 사용자 할당 ID가 있습니다.

PoolProvisioningState

풀의 현재 상태입니다.

Name 형식 Description
Deleting

string

사용자가 풀을 삭제해 달라고 요청했지만 삭제 작업이 아직 완료되지 않았습니다.
Succeeded

string

풀은 컴퓨팅 노드의 가용성에 따라 작업을 실행할 수 있습니다.

PublicIPAddressConfiguration

풀의 네트워킹 구성에 대한 공용 IP 주소 구성입니다.

Name 형식 Description
ipAddressIds

string[]

컴퓨팅 노드를 프로비전할 때 Batch 서비스에서 사용할 공용 IP 목록입니다.
여기에 지정된 IP 수는 풀의 최대 크기를 제한합니다. 각 공용 IP에 대해 100개의 전용 노드 또는 100개의 스폿/낮은 우선 순위 노드를 할당할 수 있습니다. 예를 들어 250개의 전용 VM이 필요한 풀에는 3개 이상의 공용 IP가 지정되어 있어야 합니다. 이 컬렉션의 각 요소는 /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}형식입니다.
provision

IPAddressProvisioningType

풀의 공용 IP 주소에 대한 프로비저닝 유형
기본값은 BatchManaged입니다.

ResizeError

풀 크기를 조정할 때 발생한 오류입니다.

Name 형식 Description
code

string

오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details

ResizeError[]

오류에 대한 추가 세부 정보입니다.
message

string

사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.

ResizeOperationStatus

현재 또는 마지막으로 완료된 크기 조정 작업에 대한 세부 정보입니다.

Name 형식 Description
errors

ResizeError[]

풀에서 마지막 크기 조정을 수행하는 동안 발생한 오류에 대한 세부 정보입니다.
이 속성은 마지막 풀 크기 조정 중에 오류가 발생한 경우에만 설정되며 풀 allocationState가 Steady인 경우에만 설정됩니다.
nodeDeallocationOption

ComputeNodeDeallocationOption

풀 크기가 감소하는 경우 노드 및 실행 중인 작업으로 수행할 작업을 결정합니다.
기본값은 requeue입니다.
resizeTimeout

string

풀에 컴퓨팅 노드를 할당하거나 풀에서 컴퓨팅 노드를 제거하는 시간 제한입니다.
기본값은 15분입니다. 최소값은 5분입니다. 5분 미만의 값을 지정하면 Batch 서비스에서 오류가 반환됩니다. REST API를 직접 호출하는 경우 HTTP 상태 코드는 400(잘못된 요청)입니다.
startTime

string

이 크기 조정 작업이 시작된 시간입니다.
targetDedicatedNodes

integer

풀에서 원하는 전용 컴퓨팅 노드 수입니다.
targetLowPriorityNodes

integer

풀에서 원하는 스폿/낮은 우선 순위 컴퓨팅 노드 수입니다.

ResourceFile

컴퓨팅 노드에 다운로드할 단일 파일 또는 여러 파일입니다.

Name 형식 Description
autoStorageContainerName

string

자동 스토리지 계정의 스토리지 컨테이너 이름입니다.
autoStorageContainerName, storageContainerUrl 및 httpUrl 속성은 상호 배타적이며 그 중 하나를 지정해야 합니다.
blobPrefix

string

Azure Storage 컨테이너에서 Blob을 다운로드할 때 사용할 Blob 접두사입니다. 이름이 지정된 접두사로 시작하는 Blob만 다운로드됩니다.
속성은 autoStorageContainerName 또는 storageContainerUrl을 사용하는 경우에만 유효합니다. 이 접두사는 부분 파일 이름 또는 하위 디렉터리일 수 있습니다. 접두사를 지정하지 않으면 컨테이너의 모든 파일이 다운로드됩니다.
fileMode

string

8진수 형식의 파일 권한 모드 특성입니다.
이 속성은 Linux 컴퓨팅 노드에 다운로드되는 파일에만 적용됩니다. Windows 노드에 다운로드할 resourceFile에 대해 지정된 경우 무시됩니다. Linux 노드에 대해 이 속성을 지정하지 않으면 기본값인 0770이 파일에 적용됩니다.
filePath

string

작업의 작업 디렉터리를 기준으로 파일을 다운로드할 컴퓨팅 노드의 위치입니다.
httpUrl 속성을 지정하면 filePath가 필요하며 파일 이름을 포함하여 파일이 다운로드될 경로를 설명합니다. 그렇지 않으면 autoStorageContainerName 또는 storageContainerUrl 속성이 지정된 경우 filePath는 선택 사항이며 파일을 다운로드할 디렉터리입니다. filePath가 디렉터리로 사용되는 경우 입력 데이터와 이미 연결된 모든 디렉터리 구조가 완전히 유지되고 지정된 filePath 디렉터리에 추가됩니다. 지정된 상대 경로는 작업의 작업 디렉터리에서 분리할 수 없습니다(예: '..'을 사용).
httpUrl

string

다운로드할 파일의 URL입니다.
autoStorageContainerName, storageContainerUrl 및 httpUrl 속성은 상호 배타적이며 그 중 하나를 지정해야 합니다. URL이 Azure Blob Storage 가리키는 경우 컴퓨팅 노드에서 읽을 수 있어야 합니다. Azure Storage에서 Blob에 대한 이러한 URL을 가져오는 방법에는 Blob에 대한 읽기 권한을 부여하는 SAS(공유 액세스 서명)를 포함하거나, 읽기 권한이 있는 관리 ID를 사용하거나, 공용 액세스를 허용하도록 Blob 또는 해당 컨테이너에 대한 ACL을 설정하는 세 가지 방법이 있습니다.
identityReference

ComputeNodeIdentityReference

storageContainerUrl 또는 httpUrl에서 지정한 Azure Blob Storage 액세스하는 데 사용할 사용자 할당 ID에 대한 참조입니다.
컴퓨팅 노드에서 사용할 Batch 풀과 연결된 사용자 할당 ID에 대한 참조입니다.
storageContainerUrl

string

Azure Blob Storage 내 Blob 컨테이너의 URL입니다.
autoStorageContainerName, storageContainerUrl 및 httpUrl 속성은 상호 배타적이며 그 중 하나를 지정해야 합니다. 이 URL은 컴퓨팅 노드에서 읽을 수 있고 나열할 수 있어야 합니다. Azure Storage에서 컨테이너에 대한 이러한 URL을 가져오는 세 가지 방법이 있습니다. 여기에는 컨테이너에 대한 읽기 및 목록 권한을 부여하는 SAS(공유 액세스 서명)를 포함하거나, 읽기 및 목록 권한이 있는 관리 ID를 사용하거나, 공용 액세스를 허용하도록 컨테이너에 대한 ACL을 설정합니다.

RollingUpgradePolicy

롤링 업그레이드를 수행하는 동안 사용되는 구성 매개 변수입니다.

Name 형식 Description
enableCrossZoneUpgrade

boolean

업그레이드 일괄 처리를 생성할 때 VMSS가 AZ 경계를 무시하도록 허용합니다. 업데이트 도메인 및 maxBatchInstancePercent를 고려하여 일괄 처리 크기를 결정합니다. 이 필드를 설정하지 않으면 Azure Azure Batch 기본값을 설정하지 않습니다. 만든 VirtualMachineScaleSet의 enableCrossZoneUpgrade 값은 VirtualMachineScaleSet의 기본 구성에 따라 결정됩니다. 이 필드는 NodePlacementConfiguration을 영역으로 사용하는 경우에만 true 또는 false로 설정할 수 있습니다.
maxBatchInstancePercent

integer

하나의 일괄 처리로 롤링 업그레이드를 통해 동시에 업그레이드될 총 가상 머신 인스턴스의 최대 비율입니다. 이는 최대값이므로 이전 또는 이후 일괄 처리의 비정상 인스턴스는 더 높은 안정성을 보장하기 위해 일괄 처리의 인스턴스 비율을 줄일 수 있습니다. 이 필드의 값은 5에서 100 사이여야 합니다. maxBatchInstancePercent와 maxUnhealthyInstancePercent가 모두 값으로 할당된 경우 maxBatchInstancePercent 값은 maxUnhealthyInstancePercent를 초과하지 않아야 합니다.
maxUnhealthyInstancePercent

integer

업그레이드의 결과로 또는 롤링 업그레이드가 중단되기 전에 가상 머신 상태 검사에 의해 비정상 상태로 발견되어 동시에 비정상 상태가 될 수 있는 확장 집합의 총 가상 머신 인스턴스의 최대 비율입니다. 이 제약 조건은 일괄 처리를 시작하기 전에 검사됩니다. 이 필드의 값은 5에서 100 사이여야 합니다. maxBatchInstancePercent와 maxUnhealthyInstancePercent가 모두 값으로 할당된 경우 maxBatchInstancePercent 값은 maxUnhealthyInstancePercent를 초과하지 않아야 합니다.
maxUnhealthyUpgradedInstancePercent

integer

비정상 상태인 것으로 확인될 수 있는 업그레이드된 가상 머신 인스턴스의 최대 비율입니다. 이 검사 각 일괄 처리가 업그레이드된 후에 발생합니다. 이 비율을 초과하면 롤링 업데이트가 중단됩니다. 이 필드의 값은 0에서 100 사이여야 합니다.
pauseTimeBetweenBatches

string

한 일괄 처리로 모든 가상 머신에 대한 업데이트를 완료하고 다음 일괄 처리를 시작하는 사이의 대기 시간입니다. 기간은 ISO 8601 형식으로 지정해야 합니다.
prioritizeUnhealthyInstances

boolean

확장 집합의 모든 비정상 인스턴스를 정상 인스턴스 앞에 업그레이드합니다.
rollbackFailedInstancesOnPolicyBreach

boolean

롤링 업그레이드 정책을 위반하는 경우 이전 모델로 인스턴스를 롤백하지 못했습니다.

ScaleSettings

풀에 대한 크기 조정 설정

Name 형식 Description
autoScale

AutoScaleSettings

풀에 대한 자동 크기 조정 설정입니다.
이 속성과 fixedScale은 상호 배타적이며 속성 중 하나를 지정해야 합니다.
fixedScale

FixedScaleSettings

풀에 대한 크기 조정 설정을 수정했습니다.
이 속성과 autoScale은 함께 사용할 수 없으며 속성 중 하나를 지정해야 합니다.

SecurityProfile

가상 머신 또는 가상 머신 확장 집합에 대한 보안 프로필 설정을 지정합니다.

Name 형식 Description
encryptionAtHost

boolean

이 속성은 요청의 사용자가 가상 머신 또는 가상 머신 확장 집합에 대한 호스트 암호화를 사용하거나 사용하지 않도록 설정하는 데 사용할 수 있습니다. 이렇게 하면 호스트 자체의 리소스/임시 디스크를 비롯한 모든 디스크에 대한 암호화가 활성화됩니다.
securityType

SecurityTypes

가상 머신의 SecurityType을 지정합니다. UefiSettings를 사용하도록 설정하려면 지정된 값으로 설정해야 합니다.
uefiSettings

UefiSettings

가상 머신을 만드는 동안 사용되는 보안 부팅 및 vTPM과 같은 보안 설정을 지정합니다.
가상 머신을 만드는 동안 사용되는 보안 부팅 및 vTPM과 같은 보안 설정을 지정합니다.

SecurityTypes

가상 머신의 SecurityType을 지정합니다. UefiSettings를 사용하도록 설정하려면 지정된 값으로 설정해야 합니다.

Name 형식 Description
trustedLaunch

string

신뢰할 수 있는 시작은 지속적인 고급 공격 기술로부터 보호합니다.

ServiceArtifactReference

'최신' 이미지 버전을 사용할 때 확장 집합의 모든 가상 머신에 대해 동일한 이미지 버전을 설정하는 데 사용되는 서비스 아티팩트 참조 ID를 지정합니다.

Name 형식 Description
id

string

ServiceArtifactReference의 서비스 아티팩트 참조 ID
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} 형식의 서비스 아티팩트 참조 ID입니다.

StartTask

컴퓨팅 노드가 Azure Batch 서비스의 풀에 조인하거나 컴퓨팅 노드를 다시 부팅하거나 이미지로 다시 설치할 때 실행되는 작업입니다.

Name 형식 기본값 Description
commandLine

string

시작 작업의 명령줄입니다.
명령줄은 셸에서 실행되지 않으므로 환경 변수 확장과 같은 셸 기능을 활용할 수 없습니다. 이러한 기능을 활용하려면 명령줄에서 셸을 호출해야 합니다(예: Windows의 "cmd /c MyCommand" 또는 Linux의 "/bin/sh -c MyCommand"). startTask의 다른 속성이 지정된 경우 필요합니다.
containerSettings

TaskContainerSettings

시작 태스크가 실행되는 컨테이너에 대한 설정입니다.
이 옵션을 지정하면 AZ_BATCH_NODE_ROOT_DIR 아래의 모든 디렉터리(노드의 Azure Batch 디렉터리 루트)가 컨테이너에 매핑되고, 모든 작업 환경 변수가 컨테이너에 매핑되고, 작업 명령줄이 컨테이너에서 실행됩니다.
environmentSettings

EnvironmentSetting[]

시작 작업에 대한 환경 변수 설정 목록입니다.
maxTaskRetryCount

integer

0

태스크를 다시 시도할 수 있는 최대 횟수입니다.
종료 코드가 0이 아니면 Batch 서비스가 태스크를 다시 시도합니다. 이 값은 구체적으로 재시도 횟수를 제어합니다. Batch 서비스는 태스크를 한 번 시도한 후 이 한도까지 다시 시도할 수 있습니다. 예를 들어 최대 재시도 횟수가 3인 경우 Batch는 작업을 최대 4번(초기 시도 1회, 재시도 3회)으로 시도합니다. 최대 재시도 횟수가 0이면 Batch 서비스는 작업을 다시 시도하지 않습니다. 최대 재시도 횟수가 -1이면 Batch 서비스는 제한 없이 작업을 다시 시도합니다. 기본값은 0입니다.
resourceFiles

ResourceFile[]

명령줄을 실행하기 전에 Batch 서비스가 컴퓨팅 노드에 다운로드할 파일 목록입니다.
userIdentity

UserIdentity

시작 태스크가 실행되는 사용자 ID입니다.
생략하면 태스크가 작업에 고유한 비관리 사용자로 실행됩니다.
waitForSuccess

boolean

Batch 서비스가 컴퓨팅 노드에서 작업을 예약하기 전에 시작 작업이 성공적으로 완료될 때까지 기다려야 하는지 여부(즉, 종료 코드 0으로 종료).
true이고 컴퓨팅 노드에서 시작 작업이 실패하면 Batch 서비스는 시작 작업을 최대 재시도 횟수(maxTaskRetryCount)까지 다시 시도합니다. 모든 재시도 후에도 작업이 성공적으로 완료되지 않은 경우 Batch 서비스는 컴퓨팅 노드를 사용할 수 없음으로 표시하고 작업을 예약하지 않습니다. 이 조건은 노드 상태 및 예약 오류 세부 정보를 통해 검색할 수 있습니다. false이면 Batch 서비스는 시작 작업이 완료될 때까지 기다리지 않습니다. 이 경우 시작 태스크가 계속 실행되는 동안 다른 태스크가 컴퓨팅 노드에서 실행을 시작할 수 있습니다. 시작 작업이 실패하더라도 노드에서 새 작업이 계속 예약됩니다. 기본값은 true입니다.

StorageAccountType

데이터 디스크 또는 OS 디스크를 만드는 데 사용할 스토리지 계정 유형입니다.

Name 형식 Description
Premium_LRS

string

데이터 디스크/OS 디스크는 프리미엄 로컬 중복 스토리지를 사용해야 합니다.
StandardSSD_LRS

string

데이터 디스크/OS 디스크는 표준 SSD 로컬 중복 스토리지를 사용해야 합니다.
Standard_LRS

string

데이터 디스크/OS 디스크는 표준 로컬 중복 스토리지를 사용해야 합니다.

TaskContainerSettings

작업에 대한 컨테이너 설정입니다.

Name 형식 Description
containerRunOptions

string

컨테이너 만들기 명령에 대한 추가 옵션입니다.
이러한 추가 옵션은 Batch 서비스에서 제어하는 옵션 외에도 "docker create" 명령에 대한 인수로 제공됩니다.
imageName

string

태스크가 실행될 컨테이너를 만드는 데 사용할 이미지입니다.
"docker pull"에 지정된 대로 전체 이미지 참조입니다. 이미지 이름의 일부로 태그가 제공되지 않으면 ":latest" 태그가 기본값으로 사용됩니다.
registry

ContainerRegistry

컨테이너 이미지를 포함하는 프라이빗 레지스트리입니다.
풀을 만들 때 이미 제공된 경우 이 설정을 생략할 수 있습니다.
workingDirectory

ContainerWorkingDirectory

컨테이너 작업 디렉터리의 위치를 나타내는 플래그입니다. 기본값은 'taskWorkingDirectory'입니다.

TaskSchedulingPolicy

태스크를 컴퓨팅 노드에 분산하는 방법을 지정합니다.

Name 형식 기본값 Description
nodeFillType

ComputeNodeFillType

Spread

태스크를 컴퓨팅 노드에 분산하는 방법.

UefiSettings

가상 머신을 만드는 동안 사용되는 보안 부팅 및 vTPM과 같은 보안 설정을 지정합니다.

Name 형식 Description
secureBootEnabled

boolean

가상 머신에서 보안 부팅을 사용하도록 설정할지 여부를 지정합니다.
vTpmEnabled

boolean

가상 머신에서 vTPM을 사용하도록 설정할지 여부를 지정합니다.

UpgradeMode

확장 집합에서 가상 머신으로 업그레이드하는 모드를 지정합니다.

가능한 값은 다음과 같습니다.

수동 - 확장 집합에서 가상 머신에 대한 업데이트 애플리케이션을 제어합니다. manualUpgrade 작업을 사용하여 이 작업을 수행합니다.

자동 - 확장 집합의 모든 가상 머신이 동시에 자동으로 업데이트됩니다.

롤링 - 확장 집합은 선택적 일시 중지 시간을 사용하여 일괄 처리로 업데이트를 수행합니다.

Name 형식 Description
automatic

string

확장 집합의 모든 가상 머신은 동시에 자동으로 업데이트됩니다.
manual

string

확장 집합에서 가상 머신에 대한 업데이트 애플리케이션을 제어합니다. manualUpgrade 작업을 사용하여 이 작업을 수행합니다.
rolling

string

확장 집합의 기존 인스턴스는 업그레이드할 일괄 처리로 중단됩니다. 업그레이드된 일괄 처리가 완료되면 인스턴스가 트래픽을 다시 복용하기 시작하고 다음 일괄 처리가 시작됩니다. 이 작업은 모든 인스턴스가 최신 상태가 될 때까지 계속됩니다.

UpgradePolicy

자동, 수동 또는 롤링 업그레이드 정책에 대해 설명합니다.

Name 형식 Description
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

자동 OS 업그레이드를 수행하는 데 사용되는 구성 매개 변수입니다.
자동 OS 업그레이드를 수행하는 데 사용되는 구성 매개 변수입니다.
mode

UpgradeMode

확장 집합에서 가상 머신으로 업그레이드하는 모드를 지정합니다.

가능한 값은 다음과 같습니다.

수동 - 확장 집합의 가상 머신에 대한 업데이트 애플리케이션을 제어합니다. manualUpgrade 작업을 사용하여 이 작업을 수행합니다.

자동 - 확장 집합의 모든 가상 머신이 동시에 자동으로 업데이트됩니다.

롤링 - 확장 집합은 선택적 일시 중지 시간을 사용하여 일괄적으로 업데이트를 수행합니다.
rollingUpgradePolicy

RollingUpgradePolicy

롤링 업그레이드를 수행하는 동안 사용되는 구성 매개 변수입니다.
이 속성은 virtualMachineConfiguration 속성이 있는 풀에서만 지원됩니다.

UserAccount

Azure Batch 노드에서 사용자를 만드는 데 사용되는 속성입니다.

Name 형식 Description
elevationLevel

ElevationLevel

사용자 계정의 권한 상승 수준입니다.
nonAdmin - 자동 사용자는 상승된 액세스 권한이 없는 표준 사용자입니다. admin - 자동 사용자는 관리자 권한이 높은 사용자이며 전체 관리자 권한으로 작동합니다. 기본값은 nonAdmin입니다.
linuxUserConfiguration

LinuxUserConfiguration

사용자 계정에 대한 Linux 관련 사용자 구성입니다.
이 속성은 Windows 풀에 지정된 경우 무시됩니다. 지정하지 않으면 기본 옵션을 사용하여 사용자가 만들어집니다.
name

string

사용자 계정의 이름입니다. 이름은 최대 길이가 20인 유니코드 문자를 포함할 수 있습니다.
password

string

사용자 계정의 암호입니다.
windowsUserConfiguration

WindowsUserConfiguration

사용자 계정에 대한 Windows 관련 사용자 구성입니다.
이 속성은 사용자가 Windows 풀에 있는 경우에만 지정할 수 있습니다. 를 지정하지 않으면 Windows 풀에서 사용자가 기본 옵션을 사용하여 만들어집니다.

UserAssignedIdentities

연결된 사용자 ID 목록입니다.

Name 형식 Description
clientId

string

사용자 할당 ID의 클라이언트 ID입니다.
principalId

string

사용자 할당 ID의 보안 주체 ID입니다.

UserIdentity

작업이 실행되는 사용자 ID의 정의입니다.

Name 형식 Description
autoUser

AutoUserSpecification

작업이 실행되는 자동 사용자입니다.
userName 및 autoUser 속성은 상호 배타적입니다. 둘 다 지정해야 하지만 둘 다 지정하지는 않아야 합니다.
userName

string

작업이 실행되는 사용자 ID의 이름입니다.
userName 및 autoUser 속성은 상호 배타적입니다. 둘 다 지정해야 하지만 둘 다 지정하지는 않아야 합니다.

VirtualMachineConfiguration

Azure Virtual Machines 인프라를 기반으로 풀의 컴퓨팅 노드에 대한 구성입니다.

Name 형식 Description
containerConfiguration

ContainerConfiguration

풀에 대한 컨테이너 구성입니다.
지정된 경우 작업이 컨테이너에서 실행되도록 풀의 각 노드에서 설치가 수행됩니다. 이 풀에서 실행되는 모든 일반 작업 및 작업 관리자 작업은 containerSettings 속성을 지정해야 하며 다른 모든 태스크에서 지정할 수 있습니다.
dataDisks

DataDisk[]

풀의 컴퓨팅 노드에 연결된 데이터 디스크에 대한 구성입니다.
풀의 컴퓨팅 노드에 빈 데이터 디스크가 연결되어 있어야 하는 경우 이 속성을 지정해야 합니다.
diskEncryptionConfiguration

DiskEncryptionConfiguration

풀에 대한 디스크 암호화 구성입니다.
지정된 경우 노드 프로비저닝 중에 풀의 각 노드에서 암호화가 수행됩니다.
extensions

VMExtension[]

풀에 대한 가상 머신 확장입니다.
지정된 경우 이 구성에 언급된 확장이 각 노드에 설치됩니다.
imageReference

ImageReference

사용할 Azure Virtual Machines Marketplace 이미지 또는 사용자 지정 Virtual Machine 이미지에 대한 참조입니다.
licenseType

string

운영 체제를 배포할 때 사용할 온-프레미스 라이선스 유형입니다.
이는 Windows 운영 체제를 포함하는 이미지에만 적용되며 배포될 노드에 대해 유효한 온-프레미스 라이선스를 보유하는 경우에만 사용해야 합니다. 생략하면 온-프레미스 라이선스 할인이 적용되지 않습니다. 값은 다음과 같습니다.

Windows_Server - 온-프레미스 라이선스는 Windows Server용입니다. Windows_Client - 온-프레미스 라이선스는 Windows 클라이언트용입니다.
nodeAgentSkuId

string

풀의 컴퓨팅 노드에 프로비전할 Batch 노드 에이전트의 SKU입니다.
Batch 노드 에이전트는 풀의 각 노드에서 실행되는 프로그램이며 노드와 Batch 서비스 간의 명령 및 제어 인터페이스를 제공합니다. SKU라고 하는 노드 에이전트의 구현은 서로 다른 운영 체제에 대해 여러 가지가 있습니다. 선택한 이미지 참조와 일치하는 노드 에이전트 SKU를 지정해야 합니다. 확인된 이미지 참조 목록과 함께 지원되는 노드 에이전트 SKU 목록을 얻으려면 '지원되는 노드 에이전트 SKU 나열' 작업을 참조하세요.
nodePlacementConfiguration

NodePlacementConfiguration

풀에 대한 노드 배치 구성입니다.
이 구성은 풀의 노드를 물리적으로 할당하는 방법에 대한 규칙을 지정합니다.
osDisk

OSDisk

Virtual Machine의 운영 체제 디스크에 대한 설정입니다.
임시 OSDisk 설정에 대한 구성을 포함합니다.
securityProfile

SecurityProfile

가상 머신 또는 가상 머신 확장 집합에 대한 보안 프로필 설정을 지정합니다.
가상 머신 또는 가상 머신 확장 집합에 대한 보안 프로필 설정을 지정합니다.
serviceArtifactReference

ServiceArtifactReference

'최신' 이미지 버전을 사용할 때 확장 집합의 모든 가상 머신에 대해 동일한 이미지 버전을 설정하는 데 사용되는 서비스 아티팩트 참조 ID를 지정합니다.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} 형식의 서비스 아티팩트 참조 ID입니다.
windowsConfiguration

WindowsConfiguration

가상 머신의 Windows 운영 체제 설정입니다.
imageReference가 Linux OS 이미지를 지정하는 경우 이 속성을 지정해서는 안 됩니다.

VMExtension

가상 머신 확장에 대한 구성입니다.

Name 형식 Description
autoUpgradeMinorVersion

boolean

배포 시 사용할 수 있는 경우 확장에서 최신 부 버전을 사용해야 하는지 여부를 나타냅니다. 그러나 일단 배포되면 이 속성이 true로 설정된 경우에도 확장이 재배포되지 않는 한 부 버전을 업그레이드하지 않습니다.
enableAutomaticUpgrade

boolean

사용 가능한 최신 버전의 확장이 있는 경우 플랫폼에서 확장을 자동으로 업그레이드해야 하는지 여부를 나타냅니다.
name

string

가상 머신 확장의 이름입니다.
protectedSettings

object

확장에는 protectedSettings 또는 protectedSettingsFromKeyVault 또는 보호된 설정이 전혀 포함될 수 없습니다.
provisionAfterExtensions

string[]

확장 이름의 컬렉션입니다.
이 확장을 프로비전해야 하는 확장 이름 컬렉션입니다.
publisher

string

확장 처리기 게시자의 이름입니다.
settings

object

확장에 대한 JSON 형식의 공용 설정입니다.
type

string

확장의 형식입니다.
typeHandlerVersion

string

스크립트 처리기의 버전입니다.

WindowsConfiguration

가상 머신에 적용할 Windows 운영 체제 설정입니다.

Name 형식 Description
enableAutomaticUpdates

boolean

가상 머신에서 자동 업데이트를 사용할 수 있는지 여부입니다.
생략하면 기본값은 true입니다.

WindowsUserConfiguration

Windows 노드에서 사용자 계정을 만드는 데 사용되는 속성입니다.

Name 형식 Description
loginMode

LoginMode

사용자에 대한 로그인 모드
사용자의 로그인 모드를 지정합니다. VirtualMachineConfiguration 풀의 기본값은 대화형 모드이며 CloudServiceConfiguration 풀의 경우 일괄 처리 모드입니다.