Udostępnij za pośrednictwem


Pool - Get

Pobiera informacje o określonej puli.

GET {batchUrl}/pools/{poolId}?api-version=2024-07-01.20.0
GET {batchUrl}/pools/{poolId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2024-07-01.20.0

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
batchUrl
path True

string

Podstawowy adres URL dla wszystkich żądań usługi Azure Batch.

poolId
path True

string

Identyfikator puli do pobrania.

api-version
query True

string

Wersja interfejsu API klienta.

$expand
query

string

Klauzula OData $expand.

$select
query

string

Klauzula OData $select.

timeout
query

integer

int32

Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund. Jeśli wartość jest większa niż 30, zostanie użyta wartość domyślna.

Nagłówek żądania

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

Nazwa Wymagane Typ Opis
client-request-id

string

uuid

Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Czy serwer powinien zwrócić identyfikator żądania klienta w odpowiedzi.

ocp-date

string

date-time-rfc1123

Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

If-Match

string

Wartość elementu ETag skojarzona z wersją zasobu znaną klientowi. Operacja zostanie wykonana tylko wtedy, gdy bieżący element ETag zasobu w usłudze dokładnie odpowiada wartości określonej przez klienta.

If-None-Match

string

Wartość elementu ETag skojarzona z wersją zasobu znaną klientowi. Operacja zostanie wykonana tylko wtedy, gdy bieżący element ETag zasobu w usłudze nie jest zgodny z wartością określoną przez klienta.

If-Modified-Since

string

date-time-rfc1123

Sygnatura czasowa wskazująca czas ostatniej modyfikacji zasobu znanego klientowi. Operacja zostanie wykonana tylko wtedy, gdy zasób w usłudze został zmodyfikowany od określonego czasu.

If-Unmodified-Since

string

date-time-rfc1123

Sygnatura czasowa wskazująca czas ostatniej modyfikacji zasobu znanego klientowi. Operacja zostanie wykonana tylko wtedy, gdy zasób usługi nie został zmodyfikowany od określonego czasu.

Odpowiedzi

Nazwa Typ Opis
200 OK

CloudPool

Odpowiedź zawierająca pulę.

Nagłówki

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

BatchError

Błąd usługi Batch.

Zabezpieczenia

azure_auth

Microsoft Entra OAuth 2.0 — przepływ kodu uwierzytelniania

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation Personifikuj konto użytkownika

Authorization

Typ: apiKey
W: header

Przykłady

Add a VirtualMachineConfiguration pool with OS disk
Get a pool with AcceleratedNetworking
Get a VirtualMachineConfiguration pool with extensions
Get a VirtualMachineConfiguration pool with SecurityProfile
Get a VirtualMachineConfiguration pool with ServiceArtifactReference
Get a VirtualMachineConfiguration pool with UpgradePolicy
Pool get

Add a VirtualMachineConfiguration pool with OS disk

Przykładowe żądanie

GET account.region.batch.azure.com/pools/mypool001?api-version=2024-07-01.20.0


Przykładowa odpowiedź

{
  "id": "mypool001",
  "url": "http://localhost:20302/testaccount1tls/pools/mypool001",
  "eTag": "0x8DBA3B4E91CD7B7",
  "lastModified": "2023-08-23T08:42:40.3479479Z",
  "creationTime": "2023-08-23T08:42:40.3479479Z",
  "state": "active",
  "stateTransitionTime": "2023-08-23T08:42:40.3479479Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-08-23T08:42:53.8587829Z",
  "vmSize": "standard_d2s_v3",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 1,
  "targetDedicatedNodes": 1,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts",
      "version": "latest"
    },
    "osDisk": {
      "ephemeralOSDiskSettings": {
        "placement": "CacheDisk"
      },
      "managedDisk": {
        "storageAccountType": "standardssd_lrs"
      },
      "diskSizeGB": 100,
      "caching": "readwrite"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "currentNodeCommunicationMode": "classic"
}

Get a pool with AcceleratedNetworking

Przykładowe żądanie

GET account.region.batch.azure.com/pools/pool?api-version=2024-07-01.20.0


Przykładowa odpowiedź

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8DB4792BE8566A2",
  "lastModified": "2023-04-28T02:46:19.0268066Z",
  "creationTime": "2023-04-28T02:46:19.0268066Z",
  "state": "active",
  "stateTransitionTime": "2023-04-28T02:46:19.0268066Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-04-28T02:47:17.9169655Z",
  "vmSize": "standard_d1_v2",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 2,
  "targetDedicatedNodes": 2,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "networkConfiguration": {
    "dynamicVNetAssignmentScope": "none",
    "enableAcceleratedNetworking": true
  },
  "currentNodeCommunicationMode": "classic"
}

Get a VirtualMachineConfiguration pool with extensions

Przykładowe żądanie

GET account.region.batch.azure.com/pools/pool?api-version=2024-07-01.20.0


Przykładowa odpowiedź

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8D413091E739A56",
  "lastModified": "2016-11-22T18:55:25.2608598Z",
  "creationTime": "2016-11-22T18:55:24.2632496Z",
  "state": "active",
  "stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
  "vmSize": "standard_a1",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 0,
  "currentLowPriorityNodes": 0,
  "targetDedicatedNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'",
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "nonadmin"
      }
    },
    "maxTaskRetryCount": 0,
    "waitForSuccess": false
  },
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts",
      "version": "latest"
    },
    "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": "classic",
  "currentNodeCommunicationMode": "classic"
}

Get a VirtualMachineConfiguration pool with SecurityProfile

Przykładowe żądanie

GET account.region.batch.azure.com/pools/mypool001?api-version=2024-07-01.20.0


Przykładowa odpowiedź

{
  "id": "mypool001",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8DB6CA2DFF530D1",
  "lastModified": "2023-06-14T06:45:00.0946897Z",
  "creationTime": "2023-06-14T06:45:00.0946897Z",
  "state": "active",
  "stateTransitionTime": "2023-06-14T06:45:00.0946897Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-06-14T06:45:59.4770341Z",
  "vmSize": "standard_dc2s_v2",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 1,
  "targetDedicatedNodes": 1,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "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": false
      }
    }
  },
  "currentNodeCommunicationMode": "classic"
}

Get a VirtualMachineConfiguration pool with ServiceArtifactReference

Przykładowe żądanie

GET account.region.batch.azure.com/pools/pool?api-version=2024-07-01.20.0


Przykładowa odpowiedź

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8DB51F652DFC78F",
  "lastModified": "2023-05-11T08:04:19.7259151Z",
  "creationTime": "2023-05-11T08:04:19.7259151Z",
  "state": "active",
  "stateTransitionTime": "2023-05-11T08:04:19.7259151Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-05-11T08:05:22.0020052Z",
  "vmSize": "standard_a1_v2",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 2,
  "targetDedicatedNodes": 2,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-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"
    }
  },
  "currentNodeCommunicationMode": "classic",
  "upgradePolicy": {
    "mode": "automatic",
    "automaticOSUpgradePolicy": {
      "enableAutomaticOSUpgrade": true
    }
  }
}

Get a VirtualMachineConfiguration pool with UpgradePolicy

Przykładowe żądanie

GET account.region.batch.azure.com/pools/mypool001?api-version=2024-07-01.20.0


Przykładowa odpowiedź

{
  "id": "mypool001",
  "url": "https://account.region.batch.azure.com/pools/mypool001",
  "eTag": "0x8DB51ED3C9B6CF4",
  "lastModified": "2023-05-11T06:59:16.8975092Z",
  "creationTime": "2023-05-11T06:59:16.8975092Z",
  "state": "active",
  "stateTransitionTime": "2023-05-11T06:59:16.8975092Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-05-11T07:00:34.9878574Z",
  "vmSize": "standard_a1_v2",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 2,
  "targetDedicatedNodes": 2,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64",
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "nodePlacementConfiguration": {
      "policy": "zonal"
    }
  },
  "currentNodeCommunicationMode": "classic",
  "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
    }
  }
}

Pool get

Przykładowe żądanie

GET account.region.batch.azure.com/pools/pool?api-version=2024-07-01.20.0


Przykładowa odpowiedź

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8D413091E739A56",
  "lastModified": "2016-11-22T18:55:25.2608598Z",
  "creationTime": "2016-11-22T18:55:24.2632496Z",
  "state": "active",
  "stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
  "vmSize": "standard_a1",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 0,
  "currentLowPriorityNodes": 0,
  "targetDedicatedNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'",
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "nonadmin"
      }
    },
    "maxTaskRetryCount": 0,
    "waitForSuccess": false
  },
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  }
}

Definicje

Nazwa Opis
AllocationState

Określa, czy rozmiar puli jest zmieniany.

ApplicationPackageReference

Odwołanie do pakietu do wdrożenia w węzłach obliczeniowych.

AutomaticOSUpgradePolicy

Parametry konfiguracji używane do przeprowadzania automatycznego uaktualniania systemu operacyjnego.

AutoScaleRun

Wyniki i błędy z wykonania formuły autoskalowania puli.

AutoScaleRunError

Wystąpił błąd podczas wykonywania lub obliczania formuły autoskalowania puli.

AutoUserScope

Zakres użytkownika automatycznego

AutoUserSpecification

Określa parametry dla użytkownika automatycznego, który uruchamia zadanie w usłudze Batch.

AzureBlobFileSystemConfiguration

Informacje używane do nawiązywania połączenia z kontenerem usługi Azure Storage przy użyciu systemu Blobfuse.

AzureFileShareConfiguration

Informacje używane do nawiązywania połączenia z udziałem plików platformy Azure.

BatchError

Odebrano odpowiedź o błędzie z usługi Azure Batch.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.

BatchPoolIdentity

Tożsamość puli usługi Batch, jeśli została skonfigurowana.

CachingType

Typ buforowania, który ma być włączony dla dysku.

CertificateReference

Odwołanie do certyfikatu do zainstalowania w węzłach obliczeniowych w puli.

CertificateStoreLocation

Lokalizacja magazynu certyfikatów w węźle obliczeniowym, w którym ma zostać zainstalowany certyfikat.

CertificateVisibility

Które konta użytkowników w węźle obliczeniowym powinny mieć dostęp do prywatnych danych certyfikatu.

CIFSMountConfiguration

Informacje używane do nawiązywania połączenia z systemem plików CIFS.

CloudPool

Pula w usłudze Azure Batch.

ComputeNodeFillType

Sposób dystrybucji zadań między węzłami obliczeniowymi w puli.

ComputeNodeIdentityReference

Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.

ContainerConfiguration

Konfiguracja pul z obsługą kontenerów.

ContainerHostBatchBindMountEntry

Wpis ścieżki i trybu instalacji, który chcesz zainstalować w kontenerze zadań.

ContainerHostDataPath

Ścieżki, które zostaną zainstalowane w kontenerze zadania kontenera.

ContainerRegistry

Prywatny rejestr kontenerów.

ContainerType

Technologia kontenera do użycia.

ContainerWorkingDirectory

Lokalizacja katalogu roboczego zadania kontenera.

DataDisk

Ustawienia, które będą używane przez dyski danych skojarzone z węzłami obliczeniowymi w puli. W przypadku korzystania z dołączonych dysków danych należy zainstalować i sformatować dyski z maszyny wirtualnej, aby ich używać.

DiffDiskPlacement

Określa efemeryczne umieszczanie dysku dla dysku systemu operacyjnego dla wszystkich węzłów obliczeniowych (maszyn wirtualnych) w puli.

DiffDiskSettings

Określa efemeryczne ustawienia dysku dla dysku systemu operacyjnego używanego przez węzeł obliczeniowy (VM).

DiskEncryptionConfiguration

Konfiguracja szyfrowania dysków zastosowana w węzłach obliczeniowych w puli. Konfiguracja szyfrowania dysków nie jest obsługiwana w puli systemu Linux utworzonej za pomocą obrazu galerii obliczeń platformy Azure.

DiskEncryptionTarget

Lista dysków docelowych obiektów docelowych usługi Batch zostanie zaszyfrowana w węźle obliczeniowym.

DynamicVNetAssignmentScope

Zakres dynamicznego przypisania sieci wirtualnej.

ElevationLevel

Poziom podniesienia uprawnień użytkownika.

EnvironmentSetting

Zmienna środowiskowa, która ma być ustawiana w procesie zadania.

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

ImageReference

Odwołanie do obrazu witryny Marketplace usługi Azure Virtual Machines lub obrazu galerii obliczeniowej platformy Azure. Aby uzyskać listę wszystkich odwołań do obrazów witryny Azure Marketplace zweryfikowanych przez usługę Azure Batch, zobacz operację "Lista obsługiwanych obrazów".

InboundEndpointProtocol

Protokół punktu końcowego.

InboundNATPool

Pula nat dla ruchu przychodzącego, która może służyć do adresowania określonych portów w węzłach obliczeniowych w puli usługi Batch zewnętrznie.

IPAddressProvisioningType

Typ aprowizacji dla publicznych adresów IP dla puli.

LinuxUserConfiguration

Właściwości używane do tworzenia konta użytkownika w węźle obliczeniowym systemu Linux.

LoginMode

Tryb logowania użytkownika

ManagedDisk
MetadataItem

Para nazwa-wartość skojarzona z zasobem usługi Batch.

MountConfiguration

System plików do zainstalowania w każdym węźle.

NameValuePair

Reprezentuje parę nazwa-wartość.

NetworkConfiguration

Konfiguracja sieci dla puli.

NetworkSecurityGroupRule

Reguła sieciowej grupy zabezpieczeń, która ma być stosowana do przychodzącego punktu końcowego.

NetworkSecurityGroupRuleAccess

Akcja, która powinna zostać podjęta dla określonego adresu IP, zakresu podsieci lub tagu.

NFSMountConfiguration

Informacje używane do nawiązywania połączenia z systemem plików NFS.

NodeCommunicationMode

Określa, jak pula komunikuje się z usługą Batch.

NodePlacementConfiguration

Konfiguracja umieszczania węzłów dla puli.

NodePlacementPolicyType

Zasady umieszczania dla przydzielania węzłów w puli.

OSDisk

Ustawienia dysku systemu operacyjnego węzła obliczeniowego (VM).

PoolEndpointConfiguration

Konfiguracja punktu końcowego dla puli.

PoolIdentityType

Tożsamość puli usługi Batch, jeśli została skonfigurowana.

PoolState

Bieżący stan puli.

PoolStatistics

Zawiera statystyki wykorzystania i użycia zasobów dla okresu istnienia puli.

PublicIPAddressConfiguration

Konfiguracja publicznego adresu IP konfiguracji sieci puli.

ResizeError

Wystąpił błąd podczas zmiany rozmiaru puli.

ResourceFile

Jeden plik lub wiele plików do pobrania do węzła obliczeniowego.

ResourceStatistics

Statystyki związane z zużyciem zasobów przez węzły obliczeniowe w puli.

RollingUpgradePolicy

Parametry konfiguracji używane podczas uaktualniania stopniowego.

SecurityEncryptionTypes

Określa typ szyfrowania dysku zarządzanego. Jest ona ustawiona na VMGuestStateOnly na potrzeby szyfrowania tylko obiektu blob VMGuestState i nonPersistedTPM dla nietrwałego stanu oprogramowania układowego w obiekcie blob VMGuestState. Uwaga: można go ustawić tylko dla poufnych maszyn wirtualnych i jest wymagany podczas korzystania z poufnych maszyn wirtualnych.

SecurityProfile

Określa ustawienia profilu zabezpieczeń dla maszyny wirtualnej lub zestawu skalowania maszyn wirtualnych.

SecurityTypes

Określa typ zabezpieczeń maszyny wirtualnej. Musi być ustawiona na dowolną określoną wartość, aby włączyć interfejs UefiSettings.

ServiceArtifactReference

Określa identyfikator odwołania artefaktu usługi używany do ustawiania tej samej wersji obrazu dla wszystkich maszyn wirtualnych w zestawie skalowania w przypadku używania "najnowszej" wersji obrazu.

StartTask

Zadanie uruchamiane po dołączeniu węzła do puli w usłudze Azure Batch lub ponownym uruchomieniu lub ponownym uruchomieniu węzła obliczeniowego lub ponownym obrazie.

StorageAccountType

Typ konta magazynu do użycia podczas tworzenia dysków danych lub dysku systemu operacyjnego.

TaskContainerSettings

Ustawienia kontenera dla zadania.

TaskSchedulingPolicy

Określa sposób dystrybucji zadań w węzłach obliczeniowych.

UefiSettings

Określa ustawienia zabezpieczeń, takie jak bezpieczny rozruch i maszyna wirtualna vTPM używane podczas tworzenia maszyny wirtualnej.

UpgradeMode

Określa tryb uaktualniania maszyn wirtualnych w zestawie skalowania.

Możliwe wartości to:

ręczne — kontrolujesz stosowanie aktualizacji do maszyn wirtualnych w zestawie skalowania. W tym celu należy użyć akcji manualUpgrade.

automatyczne — wszystkie maszyny wirtualne w zestawie skalowania są automatycznie aktualizowane w tym samym czasie.

rolling — zestaw skalowania wykonuje aktualizacje w partiach z opcjonalnym czasem wstrzymania między.

UpgradePolicy

Opisuje zasady uaktualniania — automatyczne, ręczne lub stopniowe.

UsageStatistics

Statystyki związane z informacjami o użyciu puli.

UserAccount

Właściwości używane do tworzenia użytkownika używanego do wykonywania zadań w węźle obliczeniowym usługi Azure Batch.

UserAssignedIdentity

Tożsamość przypisana przez użytkownika

UserIdentity

Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie.

VirtualMachineConfiguration

Konfiguracja węzłów obliczeniowych w puli oparta na infrastrukturze usługi Azure Virtual Machines.

VMDiskSecurityProfile

Określa ustawienia profilu zabezpieczeń dla dysku zarządzanego. Uwaga: można go ustawić tylko dla poufnych maszyn wirtualnych i wymagane w przypadku korzystania z poufnych maszyn wirtualnych.

VMExtension

Konfiguracja rozszerzeń maszyn wirtualnych.

WindowsConfiguration

Ustawienia systemu operacyjnego Windows, które mają być stosowane do maszyny wirtualnej.

WindowsUserConfiguration

Właściwości używane do tworzenia konta użytkownika w węźle obliczeniowym systemu Windows.

AllocationState

Określa, czy rozmiar puli jest zmieniany.

Nazwa Typ Opis
resizing

string

Rozmiar puli jest zmieniany; czyli węzły obliczeniowe są dodawane do puli lub usuwane z puli.

steady

string

Pula nie zmienia rozmiaru. Brak zmian liczby węzłów obliczeniowych w puli w toku. Pula wprowadza ten stan po jej utworzeniu i gdy w puli nie są wykonywane żadne operacje, aby zmienić liczbę węzłów obliczeniowych.

stopping

string

Rozmiar puli został zmieniony, ale użytkownik zażądał zatrzymania zmiany rozmiaru, ale żądanie zatrzymania nie zostało jeszcze ukończone.

ApplicationPackageReference

Odwołanie do pakietu do wdrożenia w węzłach obliczeniowych.

Nazwa Typ Opis
applicationId

string

Identyfikator aplikacji do wdrożenia.
Podczas tworzenia puli identyfikator aplikacji pakietu musi być w pełni kwalifikowany (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

Wersja aplikacji do wdrożenia. W przypadku pominięcia zostanie wdrożona domyślna wersja.
Jeśli pominięto tę pulę i nie określono domyślnej wersji dla tej aplikacji, żądanie kończy się niepowodzeniem z kodem błędu InvalidApplicationPackageReferences i kodem stanu HTTP 409. Jeśli zostanie to pominięte w zadaniu, a dla tej aplikacji nie zostanie określona żadna domyślna wersja, zadanie zakończy się niepowodzeniem z powodu błędu przetwarzania wstępnego.

AutomaticOSUpgradePolicy

Parametry konfiguracji używane do przeprowadzania automatycznego uaktualniania systemu operacyjnego.

Nazwa Typ Opis
disableAutomaticRollback

boolean

Czy funkcja wycofywania obrazów systemu operacyjnego powinna być wyłączona.

enableAutomaticOSUpgrade

boolean

Wskazuje, czy uaktualnienia systemu operacyjnego powinny być automatycznie stosowane do wystąpień zestawu skalowania w sposób kroczący, gdy nowsza wersja obrazu systemu operacyjnego stanie się dostępna.

Jeśli dla pul opartych na systemie Windows ustawiono wartość true, WindowsConfiguration.enableAutomaticUpdates nie można ustawić wartości true.

osRollingUpgradeDeferral

boolean

Odroczenie uaktualnień systemu operacyjnego na maszynach TVM, jeśli są uruchomione zadania.

useRollingUpgradePolicy

boolean

Wskazuje, czy zasady uaktualniania stopniowego powinny być używane podczas automatycznego uaktualniania systemu operacyjnego. Automatyczne uaktualnianie systemu operacyjnego spowoduje powrót do domyślnych zasad, jeśli żadne zasady nie są zdefiniowane w zestawie skalowania maszyn wirtualnych.

AutoScaleRun

Wyniki i błędy z wykonania formuły autoskalowania puli.

Nazwa Typ Opis
error

AutoScaleRunError

Szczegóły błędu napotkanego podczas oceniania formuły autoskalowania w puli, jeśli ocena zakończyła się niepowodzeniem.

results

string

Końcowe wartości wszystkich zmiennych używanych w ocenie formuły autoskalowania.
Każda wartość zmiennej jest zwracana w formularzu $variable=wartość, a zmienne są rozdzielane średnikami.

timestamp

string

Czas ostatniego oszacowania formuły autoskalowej.

AutoScaleRunError

Wystąpił błąd podczas wykonywania lub obliczania formuły autoskalowania puli.

Nazwa Typ Opis
code

string

Identyfikator błędu skalowania automatycznego. Kody są niezmienne i mają być używane programowo.

message

string

Komunikat opisujący błąd autoskalowania, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

values

NameValuePair[]

Lista dodatkowych szczegółów błędu związanych z błędem autoskalowania.

AutoUserScope

Zakres użytkownika automatycznego

Nazwa Typ Opis
pool

string

Określa, że zadanie jest uruchamiane jako wspólne konto użytkownika automatycznego, które jest tworzone w każdym węźle obliczeniowym w puli.

task

string

Określa, że usługa powinna utworzyć nowego użytkownika dla zadania.

AutoUserSpecification

Określa parametry dla użytkownika automatycznego, który uruchamia zadanie w usłudze Batch.

Nazwa Typ Opis
elevationLevel

ElevationLevel

Poziom podniesienia uprawnień użytkownika automatycznego.
Wartość domyślna to nonAdmin.

scope

AutoUserScope

Zakres użytkownika automatycznego
Wartość domyślna to pula. Jeśli pula jest uruchomiona w systemie Windows, należy określić wartość Zadanie, jeśli wymagana jest ściślejsza izolacja między zadaniami. Jeśli na przykład zadanie wycisza rejestr w sposób, który może mieć wpływ na inne zadania, lub jeśli certyfikaty zostały określone w puli, które nie powinny być dostępne przez zwykłe zadania, ale powinny być dostępne przez zadania StartTasks.

AzureBlobFileSystemConfiguration

Informacje używane do nawiązywania połączenia z kontenerem usługi Azure Storage przy użyciu systemu Blobfuse.

Nazwa Typ Opis
accountKey

string

Klucz konta usługi Azure Storage.
Ta właściwość wzajemnie się wyklucza zarówno z kluczem sasKey, jak i tożsamością; należy określić dokładnie jeden.

accountName

string

Nazwa konta usługi Azure Storage.

blobfuseOptions

string

Dodatkowe opcje wiersza polecenia umożliwiające przekazanie polecenia instalacji.
Są to opcje "net use" w systemach Windows i "instalowanie" w systemie Linux.

containerName

string

Nazwa kontenera usługi Azure Blob Storage.

identityReference

ComputeNodeIdentityReference

Odwołanie do tożsamości przypisanej przez użytkownika do użycia w celu uzyskania dostępu do elementu containerName
Ta właściwość wzajemnie wyklucza się zarówno z kluczem accountKey, jak i sasKey; należy określić dokładnie jeden.

relativeMountPath

string

Ścieżka względna w węźle obliczeniowym, w którym zostanie zainstalowany system plików
Wszystkie systemy plików są instalowane względem katalogu instalacji usługi Batch, dostępnego za pośrednictwem zmiennej środowiskowej AZ_BATCH_NODE_MOUNTS_DIR.

sasKey

string

Token SAS usługi Azure Storage.
Ta właściwość wzajemnie wyklucza się zarówno z kluczem konta, jak i tożsamością; należy określić dokładnie jeden.

AzureFileShareConfiguration

Informacje używane do nawiązywania połączenia z udziałem plików platformy Azure.

Nazwa Typ Opis
accountKey

string

Klucz konta usługi Azure Storage.

accountName

string

Nazwa konta usługi Azure Storage.

azureFileUrl

string

Adres URL usługi Azure Files.
Jest to formularz "https://{account}.file.core.windows.net/".

mountOptions

string

Dodatkowe opcje wiersza polecenia umożliwiające przekazanie polecenia instalacji.
Są to opcje "net use" w systemach Windows i "instalowanie" w systemie Linux.

relativeMountPath

string

Ścieżka względna w węźle obliczeniowym, w którym zostanie zainstalowany system plików
Wszystkie systemy plików są instalowane względem katalogu instalacji usługi Batch, dostępnego za pośrednictwem zmiennej środowiskowej AZ_BATCH_NODE_MOUNTS_DIR.

BatchError

Odebrano odpowiedź o błędzie z usługi Azure Batch.

Nazwa Typ Opis
code

string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.

message

ErrorMessage

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

values

BatchErrorDetail[]

Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.

Nazwa Typ Opis
key

string

Identyfikator określający znaczenie właściwości Value.

value

string

Dodatkowe informacje zawarte w odpowiedzi na błąd.

BatchPoolIdentity

Tożsamość puli usługi Batch, jeśli została skonfigurowana.

Nazwa Typ Opis
type

PoolIdentityType

Tożsamość puli usługi Batch, jeśli została skonfigurowana.
Lista tożsamości użytkowników skojarzonych z pulą usługi Batch. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

userAssignedIdentities

UserAssignedIdentity[]

Lista tożsamości użytkowników skojarzonych z kontem usługi Batch.
Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

CachingType

Typ buforowania, który ma być włączony dla dysku.

Nazwa Typ Opis
none

string

Tryb buforowania dysku nie jest włączony.

readonly

string

Tryb buforowania dysku jest tylko do odczytu.

readwrite

string

Tryb buforowania dysku jest odczytywany i zapisywany.

CertificateReference

Odwołanie do certyfikatu do zainstalowania w węzłach obliczeniowych w puli.

Nazwa Typ Opis
storeLocation

CertificateStoreLocation

Lokalizacja magazynu certyfikatów w węźle obliczeniowym, w którym ma zostać zainstalowany certyfikat.
Wartość domyślna to currentuser. Ta właściwość ma zastosowanie tylko w przypadku pul skonfigurowanych z węzłami obliczeniowymi systemu Windows. W przypadku węzłów obliczeniowych systemu Linux certyfikaty są przechowywane w katalogu roboczym Zadanie, a zmienna środowiskowa AZ_BATCH_CERTIFICATES_DIR jest dostarczana do zadania, aby wykonać zapytanie o tę lokalizację. W przypadku certyfikatów z widocznością "remoteUser" katalog "certs" jest tworzony w katalogu głównym użytkownika (np. /home/{user-name}/certs) i certyfikaty są umieszczane w tym katalogu.

storeName

string

Nazwa magazynu certyfikatów w węźle obliczeniowym, do którego ma zostać zainstalowany certyfikat.
Ta właściwość ma zastosowanie tylko w przypadku pul skonfigurowanych z węzłami obliczeniowymi systemu Windows. Typowe nazwy sklepów to: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, ale można również użyć dowolnej niestandardowej nazwy sklepu. Wartość domyślna to Moja.

thumbprint

string

Odcisk palca certyfikatu.

thumbprintAlgorithm

string

Algorytm, z którym jest skojarzony odcisk palca. Musi to być sha1.

visibility

CertificateVisibility[]

Które konta użytkowników w węźle obliczeniowym powinny mieć dostęp do prywatnych danych certyfikatu.
W tej kolekcji można określić więcej niż jedną widoczność. Wartość domyślna to wszystkie konta.

CertificateStoreLocation

Lokalizacja magazynu certyfikatów w węźle obliczeniowym, w którym ma zostać zainstalowany certyfikat.

Nazwa Typ Opis
currentuser

string

Certyfikaty należy zainstalować w magazynie certyfikatów CurrentUser.

localmachine

string

Certyfikaty należy zainstalować w magazynie certyfikatów LocalMachine.

CertificateVisibility

Które konta użytkowników w węźle obliczeniowym powinny mieć dostęp do prywatnych danych certyfikatu.

Nazwa Typ Opis
remoteuser

string

Certyfikat powinien być widoczny dla kont użytkowników, w ramach których użytkownicy uzyskują zdalny dostęp do węzła obliczeniowego.

starttask

string

Certyfikat powinien być widoczny dla konta użytkownika, w ramach którego jest uruchamiana wartość StartTask. Należy pamiętać, że jeśli zakres autoużytkownika jest pulą zarówno dla zadania startowego, jak i zadania, ten certyfikat będzie również widoczny dla zadania.

task

string

Certyfikat powinien być widoczny dla kont użytkowników, w ramach których są uruchamiane zadania podrzędne.

CIFSMountConfiguration

Informacje używane do nawiązywania połączenia z systemem plików CIFS.

Nazwa Typ Opis
mountOptions

string

Dodatkowe opcje wiersza polecenia umożliwiające przekazanie polecenia instalacji.
Są to opcje "net use" w systemach Windows i "instalowanie" w systemie Linux.

password

string

Hasło używane do uwierzytelniania w systemie plików CIFS.

relativeMountPath

string

Ścieżka względna w węźle obliczeniowym, w którym zostanie zainstalowany system plików
Wszystkie systemy plików są instalowane względem katalogu instalacji usługi Batch, dostępnego za pośrednictwem zmiennej środowiskowej AZ_BATCH_NODE_MOUNTS_DIR.

source

string

Identyfikator URI systemu plików do zainstalowania.

username

string

Użytkownik do użycia do uwierzytelniania w systemie plików CIFS.

CloudPool

Pula w usłudze Azure Batch.

Nazwa Typ Opis
allocationState

AllocationState

Określa, czy rozmiar puli jest zmieniany.

allocationStateTransitionTime

string

Czas, w którym pula wprowadziła bieżący stan alokacji.

applicationPackageReferences

ApplicationPackageReference[]

Lista pakietów do zainstalowania w każdym węźle obliczeniowym w puli.
Zmiany odwołań do pakietu mają wpływ na wszystkie nowe węzły łączące pulę, ale nie mają wpływu na węzły obliczeniowe, które znajdują się już w puli, dopóki nie zostaną ponownie uruchomione lub zrewidowane. W danej puli istnieje maksymalnie 10 odwołań do pakietu.

autoScaleEvaluationInterval

string

Interwał czasu, w którym ma być automatycznie dostosowywany rozmiar puli zgodnie z formułą autoskalowania.
Ta właściwość jest ustawiana tylko wtedy, gdy pula jest automatycznie skalowana, tj. wartość enableAutoScale ma wartość true.

autoScaleFormula

string

Formuła dla żądanej liczby węzłów obliczeniowych w puli.
Ta właściwość jest ustawiana tylko wtedy, gdy pula jest automatycznie skalowana, tj. wartość enableAutoScale ma wartość true.

autoScaleRun

AutoScaleRun

Wyniki i błędy z ostatniego wykonania formuły autoskalowania.
Ta właściwość jest ustawiana tylko wtedy, gdy pula jest automatycznie skalowana, tj. wartość enableAutoScale ma wartość true.

certificateReferences

CertificateReference[]

Lista certyfikatów do zainstalowania w każdym węźle obliczeniowym w puli.
W przypadku węzłów systemu Windows usługa Batch instaluje certyfikaty w określonym magazynie certyfikatów i lokalizacji. W przypadku węzłów obliczeniowych systemu Linux certyfikaty są przechowywane w katalogu roboczym Zadanie, a zmienna środowiskowa AZ_BATCH_CERTIFICATES_DIR jest dostarczana do zadania, aby wykonać zapytanie o tę lokalizację. W przypadku certyfikatów z widocznością "remoteUser" katalog "certs" jest tworzony w katalogu głównym użytkownika (np. /home/{user-name}/certs) i certyfikaty są umieszczane w tym katalogu.

Ostrzeżenie: Ta właściwość jest przestarzała i zostanie usunięta po lutym 2024 r. Zamiast tego użyj rozszerzenia Azure KeyVault.

creationTime

string

Czas tworzenia puli.

currentDedicatedNodes

integer

Liczba dedykowanych węzłów obliczeniowych obecnie w puli.

currentLowPriorityNodes

integer

Liczba węzłów obliczeniowych o niskim priorytcie typu spot/low-priority w puli.
Węzły obliczeniowe typu spot/low-priority, które zostały wywłaszczone, są uwzględniane w tej liczbie.

currentNodeCommunicationMode

NodeCommunicationMode

Bieżący stan trybu komunikacji puli.

displayName

string

Nazwa wyświetlana puli.
Nazwa wyświetlana nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024.

eTag

string

Element ETag puli.
Jest to nieprzezroczystym ciągiem. Można go użyć do wykrywania, czy pula zmieniła się między żądaniami. W szczególności można przekazać element ETag podczas aktualizowania puli, aby określić, że zmiany powinny obowiązywać tylko wtedy, gdy nikt inny nie zmodyfikował puli w międzyczasie.

enableAutoScale

boolean

Określa, czy rozmiar puli powinien być automatycznie dostosowywany w miarę upływu czasu.
Jeśli wartość false, należy określić co najmniej jeden z elementów targetDedicatedNodes i targetLowPriorityNodes. Jeśli wartość true, właściwość autoScaleFormula jest wymagana, a rozmiar puli zostanie automatycznie zmieniony zgodnie z formułą. Wartość domyślna to false.

enableInterNodeCommunication

boolean

Określa, czy pula zezwala na bezpośrednią komunikację między węzłami obliczeniowymi.
Nakłada to ograniczenia, do których węzły obliczeniowe można przypisać do puli. Określenie tej wartości może zmniejszyć prawdopodobieństwo przydzielenia żądanej liczby węzłów obliczeniowych w puli.

id

string

Ciąg, który jednoznacznie identyfikuje pulę w ramach konta.
Identyfikator może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączników i podkreśleń, i nie może zawierać więcej niż 64 znaków. Identyfikator jest zachowywany przy użyciu wielkości liter i bez uwzględniania wielkości liter (oznacza to, że w ramach konta mogą nie istnieć dwa identyfikatory, które różnią się tylko wielkością liter).

identity

BatchPoolIdentity

Tożsamość puli usługi Batch, jeśli została skonfigurowana.
Lista tożsamości użytkowników skojarzonych z pulą usługi Batch. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

lastModified

string

Czas ostatniej modyfikacji puli.
Jest to ostatni raz, w którym dane na poziomie puli, takie jak targetDedicatedNodes lub enableAutoscale settings, zmieniły się. Nie uwzględnia zmian na poziomie węzła, takich jak zmiana stanu węzła obliczeniowego.

metadata

MetadataItem[]

Lista par name-value skojarzonych z pulą jako metadanych.

mountConfiguration

MountConfiguration[]

Lista systemów plików do zainstalowania w każdym węźle w puli.
Obsługuje to usługi Azure Files, NFS, CIFS/SMB i Blobfuse.

networkConfiguration

NetworkConfiguration

Konfiguracja sieci dla puli.
Konfiguracja sieci dla puli.

resizeErrors

ResizeError[]

Lista błędów napotkanych podczas ostatniej zmiany rozmiaru puli.
Ta właściwość jest ustawiana tylko wtedy, gdy wystąpił co najmniej jeden błąd podczas ostatniej zmiany rozmiaru puli i tylko wtedy, gdy właściwość Pool allocationState jest stała.

resizeTimeout

string

Limit czasu alokacji węzłów obliczeniowych do puli.
Jest to limit czasu dla najnowszej operacji zmiany rozmiaru. (Początkowe ustalanie rozmiaru podczas tworzenia puli jest liczone jako zmiana rozmiaru). Wartość domyślna to 15 minut.

resourceTags

object

Tagi określone przez użytkownika skojarzone z pulą.
Tagi zdefiniowane przez użytkownika, które mają być skojarzone z pulą usługi Azure Batch. Po określeniu te tagi są propagowane do zasobów platformy Azure skojarzonych z pulą. Tę właściwość można określić tylko wtedy, gdy konto usługi Batch zostało utworzone za pomocą właściwości poolAllocationMode ustawionej na wartość "UserSubscription".

startTask

StartTask

Zadanie określone do uruchomienia w każdym węźle obliczeniowym podczas dołączania do puli.
Usługa Batch ponowi próbę wykonania zadań po wyzwoleniu operacji odzyskiwania w węźle. Przykłady operacji odzyskiwania obejmują (ale nie tylko) ponowne uruchomienie węzła w złej kondycji lub zniknięcie węzła obliczeniowego z powodu awarii hosta. Ponowne próby z powodu operacji odzyskiwania są niezależne i nie są liczone względem parametru maxTaskRetryCount. Nawet jeśli parametr maxTaskRetryCount wynosi 0, może wystąpić wewnętrzna ponowna próba spowodowana operacją odzyskiwania. W związku z tym wszystkie zadania powinny być idempotentne. Oznacza to, że zadania muszą tolerować przerywanie i ponowne uruchamianie bez powodowania uszkodzenia lub duplikowania danych. Najlepszym rozwiązaniem dla długotrwałych zadań jest użycie jakiejś formy tworzenia punktów kontrolnych. W niektórych przypadkach funkcja StartTask może zostać ponownie uruchomiona, mimo że węzeł obliczeniowy nie został ponownie uruchomiony. Należy zachować szczególną ostrożność, aby uniknąć zadań StartTasks, które tworzą proces przerwania lub instalują/uruchamiają usługi z katalogu roboczego StartTask, ponieważ uniemożliwi to usłudze Batch ponowne uruchomienie zadania StartTask.

state

PoolState

Bieżący stan puli.

stateTransitionTime

string

Czas, w którym pula weszła w bieżący stan.

stats

PoolStatistics

Statystyki użycia zasobów i użycia zasobów dla całego okresu istnienia puli.
Ta właściwość jest wypełniana tylko wtedy, gdy pula CloudPool została pobrana z klauzulą expand, w tym atrybutem "stats"; w przeciwnym razie ma wartość null. Statystyki mogą nie być natychmiast dostępne. Usługa Batch wykonuje okresowe zestawienie statystyk. Typowe opóźnienie wynosi około 30 minut.

targetDedicatedNodes

integer

Żądana liczba dedykowanych węzłów obliczeniowych w puli.

targetLowPriorityNodes

integer

Żądana liczba węzłów obliczeniowych typu spot/o niskim priorytcie w puli.

targetNodeCommunicationMode

NodeCommunicationMode

Żądany tryb komunikacji węzła dla puli.
W przypadku pominięcia wartość domyślna to Wartość domyślna.

taskSchedulingPolicy

TaskSchedulingPolicy

Sposób dystrybucji zadań między węzłami obliczeniowymi w puli.
Jeśli nie zostanie określony, wartość domyślna zostanie rozłożona.

taskSlotsPerNode

integer

Liczba miejsc zadań, których można użyć do uruchamiania współbieżnych zadań w jednym węźle obliczeniowym w puli.
Wartość domyślna to 1. Wartość maksymalna jest mniejsza od 4 razy liczbie rdzeni rozmiaru maszyny wirtualnej puli lub 256.

upgradePolicy

UpgradePolicy

Zasady uaktualniania puli.
Opisuje zasady uaktualniania — automatyczne, ręczne lub stopniowe.

url

string

Adres URL puli.

userAccounts

UserAccount[]

Lista kont użytkowników do utworzenia w każdym węźle obliczeniowym w puli.

virtualMachineConfiguration

VirtualMachineConfiguration

Konfiguracja maszyny wirtualnej dla puli.
Tę właściwość należy określić.

vmSize

string

Rozmiar maszyn wirtualnych w puli. Wszystkie maszyny wirtualne w puli mają ten sam rozmiar.
Aby uzyskać informacje o dostępnych rozmiarach maszyn wirtualnych w pulach, zobacz Wybieranie rozmiaru maszyny wirtualnej dla węzłów obliczeniowych w puli usługi Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeFillType

Sposób dystrybucji zadań między węzłami obliczeniowymi w puli.

Nazwa Typ Opis
pack

string

Jak najwięcej zadań (taskSlotsPerNode) należy przypisać do każdego węzła obliczeniowego w puli, zanim wszystkie zadania zostaną przypisane do następnego węzła obliczeniowego w puli.

spread

string

Zadania powinny być przypisywane równomiernie we wszystkich węzłach obliczeniowych w puli.

ComputeNodeIdentityReference

Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu usługi ARM tożsamości przypisanej przez użytkownika.

ContainerConfiguration

Konfiguracja pul z obsługą kontenerów.

Nazwa Typ Opis
containerImageNames

string[]

Kolekcja nazw obrazów kontenera.
Jest to pełne odwołanie do obrazu, jak można określić na "ściąganie platformy Docker". Obraz będzie pochodzić z domyślnego rejestru platformy Docker, chyba że obraz jest w pełni kwalifikowany z alternatywnym rejestrem.

containerRegistries

ContainerRegistry[]

Dodatkowe rejestry prywatne, z których można ściągać kontenery.
Jeśli jakiekolwiek obrazy muszą zostać pobrane z rejestru prywatnego, który wymaga poświadczeń, należy podać te poświadczenia tutaj.

type

ContainerType

Technologia kontenera do użycia.

ContainerHostBatchBindMountEntry

Wpis ścieżki i trybu instalacji, który chcesz zainstalować w kontenerze zadań.

Nazwa Typ Opis
isReadOnly

boolean

Zainstaluj tę ścieżkę źródłową jako tryb tylko do odczytu lub nie. Wartość domyślna to false (tryb odczytu/zapisu).
W przypadku systemu Linux, jeśli zainstalujesz tę ścieżkę jako tryb odczytu/zapisu, nie oznacza to, że wszyscy użytkownicy w kontenerze mają dostęp do odczytu/zapisu dla ścieżki, zależy to od dostępu na maszynie wirtualnej hosta. Jeśli ta ścieżka jest instalowana tylko do odczytu, wszyscy użytkownicy w kontenerze nie będą mogli modyfikować ścieżki.

source

ContainerHostDataPath

Można wybrać ścieżkę instalowaną dla klienta kontenera.

ContainerHostDataPath

Ścieżki, które zostaną zainstalowane w kontenerze zadania kontenera.

Nazwa Typ Opis
Applications

string

Ścieżka aplikacji.

JobPrep

string

Ścieżka zadania przygotowania zadania.

Shared

string

Ścieżka zadania obejmującego wiele wystąpień w celu udostępnienia plików.

Startup

string

Ścieżka zadania podrzędnego uruchamiania.

Task

string

Ścieżka zadania.

VfsMounts

string

Ścieżka zawiera wszystkie wirtualne systemy plików są instalowane w tym węźle.

ContainerRegistry

Prywatny rejestr kontenerów.

Nazwa Typ Opis
identityReference

ComputeNodeIdentityReference

Odwołanie do tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do usługi Azure Container Registry zamiast nazwy użytkownika i hasła.
Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.

password

string

Hasło do logowania się na serwerze rejestru.

registryServer

string

Adres URL rejestru.
W przypadku pominięcia wartość domyślna to "docker.io".

username

string

Nazwa użytkownika do logowania się na serwerze rejestru.

ContainerType

Technologia kontenera do użycia.

Nazwa Typ Opis
criCompatible

string

Technologia oparta na cri będzie używana do uruchamiania kontenerów.

dockerCompatible

string

Technologia kontenera zgodna z platformą Docker będzie używana do uruchamiania kontenerów.

ContainerWorkingDirectory

Lokalizacja katalogu roboczego zadania kontenera.

Nazwa Typ Opis
containerImageDefault

string

Użyj katalogu roboczego zdefiniowanego w obrazie kontenera. Należy pamiętać, że ten katalog nie będzie zawierać plików zasobów pobranych przez usługę Batch.

taskWorkingDirectory

string

Użyj standardowego katalogu roboczego zadania usługi Batch, który będzie zawierać pliki zasobów zadań wypełniane przez usługę Batch.

DataDisk

Ustawienia, które będą używane przez dyski danych skojarzone z węzłami obliczeniowymi w puli. W przypadku korzystania z dołączonych dysków danych należy zainstalować i sformatować dyski z maszyny wirtualnej, aby ich używać.

Nazwa Typ Opis
caching

CachingType

Typ buforowania, który ma być włączony dla dysków danych.
Wartość domyślna buforowania to readwrite. Aby uzyskać informacje o opcjach buforowania, zobacz: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

Początkowy rozmiar dysku w gigabajtach.

lun

integer

Numer jednostki logicznej.
Jednostka lun służy do unikatowego identyfikowania każdego dysku danych. W przypadku dołączania wielu dysków każda z nich powinna mieć odrębną jednostkę lun. Wartość musi należeć do przedziału od 0 do 63 włącznie.

storageAccountType

StorageAccountType

Typ konta magazynu, który ma być używany dla dysku danych.
W przypadku pominięcia wartość domyślna to "standard_lrs".

DiffDiskPlacement

Określa efemeryczne umieszczanie dysku dla dysku systemu operacyjnego dla wszystkich węzłów obliczeniowych (maszyn wirtualnych) w puli.

Nazwa Typ Opis
CacheDisk

string

Efemeryczny dysk systemu operacyjnego jest przechowywany w pamięci podręcznej maszyny wirtualnej.

DiffDiskSettings

Określa efemeryczne ustawienia dysku dla dysku systemu operacyjnego używanego przez węzeł obliczeniowy (VM).

Nazwa Typ Opis
placement

DiffDiskPlacement

Określa efemeryczne umieszczanie dysku dla dysku systemu operacyjnego dla wszystkich maszyn wirtualnych w puli.
Ta właściwość może być używana przez użytkownika w żądaniu, aby wybrać lokalizację, np. miejsce na dysku pamięci podręcznej na potrzeby aprowizacji dysku efemerycznego systemu operacyjnego. Aby uzyskać więcej informacji na temat wymagań dotyczących rozmiaru dysku systemu operacyjnego efemerycznego, zapoznaj się z wymaganiami dotyczącymi rozmiaru dysku efemerycznego systemu operacyjnego dla maszyn wirtualnych z systemem Windows na https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements i maszynach wirtualnych z systemem Linux w https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

Konfiguracja szyfrowania dysków zastosowana w węzłach obliczeniowych w puli. Konfiguracja szyfrowania dysków nie jest obsługiwana w puli systemu Linux utworzonej za pomocą obrazu galerii obliczeń platformy Azure.

Nazwa Typ Opis
targets

DiskEncryptionTarget[]

Lista dysków docelowych obiektów docelowych usługi Batch zostanie zaszyfrowana w węźle obliczeniowym.
Lista dysków docelowych obiektów docelowych usługi Batch zostanie zaszyfrowana w węźle obliczeniowym.

DiskEncryptionTarget

Lista dysków docelowych obiektów docelowych usługi Batch zostanie zaszyfrowana w węźle obliczeniowym.

Nazwa Typ Opis
osdisk

string

Dysk systemu operacyjnego w węźle obliczeniowym jest szyfrowany.

temporarydisk

string

Dysk tymczasowy w węźle obliczeniowym jest szyfrowany. W systemie Linux to szyfrowanie ma zastosowanie do innych partycji (takich jak te na zainstalowanych dyskach danych), gdy szyfrowanie odbywa się w czasie rozruchu.

DynamicVNetAssignmentScope

Zakres dynamicznego przypisania sieci wirtualnej.

Nazwa Typ Opis
job

string

Dynamiczne przypisywanie sieci wirtualnej jest wykonywane na zadanie.

none

string

Nie włączono dynamicznego przypisania sieci wirtualnej.

ElevationLevel

Poziom podniesienia uprawnień użytkownika.

Nazwa Typ Opis
admin

string

Użytkownik jest użytkownikiem z podwyższonym poziomem dostępu i działa z pełnymi uprawnieniami administratora.

nonadmin

string

Użytkownik jest użytkownikiem standardowym bez podwyższonego poziomu dostępu.

EnvironmentSetting

Zmienna środowiskowa, która ma być ustawiana w procesie zadania.

Nazwa Typ Opis
name

string

Nazwa zmiennej środowiskowej.

value

string

Wartość zmiennej środowiskowej.

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

Nazwa Typ Opis
lang

string

Kod języka komunikatu o błędzie

value

string

Tekst wiadomości.

ImageReference

Odwołanie do obrazu witryny Marketplace usługi Azure Virtual Machines lub obrazu galerii obliczeniowej platformy Azure. Aby uzyskać listę wszystkich odwołań do obrazów witryny Azure Marketplace zweryfikowanych przez usługę Azure Batch, zobacz operację "Lista obsługiwanych obrazów".

Nazwa Typ Opis
communityGalleryImageId

string

Unikatowy identyfikator obrazu galerii społeczności
Ta właściwość wzajemnie wyklucza się z innymi właściwościami i może być pobierana z wywołania GET obrazu galerii społeczności.

exactVersion

string

Określona wersja obrazu platformy lub obrazu platformy handlowej użytego do utworzenia węzła. To pole tylko do odczytu różni się od "version" tylko wtedy, gdy wartość określona dla "version" podczas tworzenia puli miała wartość "latest".

offer

string

Typ oferty obrazu witryny Marketplace usługi Azure Virtual Machines.
Na przykład UbuntuServer lub WindowsServer.

publisher

string

Wydawca obrazu witryny Marketplace usługi Azure Virtual Machines.
Na przykład Canonical lub MicrosoftWindowsServer.

sharedGalleryImageId

string

Unikatowy identyfikator obrazu galerii udostępnionej
Ta właściwość wzajemnie wyklucza się z innymi właściwościami i może zostać pobrana z wywołania GET obrazu galerii udostępnionej.

sku

string

Jednostka SKU obrazu witryny Marketplace usługi Azure Virtual Machines.
Na przykład 18.04-LTS lub 2019-Datacenter.

version

string

Wersja obrazu witryny Marketplace usługi Azure Virtual Machines.
Można określić wartość "latest", aby wybrać najnowszą wersję obrazu. W przypadku pominięcia wartość domyślna to "latest".

virtualMachineImageId

string

Identyfikator zasobu usługi ARM obrazu galerii obliczeniowej platformy Azure. Węzły obliczeniowe w puli zostaną utworzone przy użyciu tego identyfikatora obrazu. Jest to formularz /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} lub /subscriptions/{subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} dla zawsze domyślnej wersji obrazu.
Ta właściwość wzajemnie wyklucza się z innymi właściwościami ImageReference. Obraz galerii obliczeniowej platformy Azure musi mieć repliki w tym samym regionie i musi znajdować się w tej samej subskrypcji co konto usługi Azure Batch. Jeśli wersja obrazu nie zostanie określona w identyfikatorze imageId, zostanie użyta najnowsza wersja. Aby uzyskać informacje o ustawieniach zapory dla agenta węzła obliczeniowego usługi Batch do komunikowania się z usługą Batch, zobacz https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

Protokół punktu końcowego.

Nazwa Typ Opis
tcp

string

Użyj protokołu TCP dla punktu końcowego.

udp

string

Użyj protokołu UDP dla punktu końcowego.

InboundNATPool

Pula nat dla ruchu przychodzącego, która może służyć do adresowania określonych portów w węzłach obliczeniowych w puli usługi Batch zewnętrznie.

Nazwa Typ Opis
backendPort

integer

Numer portu w węźle obliczeniowym.
Musi to być unikatowe w puli usługi Batch. Dopuszczalne wartości to od 1 do 65535 z wyjątkiem 29876 i 29877, ponieważ są one zarezerwowane. Jeśli podano jakiekolwiek wartości zarezerwowane, żądanie zakończy się niepowodzeniem z kodem stanu HTTP 400.

frontendPortRangeEnd

integer

Ostatni numer portu w zakresie portów zewnętrznych, które będą używane do zapewnienia dostępu przychodzącego do zapleczaPort w poszczególnych węzłach obliczeniowych.
Dopuszczalny zakres wartości z zakresu od 1 do 65534 z wyjątkiem portów od 50000 do 55000, które są zarezerwowane przez usługę Batch. Wszystkie zakresy w puli muszą być odrębne i nie mogą się nakładać. Każdy zakres musi zawierać co najmniej 40 portów. Jeśli jakiekolwiek wartości zarezerwowane lub nakładające się zostaną dostarczone, żądanie zakończy się niepowodzeniem z kodem stanu HTTP 400.

frontendPortRangeStart

integer

Pierwszy numer portu w zakresie portów zewnętrznych, które będą używane do zapewnienia dostępu przychodzącego do zapleczaPort w poszczególnych węzłach obliczeniowych.
Dopuszczalny zakres wartości z zakresu od 1 do 65534 z wyjątkiem portów od 50000 do 55000, które są zarezerwowane. Wszystkie zakresy w puli muszą być odrębne i nie mogą się nakładać. Każdy zakres musi zawierać co najmniej 40 portów. Jeśli jakiekolwiek wartości zarezerwowane lub nakładające się zostaną dostarczone, żądanie zakończy się niepowodzeniem z kodem stanu HTTP 400.

name

string

Nazwa punktu końcowego.
Nazwa musi być unikatowa w puli usługi Batch, może zawierać litery, cyfry, podkreślenia, kropki i łączniki. Nazwy muszą zaczynać się literą lub cyfrą, muszą kończyć się literą, cyfrą lub podkreśleniami i nie mogą przekraczać 77 znaków. Jeśli podano nieprawidłowe wartości, żądanie zakończy się niepowodzeniem z kodem stanu HTTP 400.

networkSecurityGroupRules

NetworkSecurityGroupRule[]

Lista reguł sieciowej grupy zabezpieczeń, które zostaną zastosowane do punktu końcowego.
Maksymalna liczba reguł, które można określić we wszystkich punktach końcowych w puli usługi Batch, wynosi 25. Jeśli nie określono żadnych reguł sieciowej grupy zabezpieczeń, zostanie utworzona domyślna reguła zezwalania na dostęp przychodzący do określonego zapleczaPort. Jeśli maksymalna liczba reguł sieciowej grupy zabezpieczeń zostanie przekroczona, żądanie zakończy się niepowodzeniem z kodem stanu HTTP 400.

protocol

InboundEndpointProtocol

Protokół punktu końcowego.

IPAddressProvisioningType

Typ aprowizacji dla publicznych adresów IP dla puli.

Nazwa Typ Opis
batchmanaged

string

Publiczny adres IP zostanie utworzony i zarządzany przez usługę Batch. W zależności od rozmiaru puli może istnieć wiele publicznych adresów IP.

nopublicipaddresses

string

Nie zostanie utworzony publiczny adres IP.

usermanaged

string

Publiczne adresy IP są udostępniane przez użytkownika i będą używane do aprowizowania węzłów obliczeniowych.

LinuxUserConfiguration

Właściwości używane do tworzenia konta użytkownika w węźle obliczeniowym systemu Linux.

Nazwa Typ Opis
gid

integer

Identyfikator grupy dla konta użytkownika.
Właściwości uid i gid muszą być określone razem lub w ogóle. Jeśli nie określono bazowego systemu operacyjnego, wybiera gid.

sshPrivateKey

string

Klucz prywatny SSH dla konta użytkownika.
Klucz prywatny nie może być chroniony hasłem. Klucz prywatny służy do automatycznego konfigurowania uwierzytelniania opartego na kluczu asymetrycznym dla protokołu SSH między węzłami obliczeniowymi w puli systemu Linux, gdy właściwość enableInterNodeCommunication puli ma wartość true (jest ignorowana, jeśli właściwość enableInterNodeCommunication ma wartość false). Robi to przez umieszczenie pary kluczy w katalogu .ssh użytkownika. Jeśli nie zostanie określony, protokół SSH bez hasła nie jest skonfigurowany między węzłami obliczeniowymi (nie jest wykonywana żadna modyfikacja katalogu .ssh użytkownika).

uid

integer

Identyfikator użytkownika konta użytkownika.
Właściwości uid i gid muszą być określone razem lub w ogóle. Jeśli nie określono bazowego systemu operacyjnego, wybierze identyfikator uid.

LoginMode

Tryb logowania użytkownika

Nazwa Typ Opis
batch

string

Tryb logowania LOGON32_LOGON_BATCH Win32. Tryb logowania wsadowego jest zalecany w przypadku długotrwałych procesów równoległych.

interactive

string

Tryb logowania LOGON32_LOGON_INTERACTIVE Win32. Kontrola konta użytkownika jest włączona w pulach systemu Windows. Jeśli ta opcja jest używana z podwyższonym poziomem uprawnień tożsamości użytkownika w puli systemu Windows, sesja użytkownika nie zostanie podwyższona, chyba że aplikacja wykonywana przez wiersz polecenia zadania jest skonfigurowana tak, aby zawsze wymagać uprawnień administracyjnych lub zawsze wymagać maksymalnego uprawnienia.

ManagedDisk

Nazwa Typ Opis
securityProfile

VMDiskSecurityProfile

Określa ustawienia profilu zabezpieczeń dla dysku zarządzanego.
Określa ustawienia profilu zabezpieczeń dla dysku zarządzanego. Uwaga: można go ustawić tylko dla poufnych maszyn wirtualnych i wymagane w przypadku korzystania z poufnych maszyn wirtualnych.

storageAccountType

StorageAccountType

Typ konta magazynu dla dysku zarządzanego.

MetadataItem

Para nazwa-wartość skojarzona z zasobem usługi Batch.

Nazwa Typ Opis
name

string

Nazwa elementu metadanych.

value

string

Wartość elementu metadanych.

MountConfiguration

System plików do zainstalowania w każdym węźle.

Nazwa Typ Opis
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

Kontener usługi Azure Storage do zainstalowania przy użyciu funkcji FUSE obiektu blob w każdym węźle.
Ta właściwość wzajemnie wyklucza się ze wszystkimi innymi właściwościami.

azureFileShareConfiguration

AzureFileShareConfiguration

Udział plików platformy Azure do zainstalowania w każdym węźle.
Ta właściwość wzajemnie wyklucza się ze wszystkimi innymi właściwościami.

cifsMountConfiguration

CIFSMountConfiguration

System plików CIFS/SMB do zainstalowania w każdym węźle.
Ta właściwość wzajemnie wyklucza się ze wszystkimi innymi właściwościami.

nfsMountConfiguration

NFSMountConfiguration

System plików NFS do zainstalowania w każdym węźle.
Ta właściwość wzajemnie wyklucza się ze wszystkimi innymi właściwościami.

NameValuePair

Reprezentuje parę nazwa-wartość.

Nazwa Typ Opis
name

string

Nazwa w parze name-value.

value

string

Wartość w parze name-value.

NetworkConfiguration

Konfiguracja sieci dla puli.

Nazwa Typ Opis
dynamicVNetAssignmentScope

DynamicVNetAssignmentScope

Zakres dynamicznego przypisania sieci wirtualnej.

enableAcceleratedNetworking

boolean

Czy ta pula powinna włączyć przyspieszoną sieć.
Przyspieszona sieć umożliwia wirtualizację we/wy pojedynczego katalogu głównego (SR-IOV) do maszyny wirtualnej, co może prowadzić do zwiększenia wydajności sieci. Aby uzyskać więcej informacji, zobacz: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.

endpointConfiguration

PoolEndpointConfiguration

Konfiguracja punktów końcowych w węzłach obliczeniowych w puli usługi Batch.

publicIPAddressConfiguration

PublicIPAddressConfiguration

Konfiguracja publicznego adresu IPAddress dla węzłów obliczeniowych w puli usługi Batch.
Konfiguracja publicznego adresu IP konfiguracji sieci puli.

subnetId

string

Identyfikator zasobu usługi ARM podsieci sieci wirtualnej, do której będą przyłączone węzły obliczeniowe puli. Jest to formularz /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
Sieć wirtualna musi znajdować się w tym samym regionie i subskrypcji co konto usługi Azure Batch. Określona podsieć powinna mieć wystarczającą liczbę wolnych adresów IP, aby pomieścić liczbę węzłów obliczeniowych w puli. Jeśli podsieć nie ma wystarczającej liczby wolnych adresów IP, pula częściowo przydzieli węzły i wystąpi błąd zmiany rozmiaru. Jednostka usługi "MicrosoftAzureBatch" musi mieć rolę "Klasyczny współautor maszyny wirtualnej" Role-Based kontroli dostępu (RBAC) dla określonej sieci wirtualnej. Określona podsieć musi zezwalać na komunikację z usługi Azure Batch, aby móc zaplanować zadania w węzłach. Można to sprawdzić, sprawdzając, czy określona sieć wirtualna ma skojarzone sieciowe grupy zabezpieczeń. Jeśli komunikacja z węzłami w określonej podsieci zostanie odrzucona przez sieciową grupę zabezpieczeń, usługa Batch ustawi stan węzłów obliczeniowych na bezużyteczny. Obsługiwane są tylko sieci wirtualne ARM (Microsoft.Network/virtualNetworks). Jeśli określona sieć wirtualna ma skojarzone sieciowe grupy zabezpieczeń, należy włączyć kilka zarezerwowanych portów systemowych dla komunikacji przychodzącej, w tym portów 29876 i 29877. Włącz również połączenia wychodzące z usługą Azure Storage na porcie 443. Aby uzyskać więcej informacji, zobacz: https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Reguła sieciowej grupy zabezpieczeń, która ma być stosowana do przychodzącego punktu końcowego.

Nazwa Typ Opis
access

NetworkSecurityGroupRuleAccess

Akcja, która powinna zostać podjęta dla określonego adresu IP, zakresu podsieci lub tagu.

priority

integer

Priorytet tej reguły.
Priorytety w puli muszą być unikatowe i oceniane według priorytetu. Im niższa liczba, tym wyższy priorytet. Na przykład można określić reguły z liczbami zamówień 150, 250 i 350. Reguła z numerem porządkowym 150 ma pierwszeństwo przed regułą, która ma kolejność 250. Dozwolone priorytety to od 150 do 4096. Jeśli jakiekolwiek wartości zarezerwowane lub zduplikowane zostaną dostarczone, żądanie zakończy się niepowodzeniem z kodem stanu HTTP 400.

sourceAddressPrefix

string

Prefiks adresu źródłowego lub tag, który ma być zgodny z regułą.
Prawidłowe wartości to pojedynczy adres IP (tj. 10.10.10.10.10), podsieć IP (tj. 192.168.1.0/24), tag domyślny lub * (dla wszystkich adresów). Jeśli podano inne wartości, żądanie zakończy się niepowodzeniem z kodem stanu HTTP 400.

sourcePortRanges

string[]

Zakresy portów źródłowych zgodne z regułą.
Prawidłowe wartości to "" (dla wszystkich portów 0–65535), określony port (tj. 22) lub zakres portów (tj. 100–200). Porty muszą należeć do zakresu od 0 do 65535. Każdy wpis w tej kolekcji nie może nakładać się na żaden inny wpis (zakres lub pojedynczy port). Jeśli podano inne wartości, żądanie zakończy się niepowodzeniem z kodem stanu HTTP 400. Wartość domyślna to "".

NetworkSecurityGroupRuleAccess

Akcja, która powinna zostać podjęta dla określonego adresu IP, zakresu podsieci lub tagu.

Nazwa Typ Opis
allow

string

Zezwalaj na dostęp.

deny

string

Odmowa dostępu.

NFSMountConfiguration

Informacje używane do nawiązywania połączenia z systemem plików NFS.

Nazwa Typ Opis
mountOptions

string

Dodatkowe opcje wiersza polecenia umożliwiające przekazanie polecenia instalacji.
Są to opcje "net use" w systemach Windows i "instalowanie" w systemie Linux.

relativeMountPath

string

Ścieżka względna w węźle obliczeniowym, w którym zostanie zainstalowany system plików
Wszystkie systemy plików są instalowane względem katalogu instalacji usługi Batch, dostępnego za pośrednictwem zmiennej środowiskowej AZ_BATCH_NODE_MOUNTS_DIR.

source

string

Identyfikator URI systemu plików do zainstalowania.

NodeCommunicationMode

Określa, jak pula komunikuje się z usługą Batch.

Nazwa Typ Opis
classic

string

Węzły korzystające z trybu komunikacji klasycznej wymagają przychodzącej komunikacji TCP na portach 29876 i 29877 z "BatchNodeManagement". {region}" tag usługi i wychodząca komunikacja TCP na porcie 443 do "Storage.region" i "BatchNodeManagement". Tagi usługi {region}.

default

string

Tryb komunikacji węzła jest automatycznie ustawiany przez usługę Batch.

simplified

string

Węzły korzystające z uproszczonego trybu komunikacji wymagają komunikacji wychodzącej TCP na porcie 443 do "BatchNodeManagement. Tag usługi {region}. Nie są wymagane otwarte porty wejściowe.

NodePlacementConfiguration

Konfiguracja umieszczania węzłów dla puli.

Nazwa Typ Opis
policy

NodePlacementPolicyType

Typ zasad umieszczania węzła w pulach usługi Batch.
Zasady alokacji używane przez usługę Batch do aprowizowania węzłów. Jeśli nie zostanie określony, usługa Batch użyje zasad regionalnych.

NodePlacementPolicyType

Zasady umieszczania dla przydzielania węzłów w puli.

Nazwa Typ Opis
regional

string

Wszystkie węzły w puli zostaną przydzielone w tym samym regionie.

zonal

string

Węzły w puli będą rozmieszczone w różnych strefach dostępności z najlepszym rozwiązaniem.

OSDisk

Ustawienia dysku systemu operacyjnego węzła obliczeniowego (VM).

Nazwa Typ Opis
caching

CachingType

Określa wymagania dotyczące buforowania. Możliwe wartości to: None, ReadOnly, ReadWrite. Wartości domyślne to: Brak w przypadku magazynu w warstwie Standardowa. Funkcja ReadOnly dla usługi Premium Storage.
Wartość domyślna buforowania to brak. Aby uzyskać informacje o opcjach buforowania, zobacz: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

Początkowy rozmiar dysku w GB podczas tworzenia nowego dysku systemu operacyjnego.

ephemeralOSDiskSettings

DiffDiskSettings

Określa efemeryczne ustawienia dysku dla dysku systemu operacyjnego używanego przez węzeł obliczeniowy (VM).

managedDisk

ManagedDisk

Parametry dysku zarządzanego.

writeAcceleratorEnabled

boolean

Określa, czy na dysku należy włączyć lub wyłączyć funkcję writeAccelerator.

PoolEndpointConfiguration

Konfiguracja punktu końcowego dla puli.

Nazwa Typ Opis
inboundNATPools

InboundNATPool[]

Lista pul nat dla ruchu przychodzącego, które mogą służyć do adresowania określonych portów na pojedynczym węźle obliczeniowym zewnętrznie.
Maksymalna liczba przychodzących pul nat na pulę usługi Batch wynosi 5. Jeśli maksymalna liczba przychodzących pul nat zostanie przekroczona, żądanie zakończy się niepowodzeniem z kodem stanu HTTP 400. Nie można tego określić, jeśli parametr IPAddressProvisioningType ma wartość NoPublicIPAddresses.

PoolIdentityType

Tożsamość puli usługi Batch, jeśli została skonfigurowana.

Nazwa Typ Opis
None

string

Pula usługi Batch nie ma skojarzonej tożsamości. Ustawienie None w puli aktualizacji spowoduje usunięcie istniejących tożsamości.

UserAssigned

string

Pula usługi Batch ma przypisane przez użytkownika tożsamości.

PoolState

Bieżący stan puli.

Nazwa Typ Opis
active

string

Pula jest dostępna do uruchamiania zadań podlegających dostępności węzłów obliczeniowych.

deleting

string

Użytkownik zażądał usunięcia puli, ale operacja usuwania nie została jeszcze ukończona.

PoolStatistics

Zawiera statystyki wykorzystania i użycia zasobów dla okresu istnienia puli.

Nazwa Typ Opis
lastUpdateTime

string

Czas ostatniej aktualizacji statystyk. Wszystkie statystyki są ograniczone do zakresu między startTime i lastUpdateTime.

resourceStats

ResourceStatistics

Statystyki związane z użyciem zasobów przez węzły obliczeniowe w puli.

startTime

string

Godzina rozpoczęcia zakresu czasu objętego statystykami.

url

string

Adres URL statystyk.

usageStats

UsageStatistics

Statystyki związane z użyciem puli, takie jak ilość używanego czasu podstawowego.

PublicIPAddressConfiguration

Konfiguracja publicznego adresu IP konfiguracji sieci puli.

Nazwa Typ Opis
ipAddressIds

string[]

Lista publicznych adresów IP, których usługa Batch będzie używać podczas aprowizacji węzłów obliczeniowych.
Liczba adresów IP określonych tutaj ogranicza maksymalny rozmiar puli — 100 dedykowanych węzłów lub 100 węzłów typu spot/low-priority można przydzielić dla każdego publicznego adresu IP. Na przykład pula wymagając 250 dedykowanych maszyn wirtualnych wymaga co najmniej 3 publicznych adresów IP. Każdy element tej kolekcji ma postać: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision

IPAddressProvisioningType

Typ aprowizacji dla publicznych adresów IP dla puli.
Wartość domyślna to BatchManaged.

ResizeError

Wystąpił błąd podczas zmiany rozmiaru puli.

Nazwa Typ Opis
code

string

Identyfikator błędu zmiany rozmiaru puli. Kody są niezmienne i mają być używane programowo.

message

string

Komunikat opisujący błąd zmiany rozmiaru puli, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

values

NameValuePair[]

Lista dodatkowych szczegółów błędu związanych z błędem zmiany rozmiaru puli.

ResourceFile

Jeden plik lub wiele plików do pobrania do węzła obliczeniowego.

Nazwa Typ Opis
autoStorageContainerName

string

Nazwa kontenera magazynu na koncie automatycznego magazynu.
Właściwości autoStorageContainerName, storageContainerUrl i httpUrl wzajemnie się wykluczają i należy określić jedną z nich.

blobPrefix

string

Prefiks obiektu blob używany podczas pobierania obiektów blob z kontenera usługi Azure Storage. Zostaną pobrane tylko obiekty blob, których nazwy zaczynają się od określonego prefiksu.
Właściwość jest prawidłowa tylko wtedy, gdy jest używana właściwość autoStorageContainerName lub storageContainerUrl. Ten prefiks może być częściową nazwą pliku lub podkatalogem. Jeśli prefiks nie zostanie określony, zostaną pobrane wszystkie pliki w kontenerze.

fileMode

string

Atrybut trybu uprawnień pliku w formacie ósemkowym.
Ta właściwość ma zastosowanie tylko do plików pobieranych do węzłów obliczeniowych systemu Linux. Zostanie on zignorowany, jeśli zostanie określony dla elementu resourceFile, który zostanie pobrany do węzła obliczeniowego systemu Windows. Jeśli ta właściwość nie zostanie określona dla węzła obliczeniowego systemu Linux, do pliku zostanie zastosowana wartość domyślna 0770.

filePath

string

Lokalizacja w węźle obliczeniowym, do którego mają być pobierane pliki względem katalogu roboczego zadania.
Jeśli określono właściwość httpUrl, parametr filePath jest wymagany i opisuje ścieżkę, do której zostanie pobrany plik, w tym nazwę pliku. W przeciwnym razie, jeśli określono właściwość autoStorageContainerName lub storageContainerUrl, parametr filePath jest opcjonalny i jest katalogem do pobrania plików. W przypadku, gdy filePath jest używany jako katalog, każda struktura katalogów już skojarzona z danymi wejściowymi zostanie zachowana w całości i dołączona do określonego katalogu filePath. Określona ścieżka względna nie może przerwać katalogu roboczego zadania (na przykład przy użyciu ".".

httpUrl

string

Adres URL pliku do pobrania.
Właściwości autoStorageContainerName, storageContainerUrl i httpUrl wzajemnie się wykluczają i należy określić jedną z nich. Jeśli adres URL wskazuje usługę Azure Blob Storage, musi być czytelny z węzłów obliczeniowych. Istnieją trzy sposoby uzyskiwania takiego adresu URL dla obiektu blob w usłudze Azure Storage: obejmują sygnaturę dostępu współdzielonego udzielając uprawnień do odczytu dla obiektu blob, używanie tożsamości zarządzanej z uprawnieniami do odczytu lub ustawianie listy ACL dla obiektu blob lub kontenera, aby zezwolić na dostęp publiczny.

identityReference

ComputeNodeIdentityReference

Odwołanie do tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do usługi Azure Blob Storage określonej przez wartość storageContainerUrl lub httpUrl
Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.

storageContainerUrl

string

Adres URL kontenera obiektów blob w usłudze Azure Blob Storage.
Właściwości autoStorageContainerName, storageContainerUrl i httpUrl wzajemnie się wykluczają i należy określić jedną z nich. Ten adres URL musi być czytelny i możliwy do wyświetlenia z węzłów obliczeniowych. Istnieją trzy sposoby uzyskania takiego adresu URL dla kontenera w usłudze Azure Storage: obejmują sygnaturę dostępu współdzielonego (SAS) udzielając uprawnień do odczytu i listy w kontenerze, używanie tożsamości zarządzanej z uprawnieniami do odczytu i listy lub ustawianie listy ACL dla kontenera, aby zezwolić na dostęp publiczny.

ResourceStatistics

Statystyki związane z zużyciem zasobów przez węzły obliczeniowe w puli.

Nazwa Typ Opis
avgCPUPercentage

number

Średnie użycie procesora CPU we wszystkich węzłach obliczeniowych w puli (procent na węzeł).

avgDiskGiB

number

Średnia ilość używanego miejsca na dysku w giB we wszystkich węzłach obliczeniowych w puli.

avgMemoryGiB

number

Średnie użycie pamięci w giB we wszystkich węzłach obliczeniowych w puli.

diskReadGiB

number

Łączna ilość danych na dysku GiB odczytuje się we wszystkich węzłach obliczeniowych w puli.

diskReadIOps

integer

Całkowita liczba operacji odczytu dysku we wszystkich węzłach obliczeniowych w puli.

diskWriteGiB

number

Łączna ilość danych w giB zapisu na dysku we wszystkich węzłach obliczeniowych w puli.

diskWriteIOps

integer

Całkowita liczba operacji zapisu dysku we wszystkich węzłach obliczeniowych w puli.

lastUpdateTime

string

Czas ostatniej aktualizacji statystyk. Wszystkie statystyki są ograniczone do zakresu między startTime i lastUpdateTime.

networkReadGiB

number

Łączna ilość danych w giB odczytów sieci we wszystkich węzłach obliczeniowych w puli.

networkWriteGiB

number

Łączna ilość danych w giB zapisów sieciowych we wszystkich węzłach obliczeniowych w puli.

peakDiskGiB

number

Szczytowe używane miejsce na dysku w giB we wszystkich węzłach obliczeniowych w puli.

peakMemoryGiB

number

Szczytowe użycie pamięci w giB we wszystkich węzłach obliczeniowych w puli.

startTime

string

Godzina rozpoczęcia zakresu czasu objętego statystykami.

RollingUpgradePolicy

Parametry konfiguracji używane podczas uaktualniania stopniowego.

Nazwa Typ Opis
enableCrossZoneUpgrade

boolean

Zezwalaj usłudze VMSS na ignorowanie granic az podczas konstruowania partii uaktualniania. Weź pod uwagę domenę aktualizacji i parametr maxBatchInstancePercent w celu określenia rozmiaru partii. To pole może być ustawione na wartość true lub false tylko w przypadku używania wartości NodePlacementConfiguration jako strefowej.

maxBatchInstancePercent

integer

Maksymalny procent łącznych wystąpień maszyn wirtualnych, które zostaną uaktualnione jednocześnie przez uaktualnienie stopniowe w jednej partii. Ponieważ jest to maksimum, wystąpienia w złej kondycji w poprzednich lub przyszłych partiach mogą spowodować spadek procentu wystąpień w partii w celu zapewnienia większej niezawodności. Wartość tego pola powinna należeć do zakresu od 5 do 100 włącznie. Jeśli parametr maxBatchInstancePercent i maxUnhealthyInstancePercent są przypisywane z wartością, wartość maxBatchInstancePercent nie powinna być większa niż wartość maxUnhealthyInstancePercent.

maxUnhealthyInstancePercent

integer

Maksymalny procent łącznej liczby wystąpień maszyn wirtualnych w zestawie skalowania, które mogą być jednocześnie w złej kondycji, w wyniku uaktualnienia lub przez odnalezienie w stanie złej kondycji przez kontrolę kondycji maszyny wirtualnej przed przerwaniem uaktualnienia stopniowego. To ograniczenie zostanie sprawdzone przed uruchomieniem dowolnej partii. Wartość tego pola powinna należeć do zakresu od 5 do 100 włącznie. Jeśli parametr maxBatchInstancePercent i maxUnhealthyInstancePercent są przypisywane z wartością, wartość maxBatchInstancePercent nie powinna być większa niż wartość maxUnhealthyInstancePercent.

maxUnhealthyUpgradedInstancePercent

integer

Maksymalny procent uaktualnionych wystąpień maszyn wirtualnych, które można znaleźć w złej kondycji. Ta kontrola będzie miała miejsce po uaktualnieniu każdej partii. Jeśli ta wartość procentowa zostanie kiedykolwiek przekroczona, przerywa się aktualizacja stopniowa. Wartość tego pola powinna należeć do zakresu od 0 do 100 włącznie.

pauseTimeBetweenBatches

string

Czas oczekiwania między ukończeniem aktualizacji dla wszystkich maszyn wirtualnych w jednej partii a uruchomieniem następnej partii. Czas trwania należy określić w formacie ISO 8601.

prioritizeUnhealthyInstances

boolean

Uaktualnij wszystkie wystąpienia w złej kondycji w zestawie skalowania przed wszelkimi wystąpieniami w dobrej kondycji.

rollbackFailedInstancesOnPolicyBreach

boolean

Wycofywanie nie powiodło się wystąpienia do poprzedniego modelu, jeśli zasady uaktualniania stopniowego zostały naruszone.

SecurityEncryptionTypes

Określa typ szyfrowania dysku zarządzanego. Jest ona ustawiona na VMGuestStateOnly na potrzeby szyfrowania tylko obiektu blob VMGuestState i nonPersistedTPM dla nietrwałego stanu oprogramowania układowego w obiekcie blob VMGuestState. Uwaga: można go ustawić tylko dla poufnych maszyn wirtualnych i jest wymagany podczas korzystania z poufnych maszyn wirtualnych.

Nazwa Typ Opis
NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

Określa ustawienia profilu zabezpieczeń dla maszyny wirtualnej lub zestawu skalowania maszyn wirtualnych.

Nazwa Typ Opis
encryptionAtHost

boolean

Ta właściwość może być używana przez użytkownika w żądaniu włączenia lub wyłączenia szyfrowania hosta dla maszyny wirtualnej lub zestawu skalowania maszyn wirtualnych. Spowoduje to włączenie szyfrowania dla wszystkich dysków, w tym dysku zasobu/tymczasowego na samym hoście. Aby uzyskać więcej informacji na temat szyfrowania w wymaganiach dotyczących hosta, zobacz https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.

securityType

SecurityTypes

Określa typ zabezpieczeń maszyny wirtualnej. Musi być ustawiona na dowolną określoną wartość, aby włączyć interfejs UefiSettings.

uefiSettings

UefiSettings

Określa ustawienia zabezpieczeń, takie jak bezpieczny rozruch i maszyna wirtualna vTPM używane podczas tworzenia maszyny wirtualnej.
Określa ustawienia zabezpieczeń, takie jak bezpieczny rozruch i maszyna wirtualna vTPM używane podczas tworzenia maszyny wirtualnej.

SecurityTypes

Określa typ zabezpieczeń maszyny wirtualnej. Musi być ustawiona na dowolną określoną wartość, aby włączyć interfejs UefiSettings.

Nazwa Typ Opis
confidentialVM

string

Poufne przetwarzanie na platformie Azure oferuje poufne maszyny wirtualne przeznaczone dla dzierżaw z wysokimi wymaganiami dotyczącymi zabezpieczeń i poufności. Te maszyny wirtualne zapewniają silną, wymuszaną sprzętowo granicę, która pomaga spełnić twoje potrzeby w zakresie zabezpieczeń. Możesz użyć poufnych maszyn wirtualnych do migracji bez wprowadzania zmian w kodzie, a platforma chroni stan maszyny wirtualnej przed odczytem lub zmodyfikowaniem.

trustedLaunch

string

Zaufane uruchamianie chroni przed zaawansowanymi i trwałymi technikami ataków.

ServiceArtifactReference

Określa identyfikator odwołania artefaktu usługi używany do ustawiania tej samej wersji obrazu dla wszystkich maszyn wirtualnych w zestawie skalowania w przypadku używania "najnowszej" wersji obrazu.

Nazwa Typ Opis
id

string

Identyfikator odwołania do artefaktu usługi serviceArtifactReference
Identyfikator odwołania artefaktu usługi w postaci /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

Zadanie uruchamiane po dołączeniu węzła do puli w usłudze Azure Batch lub ponownym uruchomieniu lub ponownym uruchomieniu węzła obliczeniowego lub ponownym obrazie.

Nazwa Typ Opis
commandLine

string

Wiersz polecenia starttask.
Wiersz polecenia nie jest uruchamiany w powłoce i dlatego nie może korzystać z funkcji powłoki, takich jak rozszerzenie zmiennej środowiskowej. Jeśli chcesz skorzystać z takich funkcji, należy wywołać powłokę w wierszu polecenia, na przykład za pomocą polecenia "cmd /c MyCommand" w systemie Windows lub "/bin/sh -c MyCommand" w systemie Linux. Jeśli wiersz polecenia odwołuje się do ścieżek plików, powinien użyć ścieżki względnej (względem katalogu roboczego zadania) lub użyć zmiennej środowiskowej udostępnionej w usłudze Batch (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

TaskContainerSettings

Ustawienia kontenera, w którym jest uruchamiana funkcja StartTask.
Po określeniu tej wartości wszystkie katalogi rekursywnie poniżej AZ_BATCH_NODE_ROOT_DIR (katalogi główne katalogów usługi Azure Batch w węźle) są mapowane do kontenera, wszystkie zmienne środowiskowe zadania są mapowane do kontenera, a wiersz polecenia zadania jest wykonywany w kontenerze. Pliki utworzone w kontenerze poza AZ_BATCH_NODE_ROOT_DIR mogą nie zostać odzwierciedlone na dysku hosta, co oznacza, że interfejsy API plików usługi Batch nie będą mogły uzyskać dostępu do tych plików.

environmentSettings

EnvironmentSetting[]

Lista ustawień zmiennych środowiskowych dla elementu StartTask.

maxTaskRetryCount

integer

Maksymalna liczba ponownych prób wykonania zadania.
Usługa Batch ponawia próbę zadania, jeśli jego kod zakończenia jest inny niżzer. Należy pamiętać, że ta wartość steruje liczbą ponownych prób. Usługa Batch spróbuje raz wykonać zadanie, a następnie może ponowić próbę do tego limitu. Jeśli na przykład maksymalna liczba ponownych prób wynosi 3, usługa Batch próbuje wykonać zadanie do 4 razy (jedna początkowa próba i 3 ponownych prób). Jeśli maksymalna liczba ponownych prób wynosi 0, usługa Batch nie ponowi próby wykonania zadania. Jeśli maksymalna liczba ponownych prób wynosi -1, usługa Batch ponawia próbę zadania bez limitu, jednak nie jest to zalecane w przypadku zadania podrzędnego uruchamiania ani żadnego zadania podrzędnego. Wartość domyślna to 0 (bez ponownych prób).

resourceFiles

ResourceFile[]

Lista plików, które usługa Batch pobierze do węzła obliczeniowego przed uruchomieniem wiersza polecenia. Istnieje maksymalny rozmiar listy plików zasobów. Po przekroczeniu maksymalnego rozmiaru żądanie zakończy się niepowodzeniem, a kod błędu odpowiedzi to RequestEntityTooLarge. W takim przypadku należy zmniejszyć rozmiar kolekcji plików ResourceFiles. Można to osiągnąć przy użyciu plików .zip, pakietów aplikacji lub kontenerów platformy Docker.
Pliki wymienione w ramach tego elementu znajdują się w katalogu roboczym zadania.

userIdentity

UserIdentity

Tożsamość użytkownika, w ramach której jest uruchamiana funkcja StartTask.
W przypadku pominięcia zadanie jest uruchamiane jako użytkownik niebędący administratorem unikatowym dla zadania.

waitForSuccess

boolean

Czy usługa Batch powinna czekać na pomyślne zakończenie zadania StartTask (czyli zakończenie z kodem zakończenia 0) przed zaplanowaniem zadań w węźle obliczeniowym.
Jeśli wartość true i parametr StartTask zakończy się niepowodzeniem w węźle, usługa Batch ponawia próbę do maksymalnej liczby ponownych prób (maxTaskRetryCount). Jeśli zadanie nadal nie zostało ukończone pomyślnie po ponownych próbach, usługa Batch oznacza węzeł bezużyteczny i nie będzie planować zadań do niego. Ten warunek można wykryć za pomocą szczegółów stanu węzła obliczeniowego i informacji o błędzie. Jeśli wartość false, usługa Batch nie będzie czekać na ukończenie zadania StartTask. W takim przypadku inne zadania mogą rozpocząć wykonywanie w węźle obliczeniowym, gdy funkcja StartTask jest nadal uruchomiona; a nawet jeśli zadanie StartTask zakończy się niepowodzeniem, nowe zadania będą nadal zaplanowane w węźle obliczeniowym. Wartość domyślna to true.

StorageAccountType

Typ konta magazynu do użycia podczas tworzenia dysków danych lub dysku systemu operacyjnego.

Nazwa Typ Opis
premium_lrs

string

Dysk danych/dysk systemu operacyjnego powinien używać magazynu lokalnie nadmiarowego w warstwie Premium.

standard_lrs

string

Dysk danych/dysk systemu operacyjnego powinien używać standardowego magazynu lokalnie nadmiarowego.

standardssd_lrs

string

Dysk danych/dysk systemu operacyjnego powinien używać magazynu lokalnie nadmiarowego SSD w warstwie Standardowa.

TaskContainerSettings

Ustawienia kontenera dla zadania.

Nazwa Typ Opis
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Ścieżki, które chcesz zamontować w zadaniu kontenera.
Jeśli ta tablica ma wartość null lub nie istnieje, zadanie kontenera zainstaluje cały dysk tymczasowy w systemie Windows (lub AZ_BATCH_NODE_ROOT_DIR w systemie Linux). Jeśli ta tablica jest ustawiona jako pusta, nie zainstaluje żadnych ścieżek danych w kontenerze.

containerRunOptions

string

Dodatkowe opcje polecenia create kontenera.
Te dodatkowe opcje są dostarczane jako argumenty polecenia "docker create" oprócz tych kontrolowanych przez usługę Batch.

imageName

string

Obraz używany do utworzenia kontenera, w którym zostanie uruchomione zadanie.
Jest to pełne odwołanie do obrazu, jak można określić na "ściąganie platformy Docker". Jeśli w nazwie obrazu nie podano żadnego tagu, tag ":latest" jest używany jako domyślny.

registry

ContainerRegistry

Prywatny rejestr zawierający obraz kontenera.
To ustawienie można pominąć, jeśli zostało już udostępnione podczas tworzenia puli.

workingDirectory

ContainerWorkingDirectory

Lokalizacja katalogu roboczego zadania kontenera.
Wartość domyślna to "taskWorkingDirectory".

TaskSchedulingPolicy

Określa sposób dystrybucji zadań w węzłach obliczeniowych.

Nazwa Typ Opis
nodeFillType

ComputeNodeFillType

Sposób dystrybucji zadań między węzłami obliczeniowymi w puli.
Jeśli nie zostanie określony, wartość domyślna zostanie rozłożona.

UefiSettings

Określa ustawienia zabezpieczeń, takie jak bezpieczny rozruch i maszyna wirtualna vTPM używane podczas tworzenia maszyny wirtualnej.

Nazwa Typ Opis
secureBootEnabled

boolean

Określa, czy bezpieczny rozruch powinien być włączony na maszynie wirtualnej.

vTpmEnabled

boolean

Określa, czy maszyna wirtualna ma być włączona na maszynie wirtualnej.

UpgradeMode

Określa tryb uaktualniania maszyn wirtualnych w zestawie skalowania.

Możliwe wartości to:

ręczne — kontrolujesz stosowanie aktualizacji do maszyn wirtualnych w zestawie skalowania. W tym celu należy użyć akcji manualUpgrade.

automatyczne — wszystkie maszyny wirtualne w zestawie skalowania są automatycznie aktualizowane w tym samym czasie.

rolling — zestaw skalowania wykonuje aktualizacje w partiach z opcjonalnym czasem wstrzymania między.

Nazwa Typ Opis
automatic

string

Wszystkie maszyny wirtualne w zestawie skalowania są automatycznie aktualizowane w tym samym czasie.

manual

string

Kontrolujesz stosowanie aktualizacji do maszyn wirtualnych w zestawie skalowania. W tym celu należy użyć akcji manualUpgrade.

rolling

string

Istniejące wystąpienia w zestawie skalowania są wyłączane w partiach, które mają zostać uaktualnione. Po zakończeniu uaktualniania partii wystąpienia zaczną ponownie kierować ruch, a następna partia rozpocznie się. Będzie to kontynuowane do momentu, aż wszystkie wystąpienia up-to-date.

UpgradePolicy

Opisuje zasady uaktualniania — automatyczne, ręczne lub stopniowe.

Nazwa Typ Opis
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

Parametry konfiguracji używane do przeprowadzania automatycznego uaktualniania systemu operacyjnego.
Parametry konfiguracji używane do przeprowadzania automatycznego uaktualniania systemu operacyjnego.

mode

UpgradeMode

Określa tryb uaktualniania maszyn wirtualnych w zestawie skalowania.

Możliwe wartości to:

ręczne — kontrolujesz stosowanie aktualizacji do maszyn wirtualnych w zestawie skalowania. W tym celu należy użyć akcji manualUpgrade.

automatyczne — wszystkie maszyny wirtualne w zestawie skalowania są automatycznie aktualizowane w tym samym czasie.

rolling — zestaw skalowania wykonuje aktualizacje w partiach z opcjonalnym czasem wstrzymania między.

rollingUpgradePolicy

RollingUpgradePolicy

Parametry konfiguracji używane podczas uaktualniania stopniowego.
Parametry konfiguracji używane podczas uaktualniania stopniowego.

UsageStatistics

Statystyki związane z informacjami o użyciu puli.

Nazwa Typ Opis
dedicatedCoreTime

string

Zagregowany czas zegara ściennego dedykowanych rdzeni węzłów obliczeniowych będących częścią puli.

lastUpdateTime

string

Czas ostatniej aktualizacji statystyk. Wszystkie statystyki są ograniczone do zakresu między startTime i lastUpdateTime.

startTime

string

Godzina rozpoczęcia zakresu czasu objętego statystykami.

UserAccount

Właściwości używane do tworzenia użytkownika używanego do wykonywania zadań w węźle obliczeniowym usługi Azure Batch.

Nazwa Typ Opis
elevationLevel

ElevationLevel

Poziom podniesienia uprawnień konta użytkownika.
Wartość domyślna to nonAdmin.

linuxUserConfiguration

LinuxUserConfiguration

Konfiguracja użytkownika specyficznego dla systemu Linux dla konta użytkownika.
Ta właściwość jest ignorowana, jeśli jest określona w puli systemu Windows. Jeśli nie zostanie określony, użytkownik zostanie utworzony przy użyciu opcji domyślnych.

name

string

Nazwa konta użytkownika. Nazwy mogą zawierać dowolne znaki Unicode o maksymalnej długości do 20.

password

string

Hasło konta użytkownika.

windowsUserConfiguration

WindowsUserConfiguration

Konfiguracja użytkownika specyficznego dla systemu Windows dla konta użytkownika.
Tę właściwość można określić tylko wtedy, gdy użytkownik znajduje się w puli systemu Windows. Jeśli nie zostanie określony i w puli systemu Windows, użytkownik zostanie utworzony przy użyciu opcji domyślnych.

UserAssignedIdentity

Tożsamość przypisana przez użytkownika

Nazwa Typ Opis
clientId

string

Identyfikator klienta tożsamości przypisanej przez użytkownika.

principalId

string

Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika.

resourceId

string

Identyfikator zasobu usługi ARM tożsamości przypisanej przez użytkownika

UserIdentity

Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie.

Nazwa Typ Opis
autoUser

AutoUserSpecification

Użytkownik automatyczny, w ramach którego jest uruchamiane zadanie.
Właściwości userName i autoUser wzajemnie się wykluczają; należy określić jeden, ale nie oba te elementy.

username

string

Nazwa tożsamości użytkownika, w ramach której jest uruchamiane zadanie.
Właściwości userName i autoUser wzajemnie się wykluczają; należy określić jeden, ale nie oba te elementy.

VirtualMachineConfiguration

Konfiguracja węzłów obliczeniowych w puli oparta na infrastrukturze usługi Azure Virtual Machines.

Nazwa Typ Opis
containerConfiguration

ContainerConfiguration

Konfiguracja kontenera dla puli.
Jeśli zostanie określony, konfiguracja jest wykonywana na każdym węźle obliczeniowym w puli, aby umożliwić uruchamianie zadań w kontenerach. Wszystkie zwykłe zadania podrzędne i zadania menedżera zadań są uruchamiane w tej puli, muszą określać właściwość containerSettings, a wszystkie inne zadania mogą je określać.

dataDisks

DataDisk[]

Konfiguracja dysków danych dołączonych do węzłów obliczeniowych w puli.
Tę właściwość należy określić, jeśli węzły obliczeniowe w puli muszą mieć dołączone puste dyski danych. Nie można tego zaktualizować. Każdy węzeł obliczeniowy pobiera własny dysk (dysk nie jest udziałem plików). Nie można dołączyć istniejących dysków, każdy dołączony dysk jest pusty. Po usunięciu węzła obliczeniowego z puli dysk i wszystkie skojarzone z nim dane również zostaną usunięte. Dysk nie jest sformatowany po dołączeniu, należy go sformatować przed użyciem — aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux i https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

DiskEncryptionConfiguration

Konfiguracja szyfrowania dysków dla puli.
Jeśli określono, szyfrowanie jest wykonywane w każdym węźle w puli podczas aprowizacji węzłów.

extensions

VMExtension[]

Rozszerzenie maszyny wirtualnej dla puli.
Jeśli zostanie określony, rozszerzenia wymienione w tej konfiguracji zostaną zainstalowane w każdym węźle.

imageReference

ImageReference

Odwołanie do obrazu witryny Marketplace usługi Azure Virtual Machines lub niestandardowego obrazu maszyny wirtualnej do użycia.

licenseType

string

Typ licencji lokalnej do użycia podczas wdrażania systemu operacyjnego.
Dotyczy to tylko obrazów zawierających system operacyjny Windows i powinny być używane tylko w przypadku przechowywania prawidłowych licencji lokalnych dla węzłów obliczeniowych, które zostaną wdrożone. W przypadku pominięcia nie zastosowano rabatu na licencjonowanie lokalne. Wartości to:

Windows_Server — licencja lokalna dotyczy systemu Windows Server. Windows_Client — licencja lokalna jest dla klienta systemu Windows.

nodeAgentSKUId

string

Jednostka SKU agenta węzła obliczeniowego usługi Batch do aprowizacji w węzłach obliczeniowych w puli.
Agent węzła obliczeniowego usługi Batch to program uruchamiany w każdym węźle obliczeniowym w puli i udostępnia interfejs polecenia i sterowania między węzłem obliczeniowym a usługą Batch. Istnieją różne implementacje agenta węzła obliczeniowego nazywanego jednostkami SKU dla różnych systemów operacyjnych. Należy określić jednostkę SKU agenta węzła obliczeniowego zgodną z wybranym odwołaniem do obrazu. Aby uzyskać listę obsługiwanych jednostek SKU agenta węzła obliczeniowego wraz z listą zweryfikowanych odwołań do obrazów, zobacz operację "Lista obsługiwanych jednostek SKU agenta węzła obliczeniowego".

nodePlacementConfiguration

NodePlacementConfiguration

Konfiguracja umieszczania węzła dla puli.
Ta konfiguracja określi reguły dotyczące fizycznego przydzielania węzłów w puli.

osDisk

OSDisk

Ustawienia dysku systemu operacyjnego maszyny wirtualnej.

securityProfile

SecurityProfile

Określa ustawienia profilu zabezpieczeń dla maszyny wirtualnej lub zestawu skalowania maszyn wirtualnych.
Określa ustawienia profilu zabezpieczeń dla maszyny wirtualnej lub zestawu skalowania maszyn wirtualnych.

serviceArtifactReference

ServiceArtifactReference

Określa identyfikator odwołania artefaktu usługi używany do ustawiania tej samej wersji obrazu dla wszystkich maszyn wirtualnych w zestawie skalowania w przypadku używania "najnowszej" wersji obrazu.
Identyfikator odwołania artefaktu usługi w postaci /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

windowsConfiguration

WindowsConfiguration

Ustawienia systemu operacyjnego Windows na maszynie wirtualnej.
Nie można określić tej właściwości, jeśli właściwość imageReference określa obraz systemu operacyjnego Linux.

VMDiskSecurityProfile

Określa ustawienia profilu zabezpieczeń dla dysku zarządzanego. Uwaga: można go ustawić tylko dla poufnych maszyn wirtualnych i wymagane w przypadku korzystania z poufnych maszyn wirtualnych.

Nazwa Typ Opis
securityEncryptionType

SecurityEncryptionTypes

Określa typ szyfrowania dysku zarządzanego. Jest ona ustawiona na VMGuestStateOnly na potrzeby szyfrowania tylko obiektu blob VMGuestState i nonPersistedTPM dla nietrwałego stanu oprogramowania układowego w obiekcie blob VMGuestState. Uwaga: można go ustawić tylko dla poufnych maszyn wirtualnych i jest wymagany podczas korzystania z poufnych maszyn wirtualnych.

VMExtension

Konfiguracja rozszerzeń maszyn wirtualnych.

Nazwa Typ Opis
autoUpgradeMinorVersion

boolean

Wskazuje, czy rozszerzenie powinno używać nowszej wersji pomocniczej, jeśli jest ona dostępna w czasie wdrażania. Po wdrożeniu rozszerzenie nie uaktualni wersji pomocniczych, chyba że zostanie ponownie wdrożone, nawet jeśli ta właściwość ma wartość true.

enableAutomaticUpgrade

boolean

Wskazuje, czy rozszerzenie powinno zostać automatycznie uaktualnione przez platformę, jeśli jest dostępna nowsza wersja rozszerzenia.

name

string

Nazwa rozszerzenia maszyny wirtualnej.

protectedSettings

object

Rozszerzenie może zawierać ustawienia protectedSettings lub protectedSettingsFromKeyVault lub w ogóle nie są chronione.

provisionAfterExtensions

string[]

Kolekcja nazw rozszerzeń.
Kolekcja nazw rozszerzeń, po których należy aprowizować to rozszerzenie.

publisher

string

Nazwa wydawcy programu obsługi rozszerzeń.

settings

object

Ustawienia publiczne w formacie JSON dla rozszerzenia.

type

string

Typ rozszerzenia.

typeHandlerVersion

string

Wersja programu obsługi skryptów.

WindowsConfiguration

Ustawienia systemu operacyjnego Windows, które mają być stosowane do maszyny wirtualnej.

Nazwa Typ Opis
enableAutomaticUpdates

boolean

Określa, czy aktualizacje automatyczne są włączone na maszynie wirtualnej.
W przypadku pominięcia wartość domyślna to true.

WindowsUserConfiguration

Właściwości używane do tworzenia konta użytkownika w węźle obliczeniowym systemu Windows.

Nazwa Typ Opis
loginMode

LoginMode

Tryb logowania użytkownika
Wartość domyślna to "batch".