Microsoft.KeyVault managedHSMs

Article
12/20/2024

Définition de ressource Bicep

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2024-04-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    createMode: 'string'
    enablePurgeProtection: bool
    enableSoftDelete: bool
    initialAdminObjectIds: [
      'string'
    ]
    networkAcls: {
      bypass: 'string'
      defaultAction: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
      virtualNetworkRules: [
        {
          id: 'string'
        }
      ]
    }
    publicNetworkAccess: 'string'
    regions: [
      {
        isPrimary: bool
        name: '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[]
networkAcls	Règles régissant l’accessibilité du coffre de clés à partir d’emplacements réseau spécifiques.	MhsmNetworkRuleSet
publicNetworkAccess	Contrôlez l’autorisation sur le HSM managé à partir de réseaux publics.	'Désactivé' 'Activé'
Régions	Liste de toutes les régions associées au pool hsm managé.	MhsmGeoReplicatedRegion[]
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' 'Custom_B6' 'Standard_B1' (obligatoire)

ManagedServiceIdentity

Nom	Description	Valeur
type	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obligatoire)
userAssignedIdentities	Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes.	UserAssignedIdentities

MhsmGeoReplicatedRegion

Nom	Description	Valeur
isPrimary	Valeur booléenne qui indique si la région est la région primaire ou une région secondaire.	Bool
nom	Nom de la région géorépliquée.	corde

MhsmipRule

Nom	Description	Valeur
valeur	Plage d’adresses IPv4 en notation CIDR, telle que « 124.56.78.91 » (adresse IP simple) ou « 124.56.78.0/24 » (toutes les adresses commençant par 124.56.78).	chaîne (obligatoire)

MhsmNetworkRuleSet

Nom	Description	Valeur
contourner	Indique ce que le trafic peut contourner les règles réseau. Il peut s’agir d'« AzureServices » ou de « Aucun ». S’il n’est pas spécifié, la valeur par défaut est « AzureServices ».	'AzureServices' 'None'
defaultAction	Action par défaut lorsqu’aucune règle d’ipRules et de virtualNetworkRules ne correspond. Cette opération est utilisée uniquement après l’évaluation de la propriété de contournement.	'Autoriser' 'Refuser'
ipRules	Liste des règles d’adresse IP.	MhsmipRule []
virtualNetworkRules	Liste des règles de réseau virtuel.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nom	Description	Valeur
id	ID de ressource complet d’un sous-réseau de réseau virtuel, tel que « /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1 ».	chaîne (obligatoire)

Microsoft.KeyVault/managedHSMs

Nom	Description	Valeur
identité	Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)	ManagedServiceIdentity
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

UserAssignedIdentities

Nom	Description	Valeur

UserAssignedIdentity

Nom	Description	Valeur

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 :

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

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2024-04-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "createMode": "string",
    "enablePurgeProtection": "bool",
    "enableSoftDelete": "bool",
    "initialAdminObjectIds": [ "string" ],
    "networkAcls": {
      "bypass": "string",
      "defaultAction": "string",
      "ipRules": [
        {
          "value": "string"
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "string"
        }
      ]
    },
    "publicNetworkAccess": "string",
    "regions": [
      {
        "isPrimary": "bool",
        "name": "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[]
networkAcls	Règles régissant l’accessibilité du coffre de clés à partir d’emplacements réseau spécifiques.	MhsmNetworkRuleSet
publicNetworkAccess	Contrôlez l’autorisation sur le HSM managé à partir de réseaux publics.	'Désactivé' 'Activé'
Régions	Liste de toutes les régions associées au pool hsm managé.	MhsmGeoReplicatedRegion[]
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' 'Custom_B6' 'Standard_B1' (obligatoire)

ManagedServiceIdentity

Nom	Description	Valeur
type	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obligatoire)
userAssignedIdentities	Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes.	UserAssignedIdentities

MhsmGeoReplicatedRegion

Nom	Description	Valeur
isPrimary	Valeur booléenne qui indique si la région est la région primaire ou une région secondaire.	Bool
nom	Nom de la région géorépliquée.	corde

MhsmipRule

Nom	Description	Valeur
valeur	Plage d’adresses IPv4 en notation CIDR, telle que « 124.56.78.91 » (adresse IP simple) ou « 124.56.78.0/24 » (toutes les adresses commençant par 124.56.78).	chaîne (obligatoire)

MhsmNetworkRuleSet

Nom	Description	Valeur
contourner	Indique ce que le trafic peut contourner les règles réseau. Il peut s’agir d'« AzureServices » ou de « Aucun ». S’il n’est pas spécifié, la valeur par défaut est « AzureServices ».	'AzureServices' 'None'
defaultAction	Action par défaut lorsqu’aucune règle d’ipRules et de virtualNetworkRules ne correspond. Cette opération est utilisée uniquement après l’évaluation de la propriété de contournement.	'Autoriser' 'Refuser'
ipRules	Liste des règles d’adresse IP.	MhsmipRule []
virtualNetworkRules	Liste des règles de réseau virtuel.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nom	Description	Valeur
id	ID de ressource complet d’un sous-réseau de réseau virtuel, tel que « /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1 ».	chaîne (obligatoire)

Microsoft.KeyVault/managedHSMs

Nom	Description	Valeur
apiVersion	Version de l’API	'2024-04-01-preview'
identité	Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)	ManagedServiceIdentity
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'

UserAssignedIdentities

Nom	Description	Valeur

UserAssignedIdentity

Nom	Description	Valeur

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 de ressource

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2024-04-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    family = "string"
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      createMode = "string"
      enablePurgeProtection = bool
      enableSoftDelete = bool
      initialAdminObjectIds = [
        "string"
      ]
      networkAcls = {
        bypass = "string"
        defaultAction = "string"
        ipRules = [
          {
            value = "string"
          }
        ]
        virtualNetworkRules = [
          {
            id = "string"
          }
        ]
      }
      publicNetworkAccess = "string"
      regions = [
        {
          isPrimary = bool
          name = "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[]
networkAcls	Règles régissant l’accessibilité du coffre de clés à partir d’emplacements réseau spécifiques.	MhsmNetworkRuleSet
publicNetworkAccess	Contrôlez l’autorisation sur le HSM managé à partir de réseaux publics.	'Désactivé' 'Activé'
Régions	Liste de toutes les régions associées au pool hsm managé.	MhsmGeoReplicatedRegion[]
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' 'Custom_B6' 'Standard_B1' (obligatoire)

ManagedServiceIdentity

Nom	Description	Valeur
type	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obligatoire)
userAssignedIdentities	Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes.	UserAssignedIdentities

MhsmGeoReplicatedRegion

Nom	Description	Valeur
isPrimary	Valeur booléenne qui indique si la région est la région primaire ou une région secondaire.	Bool
nom	Nom de la région géorépliquée.	corde

MhsmipRule

Nom	Description	Valeur
valeur	Plage d’adresses IPv4 en notation CIDR, telle que « 124.56.78.91 » (adresse IP simple) ou « 124.56.78.0/24 » (toutes les adresses commençant par 124.56.78).	chaîne (obligatoire)

MhsmNetworkRuleSet

Nom	Description	Valeur
contourner	Indique ce que le trafic peut contourner les règles réseau. Il peut s’agir d'« AzureServices » ou de « Aucun ». S’il n’est pas spécifié, la valeur par défaut est « AzureServices ».	'AzureServices' 'None'
defaultAction	Action par défaut lorsqu’aucune règle d’ipRules et de virtualNetworkRules ne correspond. Cette opération est utilisée uniquement après l’évaluation de la propriété de contournement.	'Autoriser' 'Refuser'
ipRules	Liste des règles d’adresse IP.	MhsmipRule []
virtualNetworkRules	Liste des règles de réseau virtuel.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nom	Description	Valeur
id	ID de ressource complet d’un sous-réseau de réseau virtuel, tel que « /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1 ».	chaîne (obligatoire)

Microsoft.KeyVault/managedHSMs

Nom	Description	Valeur
identité	Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)	ManagedServiceIdentity
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@2024-04-01-preview »

UserAssignedIdentities

Nom	Description	Valeur

UserAssignedIdentity

Nom	Description	Valeur

Partager via

Microsoft.KeyVault managedHSMs

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Exemples de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Commentaires

Ressources supplémentaires