Microsoft.KeyVault managedHSMs 2020-04-01-preview
Définition de ressource Bicep
Le type de ressource managedHSMs 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 d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.KeyVault/managedHSMs, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.KeyVault/managedHSMs@2020-04-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
family: 'B'
name: 'string'
}
properties: {
createMode: 'string'
enablePurgeProtection: bool
enableSoftDelete: bool
initialAdminObjectIds: [
'string'
]
softDeleteRetentionInDays: int
tenantId: 'string'
}
}
Valeurs de propriétés
managedHSMs
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource | string (obligatoire) |
| location | Emplacement Azure pris en charge où le pool HSM managé doit être créé. | string |
| tags | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| sku | Détails de la référence SKU | ManagedHsmSku |
| properties | Propriétés du HSM managé | ManagedHsmProperties |
ManagedHsmProperties
| Nom | Description | Valeur |
|---|---|---|
| createMode | Mode de création pour indiquer si la ressource est en cours de création ou est en cours de récupération à partir d’une ressource supprimée. | 'default' 'recover' |
| enablePurgeProtection | Propriété spécifiant si la protection contre le vidage est activée pour ce pool HSM managé. La définition de cette propriété sur true active la protection contre le vidage pour ce pool HSM managé et son contenu. Seul le service HSM managé peut lancer une suppression définitive et irrécupérable. L’activation de cette fonctionnalité est irréversible. | bool |
| enableSoftDelete | Propriété permettant de spécifier si la fonctionnalité de « suppression réversible » est activée pour ce pool HSM managé. La suppression réversible est activée par défaut pour tous les HSM managés et est immuable. | bool |
| initialAdminObjectIds | Tableau d’ID d’objet administrateurs initiaux pour ce pool hsm managé. | string[] |
| softDeleteRetentionInDays | Jours de conservation des données supprimées de manière réversible. Lorsque vous supprimez un HSM ou une clé, il reste récupérable pendant la période de rétention configurée ou pendant une période par défaut de 90 jours. Il accepte les valeurs comprises entre 7 et 90. | int |
| tenantId | ID de locataire Azure Active Directory qui doit être utilisé pour l’authentification des demandes adressées au pool HSM managé. | string Contraintes : Longueur minimale = 36 Longueur maximale = 36 Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmSku
| Nom | Description | Valeur |
|---|---|---|
| famille | Famille de références SKU du pool HSM managé | 'B' (obligatoire) |
| name | Référence SKU du pool HSM managé | 'Custom_B32' 'Standard_B1' (obligatoire) |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
Créer un HSM managé Azure Key Vault |
Ce modèle crée un HSM managé Azure Key Vault. |
Définition de ressources de modèle ARM
Le type de ressource managedHSMs 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 d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.KeyVault/managedHSMs, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.KeyVault/managedHSMs",
"apiVersion": "2020-04-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"family": "B",
"name": "string"
},
"properties": {
"createMode": "string",
"enablePurgeProtection": "bool",
"enableSoftDelete": "bool",
"initialAdminObjectIds": [ "string" ],
"softDeleteRetentionInDays": "int",
"tenantId": "string"
}
}
Valeurs de propriétés
managedHSMs
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.KeyVault/managedHSM » |
| apiVersion | Version de l’API de ressource | « 2020-04-01-preview » |
| name | Nom de la ressource | chaîne (obligatoire) |
| location | Emplacement Azure pris en charge où le pool HSM managé doit être créé. | string |
| tags | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| sku | Détails de la référence SKU | ManagedHsmSku |
| properties | Propriétés du HSM managé | ManagedHsmProperties |
ManagedHsmProperties
| Nom | Description | Valeur |
|---|---|---|
| createMode | Mode de création pour indiquer si la ressource est en cours de création ou est en cours de récupération à partir d’une ressource supprimée. | 'default' 'récupérer' |
| enablePurgeProtection | Propriété spécifiant si la protection contre la purge est activée pour ce pool HSM managé. La définition de cette propriété sur true active la protection contre la purge de ce pool HSM managé et de son contenu. Seul le service HSM managé peut lancer une suppression difficile et irrécupérable. L’activation de cette fonctionnalité est irréversible. | bool |
| enableSoftDelete | Propriété permettant de spécifier si la fonctionnalité « suppression réversible » est activée pour ce pool HSM managé. La suppression réversible est activée par défaut pour tous les HSM managés et est immuable. | bool |
| initialAdminObjectIds | Tableau des ID d’objet des administrateurs initiaux pour ce pool hsm managé. | string[] |
| softDeleteRetentionInDays | Jours de rétention des données supprimés de manière réversible. Lorsque vous supprimez un HSM ou une clé, il reste récupérable pendant la période de rétention configurée ou pendant une période par défaut de 90 jours. Il accepte des valeurs comprises entre 7 et 90. | int |
| tenantId | ID de locataire Azure Active Directory qui doit être utilisé pour l’authentification des demandes adressées au pool HSM managé. | string Contraintes : Longueur minimale = 36 Longueur maximale = 36 Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmSku
| Nom | Description | Valeur |
|---|---|---|
| famille | Famille de références SKU du pool HSM managé | 'B' (obligatoire) |
| name | Référence SKU du pool HSM managé | 'Custom_B32' 'Standard_B1' (obligatoire) |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
| Créer un HSM managé Azure Key Vault |
Ce modèle crée un HSM managé Azure Key Vault. |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource managedHSMs 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.KeyVault/managedHSMs, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/managedHSMs@2020-04-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
createMode = "string"
enablePurgeProtection = bool
enableSoftDelete = bool
initialAdminObjectIds = [
"string"
]
softDeleteRetentionInDays = int
tenantId = "string"
}
sku = {
family = "B"
name = "string"
}
})
}
Valeurs de propriétés
managedHSMs
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.KeyVault/managedHSMs@2020-04-01-preview » |
| name | Nom de la ressource | chaîne (obligatoire) |
| location | Emplacement Azure pris en charge où le pool HSM managé doit être créé. | string |
| 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 de ressource | Dictionnaire de noms et de valeurs d’étiquettes. |
| sku | Détails de la référence SKU | ManagedHsmSku |
| properties | Propriétés du HSM managé | ManagedHsmProperties |
ManagedHsmProperties
| Nom | Description | Valeur |
|---|---|---|
| createMode | Mode de création pour indiquer si la ressource est en cours de création ou est en cours de récupération à partir d’une ressource supprimée. | « valeur par défaut » « récupérer » |
| enablePurgeProtection | Propriété spécifiant si la protection contre la purge est activée pour ce pool HSM managé. La définition de cette propriété sur true active la protection contre la purge de ce pool HSM managé et de son contenu. Seul le service HSM managé peut lancer une suppression difficile et irrécupérable. L’activation de cette fonctionnalité est irréversible. | bool |
| enableSoftDelete | Propriété permettant de spécifier si la fonctionnalité « suppression réversible » est activée pour ce pool HSM managé. La suppression réversible est activée par défaut pour tous les HSM managés et est immuable. | bool |
| initialAdminObjectIds | Tableau des ID d’objet des administrateurs initiaux pour ce pool hsm managé. | string[] |
| softDeleteRetentionInDays | Jours de rétention des données supprimés de manière réversible. Lorsque vous supprimez un HSM ou une clé, il reste récupérable pendant la période de rétention configurée ou pendant une période par défaut de 90 jours. Il accepte des valeurs comprises entre 7 et 90. | int |
| tenantId | ID de locataire Azure Active Directory qui doit être utilisé pour l’authentification des demandes adressées au pool HSM managé. | string Contraintes : Longueur minimale = 36 Longueur maximale = 36 Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmSku
| Nom | Description | Valeur |
|---|---|---|
| famille | Famille de références SKU du pool HSM managé | « B » (obligatoire) |
| name | Référence SKU du pool HSM managé | « Custom_B32 » « Standard_B1 » (obligatoire) |