Partager via


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 :

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.KeyVault/managedHSMs, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2020-04-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    createMode: 'string'
    enablePurgeProtection: bool
    enableSoftDelete: bool
    initialAdminObjectIds: [
      'string'
    ]
    softDeleteRetentionInDays: int
    tenantId: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

ManagedHsmProperties

Nom Description Valeur
createMode Mode de création pour indiquer si la ressource est en cours de création ou est récupérée à partir d’une ressource supprimée. 'default'
'récupérer'
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 irrécupérable difficile. 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 d’ID d’objet administrateurs initiaux pour ce pool hsm managé. string[]
softDeleteRetentionInDays Jours de rétention des données supprimées de manière réversible. Lorsque vous supprimez un HSM ou une clé, il reste récupérable pour la période de rétention configurée ou pendant une période par défaut de 90 jours. Elle accepte les valeurs comprises entre 7 et 90. Int
tenantId ID de locataire Azure Active Directory qui doit être utilisé pour l’authentification des requêtes auprès du pool HSM managé. corde

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}$

ManagedHsmResourceTags

Nom Description Valeur

ManagedHsmSku

Nom Description Valeur
Famille Famille de références SKU du pool HSM managé 'B' (obligatoire)
nom Référence SKU du pool HSM managé 'Custom_B32'
'Standard_B1' (obligatoire)

Microsoft.KeyVault/managedHSMs

Nom Description Valeur
emplacement Emplacement Azure pris en charge où le pool HSM managé doit être créé. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés du HSM managé ManagedHsmProperties
Sku Détails de la référence SKU ManagedHsmSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep Description
créer un HSM managé Azure Key Vault Ce modèle crée un HSM managé Azure Key Vault.

Définition de ressource de modèle ARM

Le type de ressource managedHSMs 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.KeyVault/managedHSMs, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "createMode": "string",
    "enablePurgeProtection": "bool",
    "enableSoftDelete": "bool",
    "initialAdminObjectIds": [ "string" ],
    "softDeleteRetentionInDays": "int",
    "tenantId": "string"
  },
  "sku": {
    "family": "string",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

ManagedHsmProperties

Nom Description Valeur
createMode Mode de création pour indiquer si la ressource est en cours de création ou est récupérée à partir d’une ressource supprimée. 'default'
'récupérer'
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 irrécupérable difficile. 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 d’ID d’objet administrateurs initiaux pour ce pool hsm managé. string[]
softDeleteRetentionInDays Jours de rétention des données supprimées de manière réversible. Lorsque vous supprimez un HSM ou une clé, il reste récupérable pour la période de rétention configurée ou pendant une période par défaut de 90 jours. Elle accepte les valeurs comprises entre 7 et 90. Int
tenantId ID de locataire Azure Active Directory qui doit être utilisé pour l’authentification des requêtes auprès du pool HSM managé. corde

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}$

ManagedHsmResourceTags

Nom Description Valeur

ManagedHsmSku

Nom Description Valeur
Famille Famille de références SKU du pool HSM managé 'B' (obligatoire)
nom Référence SKU du pool HSM managé 'Custom_B32'
'Standard_B1' (obligatoire)

Microsoft.KeyVault/managedHSMs

Nom Description Valeur
apiVersion Version de l’API '2020-04-01-preview'
emplacement Emplacement Azure pris en charge où le pool HSM managé doit être créé. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés du HSM managé ManagedHsmProperties
Sku Détails de la référence SKU ManagedHsmSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.KeyVault/managedHSMs'

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2020-04-01-preview"
  name = "string"
  location = "string"
  sku = {
    family = "string"
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      createMode = "string"
      enablePurgeProtection = bool
      enableSoftDelete = bool
      initialAdminObjectIds = [
        "string"
      ]
      softDeleteRetentionInDays = int
      tenantId = "string"
    }
  })
}

Valeurs de propriété

ManagedHsmProperties

Nom Description Valeur
createMode Mode de création pour indiquer si la ressource est en cours de création ou est récupérée à partir d’une ressource supprimée. 'default'
'récupérer'
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 irrécupérable difficile. 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 d’ID d’objet administrateurs initiaux pour ce pool hsm managé. string[]
softDeleteRetentionInDays Jours de rétention des données supprimées de manière réversible. Lorsque vous supprimez un HSM ou une clé, il reste récupérable pour la période de rétention configurée ou pendant une période par défaut de 90 jours. Elle accepte les valeurs comprises entre 7 et 90. Int
tenantId ID de locataire Azure Active Directory qui doit être utilisé pour l’authentification des requêtes auprès du pool HSM managé. corde

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}$

ManagedHsmResourceTags

Nom Description Valeur

ManagedHsmSku

Nom Description Valeur
Famille Famille de références SKU du pool HSM managé 'B' (obligatoire)
nom Référence SKU du pool HSM managé 'Custom_B32'
'Standard_B1' (obligatoire)

Microsoft.KeyVault/managedHSMs

Nom Description Valeur
emplacement Emplacement Azure pris en charge où le pool HSM managé doit être créé. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés du HSM managé ManagedHsmProperties
Sku Détails de la référence SKU ManagedHsmSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.KeyVault/managedHSMs@2020-04-01-preview »