Microsoft.Batch batchAccounts

Article
03/16/2024

Définition de ressource Bicep

Le type de ressource batchAccounts peut être déployé avec des opérations qui ciblent :

Groupes de ressources - Voir commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Batch/batchAccounts, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Batch/batchAccounts@2023-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    allowedAuthenticationModes: [
      'string'
    ]
    autoStorage: {
      authenticationMode: 'string'
      nodeIdentityReference: {
        resourceId: 'string'
      }
      storageAccountId: 'string'
    }
    encryption: {
      keySource: 'string'
      keyVaultProperties: {
        keyIdentifier: 'string'
      }
    }
    keyVaultReference: {
      id: 'string'
      url: 'string'
    }
    networkProfile: {
      accountAccess: {
        defaultAction: 'string'
        ipRules: [
          {
            action: 'Allow'
            value: 'string'
          }
        ]
      }
      nodeManagementAccess: {
        defaultAction: 'string'
        ipRules: [
          {
            action: 'Allow'
            value: 'string'
          }
        ]
      }
    }
    poolAllocationMode: 'string'
    publicNetworkAccess: 'string'
  }
}

Valeurs de propriétés

batchAccounts

Nom	Description	Valeur
name	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 3-24 Caractères valides : Lettres minuscules et chiffres.
location	Région dans laquelle créer le compte.	chaîne (obligatoire)
tags	Balises spécifiées par l’utilisateur associées au compte.	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
identité	Identité du compte Batch.	BatchAccountIdentity
properties	Propriétés du compte Batch.	BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour le compte Batch.	'None' 'SystemAssigned' 'UserAssigned' (obligatoire)
userAssignedIdentities	Liste des identités d’utilisateur associées au compte Batch.	BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nom	Description	Valeur
{propriété personnalisée}		UserAssignedIdentities

UserAssignedIdentities

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Nom	Description	Valeur
allowedAuthenticationModes	Liste des modes d’authentification autorisés pour le compte Batch qui peuvent être utilisés pour s’authentifier auprès du plan de données. Cela n’affecte pas l’authentification avec le plan de contrôle.	Tableau de chaînes contenant l’un des éléments suivants : 'AAD' 'SharedKey' 'TaskAuthenticationToken'
autoStorage	Propriétés liées au compte de stockage automatique.	AutoStorageBasePropertiesOrAutoStorageProperties
le chiffrement	Configure la façon dont les données du client sont chiffrées à l’intérieur du compte Batch. Par défaut, les comptes sont chiffrés à l’aide d’une clé managée Microsoft. Pour un contrôle supplémentaire, une clé gérée par le client peut être utilisée à la place.	EncryptionProperties
keyVaultReference	Référence au coffre de clés Azure associé au compte Batch.	KeyVaultReference
networkProfile	Le profil réseau prend effet uniquement lorsque publicNetworkAccess est activé.	NetworkProfile
poolAllocationMode	Le mode d’allocation de pool affecte également la façon dont les clients peuvent s’authentifier auprès de l’API Batch Service. Si le mode est BatchService, les clients peuvent s’authentifier à l’aide de clés d’accès ou de Microsoft Entra ID. Si le mode est UserSubscription, les clients doivent utiliser Microsoft Entra ID. La valeur par défaut est BatchService.	'BatchService' 'UserSubscription'
publicNetworkAccess	Si elle n’est pas spécifiée, la valeur par défaut est « enabled ».	'Désactivé' 'Enabled'

AutoStorageBasePropertiesOrAutoStorageProperties

Nom	Description	Valeur
authenticationMode	Mode d’authentification utilisé par le service Batch pour gérer le compte de stockage automatique.	'BatchAccountManagedIdentity' 'StorageKeys'
nodeIdentityReference	L’identité référencée ici doit être affectée aux pools qui ont des nœuds de calcul qui ont besoin d’accéder au stockage automatique.	ComputeNodeIdentityReference
storageAccountId	ID de ressource du compte de stockage à utiliser pour le compte de stockage automatique.	string (obligatoire)

ComputeNodeIdentityReference

Nom	Description	Valeur
resourceId	ID de ressource ARM de l’identité affectée par l’utilisateur.	string

EncryptionProperties

Nom	Description	Valeur
keySource	Type de la source de clé.	'Microsoft.Batch' 'Microsoft.KeyVault'
keyVaultProperties	Détails supplémentaires lors de l’utilisation de Microsoft.KeyVault	KeyVaultProperties

KeyVaultProperties

Nom	Description	Valeur
keyIdentifier	Chemin d’accès complet au secret avec ou sans version. Par exemple : `https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053`. ou `https://mykeyvault.vault.azure.net/keys/testkey`. Pour être utilisable, les conditions préalables suivantes doivent être remplies : Le compte Batch a une identité affectée par le système L’identité de compte a reçu les autorisations Clé/Obtenir, Clé/Unwrap et Clé/Wrap La suppression réversible et la protection contre le vidage du coffre de clés sont activées	string

KeyVaultReference

Nom	Description	Valeur
id	ID de ressource du coffre de clés Azure associé au compte Batch.	string (obligatoire)
url	URL du coffre de clés Azure associé au compte Batch.	string (obligatoire)

NetworkProfile

Nom	Description	Valeur
Accèsclient	Profil d’accès réseau pour le point de terminaison batchAccount (API de plan de données de compte Batch).	EndpointAccessProfile
nodeManagementAccess	Profil d’accès réseau pour le point de terminaison nodeManagement (service Batch gérant les nœuds de calcul pour les pools Batch).	EndpointAccessProfile

EndpointAccessProfile

Nom	Description	Valeur
defaultAction	Action par défaut pour l’accès au point de terminaison. Elle s’applique uniquement lorsque publicNetworkAccess est activé.	'Autoriser' 'Deny' (obligatoire)
ipRules	Tableau de plages d’adresses IP pour filtrer l’adresse IP du client.	IPRule[]

IPRule

Nom	Description	Valeur
action	Action lorsque l’adresse IP du client est mise en correspondance.	'Allow' (obligatoire)
value	Adresse IPv4 ou plage d’adresses IPv4 au format CIDR.	string (obligatoire)

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Azure Batch pool sans adresses IP publiques	Ce modèle crée Azure Batch pool de communication de nœud simplifié sans adresses IP publiques.
Créer un compte Batch à l’aide d’un modèle	Ce modèle crée un compte Batch et un compte de stockage.

Définition de ressources de modèle ARM

Le type de ressource batchAccounts peut être déployé avec des opérations qui ciblent :

Groupes de ressources - Voir commandes de déploiement de groupe de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Batch/batchAccounts, ajoutez le CODE JSON suivant à votre modèle.

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2023-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "allowedAuthenticationModes": [ "string" ],
    "autoStorage": {
      "authenticationMode": "string",
      "nodeIdentityReference": {
        "resourceId": "string"
      },
      "storageAccountId": "string"
    },
    "encryption": {
      "keySource": "string",
      "keyVaultProperties": {
        "keyIdentifier": "string"
      }
    },
    "keyVaultReference": {
      "id": "string",
      "url": "string"
    },
    "networkProfile": {
      "accountAccess": {
        "defaultAction": "string",
        "ipRules": [
          {
            "action": "Allow",
            "value": "string"
          }
        ]
      },
      "nodeManagementAccess": {
        "defaultAction": "string",
        "ipRules": [
          {
            "action": "Allow",
            "value": "string"
          }
        ]
      }
    },
    "poolAllocationMode": "string",
    "publicNetworkAccess": "string"
  }
}

Valeurs de propriétés

batchAccounts

Nom	Description	Valeur
type	Type de ressource	« Microsoft.Batch/batchAccounts »
apiVersion	Version de l’API de ressource	'2023-11-01'
name	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 3-24 Caractères valides : Lettres minuscules et chiffres.
location	Région dans laquelle créer le compte.	chaîne (obligatoire)
tags	Balises spécifiées par l’utilisateur associées au compte.	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
identité	Identité du compte Batch.	BatchAccountIdentity
properties	Propriétés du compte Batch.	BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour le compte Batch.	'None' 'SystemAssigned' 'UserAssigned' (obligatoire)
userAssignedIdentities	Liste des identités d’utilisateur associées au compte Batch.	BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nom	Description	Valeur
{propriété personnalisée}		UserAssignedIdentities

UserAssignedIdentities

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Nom	Description	Valeur
allowedAuthenticationModes	Liste des modes d’authentification autorisés pour le compte Batch qui peuvent être utilisés pour s’authentifier auprès du plan de données. Cela n’affecte pas l’authentification avec le plan de contrôle.	Tableau de chaînes contenant l’un des éléments suivants : 'AAD' 'SharedKey' 'TaskAuthenticationToken'
autoStorage	Propriétés liées au compte de stockage automatique.	AutoStorageBasePropertiesOrAutoStorageProperties
le chiffrement	Configure la façon dont les données du client sont chiffrées à l’intérieur du compte Batch. Par défaut, les comptes sont chiffrés à l’aide d’une clé managée Microsoft. Pour un contrôle supplémentaire, une clé gérée par le client peut être utilisée à la place.	EncryptionProperties
keyVaultReference	Référence au coffre de clés Azure associé au compte Batch.	KeyVaultReference
networkProfile	Le profil réseau prend effet uniquement lorsque publicNetworkAccess est activé.	NetworkProfile
poolAllocationMode	Le mode d’allocation de pool affecte également la façon dont les clients peuvent s’authentifier auprès de l’API Batch Service. Si le mode est BatchService, les clients peuvent s’authentifier à l’aide de clés d’accès ou de Microsoft Entra ID. Si le mode est UserSubscription, les clients doivent utiliser Microsoft Entra ID. La valeur par défaut est BatchService.	'BatchService' 'UserSubscription'
publicNetworkAccess	Si elle n’est pas spécifiée, la valeur par défaut est « enabled ».	'Désactivé' 'Enabled'

AutoStorageBasePropertiesOrAutoStorageProperties

Nom	Description	Valeur
authenticationMode	Mode d’authentification utilisé par le service Batch pour gérer le compte de stockage automatique.	'BatchAccountManagedIdentity' 'StorageKeys'
nodeIdentityReference	L’identité référencée ici doit être affectée aux pools qui ont des nœuds de calcul qui ont besoin d’accéder au stockage automatique.	ComputeNodeIdentityReference
storageAccountId	ID de ressource du compte de stockage à utiliser pour le compte de stockage automatique.	chaîne (obligatoire)

ComputeNodeIdentityReference

Nom	Description	Valeur
resourceId	ID de ressource ARM de l’identité affectée par l’utilisateur.	string

EncryptionProperties

Nom	Description	Valeur
keySource	Type de la source de clé.	'Microsoft.Batch' 'Microsoft.KeyVault'
keyVaultProperties	Détails supplémentaires lors de l’utilisation de Microsoft.KeyVault	KeyVaultProperties

KeyVaultProperties

Nom	Description	Valeur
keyIdentifier	Chemin d’accès complet au secret avec ou sans version. Par exemple : `https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053`. ou `https://mykeyvault.vault.azure.net/keys/testkey`. Pour être utilisable, les conditions préalables suivantes doivent être remplies : Le compte Batch a une identité affectée par le système L’identité du compte a reçu les autorisations Key/Get, Key/Unwrap et Key/Wrap La suppression réversible et la protection contre la purge du coffre sont activées	string

KeyVaultReference

Nom	Description	Valeur
id	ID de ressource du coffre de clés Azure associé au compte Batch.	chaîne (obligatoire)
url	URL du coffre de clés Azure associé au compte Batch.	chaîne (obligatoire)

NetworkProfile

Nom	Description	Valeur
Accèsclient	Profil d’accès réseau pour le point de terminaison batchAccount (API de plan de données de compte Batch).	EndpointAccessProfile
nodeManagementAccess	Profil d’accès réseau pour le point de terminaison nodeManagement (service Batch gérant les nœuds de calcul pour les pools Batch).	EndpointAccessProfile

EndpointAccessProfile

Nom	Description	Valeur
defaultAction	Action par défaut pour l’accès au point de terminaison. Elle s’applique uniquement lorsque publicNetworkAccess est activé.	'Autoriser' 'Deny' (obligatoire)
ipRules	Tableau de plages d’adresses IP pour filtrer l’adresse IP du client.	IPRule[]

IPRule

Nom	Description	Valeur
action	Action lorsque l’adresse IP du client est mise en correspondance.	'Allow' (obligatoire)
value	Adresse IPv4 ou plage d’adresses IPv4 au format CIDR.	chaîne (obligatoire)

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Azure Batch pool sans adresses IP publiques	Ce modèle crée Azure Batch pool de communication de nœuds simplifié sans adresses IP publiques.
Créer un compte Batch à l’aide d’un modèle	Ce modèle crée un compte Batch et un compte de stockage.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource batchAccounts peut être déployé avec des opérations qui ciblent :

Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Batch/batchAccounts, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Batch/batchAccounts@2023-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      allowedAuthenticationModes = [
        "string"
      ]
      autoStorage = {
        authenticationMode = "string"
        nodeIdentityReference = {
          resourceId = "string"
        }
        storageAccountId = "string"
      }
      encryption = {
        keySource = "string"
        keyVaultProperties = {
          keyIdentifier = "string"
        }
      }
      keyVaultReference = {
        id = "string"
        url = "string"
      }
      networkProfile = {
        accountAccess = {
          defaultAction = "string"
          ipRules = [
            {
              action = "Allow"
              value = "string"
            }
          ]
        }
        nodeManagementAccess = {
          defaultAction = "string"
          ipRules = [
            {
              action = "Allow"
              value = "string"
            }
          ]
        }
      }
      poolAllocationMode = "string"
      publicNetworkAccess = "string"
    }
  })
}

Valeurs de propriétés

batchAccounts

Nom	Description	Valeur
type	Type de ressource	« Microsoft.Batch/batchAccounts@2023-11-01 »
name	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 3-24 Caractères valides : Lettres minuscules et chiffres.
location	Région dans laquelle créer le compte.	chaîne (obligatoire)
parent_id	Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources.	chaîne (obligatoire)
tags	Balises spécifiées par l’utilisateur associées au compte.	Dictionnaire de noms et de valeurs d’étiquettes.
identité	Identité du compte Batch.	BatchAccountIdentity
properties	Propriétés du compte Batch.	BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour le compte Batch.	« SystemAssigned » « UserAssigned » (obligatoire)
identity_ids	Liste des identités d’utilisateur associées au compte Batch.	Tableau d’ID d’identité utilisateur.

BatchAccountIdentityUserAssignedIdentities

Nom	Description	Valeur
{propriété personnalisée}		UserAssignedIdentities

UserAssignedIdentities

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Nom	Description	Valeur
allowedAuthenticationModes	Liste des modes d’authentification autorisés pour le compte Batch qui peuvent être utilisés pour s’authentifier auprès du plan de données. Cela n’affecte pas l’authentification avec le plan de contrôle.	Tableau de chaînes contenant l’un des éléments suivants : « AAD » « SharedKey » « TaskAuthenticationToken »
autoStorage	Propriétés liées au compte de stockage automatique.	AutoStorageBasePropertiesOrAutoStorageProperties
le chiffrement	Configure la façon dont les données du client sont chiffrées à l’intérieur du compte Batch. Par défaut, les comptes sont chiffrés à l’aide d’une clé managée Microsoft. Pour un contrôle supplémentaire, une clé gérée par le client peut être utilisée à la place.	EncryptionProperties
keyVaultReference	Référence au coffre de clés Azure associé au compte Batch.	KeyVaultReference
networkProfile	Le profil réseau prend effet uniquement lorsque publicNetworkAccess est activé.	NetworkProfile
poolAllocationMode	Le mode d’allocation de pool affecte également la façon dont les clients peuvent s’authentifier auprès de l’API Batch Service. Si le mode est BatchService, les clients peuvent s’authentifier à l’aide de clés d’accès ou de Microsoft Entra ID. Si le mode est UserSubscription, les clients doivent utiliser Microsoft Entra ID. La valeur par défaut est BatchService.	« BatchService » « UserSubscription »
publicNetworkAccess	Si elle n’est pas spécifiée, la valeur par défaut est « enabled ».	« Désactivé » « Activé »

AutoStorageBasePropertiesOrAutoStorageProperties

Nom	Description	Valeur
authenticationMode	Mode d’authentification utilisé par le service Batch pour gérer le compte de stockage automatique.	« BatchAccountManagedIdentity » « StorageKeys »
nodeIdentityReference	L’identité référencée ici doit être affectée aux pools qui ont des nœuds de calcul qui ont besoin d’accéder au stockage automatique.	ComputeNodeIdentityReference
storageAccountId	ID de ressource du compte de stockage à utiliser pour le compte de stockage automatique.	chaîne (obligatoire)

ComputeNodeIdentityReference

Nom	Description	Valeur
resourceId	ID de ressource ARM de l’identité affectée par l’utilisateur.	string

EncryptionProperties

Nom	Description	Valeur
keySource	Type de la source de clé.	« Microsoft.Batch » « Microsoft.KeyVault »
keyVaultProperties	Détails supplémentaires lors de l’utilisation de Microsoft.KeyVault	KeyVaultProperties

KeyVaultProperties

Nom	Description	Valeur
keyIdentifier	Chemin d’accès complet au secret avec ou sans version. Par exemple : `https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053`. ou `https://mykeyvault.vault.azure.net/keys/testkey`. Pour être utilisable, les conditions préalables suivantes doivent être remplies : Le compte Batch a une identité affectée par le système L’identité du compte a reçu les autorisations Key/Get, Key/Unwrap et Key/Wrap La suppression réversible et la protection contre la purge du coffre sont activées	string

KeyVaultReference

Nom	Description	Valeur
id	ID de ressource du coffre de clés Azure associé au compte Batch.	chaîne (obligatoire)
url	URL du coffre de clés Azure associé au compte Batch.	chaîne (obligatoire)

NetworkProfile

Nom	Description	Valeur
Accèsclient	Profil d’accès réseau pour le point de terminaison batchAccount (API de plan de données de compte Batch).	EndpointAccessProfile
nodeManagementAccess	Profil d’accès réseau pour le point de terminaison nodeManagement (service Batch gérant les nœuds de calcul pour les pools Batch).	EndpointAccessProfile

EndpointAccessProfile

Nom	Description	Valeur
defaultAction	Action par défaut pour l’accès au point de terminaison. Elle s’applique uniquement lorsque publicNetworkAccess est activé.	« Autoriser » « Refuser » (obligatoire)
ipRules	Tableau de plages d’adresses IP pour filtrer l’adresse IP du client.	IPRule[]

IPRule

Nom	Description	Valeur
action	Action lorsque l’adresse IP du client est mise en correspondance.	« Autoriser » (obligatoire)
value	Adresse IPv4 ou plage d’adresses IPv4 au format CIDR.	chaîne (obligatoire)

Microsoft.Batch batchAccounts

Définition de ressource Bicep

Format des ressources

Valeurs de propriétés

batchAccounts

BatchAccountIdentity

BatchAccountIdentityUserAssignedIdentities

UserAssignedIdentities

BatchAccountCreatePropertiesOrBatchAccountProperties

AutoStorageBasePropertiesOrAutoStorageProperties

ComputeNodeIdentityReference

EncryptionProperties

KeyVaultProperties

KeyVaultReference

NetworkProfile

EndpointAccessProfile

IPRule

Modèles de démarrage rapide

Définition de ressources de modèle ARM

Format des ressources

Valeurs de propriétés

batchAccounts

BatchAccountIdentity

BatchAccountIdentityUserAssignedIdentities

UserAssignedIdentities

BatchAccountCreatePropertiesOrBatchAccountProperties

AutoStorageBasePropertiesOrAutoStorageProperties

ComputeNodeIdentityReference

EncryptionProperties

KeyVaultProperties

KeyVaultReference

NetworkProfile

EndpointAccessProfile

IPRule

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Valeurs de propriétés

batchAccounts

BatchAccountIdentity

BatchAccountIdentityUserAssignedIdentities

UserAssignedIdentities

BatchAccountCreatePropertiesOrBatchAccountProperties

AutoStorageBasePropertiesOrAutoStorageProperties

ComputeNodeIdentityReference

EncryptionProperties

KeyVaultProperties

KeyVaultReference

NetworkProfile

EndpointAccessProfile

IPRule

Commentaires

Commentaires

Ressources supplémentaires