Microsoft.Batch batchAccounts 2022-01-01
Définition de ressource Bicep
Le type de ressource batchAccounts peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez 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 de ressource
Pour créer une ressource Microsoft.Batch/batchAccounts, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.Batch/batchAccounts@2022-01-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'
}
poolAllocationMode: 'string'
publicNetworkAccess: 'string'
}
}
Valeurs de propriété
batchAccounts
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | chaîne (obligatoire) Limite de caractères : 3 à 24 Caractères valides : Lettres minuscules et chiffres. |
| emplacement | Région dans laquelle créer le compte. | chaîne (obligatoire) |
| étiquettes | Balises spécifiées par l’utilisateur associées au compte. | Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
| identité | Identité du compte Batch. | BatchAccountIdentity |
| Propriétés | 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 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 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 |
| 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 d’Azure Active Directory. Si le mode est UserSubscription, les clients doivent utiliser Azure Active Directory. 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. | corde |
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 complet du secret versionné. Exemple https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. 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 |
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) |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
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 :
- groupes de ressources - Consultez 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 de ressource
Pour créer une ressource Microsoft.Batch/batchAccounts, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.Batch/batchAccounts",
"apiVersion": "2022-01-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"
},
"poolAllocationMode": "string",
"publicNetworkAccess": "string"
}
}
Valeurs de propriété
batchAccounts
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | 'Microsoft.Batch/batchAccounts' |
| apiVersion | Version de l’API de ressource | '2022-01-01' |
| nom | Nom de la ressource | chaîne (obligatoire) Limite de caractères : 3 à 24 Caractères valides : Lettres minuscules et chiffres. |
| emplacement | Région dans laquelle créer le compte. | chaîne (obligatoire) |
| étiquettes | Balises spécifiées par l’utilisateur associées au compte. | Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
| identité | Identité du compte Batch. | BatchAccountIdentity |
| Propriétés | 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 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 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 |
| 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 d’Azure Active Directory. Si le mode est UserSubscription, les clients doivent utiliser Azure Active Directory. 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. | corde |
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 complet du secret versionné. Exemple https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. 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 |
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) |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
|
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 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 de ressource
Pour créer une ressource Microsoft.Batch/batchAccounts, ajoutez terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Batch/batchAccounts@2022-01-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"
}
poolAllocationMode = "string"
publicNetworkAccess = "string"
}
})
}
Valeurs de propriété
batchAccounts
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.Batch/batchAccounts@2022-01-01 » |
| nom | Nom de la ressource | chaîne (obligatoire) Limite de caractères : 3 à 24 Caractères valides : Lettres minuscules et chiffres. |
| emplacement | 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) |
| étiquettes | 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 |
| Propriétés | 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 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 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 |
| 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 d’Azure Active Directory. Si le mode est UserSubscription, les clients doivent utiliser Azure Active Directory. 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. | corde |
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 complet du secret versionné. Exemple https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. 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 |
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) |