Pools - Get Pool
Obtient des informations sur le pool spécifié.
GET {endpoint}/pools/{poolId}?api-version=2025-06-01
GET {endpoint}/pools/{poolId}?api-version=2025-06-01&timeOut={timeOut}&$select={$select}&$expand={$expand}
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Point de terminaison de compte Batch (par exemple : https://batchaccount.eastus2.batch.azure.com). |
|
pool
|
path | True |
string |
ID du pool à obtenir. |
|
api-version
|
query | True |
string minLength: 1 |
Version de l’API à utiliser pour cette opération. |
|
$expand
|
query |
string[] |
Clause $expand OData. |
|
|
$select
|
query |
string[] |
Clause OData $select. |
|
|
time
|
query |
integer (int32) |
Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, le par défaut sera utilisé à la place. » |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| client-request-id |
string |
L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
| return-client-request-id |
boolean |
Indique si le serveur doit retourner l’ID client-request-id dans la réponse. |
|
| ocp-date |
string (date-time-rfc7231) |
Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST. |
|
| If-Modified-Since |
string (date-time-rfc7231) |
Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée. |
|
| If-Unmodified-Since |
string (date-time-rfc7231) |
Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée. |
|
| If-Match |
string |
Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client. |
|
| If-None-Match |
string |
Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
La demande a réussi. En-têtes
|
|
| Other Status Codes |
Réponse d’erreur inattendue. |
Sécurité
OAuth2Auth
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Étendues
| Nom | Description |
|---|---|
| https://batch.core.windows.net//.default |
Exemples
Add a VirtualMachineConfiguration pool with OS disk
Exemple de requête
GET {endpoint}/pools/mypool001?api-version=2025-06-01
Exemple de réponse
{
"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_D2ds_v5",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 1,
"targetDedicatedNodes": 1,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"sku": "server",
"version": "latest"
},
"osDisk": {
"ephemeralOSDiskSettings": {
"placement": "cachedisk"
},
"managedDisk": {
"storageAccountType": "standardssd_lrs"
},
"diskSizeGB": 100,
"caching": "readwrite"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04"
}
}
Get a pool with AcceleratedNetworking
Exemple de requête
GET {endpoint}/pools/pool?api-version=2025-06-01
Exemple de réponse
{
"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": "2025-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64"
},
"networkConfiguration": {
"dynamicVNetAssignmentScope": "none",
"enableAcceleratedNetworking": true
}
}
Get a VirtualMachineConfiguration pool with extensions
Exemple de requête
GET {endpoint}/pools/pool?api-version=2025-06-01
Exemple de réponse
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8D413091E739A56",
"lastModified": "2025-11-22T18:55:25.2608598Z",
"creationTime": "2025-11-22T18:55:24.2632496Z",
"state": "active",
"stateTransitionTime": "2025-11-22T18:55:24.2632496Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2025-11-22T18:55:24.8154041Z",
"vmSize": "Standard_D4d_v5",
"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": "ubuntu-24_04-lts",
"sku": "server",
"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"
}
}
]
}
}
Get a VirtualMachineConfiguration pool with SecurityProfile
Exemple de requête
GET {endpoint}/pools/mypool001?api-version=2025-06-01
Exemple de réponse
{
"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": "ubuntu-24_04-lts",
"sku": "18_04-lts-gen2",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 18.04",
"securityProfile": {
"securityType": "trustedLaunch",
"encryptionAtHost": true,
"uefiSettings": {
"secureBootEnabled": false
}
}
}
}
Get a VirtualMachineConfiguration pool with ServiceArtifactReference
Exemple de requête
GET {endpoint}/pools/pool?api-version=2025-06-01
Exemple de réponse
{
"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_D4d_v5",
"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": "2025-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"
}
}
}
Pool get
Exemple de requête
GET {endpoint}/pools/pool?api-version=2025-06-01
Exemple de réponse
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8D413091E739A56",
"lastModified": "2025-11-22T18:55:25.2608598Z",
"creationTime": "2025-11-22T18:55:24.2632496Z",
"state": "active",
"stateTransitionTime": "2025-11-22T18:55:24.2632496Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2025-11-22T18:55:24.8154041Z",
"vmSize": "Standard_D4d_v5",
"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": "ubuntu-24_04-lts",
"sku": "server",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04"
}
}
Pool get with confidential disk encryption set for user subscription accounts
Exemple de requête
GET {endpoint}/pools/pool?api-version=2025-06-01
Exemple de réponse
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DDB7C351BD9078",
"lastModified": "2025-06-30T10:46:07.4361976Z",
"creationTime": "2025-06-30T10:46:07.4361956Z",
"state": "active",
"stateTransitionTime": "2025-06-30T10:46:07.4361956Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2025-06-30T10:46:49.4152394Z",
"vmSize": "standard_dc2as_v5",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 1,
"targetDedicatedNodes": 1,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread",
"jobDefaultOrder": "none"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2019-datacenter-core-g2",
"version": "latest"
},
"osDisk": {
"ephemeralOSDiskSettings": {},
"managedDisk": {
"storageAccountType": "standard_lrs",
"securityProfile": {
"securityEncryptionType": "DiskWithVMGuestState"
},
"diskEncryptionSet": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
}
},
"caching": "none"
},
"nodeAgentSKUId": "batch.node.windows amd64",
"dataDisks": [
{
"lun": 0,
"caching": "none",
"diskSizeGB": 1024,
"managedDisk": {
"storageAccountType": "standard_lrs",
"diskEncryptionSet": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
}
}
}
],
"securityProfile": {
"securityType": "confidentialvm",
"uefiSettings": {
"secureBootEnabled": true,
"vTpmEnabled": true
}
}
}
}
Pool get with customer managed key
Exemple de requête
GET {endpoint}/pools/pool?api-version=2025-06-01
Exemple de réponse
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DDB7B41717D6E3",
"lastModified": "2025-06-30T08:57:06.5913059Z",
"creationTime": "2025-06-30T08:55:44.4305839Z",
"state": "active",
"stateTransitionTime": "2025-06-30T08:55:44.4305839Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2025-06-30T08:58:17.3869385Z",
"vmSize": "Standard_D2ds_v5",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 1,
"targetDedicatedNodes": 1,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread",
"jobDefaultOrder": "none"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"sku": "server",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04",
"diskEncryptionConfiguration": {
"targets": [
"osdisk",
"temporarydisk"
],
"customerManagedKey": {
"keyUrl": "https://<vaultEndpoint>/keys/<keyName>/<keyVersion>",
"identityReference": {
"resourceId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"
}
}
}
},
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": [
{
"resourceId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
"principalId": "principalId",
"clientId": "clientId"
}
]
}
}
Pool get with disk encryption set for user subscription accounts
Exemple de requête
GET {endpoint}/pools/pool?api-version=2025-06-01
Exemple de réponse
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DDB7ADE50EE47F",
"lastModified": "2025-06-30T08:12:45.6662143Z",
"creationTime": "2025-06-30T08:12:45.6662134Z",
"state": "active",
"stateTransitionTime": "2025-06-30T08:12:45.6662134Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2025-06-30T08:13:38.0293152Z",
"vmSize": "Standard_D2ds_v5",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 1,
"targetDedicatedNodes": 1,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread",
"jobDefaultOrder": "none"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2019-datacenter-core-g2",
"version": "latest"
},
"osDisk": {
"ephemeralOSDiskSettings": {},
"managedDisk": {
"storageAccountType": "standard_lrs",
"diskEncryptionSet": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
}
},
"caching": "none"
},
"nodeAgentSKUId": "batch.node.windows amd64",
"dataDisks": [
{
"lun": 0,
"caching": "none",
"diskSizeGB": 1024,
"managedDisk": {
"storageAccountType": "standard_lrs",
"diskEncryptionSet": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
}
}
}
]
}
}
Définitions
| Nom | Description |
|---|---|
|
Allocation |
Allocation Enums de l’État |
|
Automatic |
Paramètres de configuration utilisés pour effectuer la mise à niveau automatique du système d’exploitation. |
|
Auto |
Résultats et erreurs d’une exécution d’une formule de mise à l’échelle automatique du pool. |
|
Auto |
Erreur qui s’est produite lors de l’exécution ou de l’évaluation d’une formule de mise à l’échelle automatique de pool. |
|
Auto |
Enums AutoUserScope |
|
Auto |
Spécifie les options de l’utilisateur automatique qui exécute une tâche Azure Batch. |
|
Azure |
Informations utilisées pour se connecter à un conteneur de stockage Azure à l’aide d’Blobfuse. |
|
Azure |
Informations utilisées pour se connecter à un partage de fichiers Azure. |
|
Batch |
Référence à un package à déployer sur des nœuds de calcul. |
|
Batch |
Configuration des pools avec conteneur. |
|
Batch |
Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par le nœud de calcul (machine virtuelle). |
|
Batch |
Réponse d’erreur reçue du service Azure Batch. |
|
Batch |
Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch. |
|
Batch |
Message d’erreur reçu dans une réponse d’erreur Azure Batch. |
|
Batch |
Pool NAT entrant qui peut être utilisé pour traiter des ports spécifiques sur des nœuds de calcul dans un pool Batch en externe. |
|
Batch |
Enums BatchJobDefaultOrder |
|
Batch |
Le service Batch n’affecte aucune signification à ces métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur. |
|
Batch |
Enums BatchNodeFillType |
|
Batch |
Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera. |
|
Batch |
Pour le placement régional, les nœuds du pool seront alloués dans la même région. Pour le placement zonal, les nœuds du pool sont répartis entre différentes zones avec un meilleur équilibrage des efforts. |
|
Batch |
Enums BatchNodePlacementPolicyType |
|
Batch |
Paramètres du disque du système d’exploitation du nœud de calcul (machine virtuelle). |
|
Batch |
Pool dans le service Azure Batch. |
|
Batch |
Configuration du point de terminaison pour un pool. |
|
Batch |
Identité du pool Batch, s’il est configuré. |
|
Batch |
Référence de l’une des identités de pool à chiffrer Disk. Cette identité sera utilisée pour accéder au coffre de clés. |
|
Batch |
Enums BatchPoolIdentityType |
|
Batch |
Statistiques relatives à la consommation des ressources par les nœuds de calcul dans un pool. |
|
Batch |
Enums de BatchPoolState |
|
Batch |
Contient les statistiques d’utilisation et d’utilisation des ressources pour la durée de vie d’un pool. |
|
Batch |
Statistiques relatives aux informations d’utilisation du pool. |
|
Batch |
Configuration d’adresse IP publique de la configuration réseau d’un pool. |
|
Batch |
Batch réessaye les tâches lorsqu’une opération de récupération est déclenchée sur un nœud. Les exemples d’opérations de récupération incluent (mais ne sont pas limités) lorsqu’un nœud non sain est redémarré ou qu’un nœud de calcul a disparu en raison d’une défaillance de l’hôte. Les nouvelles tentatives en raison d’opérations de récupération sont indépendantes et ne sont pas comptabilisées par rapport au maxTaskRetryCount. Même si maxTaskRetryCount est 0, une nouvelle tentative interne en raison d’une opération de récupération peut se produire. En raison de cela, toutes les tâches doivent être idempotentes. Cela signifie que les tâches doivent tolérer l’interruption et le redémarrage sans provoquer d’altération ou de doublon des données. La meilleure pratique pour les tâches longues consiste à utiliser une forme de point de contrôle. Dans certains cas, startTask peut être réexécuter même si le nœud de calcul n’a pas été redémarré. Vous devez veiller à éviter les tâches StartTask qui créent un processus d’arrêt ou installent/lancent des services à partir du répertoire de travail StartTask, car cela empêche Batch de pouvoir réexécuter l’objet StartTask. |
|
Batch |
Paramètres de conteneur d’une tâche. |
|
Batch |
Spécifie la façon dont les tâches doivent être distribuées entre les nœuds de calcul. |
|
Batch |
Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle. |
|
Batch |
Identité affectée par l’utilisateur |
|
Batch |
Spécifie les paramètres du profil de sécurité pour le disque managé. Remarque : Il ne peut être défini que pour les machines virtuelles confidentielles et requis lors de l’utilisation de machines virtuelles confidentielles. |
|
Batch |
Référence à une image de la Place de marché de machines virtuelles Azure ou à une image de galerie de calcul Azure. Pour obtenir la liste de toutes les références d’images de la Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Liste des images prises en charge ». |
|
Caching |
Enums CachingType |
|
Cifs |
Informations utilisées pour se connecter à un système de fichiers CIFS. |
|
Container |
Entrée du chemin d’accès et du mode montage que vous souhaitez monter dans le conteneur de tâches. |
|
Container |
Chemins d’accès qui seront montés sur le conteneur de la tâche de conteneur. |
|
Container |
Registre de conteneurs privé. |
|
Container |
Enums ContainerType |
|
Container |
ContainerWorkingDirectory enums |
|
Data |
Paramètres qui seront utilisés par les disques de données associés aux nœuds de calcul dans le pool. Lorsque vous utilisez des disques de données attachés, vous devez monter et mettre en forme les disques à partir d’une machine virtuelle pour les utiliser. |
|
Diff |
Spécifie le placement éphémère du disque du système d’exploitation pour tous les nœuds de calcul (VM) du pool. Cette propriété peut être utilisée par l’utilisateur dans la demande pour choisir l’emplacement dans lequel le système d’exploitation doit se trouver. Par exemple, cachez l’espace disque pour l’approvisionnement de disque de système d’exploitation éphémère. Pour plus d’informations sur les exigences en taille de disque d’OS éphémère, veuillez consulter les exigences de taille de disque pour les machines virtuelles Windows à https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements et Linux à https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements |
|
Disk |
Référence de la clé gérée par le client pour chiffrer le disque. |
|
Disk |
Configuration de chiffrement de disque appliquée aux nœuds de calcul du pool. La configuration du chiffrement de disque n’est pas prise en charge sur le pool Linux créé avec l’image de la galerie de calcul Azure. |
|
Disk |
ID de ressource ARM du jeu de chiffrement de disque. |
|
Disk |
Enums DiskEncryptionTarget |
|
Dynamic |
DynamicVNetAssignmentScope enums |
|
Elevation |
Enums de niveau d’élévation |
|
Environment |
Variable d’environnement à définir sur un processus de tâche. |
|
Host |
Spécifie des paramètres de point de terminaison d’hôte particuliers. |
|
Host |
HostEndpointSettingsModeTypes enums |
|
Inbound |
InboundEndpointProtocol enums |
|
Ip |
IPAddressProvisioningType enums |
| IPFamily |
Familles d’adresses IP utilisées pour spécifier les versions d’adresses IP disponibles pour le pool. |
| IPTag |
Contient la balise IP associée à l’adresse IP publique. |
|
Linux |
Propriétés utilisées pour créer un compte d’utilisateur sur un nœud de calcul Linux. |
|
Login |
Enums LoginMode |
|
Managed |
Paramètres de disque managé. |
|
Mount |
Système de fichiers à monter sur chaque nœud. |
|
Name |
Représente une paire nom-valeur. |
|
Network |
Configuration réseau d’un pool. |
|
Network |
Règle de groupe de sécurité réseau à appliquer à un point de terminaison entrant. |
|
Network |
NetworkSecurityGroupRuleAccess enums |
|
Nfs |
Informations utilisées pour se connecter à un système de fichiers NFS. |
|
Proxy |
Spécifie les paramètres ProxyAgent lors de la création de la machine virtuelle. |
|
Resize |
Erreur qui s’est produite lors du redimensionnement d’un pool. |
|
Resource |
Un seul fichier ou plusieurs fichiers à télécharger sur un nœud de calcul. |
|
Rolling |
Paramètres de configuration utilisés lors de l’exécution d’une mise à niveau propagée. |
|
Security |
Enums SecurityEncryptionTypes |
|
Security |
Spécifie les paramètres de profil de sécurité de la machine virtuelle ou du groupe de machines virtuelles identiques. |
|
Security |
Spécifie le SecurityType de la machine virtuelle. Il doit être défini sur n’importe quelle valeur spécifiée pour activer UefiSettings. |
|
Service |
Spécifie l’ID de référence de l’artefact de service utilisé pour définir la même version d’image pour toutes les machines virtuelles du groupe identique lors de l’utilisation de la version d’image la plus récente. |
|
Storage |
Énumérations StorageAccountType |
|
Upgrade |
Enums UpgradeMode |
|
Upgrade |
Décrit une stratégie de mise à niveau : automatique, manuelle ou propagée. |
|
User |
Propriétés utilisées pour créer un utilisateur utilisé pour exécuter des tâches sur un nœud de calcul Azure Batch. |
|
User |
Définition de l’identité de l’utilisateur sous laquelle la tâche est exécutée. Spécifiez la propriété userName ou autoUser, mais pas les deux. |
|
Virtual |
Configuration des nœuds de calcul dans un pool en fonction de l’infrastructure des machines virtuelles Azure. |
| VMExtension |
Configuration des extensions de machine virtuelle. |
|
Windows |
Paramètres du système d’exploitation Windows à appliquer à la machine virtuelle. |
|
Windows |
Propriétés utilisées pour créer un compte d’utilisateur sur un nœud de calcul Windows. |
AllocationState
Allocation Enums de l’État
| Valeur | Description |
|---|---|
| steady |
La piscine ne se redimensionne pas. Aucun changement n’a été effectué dans le nombre de nœuds de calcul dans le pool en cours. Un pool entre dans cet état lorsqu’il est créé et lorsqu’aucune opération n’est effectuée sur le pool pour modifier le nombre de nœuds de calcul. |
| resizing |
La piscine est en train de se redimensionner ; c’est-à-dire que les nœuds de calcul sont ajoutés ou retirés du pool. |
| stopping |
Le pool était en train de se redimensionner, mais l’utilisateur a demandé que la redimensionnement soit arrêtée, bien que la demande d’arrêt n’ait pas encore été complétée. |
AutomaticOsUpgradePolicy
Paramètres de configuration utilisés pour effectuer la mise à niveau automatique du système d’exploitation.
| Nom | Type | Description |
|---|---|---|
| disableAutomaticRollback |
boolean |
Indique si la fonctionnalité de restauration d’image du système d’exploitation doit être désactivée. |
| enableAutomaticOSUpgrade |
boolean |
Indique si les mises à niveau du système d’exploitation doivent être appliquées automatiquement aux instances de groupe identique de manière propagée lorsqu’une version plus récente de l’image du système d’exploitation devient disponible. |
| osRollingUpgradeDeferral |
boolean |
Différer les mises à niveau du système d’exploitation sur les machines virtuelles si elles exécutent des tâches. |
| useRollingUpgradePolicy |
boolean |
Indique si la stratégie de mise à niveau propagée doit être utilisée pendant la mise à niveau automatique du système d’exploitation. La mise à niveau automatique du système d’exploitation revient à la stratégie par défaut si aucune stratégie n’est définie sur vmSS. |
AutoScaleRun
Résultats et erreurs d’une exécution d’une formule de mise à l’échelle automatique du pool.
| Nom | Type | Description |
|---|---|---|
| error |
Détails de l’erreur rencontrée évaluant la formule d’autoscale sur le Pool, si l’évaluation échouait. |
|
| results |
string |
Valeurs finales de toutes les variables utilisées dans l’évaluation de la formule de mise à l’échelle automatique. Chaque valeur de variable est retournée sous la forme $variable=value, et les variables sont séparées par des points-virgules. |
| timestamp |
string (date-time) |
Heure à laquelle la formule de mise à l’échelle automatique a été évaluée pour la dernière fois. |
AutoScaleRunError
Erreur qui s’est produite lors de l’exécution ou de l’évaluation d’une formule de mise à l’échelle automatique de pool.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Un identifiant pour l’erreur d’autoscale. Les codes sont invariants et sont destinés à être consommés par programme. |
| message |
string |
Un message décrivant l’erreur d’autoscale, destiné à être affiché dans une interface utilisateur. |
| values |
Une liste de détails supplémentaires sur l’erreur liée à l’erreur d’autoscale. |
AutoUserScope
Enums AutoUserScope
| Valeur | Description |
|---|---|
| task |
Précise que le service doit créer un nouvel utilisateur pour la tâche. |
| pool |
Spécifie que la tâche s’exécute comme le compte utilisateur automatique commun, créé sur chaque nœud de calcul d’un pool. |
AutoUserSpecification
Spécifie les options de l’utilisateur automatique qui exécute une tâche Azure Batch.
| Nom | Type | Description |
|---|---|---|
| elevationLevel |
Niveau d’élévation de l’utilisateur automatique. La valeur par défaut n’est pasAdmin. |
|
| scope |
Étendue de l’utilisateur automatique. La valeur par défaut est pool. Si le pool exécute Windows, une valeur de tâche doit être spécifiée si une isolation plus stricte entre les tâches est requise. Par exemple, si la tâche modifie le registre d’une manière qui pourrait avoir un impact sur d’autres tâches. |
AzureBlobFileSystemConfiguration
Informations utilisées pour se connecter à un conteneur de stockage Azure à l’aide d’Blobfuse.
| Nom | Type | Description |
|---|---|---|
| accountKey |
string (password) |
Clé de compte de stockage Azure. Cette propriété s’exclue mutuellement avec sasKey et l’identité ; exactement un doit être spécifié. |
| accountName |
string |
Nom du compte de stockage Azure. |
| blobfuseOptions |
string |
Options de ligne de commande supplémentaires à passer à la commande de montage. Il s’agit des options « net use » dans les options Windows et « mount » dans Linux. |
| containerName |
string |
Nom du conteneur stockage Blob Azure. |
| identityReference |
La référence à l’identité attribuée par l’utilisateur pour accéder à ContainerName. Cette propriété s’exclue mutuellement avec accountKey et sasKey ; exactement un doit être spécifié. |
|
| relativeMountPath |
string |
Le chemin relatif sur le nœud de calcul où le système de fichiers sera monté. Tous les systèmes de fichiers sont montés par rapport au répertoire de montage Batch, accessible via la variable d’environnement AZ_BATCH_NODE_MOUNTS_DIR. |
| sasKey |
string (password) |
Jeton SAP stockage Azure. Cette propriété s’exclue mutuellement avec accountKey et l’identité ; exactement un doit être spécifié. |
AzureFileShareConfiguration
Informations utilisées pour se connecter à un partage de fichiers Azure.
| Nom | Type | Description |
|---|---|---|
| accountKey |
string (password) |
Clé du compte stockage Azure. |
| accountName |
string |
Nom du compte stockage Azure. |
| azureFileUrl |
string (uri) |
URL Azure Files. Il s’agit de la forme « https://{account}.file.core.windows.net/ ». |
| mountOptions |
string |
Options de ligne de commande supplémentaires à passer à la commande de montage. Il s’agit des options « net use » dans les options Windows et « mount » dans Linux. |
| relativeMountPath |
string |
Le chemin relatif sur le nœud de calcul où le système de fichiers sera monté. Tous les systèmes de fichiers sont montés par rapport au répertoire de montage Batch, accessible via la variable d’environnement AZ_BATCH_NODE_MOUNTS_DIR. |
BatchApplicationPackageReference
Référence à un package à déployer sur des nœuds de calcul.
| Nom | Type | Description |
|---|---|---|
| applicationId |
string |
L’identifiant de l’application à déployer. Lors de la création d’un pool, l’ID d’application du package doit être complet (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). |
| version |
string |
Version de l’application à déployer. En cas d’omission, la version par défaut est déployée. Si cela est omis sur un Pool, et qu’aucune version par défaut n’est spécifiée pour cette application, la requête échoue avec le code d’erreur InvalidApplicationPackageReferences et le code d’état HTTP 409. Si cette option est omise sur une tâche et qu’aucune version par défaut n’est spécifiée pour cette application, la tâche échoue avec une erreur de prétraitement. |
BatchContainerConfiguration
Configuration des pools avec conteneur.
| Nom | Type | Description |
|---|---|---|
| containerImageNames |
string[] |
La collection de conteneurs Noms d’images. Voici la référence complète de l’image, comme cela serait spécifié pour « docker pull ». Une image sera issue du registre Docker par défaut, sauf si l’image est pleinement qualifiée auprès d’un registre alternatif. |
| containerRegistries |
Registres privés supplémentaires à partir desquels les conteneurs peuvent être extraits. Si des images doivent être téléchargées depuis un registre privé nécessitant des identifiants, ces identifiants doivent être fournis ici. |
|
| type |
Technologie de conteneur à utiliser. |
BatchDiffDiskSettings
Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par le nœud de calcul (machine virtuelle).
| Nom | Type | Description |
|---|---|---|
| placement |
Spécifie le placement éphémère du disque du système d’exploitation pour toutes les machines virtuelles du pool. Cette propriété peut être utilisée par l’utilisateur dans la demande pour choisir l’emplacement, par exemple, mettre en cache l’espace disque pour l’approvisionnement de disque de système d’exploitation éphémère. Pour plus d’informations sur les exigences de taille de disque de système d’exploitation éphémère, reportez-vous à la configuration requise pour la taille de disque du système d’exploitation éphémère pour les machines virtuelles Windows à https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements et les machines virtuelles Linux à https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. |
BatchError
Réponse d’erreur reçue du service Azure Batch.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme. |
| message |
Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur. |
|
| values |
Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur. |
BatchErrorDetail
Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
| Nom | Type | Description |
|---|---|---|
| key |
string |
Identificateur spécifiant la signification de la propriété Value. |
| value |
string |
Informations supplémentaires incluses dans la réponse d’erreur. |
BatchErrorMessage
Message d’erreur reçu dans une réponse d’erreur Azure Batch.
| Nom | Type | Description |
|---|---|---|
| lang |
string |
Le code de langue du message d’erreur. |
| value |
string |
Le texte du message. |
BatchInboundNatPool
Pool NAT entrant qui peut être utilisé pour traiter des ports spécifiques sur des nœuds de calcul dans un pool Batch en externe.
| Nom | Type | Description |
|---|---|---|
| backendPort |
integer (int32) |
Le numéro de port sur le nœud de calcul. Cela doit être unique au sein d’un groupe de lots. Les valeurs acceptables sont comprises entre 1 et 65535, sauf pour 29876 et 29877, car elles sont réservées. Si des valeurs réservées sont fournies, la requête échoue avec le code d’état HTTP 400. |
| frontendPortRangeEnd |
integer (int32) |
Le dernier numéro de port dans la plage des ports externes qui seront utilisés pour fournir un accès entrant au backendPort sur les nœuds de calcul individuels. Les valeurs acceptables sont comprises entre 1 et 65534, à l’exception des ports compris entre 5 000 et 55 000, qui sont réservés par le service Batch. Toutes les plages d’un pool doivent être distinctes et ne peuvent pas se chevaucher. Chaque plage doit contenir au moins 40 ports. Si des valeurs réservées ou superposées sont fournies, la requête échoue avec le code d’état HTTP 400. |
| frontendPortRangeStart |
integer (int32) |
Le premier numéro de port dans la plage des ports externes qui serviront à fournir un accès entrant au backendPort sur les nœuds de calcul individuels. Les valeurs acceptables sont comprises entre 1 et 65534, à l’exception des ports compris entre 50000 et 55000, qui sont réservés. Toutes les plages d’un pool doivent être distinctes et ne peuvent pas se chevaucher. Chaque plage doit contenir au moins 40 ports. Si des valeurs réservées ou superposées sont fournies, la requête échoue avec le code d’état HTTP 400. |
| name |
string |
Nom du point de terminaison. Le nom doit être unique au sein d’un Batch Pool, il peut contenir des lettres, des chiffres, des sous-traits, des points et des traits d’endroit. Les noms doivent commencer par une lettre ou un nombre, doivent se terminer par une lettre, un nombre ou un trait de soulignement, et ne peuvent pas dépasser 77 caractères. Si des valeurs non valides sont fournies, la requête échoue avec le code d’état HTTP 400. |
| networkSecurityGroupRules |
Liste des règles de groupe de sécurité réseau qui seront appliquées au point de terminaison. Le nombre maximal de règles pouvant être spécifiées sur tous les points de terminaison d’un pool de batch est de 25. Si aucune règle de groupe de sécurité réseau n’est spécifiée, une règle par défaut est créée pour autoriser l’accès entrant au backendPort spécifié. Si le nombre maximal de règles de groupe de sécurité réseau est dépassé, la requête échoue avec le code d’état HTTP 400. |
|
| protocol |
Protocole du point de terminaison. |
BatchJobDefaultOrder
Enums BatchJobDefaultOrder
| Valeur | Description |
|---|---|
| none |
Les tâches doivent être planifiées uniformément à partir de tous les emplois à priorité égale pour le pool. |
| creationtime |
Si les emplois ont la même priorité, les tâches issues de postes créés plus tôt doivent être planifiées en premier. |
BatchMetadataItem
Le service Batch n’affecte aucune signification à ces métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur.
| Nom | Type | Description |
|---|---|---|
| name |
string |
Nom de l’élément de métadonnées. |
| value |
string |
Valeur de l’élément de métadonnées. |
BatchNodeFillType
Enums BatchNodeFillType
| Valeur | Description |
|---|---|
| spread |
Les tâches doivent être réparties équitablement sur tous les nœuds de calcul du pool. |
| pack |
Le plus de tâches possible (taskSlotsPerNode) doivent être attribuées à chaque nœud de calcul du pool avant que toute tâche ne soit attribuée au nœud de calcul suivant du pool. |
BatchNodeIdentityReference
Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
| Nom | Type | Description |
|---|---|---|
| resourceId |
string (arm-id) |
ID de ressource ARM de l’identité affectée par l’utilisateur. |
BatchNodePlacementConfiguration
Pour le placement régional, les nœuds du pool seront alloués dans la même région. Pour le placement zonal, les nœuds du pool sont répartis entre différentes zones avec un meilleur équilibrage des efforts.
| Nom | Type | Description |
|---|---|---|
| policy |
Type de stratégie de placement de nœud sur les pools Batch. Stratégie d’allocation utilisée par le service Batch pour approvisionner les nœuds. S’il n’est pas spécifié, Batch utilise la stratégie régionale. |
BatchNodePlacementPolicyType
Enums BatchNodePlacementPolicyType
| Valeur | Description |
|---|---|
| regional |
Tous les nœuds du pool seront alloués dans la même région. |
| zonal |
Les nœuds du pool seront répartis sur différentes zones de disponibilité avec un équilibrage optimal. |
BatchOsDisk
Paramètres du disque du système d’exploitation du nœud de calcul (machine virtuelle).
| Nom | Type | Description |
|---|---|---|
| caching |
Spécifie les exigences de mise en cache. Les valeurs possibles sont : None, ReadOnly, ReadWrite. Les valeurs par défaut sont : Aucune pour le stockage Standard. ReadOnly pour le stockage Premium. |
|
| diskSizeGB |
integer (int32) |
Taille initiale du disque en Go lors de la création d’un disque de système d’exploitation. |
| ephemeralOSDiskSettings |
Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par le nœud de calcul (machine virtuelle). |
|
| managedDisk |
Paramètres de disque managé. |
|
| writeAcceleratorEnabled |
boolean |
Spécifie si writeAccelerator doit être activé ou désactivé sur le disque. |
BatchPool
Pool dans le service Azure Batch.
| Nom | Type | Description |
|---|---|---|
| allocationState |
Indique si le redimensionnement du pool est en cours. |
|
| allocationStateTransitionTime |
string (date-time) |
Heure à laquelle le pool a entré son état d’allocation actuel. |
| applicationPackageReferences |
Liste des packages à installer sur chaque nœud de calcul du pool. Les modifications apportées aux références de package affectent tous les nouveaux nœuds qui rejoignent le pool, mais n’affectent pas les nœuds de calcul qui se trouvent déjà dans le pool tant qu’ils ne sont pas redémarrés ou réinitialisé. Il existe un maximum de 10 références de package sur un pool donné. |
|
| autoScaleEvaluationInterval |
string (duration) |
Intervalle de temps auquel ajuster automatiquement la taille du pool en fonction de la formule de mise à l’échelle automatique. Cette propriété est définie uniquement si le pool est automatiquement mis à l’échelle, c’est-à-dire que enableAutoScale a la valeur true. |
| autoScaleFormula |
string |
Formule pour le nombre souhaité de nœuds de calcul dans le pool. Cette propriété est définie uniquement si le pool est automatiquement mis à l’échelle, c’est-à-dire que enableAutoScale a la valeur true. |
| autoScaleRun |
Résultats et erreurs de la dernière exécution de la formule de mise à l’échelle automatique. Cette propriété est définie uniquement si le pool est automatiquement mis à l’échelle, c’est-à-dire que enableAutoScale a la valeur true. |
|
| creationTime |
string (date-time) |
Heure de création du pool. |
| currentDedicatedNodes |
integer (int32) |
Nombre de nœuds de calcul dédiés actuellement dans le pool. |
| currentLowPriorityNodes |
integer (int32) |
Nombre de nœuds de calcul Spot/Basse priorité actuellement dans le pool. Les nœuds de calcul spot/basse priorité qui ont été préemptés sont inclus dans ce nombre. |
| displayName |
string |
Le nom complet n’a pas besoin d’être unique et peut contenir des caractères Unicode pouvant atteindre une longueur maximale de 1024. |
| eTag |
string |
ETag du pool. Il s’agit d’une chaîne opaque. Vous pouvez l’utiliser pour détecter si le pool a changé entre les requêtes. En particulier, vous pouvez passer l’ETag lors de la mise à jour d’un pool pour spécifier que vos modifications doivent prendre effet uniquement si personne d’autre n’a modifié le pool en attendant. |
| enableAutoScale |
boolean |
Indique si la taille du pool doit être ajustée automatiquement au fil du temps. Si la valeur est false, au moins un des targetDedicatedNodes et targetLowPriorityNodes doivent être spécifiés. Si la valeur est true, la propriété autoScaleFormula est requise et le pool se redimensionne automatiquement en fonction de la formule. La valeur par défaut est false. |
| enableInterNodeCommunication |
boolean |
Indique si le pool autorise la communication directe entre les nœuds de calcul. L’activation de la communication entre nœuds limite la taille maximale du pool en raison de restrictions de déploiement sur les nœuds de calcul du pool. Cela peut entraîner le fait que le pool n’atteigne pas sa taille souhaitée. La valeur par défaut est false. |
| id |
string |
Chaîne qui identifie de façon unique le pool dans le compte. L’ID peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement, et ne peut pas contenir plus de 64 caractères. L’ID est respectant la casse et ne respecte pas la casse (autrement dit, vous n’avez peut-être pas deux ID au sein d’un compte qui diffèrent uniquement par cas). |
| identity |
Identité du pool Batch, s’il est configuré. Liste des identités utilisateur associées au pool Batch. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». |
|
| lastModified |
string (date-time) |
Heure de la dernière modification du pool. Il s’agit de la dernière fois où les données au niveau du pool, telles que targetDedicatedNodes ou activer les paramètresAutoscale, ont changé. Elle ne prend pas en compte les modifications au niveau du nœud, telles qu’un nœud de calcul qui change d’état. |
| metadata |
Liste des paires nom-valeur associées au pool en tant que métadonnées. |
|
| mountConfiguration |
Montez le stockage à l’aide du système de fichiers spécifié pendant toute la durée de vie du pool. Montez le stockage à l’aide d’un système de fichiers basé sur Azure fileshare, NFS, CIFS ou Blobfuse. |
|
| networkConfiguration |
Configuration réseau du pool. |
|
| resizeErrors |
Liste des erreurs rencontrées lors de l’exécution du dernier redimensionnement sur le pool. Cette propriété n’est définie que si une ou plusieurs erreurs se sont produites pendant le dernier redimensionnement du pool, et uniquement lorsque l’allocationState du pool est stable. |
|
| resizeTimeout |
string (duration) |
Délai d’expiration pour l’allocation de nœuds de calcul au pool. Il s’agit du délai d’expiration de l’opération de redimensionnement la plus récente. (Le dimensionnement initial lorsque le pool est créé compte en tant que redimensionnement.) La valeur par défaut est de 15 minutes. |
| startTask |
Tâche spécifiée pour s’exécuter sur chaque nœud de calcul au fur et à mesure qu’elle joint le pool. |
|
| state |
État actuel du pool. |
|
| stateTransitionTime |
string (date-time) |
Heure à laquelle le pool a entré son état actuel. |
| stats |
Statistiques d’utilisation et d’utilisation des ressources pour toute la durée de vie du pool. Cette propriété est remplie uniquement si BatchPool a été récupéré avec une clause expand, y compris l’attribut « stats » ; sinon, il s’agit de null. Les statistiques peuvent ne pas être immédiatement disponibles. Le service Batch effectue un cumul périodique des statistiques. Le délai classique est d’environ 30 minutes. |
|
| targetDedicatedNodes |
integer (int32) |
Nombre souhaité de nœuds de calcul dédiés dans le pool. |
| targetLowPriorityNodes |
integer (int32) |
Nombre souhaité de nœuds de calcul Spot/Basse priorité dans le pool. |
| taskSchedulingPolicy |
Comment les tâches sont distribuées entre les nœuds de calcul d’un pool. S’il n’est pas spécifié, la valeur par défaut est répartie. |
|
| taskSlotsPerNode |
integer (int32) |
Nombre d’emplacements de tâche qui peuvent être utilisés pour exécuter des tâches simultanées sur un nœud de calcul unique dans le pool. La valeur par défaut est 1. La valeur maximale est la plus petite de 4 fois le nombre de cœurs de la vmSize du pool ou 256. |
| upgradePolicy |
Stratégie de mise à niveau pour le pool. Décrit une stratégie de mise à niveau : automatique, manuelle ou propagée. |
|
| url |
string (uri) |
URL du pool. |
| userAccounts |
Liste des comptes d’utilisateur à créer sur chaque nœud de calcul du pool. |
|
| virtualMachineConfiguration |
Configuration de la machine virtuelle pour le pool. Cette propriété doit être spécifiée. |
|
| vmSize |
string |
Taille des machines virtuelles dans le pool. Toutes les machines virtuelles d’un pool sont de la même taille. Pour plus d’informations sur les tailles disponibles de machines virtuelles dans les pools, consultez Choisir une taille de machine virtuelle pour les nœuds de calcul dans un pool Azure Batch (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). |
BatchPoolEndpointConfiguration
Configuration du point de terminaison pour un pool.
| Nom | Type | Description |
|---|---|---|
| inboundNATPools |
Une liste des pools NAT entrants pouvant être utilisés pour adresser des ports spécifiques sur un nœud de calcul individuel à l’externe. Le nombre maximal de NAT Pools entrants par lot est de 5. Si le nombre maximal de NAT Pools entrants est dépassé, la requête échoue avec le code d’état HTTP 400. Cela ne peut pas être spécifié si IPAddressProvisioningType est NoPublicIPAddresses. |
BatchPoolIdentity
Identité du pool Batch, s’il est configuré.
| Nom | Type | Description |
|---|---|---|
| type |
Identité du pool Batch, s’il est configuré. Liste des identités utilisateur associées au pool Batch. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». |
|
| userAssignedIdentities |
Liste des identités utilisateur associées au compte Batch. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». |
BatchPoolIdentityReference
Référence de l’une des identités de pool à chiffrer Disk. Cette identité sera utilisée pour accéder au coffre de clés.
| Nom | Type | Description |
|---|---|---|
| resourceId |
string (arm-id) |
ID de ressource ARM de l’identité affectée par l’utilisateur. Cette référence doit être incluse dans les identités de pool. |
BatchPoolIdentityType
Enums BatchPoolIdentityType
| Valeur | Description |
|---|---|
| UserAssigned |
Le pool Batch a des identités affectées par l’utilisateur avec elle. |
| None |
Le pool Batch n’a aucune identité associée. La définition |
BatchPoolResourceStatistics
Statistiques relatives à la consommation des ressources par les nœuds de calcul dans un pool.
| Nom | Type | Description |
|---|---|---|
| avgCPUPercentage |
number (float) |
L’utilisation moyenne du processeur sur tous les nœuds de calcul du pool (pourcentage par nœud). |
| avgDiskGiB |
number (float) |
L’espace disque moyen utilisé en Gio pour tous les nœuds de calcul du pool. |
| avgMemoryGiB |
number (float) |
L’utilisation moyenne de la mémoire en GiB sur tous les nœuds de calcul du pool. |
| diskReadGiB |
number (float) |
La quantité totale de données en Gio de disque est lue sur tous les nœuds de calcul du pool. |
| diskReadIOps |
string (int64) |
Le nombre total d’opérations de lecture de disque sur tous les nœuds de calcul du pool. |
| diskWriteGiB |
number (float) |
La quantité totale de données en Gio d’écritures sur disque est répartie sur tous les nœuds de calcul du pool. |
| diskWriteIOps |
string (int64) |
Le nombre total d’opérations d’écriture sur disque sur tous les nœuds de calcul du pool. |
| lastUpdateTime |
string (date-time) |
L’heure à laquelle les statistiques ont été mises à jour pour la dernière fois. Toutes les statistiques sont limitées à la plage entre startTime et lastUpdateTime. |
| networkReadGiB |
number (float) |
La quantité totale de données en Gio du réseau est lue sur tous les nœuds de calcul du pool. |
| networkWriteGiB |
number (float) |
La quantité totale de données en Gio du réseau s’écrit sur tous les nœuds de calcul du pool. |
| peakDiskGiB |
number (float) |
Le pic utilisait l’espace disque en GiB sur tous les nœuds de calcul du pool. |
| peakMemoryGiB |
number (float) |
L’utilisation maximale de la mémoire en Gio sur tous les nœuds de calcul du pool. |
| startTime |
string (date-time) |
L’heure de début de la plage horaire couverte par les statistiques. |
BatchPoolState
Enums de BatchPoolState
| Valeur | Description |
|---|---|
| active |
Le Pool est disponible pour exécuter des tâches sous réserve de la disponibilité des nœuds de calcul. |
| deleting |
L’utilisateur a demandé la suppression du pool, mais l’opération de suppression n’a pas encore été terminée. |
BatchPoolStatistics
Contient les statistiques d’utilisation et d’utilisation des ressources pour la durée de vie d’un pool.
| Nom | Type | Description |
|---|---|---|
| lastUpdateTime |
string (date-time) |
L’heure à laquelle les statistiques ont été mises à jour pour la dernière fois. Toutes les statistiques sont limitées à la plage entre startTime et lastUpdateTime. |
| resourceStats |
Statistiques liées à la consommation de ressources par les nœuds de calcul du pool. |
|
| startTime |
string (date-time) |
L’heure de début de la plage horaire couverte par les statistiques. |
| url |
string (uri) |
L’URL des statistiques. |
| usageStats |
Statistiques liées à l’utilisation du pool, comme la quantité de temps de cœur utilisé. |
BatchPoolUsageStatistics
Statistiques relatives aux informations d’utilisation du pool.
| Nom | Type | Description |
|---|---|---|
| dedicatedCoreTime |
string (duration) |
Le temps agrégé de l’horloge murale des cœurs dédiés des nœuds de calcul faisant partie du pool. |
| lastUpdateTime |
string (date-time) |
L’heure à laquelle les statistiques ont été mises à jour pour la dernière fois. Toutes les statistiques sont limitées à la plage entre startTime et lastUpdateTime. |
| startTime |
string (date-time) |
L’heure de début de la plage horaire couverte par les statistiques. |
BatchPublicIpAddressConfiguration
Configuration d’adresse IP publique de la configuration réseau d’un pool.
| Nom | Type | Description |
|---|---|---|
| ipAddressIds |
string[] (arm-id) |
Liste des adresses IP publiques que le service Batch utilisera lors de l’approvisionnement de nœuds de calcul. Le nombre d’adresses IP spécifiées ici limite la taille maximale du pool - 100 nœuds dédiés ou 100 nœuds Spot/Basse priorité peuvent être alloués pour chaque adresse IP publique. Par exemple, un pool nécessitant 250 machines virtuelles dédiées aurait besoin d’au moins 3 adresses IP publiques spécifiées. Chaque élément de cette collection est de la forme : /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. |
| ipFamilies |
IPFamily[] |
Familles d’adresses IP utilisées pour spécifier les versions d’adresses IP disponibles pour le pool. Les familles d’adresses IP sont utilisées pour déterminer les pools à pile unique ou à double pile. Pour une pile unique, la valeur attendue est IPv4. Pour la double pile, les valeurs attendues sont IPv4 et IPv6. |
| ipTags |
IPTag[] |
Liste des balises IP associées aux adresses IP publiques du pool. Les balises IP sont utilisées pour catégoriser et filtrer les adresses IP publiques à des fins de facturation et de gestion. |
| provision |
Type d’approvisionnement pour les adresses IP publiques pour le pool. La valeur par défaut est BatchManaged. |
BatchStartTask
Batch réessaye les tâches lorsqu’une opération de récupération est déclenchée sur un nœud. Les exemples d’opérations de récupération incluent (mais ne sont pas limités) lorsqu’un nœud non sain est redémarré ou qu’un nœud de calcul a disparu en raison d’une défaillance de l’hôte. Les nouvelles tentatives en raison d’opérations de récupération sont indépendantes et ne sont pas comptabilisées par rapport au maxTaskRetryCount. Même si maxTaskRetryCount est 0, une nouvelle tentative interne en raison d’une opération de récupération peut se produire. En raison de cela, toutes les tâches doivent être idempotentes. Cela signifie que les tâches doivent tolérer l’interruption et le redémarrage sans provoquer d’altération ou de doublon des données. La meilleure pratique pour les tâches longues consiste à utiliser une forme de point de contrôle. Dans certains cas, startTask peut être réexécuter même si le nœud de calcul n’a pas été redémarré. Vous devez veiller à éviter les tâches StartTask qui créent un processus d’arrêt ou installent/lancent des services à partir du répertoire de travail StartTask, car cela empêche Batch de pouvoir réexécuter l’objet StartTask.
| Nom | Type | Description |
|---|---|---|
| commandLine |
string |
Ligne de commande de StartTask. La ligne de commande ne s’exécute pas sous un interpréteur de commandes et ne peut donc pas tirer parti des fonctionnalités de l’interpréteur de commandes telles que l’extension de variable d’environnement. Si vous souhaitez tirer parti de ces fonctionnalités, vous devez appeler l’interpréteur de commandes dans la ligne de commande, par exemple en utilisant « cmd /c MyCommand » dans Windows ou « /bin/sh -c MyCommand » dans Linux. Si la ligne de commande fait référence à des chemins de fichier, elle doit utiliser un chemin relatif (par rapport au répertoire de travail de tâche) ou utiliser la variable d’environnement fournie par Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). |
| containerSettings |
Les paramètres du conteneur sous lequel s’exécute la tâche Démarrer. Lorsque cela est spécifié, tous les répertoires sous le AZ_BATCH_NODE_ROOT_DIR (la racine des répertoires Azure Batch sur le nœud) sont mappés dans le conteneur, toutes les variables de l’environnement Tâche sont mappées dans le conteneur, et la ligne de commande Tâche est exécutée dans le conteneur. Les fichiers produits dans le conteneur en dehors de AZ_BATCH_NODE_ROOT_DIR peuvent ne pas être reflétés sur le disque hôte, ce qui signifie que les API de fichiers Batch ne pourront pas accéder à ces fichiers. |
|
| environmentSettings |
Liste des paramètres de variable d’environnement pour StartTask. |
|
| maxTaskRetryCount |
integer (int32) |
Nombre maximal de nouvelles tentatives de la tâche. Le service Batch retente une tâche si son code de sortie n’est pas différent de zéro. Notez que cette valeur contrôle spécifiquement le nombre de nouvelles tentatives. Le service Batch essaiera la tâche une seule fois et peut ensuite réessayer jusqu’à cette limite. Par exemple, si le nombre maximal de nouvelles tentatives est égal à 3, Batch tente la tâche jusqu’à 4 fois (une tentative initiale et 3 nouvelles tentatives). Si le nombre maximal de nouvelles tentatives est égal à 0, le service Batch ne réessaye pas la tâche. Si le nombre maximal de nouvelles tentatives est -1, le service Batch retente la tâche sans limite, mais cela n’est pas recommandé pour une tâche de démarrage ou une tâche. La valeur par défaut est 0 (aucune nouvelle tentative). |
| resourceFiles |
Liste des fichiers que le service Batch télécharge sur le nœud de calcul avant d’exécuter la ligne de commande. Il existe une taille maximale pour la liste des fichiers de ressources. Lorsque la taille maximale est dépassée, la requête échoue et le code d’erreur de réponse est RequestEntityTooLarge. Si cela se produit, la collection de ResourceFiles doit être réduite en taille. Pour ce faire, vous pouvez utiliser des fichiers .zip, des packages d’application ou des conteneurs Docker. Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche. |
|
| userIdentity |
L’identité utilisateur sous laquelle s’exécute la StartTask. Si elle est omise, la tâche s’exécute en tant qu’utilisateur non administratif unique à la tâche. |
|
| waitForSuccess |
boolean |
Indique si le service Batch doit attendre que StartTask se termine correctement (autrement dit, pour quitter avec le code de sortie 0) avant de planifier des tâches sur le nœud de calcul. Si la valeur est true et que StartTask échoue sur un nœud, le service Batch retente la tâche StartTask jusqu’à son nombre maximal de nouvelles tentatives (maxTaskRetryCount). Si la tâche n’est toujours pas terminée après toutes les nouvelles tentatives, le service Batch marque le nœud inutilisable et ne planifie pas les tâches. Cette condition peut être détectée via les détails de l’état du nœud de calcul et des informations d’échec. Si la valeur est false, le service Batch n’attend pas la fin de l’opération StartTask. Dans ce cas, d’autres tâches peuvent commencer à s’exécuter sur le nœud de calcul pendant l’exécution de StartTask ; et même si StartTask échoue, les nouvelles tâches continuent d’être planifiées sur le nœud de calcul. La valeur par défaut est true. |
BatchTaskContainerSettings
Paramètres de conteneur d’une tâche.
| Nom | Type | Description |
|---|---|---|
| containerHostBatchBindMounts |
Chemins que vous souhaitez monter sur la tâche conteneur. Si ce tableau est null ou n’est pas présent, la tâche de conteneur monte l’intégralité du lecteur de disque temporaire dans windows (ou AZ_BATCH_NODE_ROOT_DIR sous Linux). Il ne monte aucun chemin de données dans un conteneur si ce tableau est défini comme vide. |
|
| containerRunOptions |
string |
Options supplémentaires pour la commande de création de conteneur. Ces options supplémentaires sont fournies en tant qu’arguments de la commande « docker create », en plus de celles contrôlées par le service Batch. |
| imageName |
string |
L’image à utiliser pour créer le conteneur dans lequel la tâche s’exécutera. Voici la référence complète de l’image, comme cela serait spécifié pour « docker pull ». Si aucune étiquette n’est fournie dans le nom de l’image, la balise « :lont » est utilisée par défaut. |
| registry |
Le registre privé qui contient l’image du conteneur. Ce paramètre peut être omis si cela a déjà été proposé lors de la création du pool. |
|
| workingDirectory |
L’emplacement du répertoire de travail Tâches du conteneur. La valeur par défaut est « taskWorkingDirectory ». |
BatchTaskSchedulingPolicy
Spécifie la façon dont les tâches doivent être distribuées entre les nœuds de calcul.
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| jobDefaultOrder | none |
Ordre de planification des tâches de différents travaux ayant la même priorité. S’il n’est pas spécifié, la valeur par défaut est none. |
|
| nodeFillType |
Comment les tâches sont distribuées entre les nœuds de calcul d’un pool. S’il n’est pas spécifié, la valeur par défaut est répartie. |
BatchUefiSettings
Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle.
| Nom | Type | Description |
|---|---|---|
| secureBootEnabled |
boolean |
Spécifie si le démarrage sécurisé doit être activé sur la machine virtuelle. |
| vTpmEnabled |
boolean |
Spécifie si vTPM doit être activé sur la machine virtuelle. |
BatchUserAssignedIdentity
Identité affectée par l’utilisateur
| Nom | Type | Description |
|---|---|---|
| clientId |
string |
ID client de l’identité affectée par l’utilisateur. |
| principalId |
string |
L’identifiant principal de l’identité attribuée par l’utilisateur. |
| resourceId |
string (arm-id) |
ID de ressource ARM de l’identité affectée par l’utilisateur. |
BatchVmDiskSecurityProfile
Spécifie les paramètres du profil de sécurité pour le disque managé. Remarque : Il ne peut être défini que pour les machines virtuelles confidentielles et requis lors de l’utilisation de machines virtuelles confidentielles.
| Nom | Type | Description |
|---|---|---|
| securityEncryptionType |
Spécifie le EncryptionType du disque managé. Il est défini sur VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState. Remarque : Il ne peut être défini que pour les machines virtuelles confidentielles et est requis lors de l’utilisation de machines virtuelles confidentielles. |
BatchVmImageReference
Référence à une image de la Place de marché de machines virtuelles Azure ou à une image de galerie de calcul Azure. Pour obtenir la liste de toutes les références d’images de la Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Liste des images prises en charge ».
| Nom | Type | Description |
|---|---|---|
| communityGalleryImageId |
string |
L’image de la galerie communautaire identifie uniquement. Cette propriété s’exclue mutuellement avec d’autres propriétés et peut être extraite de l’appel GET de la galerie de la galerie de communautés. |
| exactVersion |
string |
La version spécifique de l’image de plateforme ou de l’image marketplace utilisée pour créer le nœud. Ce champ en lecture seule diffère de « version » uniquement si la valeur spécifiée pour « version » lors de la création du pool était « plus récente ». |
| offer |
string |
Le type d’offre de l’image Azure Virtual Machines Marketplace. Par exemple, UbuntuServer ou WindowsServer. |
| publisher |
string |
L’éditeur de l’image Azure Virtual Machines Marketplace. Par exemple, Canonical ou MicrosoftWindowsServer. |
| sharedGalleryImageId |
string |
L’identifiant unique de l’image de galerie partagée. Cette propriété s’exclue mutuellement avec d’autres propriétés et peut être extraite de l’appel GET de l’image de galerie partagée. |
| sku |
string |
Le SKU de l’image Azure Virtual Machines Marketplace. Par exemple, 18.04-LTS ou 2019-Datacenter. |
| version |
string |
La version de l’image Azure Virtual Machines Marketplace. Une valeur de « plus tard » peut être spécifiée pour sélectionner la dernière version d’une image. S’il est omis, la valeur par défaut est « latest ». |
| virtualMachineImageId |
string (arm-id) |
Identificateur de ressource ARM de l’image de la galerie de calcul Azure. Les nœuds de calcul du pool seront créés à l’aide de cet identifiant d’image. Ceci prend la forme /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} pour toujours utiliser par défaut la dernière version de l’image. Cette propriété est mutuellement exclusive avec les autres propriétés ImageReference. L’image de la galerie Azure Compute doit avoir des répliques dans la même région et être dans le même abonnement que le compte Azure Batch. Si la version de l’image n’est pas spécifiée dans l’imageId, la version la plus récente sera utilisée. Pour des informations sur les paramètres de pare-feu de l’agent du nœud de calcul batch afin de communiquer avec le service Batch, voir https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. |
CachingType
Enums CachingType
| Valeur | Description |
|---|---|
| none |
Le mode de mise en cache du disque n’est pas activé. |
| readonly |
Le mode de mise en cache du disque est en lecture seule. |
| readwrite |
Le mode de mise en cache du disque est en lecture et en écriture. |
CifsMountConfiguration
Informations utilisées pour se connecter à un système de fichiers CIFS.
| Nom | Type | Description |
|---|---|---|
| mountOptions |
string |
Options de ligne de commande supplémentaires à passer à la commande de montage. Il s’agit des options « net use » dans les options Windows et « mount » dans Linux. |
| password |
string (password) |
Mot de passe à utiliser pour l’authentification auprès du système de fichiers CIFS. |
| relativeMountPath |
string |
Le chemin relatif sur le nœud de calcul où le système de fichiers sera monté. Tous les systèmes de fichiers sont montés par rapport au répertoire de montage Batch, accessible via la variable d’environnement AZ_BATCH_NODE_MOUNTS_DIR. |
| source |
string |
URI du système de fichiers à monter. |
| username |
string |
Utilisateur à utiliser pour l’authentification auprès du système de fichiers CIFS. |
ContainerHostBatchBindMountEntry
Entrée du chemin d’accès et du mode montage que vous souhaitez monter dans le conteneur de tâches.
| Nom | Type | Description |
|---|---|---|
| isReadOnly |
boolean |
Montez ce chemin source en mode lecture seule ou non. La valeur par défaut est false (mode lecture/écriture). Pour Linux, si vous montez ce chemin en mode lecture/écriture, cela ne signifie pas que tous les utilisateurs du conteneur disposent de l’accès en lecture/écriture pour le chemin d’accès, cela dépend de l’accès dans la machine virtuelle hôte. Si ce chemin d’accès est monté en lecture seule, tous les utilisateurs du conteneur ne pourront pas modifier le chemin d’accès. |
| source |
Le chemin d’accès à monter sur le client conteneur peut être sélectionné. |
ContainerHostDataPath
Chemins d’accès qui seront montés sur le conteneur de la tâche de conteneur.
| Valeur | Description |
|---|---|
| Shared |
Chemin d’accès de la tâche multi-instances pour partager leurs fichiers. |
| Startup |
Chemin d’accès de la tâche de démarrage. |
| VfsMounts |
Le chemin d’accès contient tous les systèmes de fichiers virtuels sont montés sur ce nœud. |
| Task |
Chemin d’accès de la tâche. |
| JobPrep |
Chemin de la tâche de préparation du travail. |
| Applications |
Chemin d’accès des applications. |
ContainerRegistryReference
Registre de conteneurs privé.
| Nom | Type | Description |
|---|---|---|
| identityReference |
Référence à l’identité affectée par l’utilisateur à utiliser pour accéder à azure Container Registry au lieu du nom d’utilisateur et du mot de passe. |
|
| password |
string (password) |
Mot de passe pour vous connecter au serveur de Registre. |
| registryServer |
string (uri) |
L’URL du registre. S’il est omis, la valeur par défaut est « docker.io ». |
| username |
string |
Nom d’utilisateur à connecter au serveur de Registre. |
ContainerType
Enums ContainerType
| Valeur | Description |
|---|---|
| dockerCompatible |
Une technologie de conteneur compatible Docker sera utilisée pour lancer les conteneurs. |
| criCompatible |
Une technologie basée sur CRI sera utilisée pour lancer les conteneurs. |
ContainerWorkingDirectory
ContainerWorkingDirectory enums
| Valeur | Description |
|---|---|
| taskWorkingDirectory |
Utilisez le répertoire de travail standard du service Batch Task, qui contiendra les fichiers de ressources de la tâche remplis par Batch. |
| containerImageDefault |
Utilisez le répertoire de travail défini dans l’image du conteneur. Attention : ce répertoire ne contiendra pas les fichiers de ressources téléchargés par Batch. |
DataDisk
Paramètres qui seront utilisés par les disques de données associés aux nœuds de calcul dans le pool. Lorsque vous utilisez des disques de données attachés, vous devez monter et mettre en forme les disques à partir d’une machine virtuelle pour les utiliser.
| Nom | Type | Description |
|---|---|---|
| caching |
Type de mise en cache à activer pour les disques de données. La valeur par défaut de la mise en cache est readwrite. Pour plus d’informations sur les options de mise en cache, consultez : https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. |
|
| diskSizeGB |
integer (int32) |
Taille du disque initial en gigaoctets. |
| lun |
integer (int32) |
Numéro d’unité logique. LogicalUnitNumber est utilisé pour identifier de manière unique chaque disque de données. Si vous attachez plusieurs disques, chacun doit avoir un numéro d’unité logique distinct. La valeur doit être comprise entre 0 et 63, inclus. |
| managedDisk |
Paramètres de disque managé. |
|
| storageAccountType |
Type de compte de stockage à utiliser pour le disque de données. S’il est omis, la valeur par défaut est « standard_lrs ». |
DiffDiskPlacement
Spécifie le placement éphémère du disque du système d’exploitation pour tous les nœuds de calcul (VM) du pool. Cette propriété peut être utilisée par l’utilisateur dans la demande pour choisir l’emplacement dans lequel le système d’exploitation doit se trouver. Par exemple, cachez l’espace disque pour l’approvisionnement de disque de système d’exploitation éphémère. Pour plus d’informations sur les exigences en taille de disque d’OS éphémère, veuillez consulter les exigences de taille de disque pour les machines virtuelles Windows à https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements et Linux à https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements
| Valeur | Description |
|---|---|
| cachedisk |
Le disque de système d’exploitation éphémère est stocké sur le cache de la machine virtuelle. |
DiskCustomerManagedKey
Référence de la clé gérée par le client pour chiffrer le disque.
| Nom | Type | Description |
|---|---|---|
| identityReference |
Référence de l’une des identités de pool à chiffrer Disk. Cette identité sera utilisée pour accéder au KeyVault. |
|
| keyUrl |
string |
URL de clé entièrement versionnée pointant vers une clé dans KeyVault. Le segment de version de l’URL est requis, quelle que soit la valeur rotationToLatestKeyVersionEnabled. |
| rotationToLatestKeyVersionEnabled |
boolean |
Définissez cet indicateur sur true pour activer la mise à jour automatique du chiffrement de disque vers la dernière version de la clé. La valeur par défaut est false. |
DiskEncryptionConfiguration
Configuration de chiffrement de disque appliquée aux nœuds de calcul du pool. La configuration du chiffrement de disque n’est pas prise en charge sur le pool Linux créé avec l’image de la galerie de calcul Azure.
| Nom | Type | Description |
|---|---|---|
| customerManagedKey |
Référence de clé gérée par le client pour chiffrer le disque du système d’exploitation. La clé gérée par le client chiffrera le disque du système d’exploitation par EncryptionAtRest, et par défaut, nous chiffrerons également le disque de données. Il ne peut être utilisé que lorsque le pool est configuré avec une identité et qu’OsDisk est défini comme l’une des cibles de DiskEncryption. |
|
| targets |
La liste des cibles de disque batch Service chiffre sur le nœud de calcul. La liste des cibles de disque batch Service chiffre sur le nœud de calcul. |
DiskEncryptionSetParameters
ID de ressource ARM du jeu de chiffrement de disque.
| Nom | Type | Description |
|---|---|---|
| id |
string (arm-id) |
ID de ressource ARM du jeu de chiffrement de disque. La ressource doit se trouver dans le même abonnement que le compte Batch. |
DiskEncryptionTarget
Enums DiskEncryptionTarget
| Valeur | Description |
|---|---|
| osdisk |
Le disque du système d’exploitation sur le nœud de calcul est chiffré. |
| temporarydisk |
Le disque temporaire sur le nœud de calcul est chiffré. Sur Linux, ce chiffrement s’applique à d’autres partitions (telles que celles sur des disques de données montés) lorsque le chiffrement se produit au moment du démarrage. |
DynamicVNetAssignmentScope
DynamicVNetAssignmentScope enums
| Valeur | Description |
|---|---|
| none |
Aucune attribution de réseau virtuel dynamique n’est activée. |
| job |
L’attribution de réseau virtuel dynamique est effectuée par travail. |
ElevationLevel
Enums de niveau d’élévation
| Valeur | Description |
|---|---|
| nonadmin |
L’utilisateur est un utilisateur standard sans accès élevé. |
| admin |
L’utilisateur est un utilisateur disposant d’un accès élevé et fonctionne avec des autorisations d’administrateur complètes. |
EnvironmentSetting
Variable d’environnement à définir sur un processus de tâche.
| Nom | Type | Description |
|---|---|---|
| name |
string |
Nom de la variable d’environnement. |
| value |
string |
Valeur de la variable d’environnement. |
HostEndpointSettings
Spécifie des paramètres de point de terminaison d’hôte particuliers.
| Nom | Type | Description |
|---|---|---|
| inVMAccessControlProfileReferenceId |
string |
Spécifie la référence à l’ID de ressource InVMAccessControlProfileVersion sous la forme /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}. |
| mode |
Spécifie le mode d’exécution de la politique de contrôle d’accès. |
HostEndpointSettingsModeTypes
HostEndpointSettingsModeTypes enums
| Valeur | Description |
|---|---|
| Audit |
En mode Audit, le système agit comme s’il applique la stratégie de contrôle d’accès, y compris l’émission d’entrées de déni d’accès dans les journaux, mais il ne refuse pas réellement les demandes aux points de terminaison hôtes. |
| Enforce |
Le mode d’application est le mode de fonctionnement recommandé et le système appliquera la politique de contrôle d’accès. Cette propriété ne peut pas être utilisée avec « inVMAccessControlProfileReferenceId ». |
InboundEndpointProtocol
InboundEndpointProtocol enums
| Valeur | Description |
|---|---|
| tcp |
Utilisez TCP pour le point de terminaison. |
| udp |
Utilisez UDP pour le point de terminaison. |
IpAddressProvisioningType
IPAddressProvisioningType enums
| Valeur | Description |
|---|---|
| batchmanaged |
Une adresse IP publique sera créée et gérée par Batch. Il peut y avoir plusieurs adresses IP publiques en fonction de la taille du pool. |
| usermanaged |
Les adresses IP publiques sont fournies par l’utilisateur et seront utilisées pour approvisionner les nœuds de calcul. |
| nopublicipaddresses |
Aucune adresse IP publique ne sera créée. |
IPFamily
Familles d’adresses IP utilisées pour spécifier les versions d’adresses IP disponibles pour le pool.
| Valeur | Description |
|---|---|
| IPv4 |
IPv4 est disponible dans le pool. |
| IPv6 |
IPv6 est disponible pour le pool. |
IPTag
Contient la balise IP associée à l’adresse IP publique.
| Nom | Type | Description |
|---|---|---|
| ipTagType |
string |
Type de balise IP. Exemple : FirstPartyUsage. |
| tag |
string |
Valeur de la balise IP associée à l’adresse IP publique. Exemple : SQL. |
LinuxUserConfiguration
Propriétés utilisées pour créer un compte d’utilisateur sur un nœud de calcul Linux.
| Nom | Type | Description |
|---|---|---|
| gid |
integer (int32) |
L’identifiant de groupe pour le compte utilisateur. Les propriétés uid et gid doivent être spécifiées ensemble ou pas du tout. Si le système d’exploitation sous-jacent n’est pas spécifié, le gid est sélectionné. |
| sshPrivateKey |
string (password) |
La clé privée SSH pour le compte utilisateur. La clé privée ne doit pas être protégée par mot de passe. La clé privée est utilisée pour configurer automatiquement l’authentification basée sur une clé asymétrique pour SSH entre les nœuds de calcul dans un pool Linux lorsque la propriété d’activation InterNodeCommunication du pool est vraie (elle est ignorée si enableInterNodeCommunication est fausse). Pour ce faire, placez la paire de clés dans le répertoire .ssh de l’utilisateur. Si non spécifié, le SSH sans mot de passe n’est pas configuré entre les nœuds de calcul (aucune modification du répertoire .ssh de l’utilisateur n’est effectuée). |
| uid |
integer (int32) |
L’identifiant utilisateur du compte utilisateur. Les propriétés uid et gid doivent être spécifiées ensemble ou pas du tout. S’il n’est pas spécifié, le système d’exploitation sous-jacent sélectionne l’interface utilisateur. |
LoginMode
Enums LoginMode
| Valeur | Description |
|---|---|
| batch |
Mode de connexion Win32 LOGON32_LOGON_BATCH. Le mode de connexion par lots est recommandé pour les processus parallèles longs. |
| interactive |
Mode de connexion Win32 LOGON32_LOGON_INTERACTIVE. L’UAC est activé sur les pools Windows VirtualMachineConfiguration. Si cette option est utilisée avec une identité utilisateur élevée dans un pool de configuration Windows VirtualMachineConfiguration, la session utilisateur ne sera pas élevée à moins que l’application exécutée par la ligne de commande Task ne soit configurée pour toujours exiger un privilège administrateur ou un privilège maximal. |
ManagedDisk
Paramètres de disque managé.
| Nom | Type | Description |
|---|---|---|
| diskEncryptionSet |
Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé. Il ne peut être défini qu’en mode UserSubscription. |
|
| securityProfile |
Spécifie les paramètres du profil de sécurité pour le disque managé. |
|
| storageAccountType |
Type de compte de stockage pour disque managé. |
MountConfiguration
Système de fichiers à monter sur chaque nœud.
| Nom | Type | Description |
|---|---|---|
| azureBlobFileSystemConfiguration |
Conteneur de stockage Azure à monter à l’aide de FUSE d’objet blob sur chaque nœud. Cette propriété s’exclue mutuellement avec toutes les autres propriétés. |
|
| azureFileShareConfiguration |
Partage de fichiers Azure à monter sur chaque nœud. Cette propriété s’exclue mutuellement avec toutes les autres propriétés. |
|
| cifsMountConfiguration |
Système de fichiers CIFS/SMB à monter sur chaque nœud. Cette propriété s’exclue mutuellement avec toutes les autres propriétés. |
|
| nfsMountConfiguration |
Système de fichiers NFS à monter sur chaque nœud. Cette propriété s’exclue mutuellement avec toutes les autres propriétés. |
NameValuePair
Représente une paire nom-valeur.
| Nom | Type | Description |
|---|---|---|
| name |
string |
Le nom dans la paire nom-valeur. |
| value |
string |
La valeur dans la paire nom-valeur. |
NetworkConfiguration
Configuration réseau d’un pool.
| Nom | Type | Description |
|---|---|---|
| dynamicVNetAssignmentScope |
Étendue de l’attribution de réseau virtuel dynamique. |
|
| enableAcceleratedNetworking |
boolean |
Indique si ce pool doit activer la mise en réseau accélérée. La mise en réseau accélérée permet une virtualisation d’E/S racine unique (SR-IOV) vers une machine virtuelle, ce qui peut entraîner une amélioration des performances réseau. Pour plus d’informations, consultez : https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. |
| endpointConfiguration |
La configuration des points de terminaison sur les nœuds de calcul dans le Batch Pool. |
|
| publicIPAddressConfiguration |
Configuration IPAddress publique pour les nœuds de calcul dans le pool Batch. |
|
| subnetId |
string |
L’identifiant de ressource ARM du sous-réseau réseau virtuel auquel les nœuds de calcul du pool vont rejoindre. Il s’agit de la forme /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Le réseau virtuel doit se trouver dans la même région et dans le même abonnement que le compte Azure Batch. Le sous-réseau spécifié doit avoir suffisamment d’adresses IP libres pour accueillir le nombre de nœuds de calcul dans le pool. Si le sous-réseau ne dispose pas d’assez d’adresses IP libres, le pool allouera partiellement des nœuds et une erreur de redimensionnement se produira. Le principal de service « MicrosoftAzureBatch » doit avoir le rôle « Contributeur de machine virtuelle classique » Role-Based Contrôle d’accès (RBAC) pour le réseau virtuel spécifié. Le sous-réseau spécifié doit permettre la communication depuis le service batch Azure pour pouvoir planifier les tâches sur les nœuds. Cela peut être vérifié en vérifiant si le réseau virtuel spécifié a des groupes de sécurité réseau (NSG) associés. Si la communication aux nœuds dans le sous-réseau spécifié est refusée par un groupe de sécurité réseau, le service Batch définit l’état des nœuds de calcul sur inutilisable. Seuls les réseaux virtuels ARM (« Microsoft.Network/virtualNetworks ») sont pris en charge. Si le VNet spécifié possède des groupes de sécurité réseau (NSG) associés, alors quelques ports système réservés doivent être activés pour la communication entrante, y compris les ports 29876 et 29877. Activez également les connexions sortantes au stockage Azure sur le port 443. Pour plus d’informations, consultez : https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration |
NetworkSecurityGroupRule
Règle de groupe de sécurité réseau à appliquer à un point de terminaison entrant.
| Nom | Type | Description |
|---|---|---|
| access |
Action qui doit être effectuée pour une adresse IP, une plage de sous-réseaux ou une balise spécifiée. |
|
| priority |
integer (int32) |
Priorité de cette règle. Les priorités au sein d’un Pool doivent être uniques et évaluées par ordre de priorité. Plus le nombre est faible, plus la priorité est élevée. Par exemple, les règles peuvent être spécifiées avec des numéros de commande de 150, 250 et 350. La règle avec le numéro d’ordre de 150 est prioritaire sur la règle dont l’ordre est de 250. Les priorités autorisées sont de 150 à 4096. Si des valeurs réservées ou dupliquées sont fournies, la requête échoue avec le code d’état HTTP 400. |
| sourceAddressPrefix |
string |
Préfixe ou balise d’adresse source à mettre en correspondance pour la règle. Les valeurs valides sont une seule adresse IP (c’est-à-dire 10.10.10.10), un sous-réseau IP (par exemple, 192.168.1.0/24), une balise par défaut ou * (pour toutes les adresses). Si d’autres valeurs sont fournies, la requête échoue avec le code d’état HTTP 400. |
| sourcePortRanges |
string[] |
Plages de ports sources à mettre en correspondance pour la règle. Les valeurs valides sont « » (pour tous les ports 0 à 65535), un port spécifique (c’est-à-dire 22), ou une plage de ports (c’est-à-dire 100-200). Les ports doivent être dans la plage de 0 à 65535. Chaque entrée de cette collection ne doit pas chevaucher une autre entrée (ni une plage ni un port individuel). Si d’autres valeurs sont fournies, la requête échoue avec le code d’état HTTP 400. La valeur par défaut est « ». |
NetworkSecurityGroupRuleAccess
NetworkSecurityGroupRuleAccess enums
| Valeur | Description |
|---|---|
| allow |
Autoriser l’accès. |
| deny |
Refuser l’accès. |
NfsMountConfiguration
Informations utilisées pour se connecter à un système de fichiers NFS.
| Nom | Type | Description |
|---|---|---|
| mountOptions |
string |
Options de ligne de commande supplémentaires à passer à la commande de montage. Il s’agit des options « net use » dans les options Windows et « mount » dans Linux. |
| relativeMountPath |
string |
Le chemin relatif sur le nœud de calcul où le système de fichiers sera monté. Tous les systèmes de fichiers sont montés par rapport au répertoire de montage Batch, accessible via la variable d’environnement AZ_BATCH_NODE_MOUNTS_DIR. |
| source |
string |
URI du système de fichiers à monter. |
ProxyAgentSettings
Spécifie les paramètres ProxyAgent lors de la création de la machine virtuelle.
| Nom | Type | Description |
|---|---|---|
| enabled |
boolean |
Spécifie si la fonctionnalité Protocole de sécurité des métadonnées doit être activée sur la machine virtuelle ou le groupe de machines virtuelles identiques. La valeur par défaut est False. |
| imds |
Paramètres du point de terminaison IMDS. |
|
| wireServer |
Paramètres du point de terminaison WireServer. |
ResizeError
Erreur qui s’est produite lors du redimensionnement d’un pool.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Un identifiant pour l’erreur de redimensionnement du pool. Les codes sont invariants et sont destinés à être consommés par programme. |
| message |
string |
Un message décrivant l’erreur de redimensionnement du pool, destiné à être affiché dans une interface utilisateur. |
| values |
Une liste des détails supplémentaires sur l’erreur d’erreur de redimensionnement du pool. |
ResourceFile
Un seul fichier ou plusieurs fichiers à télécharger sur un nœud de calcul.
| Nom | Type | Description |
|---|---|---|
| autoStorageContainerName |
string |
Le nom du conteneur de stockage est dans le compte de stockage automatique. Les propriétés autoStorageContainerName, storageContainerUrl et httpUrl s’excluent mutuellement et l’une d’elles doit être spécifiée. |
| blobPrefix |
string |
Préfixe d’objet blob à utiliser lors du téléchargement d’objets blob à partir d’un conteneur stockage Azure. Seuls les objets blob dont les noms commencent par le préfixe spécifié sont téléchargés. La propriété est valide uniquement lorsque autoStorageContainerName ou storageContainerUrl est utilisé. Ce préfixe peut être un nom de fichier partiel ou un sous-répertoire. Si aucun préfixe n’est spécifié, tous les fichiers du conteneur sont téléchargés. |
| fileMode |
string |
Attribut du mode d’autorisation de fichier au format octal. Cette propriété ne s’applique qu’aux fichiers téléchargés vers des nœuds de calcul Linux. Il sera ignoré s’il est spécifié pour un resourceFile qui sera téléchargé sur un nœud de calcul Windows. Si cette propriété n’est pas spécifiée pour un nœud Linux Compute, alors une valeur par défaut de 0770 est appliquée au fichier. |
| filePath |
string |
L’emplacement sur le nœud de calcul vers lequel télécharger le(s) fichier(s), par rapport au répertoire de travail de la tâche. Si la propriété httpUrl est spécifiée, filePath est requis et décrit le chemin vers lequel le fichier sera téléchargé, y compris le nom de fichier. Sinon, si la propriété autoStorageContainerName ou storageContainerUrl est spécifiée, filePath est facultatif et est le répertoire dans lequel télécharger les fichiers. Dans le cas où filePath est utilisé comme répertoire, toute structure de répertoires déjà associée aux données d’entrée sera conservée dans son intégralité et ajoutée au répertoire filePath spécifié. Le chemin relatif spécifié ne peut pas sortir du répertoire de travail de la tâche (par exemple en utilisant '..'). |
| httpUrl |
string (uri) |
URL du fichier à télécharger. Les propriétés autoStorageContainerName, storageContainerUrl et httpUrl s’excluent mutuellement et l’une d’elles doit être spécifiée. Si l’URL pointe vers stockage Blob Azure, elle doit être lisible à partir de nœuds de calcul. Il existe trois façons d’obtenir cette URL pour un objet blob dans le stockage Azure : incluez une signature d’accès partagé (SAP) accordant des autorisations de lecture sur l’objet blob, utilisez une identité managée avec une autorisation de lecture ou définissez la liste de contrôle d’accès pour l’objet blob ou son conteneur afin d’autoriser l’accès public. |
| identityReference |
La référence à l’identité attribuée par l’utilisateur pour accéder à Azure Blob Storage spécifiée par storageContainerUrl ou httpUrl. |
|
| storageContainerUrl |
string (uri) |
URL du conteneur d’objets blob dans Stockage Blob Azure. Les propriétés autoStorageContainerName, storageContainerUrl et httpUrl s’excluent mutuellement et l’une d’elles doit être spécifiée. Cette URL doit être lisible et listable à partir de nœuds de calcul. Il existe trois façons d’obtenir une telle URL pour un conteneur dans le stockage Azure : inclure une signature d’accès partagé (SAP) accordant des autorisations de lecture et de liste sur le conteneur, utiliser une identité managée avec des autorisations de lecture et de liste, ou définir la liste de contrôle d’accès pour le conteneur afin d’autoriser l’accès public. |
RollingUpgradePolicy
Paramètres de configuration utilisés lors de l’exécution d’une mise à niveau propagée.
| Nom | Type | Description |
|---|---|---|
| enableCrossZoneUpgrade |
boolean |
Autorisez VMSS à ignorer les limites AZ lors de la construction de lots de mise à niveau. Prenez en compte le domaine de mise à jour et maxBatchInstancePercent pour déterminer la taille du lot. Ce champ peut être défini sur true ou false uniquement lors de l’utilisation de NodePlacementConfiguration comme Zonal. |
| maxBatchInstancePercent |
integer (int32) |
Pourcentage maximal d’instances de machines virtuelles totales qui seront mises à niveau simultanément par la mise à niveau propagée dans un lot. Comme il s’agit d’un nombre maximal d’instances non saines dans les lots précédents ou futurs, le pourcentage d’instances d’un lot peut diminuer pour garantir une fiabilité plus élevée. La valeur de ce champ doit être comprise entre 5 et 100, inclus. Si maxBatchInstancePercent et maxUnhealthyInstancePercent sont attribués avec la valeur, la valeur de maxBatchInstancePercent ne doit pas être supérieure à maxUnhealthyInstancePercent. |
| maxUnhealthyInstancePercent |
integer (int32) |
Pourcentage maximal des instances de machine virtuelle totales dans le groupe identique qui peuvent être simultanément non saines, soit en raison d’une mise à niveau, soit en étant trouvées dans un état non sain par les vérifications d’intégrité de la machine virtuelle avant l’abandon de la mise à niveau propagée. Cette contrainte sera vérifiée avant de démarrer un lot. La valeur de ce champ doit être comprise entre 5 et 100, inclus. Si maxBatchInstancePercent et maxUnhealthyInstancePercent sont attribués avec la valeur, la valeur de maxBatchInstancePercent ne doit pas être supérieure à maxUnhealthyInstancePercent. |
| maxUnhealthyUpgradedInstancePercent |
integer (int32) |
Pourcentage maximal d’instances de machine virtuelle mises à niveau qui peuvent être trouvées dans un état non sain. Cette vérification se produit après la mise à niveau de chaque lot. Si ce pourcentage est jamais dépassé, la mise à jour propagée abandonne. La valeur de ce champ doit être comprise entre 0 et 100, inclus. |
| pauseTimeBetweenBatches |
string (duration) |
Délai d’attente entre la fin de la mise à jour pour toutes les machines virtuelles d’un lot et le démarrage du lot suivant. La durée doit être spécifiée au format ISO 8601. |
| prioritizeUnhealthyInstances |
boolean |
Mettez à niveau toutes les instances non saines dans un groupe identique avant toutes les instances saines. |
| rollbackFailedInstancesOnPolicyBreach |
boolean |
Échec de restauration des instances dans le modèle précédent si la stratégie de mise à niveau propagée est enfreinte. |
SecurityEncryptionTypes
Enums SecurityEncryptionTypes
| Valeur | Description |
|---|---|
| DiskWithVMGuestState |
EncryptionType du disque managé est défini sur DiskWithVMGuestState pour le chiffrement du disque managé avec l’objet blob VMGuestState. Il n’est pas pris en charge dans les disques de données. |
| NonPersistedTPM |
EncryptionType du disque managé est défini sur NonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState. |
| VMGuestStateOnly |
EncryptionType du disque managé est défini sur VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState uniquement. |
SecurityProfile
Spécifie les paramètres de profil de sécurité de la machine virtuelle ou du groupe de machines virtuelles identiques.
| Nom | Type | Description |
|---|---|---|
| encryptionAtHost |
boolean |
Cette propriété peut être utilisée par l’utilisateur dans la demande pour activer ou désactiver le chiffrement de l’hôte pour la machine virtuelle ou le groupe de machines virtuelles identiques. Cela active le chiffrement pour tous les disques, y compris le disque Resource/Temp sur l’hôte lui-même. Pour plus d’informations sur le chiffrement aux exigences de l’hôte, reportez-vous à https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. |
| proxyAgentSettings |
Spécifie les paramètres ProxyAgent lors de la création de la machine virtuelle. |
|
| securityType |
Spécifie le SecurityType de la machine virtuelle. Il doit être défini sur n’importe quelle valeur spécifiée pour activer UefiSettings. |
|
| uefiSettings |
Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle. Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle. |
SecurityTypes
Spécifie le SecurityType de la machine virtuelle. Il doit être défini sur n’importe quelle valeur spécifiée pour activer UefiSettings.
| Valeur | Description |
|---|---|
| trustedLaunch |
Le lancement fiable protège contre les techniques d’attaque avancées et persistantes. |
| confidentialvm |
L’informatique confidentielle Azure offre des machines virtuelles confidentielles pour les locataires avec des exigences de sécurité et de confidentialité élevées. Ces machines virtuelles fournissent une limite stricte d’application matérielle pour répondre à vos besoins en matière de sécurité. Vous pouvez utiliser des machines virtuelles confidentielles pour les migrations sans apporter de modifications à votre code, avec la plateforme protégeant l’état de votre machine virtuelle contre la lecture ou la modification. |
ServiceArtifactReference
Spécifie l’ID de référence de l’artefact de service utilisé pour définir la même version d’image pour toutes les machines virtuelles du groupe identique lors de l’utilisation de la version d’image la plus récente.
| Nom | Type | Description |
|---|---|---|
| id |
string |
L’identifiant de référence d’artefact de service ServiceArtifactReference. ID de référence de l’artefact de service sous la forme de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} |
StorageAccountType
Énumérations StorageAccountType
| Valeur | Description |
|---|---|
| standard_lrs |
Le disque de données doit utiliser un stockage localement redondant standard. |
| premium_lrs |
Le disque de données doit utiliser un stockage localement redondant premium. |
| standardssd_lrs |
Le disque de données/disque du système d’exploitation doit utiliser un stockage SSD standard localement redondant. |
UpgradeMode
Enums UpgradeMode
| Valeur | Description |
|---|---|
| automatic |
Toutes les machines virtuelles du groupe identique sont automatiquement mises à jour en même temps. |
| manual |
Vous contrôlez l’application des mises à jour des machines virtuelles dans le groupe identique. Pour ce faire, utilisez l’action manualUpgrade. |
| rolling |
Les instances existantes d’un groupe identique sont supprimées par lots pour être mises à niveau. Une fois le lot mis à niveau terminé, les instances commencent à reprendre le trafic et le lot suivant commence. Cela se poursuit jusqu’à ce que toutes les instances ont apporté up-to-date. |
UpgradePolicy
Décrit une stratégie de mise à niveau : automatique, manuelle ou propagée.
| Nom | Type | Description |
|---|---|---|
| automaticOSUpgradePolicy |
Paramètres de configuration utilisés pour effectuer la mise à niveau automatique du système d’exploitation. Paramètres de configuration utilisés pour effectuer la mise à niveau automatique du système d’exploitation. |
|
| mode |
Spécifie le mode d’une mise à niveau vers des machines virtuelles dans le groupe identique. |
|
| rollingUpgradePolicy |
Paramètres de configuration utilisés lors de l’exécution d’une mise à niveau propagée. |
UserAccount
Propriétés utilisées pour créer un utilisateur utilisé pour exécuter des tâches sur un nœud de calcul Azure Batch.
| Nom | Type | Description |
|---|---|---|
| elevationLevel |
Le niveau d’élévation du compte utilisateur. La valeur par défaut n’est pasAdmin. |
|
| linuxUserConfiguration |
La configuration utilisateur spécifique à Linux pour le compte utilisateur. Cette propriété est ignorée si spécifiée sur un Windows Pool. S’il n’est pas spécifié, l’utilisateur est créé avec les options par défaut. |
|
| name |
string |
Le nom du compte utilisateur. Les noms peuvent contenir n’importe quel caractère Unicode jusqu’à une longueur maximale de 20. |
| password |
string (password) |
Le mot de passe du compte utilisateur. |
| windowsUserConfiguration |
La configuration utilisateur spécifique à Windows pour le compte utilisateur. Cette propriété ne peut être spécifiée que si l’utilisateur est sur un Windows Pool. Si non spécifié et sur un pool Windows, l’utilisateur est créé avec les options par défaut. |
UserIdentity
Définition de l’identité de l’utilisateur sous laquelle la tâche est exécutée. Spécifiez la propriété userName ou autoUser, mais pas les deux.
| Nom | Type | Description |
|---|---|---|
| autoUser |
L’utilisateur automatique sous lequel la tâche est exécutée. Les propriétés userName et autoUser s’excluent mutuellement ; vous devez en spécifier un, mais pas les deux. |
|
| username |
string |
Le nom de l’identité utilisateur sous laquelle la tâche est exécutée. Les propriétés userName et autoUser s’excluent mutuellement ; vous devez en spécifier un, mais pas les deux. |
VirtualMachineConfiguration
Configuration des nœuds de calcul dans un pool en fonction de l’infrastructure des machines virtuelles Azure.
| Nom | Type | Description |
|---|---|---|
| containerConfiguration |
La configuration du conteneur pour le Pool. Si spécifié, la configuration est effectuée sur chaque nœud de calcul du pool afin de permettre l’exécution des tâches dans des conteneurs. Toutes les tâches régulières et les tâches du gestionnaire de tâches qui s’exécutent sur ce pool doivent spécifier la propriété containerSettings, et toutes les autres tâches peuvent la spécifier. |
|
| dataDisks |
Data |
La configuration des disques de données attachés aux nœuds de calcul du pool. Cette propriété doit être spécifiée si les nœuds de calcul du pool doivent avoir des disques de données vides attachés à eux. Cela ne peut pas être mis à jour. Chaque nœud de calcul dispose de son propre disque (le disque n’est pas un partage de fichiers). Les disques existants ne peuvent pas être attachés, chaque disque connecté est vide. Lorsque le nœud de calcul est retiré du pool, le disque et toutes les données qui y sont associées sont également supprimés. Le disque n’est pas formaté après avoir été attaché, il doit l’être avant utilisation - pour plus d’informations, voir https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux et https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. |
| diskEncryptionConfiguration |
Configuration du chiffrement de disque pour le pool. Si spécifié, le chiffrement est effectué sur chaque nœud du pool pendant l’approvisionnement de nœuds. |
|
| extensions |
Extension de machine virtuelle pour le pool. Si elle est spécifiée, les extensions mentionnées dans cette configuration sont installées sur chaque nœud. |
|
| imageReference |
Référence à l’image de la Place de marché des machines virtuelles Azure ou à l’image de machine virtuelle personnalisée à utiliser. |
|
| licenseType |
string |
Cela ne s’applique qu’aux images contenant le système d’exploitation Windows, et ne doit être utilisée que lorsque vous détenez des licences valides sur site pour les nœuds de calcul qui seront déployés. En cas d’omission, aucune remise de licence locale n’est appliquée. Les valeurs sont les suivantes : Windows_Server : la licence locale est destinée à Windows Server. Windows_Client : la licence locale est destinée au client Windows. |
| nodeAgentSKUId |
string |
Référence (SKU) de l’agent Batch Compute Node à provisionner sur les nœuds de calcul du pool. L’agent Batch Compute Node est un programme qui s’exécute sur chaque nœud de calcul du pool et fournit l’interface de commande et de contrôle entre le nœud de calcul et le service Batch. Il existe différentes implémentations de l’agent de nœud de calcul, appelées références SKU, pour différents systèmes d’exploitation. Vous devez spécifier une référence SKU de l’agent Compute Node qui correspond à la référence d’image sélectionnée. Pour obtenir la liste des références SKU de l’agent de nœud de calcul prises en charge, ainsi que leur liste de références d’images vérifiées, consultez l’opération « Répertorier les références SKU de l’agent de nœud de calcul prises en charge ». |
| nodePlacementConfiguration |
Configuration de placement de nœud pour le pool. Cette configuration spécifie des règles sur la façon dont les nœuds du pool seront alloués physiquement. |
|
| osDisk |
Paramètres du disque du système d’exploitation de la machine virtuelle. |
|
| securityProfile |
Spécifie les paramètres de profil de sécurité de la machine virtuelle ou du groupe de machines virtuelles identiques. |
|
| serviceArtifactReference |
Spécifie l’ID de référence de l’artefact de service utilisé pour définir la même version d’image pour toutes les machines virtuelles du groupe identique lors de l’utilisation de la version d’image la plus récente. ID de référence de l’artefact de service sous la forme de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} |
|
| windowsConfiguration |
Paramètres du système d’exploitation Windows sur la machine virtuelle. Cette propriété ne doit pas être spécifiée si la propriété imageReference spécifie une image Linux OS. |
VMExtension
Configuration des extensions de machine virtuelle.
| Nom | Type | Description |
|---|---|---|
| autoUpgradeMinorVersion |
boolean |
Indique si l’extension doit utiliser une version mineure plus récente si elle est disponible au moment du déploiement. Une fois déployée, toutefois, l’extension ne met pas à niveau les versions mineures, sauf si elle est redéployée, même avec cette propriété définie sur true. |
| enableAutomaticUpgrade |
boolean |
Indique si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente de l’extension disponible. |
| name |
string |
Nom de l’extension de machine virtuelle. |
| protectedSettings |
object |
L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout. |
| provisionAfterExtensions |
string[] |
Collection de noms d’extensions. Collection de noms d’extensions après lesquels cette extension doit être provisionnée. |
| publisher |
string |
Nom du serveur de publication du gestionnaire d’extensions. |
| settings |
object |
Paramètres publics au format JSON pour l’extension. |
| type |
string |
Le type de l’extension. |
| typeHandlerVersion |
string |
Version du gestionnaire de scripts. |
WindowsConfiguration
Paramètres du système d’exploitation Windows à appliquer à la machine virtuelle.
| Nom | Type | Description |
|---|---|---|
| enableAutomaticUpdates |
boolean |
Indique si les mises à jour automatiques sont activées sur la machine virtuelle. Si elle est omise, la valeur par défaut est true. |
WindowsUserConfiguration
Propriétés utilisées pour créer un compte d’utilisateur sur un nœud de calcul Windows.
| Nom | Type | Description |
|---|---|---|
| loginMode |
Le mode de connexion pour l’utilisateur. Par défaut, c’est « batch ». |