Partager via


Microsoft.Batch BatchAccounts

Définition de ressource Bicep

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

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

Format de ressource

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

resource symbolicname 'Microsoft.Batch/batchAccounts@2024-07-01' = {
  scope: resourceSymbolicName or scope
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de la propriété

Microsoft.Batch/batchAccounts

Nom Descriptif Valeur
identité Identité du compte Batch. BatchAccountIdentity
emplacement Région dans laquelle créer le compte. chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 24
Modèle = ^[a-zA-Z0-9]+$ (obligatoire)
Propriétés Propriétés du compte Batch. BatchAccountCreatePropertiesOrBatchAccountProperties
portée Utilisez-la lors de la création d’une ressource dans une étendue différente de l’étendue de déploiement. Définissez cette propriété sur le nom symbolique d’une ressource pour appliquer la ressource d’extension .
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

AutoStorageBasePropertiesOrAutoStorageProperties

Nom Descriptif Valeur
mode d’authentification Mode d’authentification utilisé par le service Batch pour gérer le compte de stockage automatique. 'BatchAccountManagedIdentity'
'Clés de stockage'
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)

BatchAccountCreateParametersTags

Nom Descriptif Valeur

BatchAccountCreatePropertiesOrBatchAccountProperties

Nom Descriptif 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'
'Clé partagée'
'Jeton d’authentification tâche'
autoStorage Propriétés associées au compte de stockage automatique. AutoStorageBasePropertiesOrAutoStorageProperties
chiffrement Configure la façon dont les données client sont chiffrées à l’intérieur du compte Batch. Par défaut, les comptes sont chiffrés à l’aide d’une clé gérée par 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 de service Batch. Si le mode est BatchService, les clients peuvent s’authentifier à l’aide de clés d’accès ou de l’ID Microsoft Entra. Si le mode est UserSubscription, les clients doivent utiliser l’ID Microsoft Entra. La valeur par défaut est BatchService. 'BatchService'
'Abonnement utilisateur'
publicNetworkAccess Type d’accès réseau pour l’exploitation sur les ressources du compte Batch. 'Désactivé'
'Activé'
« SecuredByPerimeter »

BatchAccountIdentity

Nom Descriptif Valeur
type Type d’identité utilisé pour le compte Batch. « Aucun »
'SystemAssigned'
'UserAssigned' (obligatoire)
Identités attribuées par l'utilisateur Liste des identités utilisateur associées au compte Batch. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nom Descriptif Valeur

ComputeNodeIdentityReference

Nom Descriptif Valeur
identifiant de ressource ID de ressource ARM de l’identité affectée par l’utilisateur. corde

Propriétés de chiffrement

Nom Descriptif 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

EndpointAccessProfile

Nom Descriptif 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 Descriptif Valeur
action Action lorsque l’adresse IP du client est mise en correspondance. 'Allow' (obligatoire)
valeur Adresse IPv4 ou plage d’adresses IPv4 au format CIDR. chaîne (obligatoire)

KeyVaultProperties

Nom Descriptif Valeur
cléIdentificateur Chemin complet du 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
KeyVault a la protection contre la suppression réversible et le vidage activés
corde

Référence KeyVault

Nom Descriptif Valeur
pièce d'identité 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)

Profil réseau

Nom Descriptif Valeur
accountAccess 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

UserAssignedIdentities

Nom Descriptif Valeur

Exemples d’utilisation

Modules vérifiés Azure

Les modules vérifiés Azure suivants peuvent être utilisés pour déployer ce type de ressource.

Module Descriptif
compte Batch Module de ressources AVM pour le compte Batch

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Fichier Bicep Descriptif
pool Azure Batch sans adresses IP publiques Ce modèle crée un pool de communications de nœud simplifié Azure Batch 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 de modèle ARM

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

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

Format de ressource

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

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2024-07-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de la propriété

Microsoft.Batch/batchAccounts

Nom Descriptif Valeur
apiVersion Version de l’API '2024-07-01'
identité Identité du compte Batch. BatchAccountIdentity
emplacement Région dans laquelle créer le compte. chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 24
Modèle = ^[a-zA-Z0-9]+$ (obligatoire)
Propriétés Propriétés du compte Batch. BatchAccountCreatePropertiesOrBatchAccountProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.Batch/batchAccounts'

AutoStorageBasePropertiesOrAutoStorageProperties

Nom Descriptif Valeur
mode d’authentification Mode d’authentification utilisé par le service Batch pour gérer le compte de stockage automatique. 'BatchAccountManagedIdentity'
'Clés de stockage'
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)

BatchAccountCreateParametersTags

Nom Descriptif Valeur

BatchAccountCreatePropertiesOrBatchAccountProperties

Nom Descriptif 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'
'Clé partagée'
'Jeton d’authentification tâche'
autoStorage Propriétés associées au compte de stockage automatique. AutoStorageBasePropertiesOrAutoStorageProperties
chiffrement Configure la façon dont les données client sont chiffrées à l’intérieur du compte Batch. Par défaut, les comptes sont chiffrés à l’aide d’une clé gérée par 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 de service Batch. Si le mode est BatchService, les clients peuvent s’authentifier à l’aide de clés d’accès ou de l’ID Microsoft Entra. Si le mode est UserSubscription, les clients doivent utiliser l’ID Microsoft Entra. La valeur par défaut est BatchService. 'BatchService'
'Abonnement utilisateur'
publicNetworkAccess Type d’accès réseau pour l’exploitation sur les ressources du compte Batch. 'Désactivé'
'Activé'
« SecuredByPerimeter »

BatchAccountIdentity

Nom Descriptif Valeur
type Type d’identité utilisé pour le compte Batch. « Aucun »
'SystemAssigned'
'UserAssigned' (obligatoire)
Identités attribuées par l'utilisateur Liste des identités utilisateur associées au compte Batch. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nom Descriptif Valeur

ComputeNodeIdentityReference

Nom Descriptif Valeur
identifiant de ressource ID de ressource ARM de l’identité affectée par l’utilisateur. corde

Propriétés de chiffrement

Nom Descriptif 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

EndpointAccessProfile

Nom Descriptif 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 Descriptif Valeur
action Action lorsque l’adresse IP du client est mise en correspondance. 'Allow' (obligatoire)
valeur Adresse IPv4 ou plage d’adresses IPv4 au format CIDR. chaîne (obligatoire)

KeyVaultProperties

Nom Descriptif Valeur
cléIdentificateur Chemin complet du 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
KeyVault a la protection contre la suppression réversible et le vidage activés
corde

Référence KeyVault

Nom Descriptif Valeur
pièce d'identité 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)

Profil réseau

Nom Descriptif Valeur
accountAccess 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

UserAssignedIdentities

Nom Descriptif Valeur

Exemples d’utilisation

Modèles de démarrage rapide Microsoft Azure

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

Modèle Descriptif
pool Azure Batch sans adresses IP publiques

Déployer sur Azure
Ce modèle crée un pool de communications de nœud simplifié Azure Batch sans adresses IP publiques.
Créer un compte Batch à l’aide d’un modèle

Déployer sur Azure
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 :

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

Format de ressource

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Batch/batchAccounts@2024-07-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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 la propriété

Microsoft.Batch/batchAccounts

Nom Descriptif Valeur
identité Identité du compte Batch. BatchAccountIdentity
emplacement Région dans laquelle créer le compte. chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 24
Modèle = ^[a-zA-Z0-9]+$ (obligatoire)
parent_id ID de la ressource à laquelle appliquer cette ressource d’extension. chaîne (obligatoire)
Propriétés Propriétés du compte Batch. BatchAccountCreatePropertiesOrBatchAccountProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.Batch/batchAccounts@2024-07-01 »

AutoStorageBasePropertiesOrAutoStorageProperties

Nom Descriptif Valeur
mode d’authentification Mode d’authentification utilisé par le service Batch pour gérer le compte de stockage automatique. 'BatchAccountManagedIdentity'
'Clés de stockage'
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)

BatchAccountCreateParametersTags

Nom Descriptif Valeur

BatchAccountCreatePropertiesOrBatchAccountProperties

Nom Descriptif 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'
'Clé partagée'
'Jeton d’authentification tâche'
autoStorage Propriétés associées au compte de stockage automatique. AutoStorageBasePropertiesOrAutoStorageProperties
chiffrement Configure la façon dont les données client sont chiffrées à l’intérieur du compte Batch. Par défaut, les comptes sont chiffrés à l’aide d’une clé gérée par 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 de service Batch. Si le mode est BatchService, les clients peuvent s’authentifier à l’aide de clés d’accès ou de l’ID Microsoft Entra. Si le mode est UserSubscription, les clients doivent utiliser l’ID Microsoft Entra. La valeur par défaut est BatchService. 'BatchService'
'Abonnement utilisateur'
publicNetworkAccess Type d’accès réseau pour l’exploitation sur les ressources du compte Batch. 'Désactivé'
'Activé'
« SecuredByPerimeter »

BatchAccountIdentity

Nom Descriptif Valeur
type Type d’identité utilisé pour le compte Batch. « Aucun »
'SystemAssigned'
'UserAssigned' (obligatoire)
Identités attribuées par l'utilisateur Liste des identités utilisateur associées au compte Batch. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nom Descriptif Valeur

ComputeNodeIdentityReference

Nom Descriptif Valeur
identifiant de ressource ID de ressource ARM de l’identité affectée par l’utilisateur. corde

Propriétés de chiffrement

Nom Descriptif 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

EndpointAccessProfile

Nom Descriptif 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 Descriptif Valeur
action Action lorsque l’adresse IP du client est mise en correspondance. 'Allow' (obligatoire)
valeur Adresse IPv4 ou plage d’adresses IPv4 au format CIDR. chaîne (obligatoire)

KeyVaultProperties

Nom Descriptif Valeur
cléIdentificateur Chemin complet du 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
KeyVault a la protection contre la suppression réversible et le vidage activés
corde

Référence KeyVault

Nom Descriptif Valeur
pièce d'identité 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)

Profil réseau

Nom Descriptif Valeur
accountAccess 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

UserAssignedIdentities

Nom Descriptif Valeur

Exemples d’utilisation

Échantillons Terraform

Exemple de base de déploiement d’un compte Azure Batch.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "batchAccount" {
  type      = "Microsoft.Batch/batchAccounts@2022-10-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      encryption = {
        keySource = "Microsoft.Batch"
      }
      poolAllocationMode  = "BatchService"
      publicNetworkAccess = "Enabled"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Modules vérifiés Azure

Les modules vérifiés Azure suivants peuvent être utilisés pour déployer ce type de ressource.

Module Descriptif
compte Batch Module de ressources AVM pour le compte Batch