Microsoft.KeyVault managedHSM 2023-07-01
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 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 Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.KeyVault/managedHSMs@2023-07-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
family: 'B'
name: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
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és
managedHSMs
| Nom | Description | Valeur |
|---|---|---|
| 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 |
| identité | Identité de service managée (identités attribuées par le système et/ou attribuées par l’utilisateur) | ManagedServiceIdentity |
| properties | Propriétés du HSM managé | ManagedHsmProperties |
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 au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs du dictionnaire peuvent être des objets vides ({}) dans les requêtes. | UserAssignedIdentities |
UserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | userAssignedIdentity |
userAssignedIdentity
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
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[] |
| networkAcls | Règles régissant l’accessibilité du coffre de clés à partir d’emplacements réseau spécifiques. | MhsmNetworkRuleSet |
| publicNetworkAccess | Contrôler l’autorisation sur le HSM managé à partir de réseaux publics. | 'Désactivé' 'Enabled' |
| regions | Liste de toutes les régions associées au pool hsm managé. | MhsmGeoReplicatedRegion[] |
| 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}$ |
MhsmNetworkRuleSet
| Nom | Description | Valeur |
|---|---|---|
| ignorer | Indique quel trafic peut contourner les règles réseau. Il peut s’agir de « 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 quand aucune règle d’ipRules et de virtualNetworkRules ne correspondent. Elle est utilisée uniquement après l’évaluation de la propriété bypass. | 'Autoriser' 'Deny' |
| ipRules | Liste des règles d’adresse IP. | MhsmipRule[] |
| virtualNetworkRules | Liste des règles de réseau virtuel. | MhsmVirtualNetworkRule[] |
MhsmipRule
| Nom | Description | Valeur |
|---|---|---|
| value | Une 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 qui commencent par 124.56.78). | string (obligatoire) |
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/subnets/subnets1 ». | string (obligatoire) |
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 |
| name | Nom de la région géorépliquée. | string |
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' 'Custom_B6' '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": "2023-07-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"family": "B",
"name": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"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és
managedHSMs
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | 'Microsoft.KeyVault/managedHSMs' |
| apiVersion | Version de l’API de ressource | '2023-07-01' |
| 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 |
| identité | Identité de service managée (identités attribuées par le système et/ou attribuées par l’utilisateur) | ManagedServiceIdentity |
| properties | Propriétés du HSM managé | ManagedHsmProperties |
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 au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs du dictionnaire peuvent être des objets vides ({}) dans les requêtes. | UserAssignedIdentities |
UserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | userAssignedIdentity |
userAssignedIdentity
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
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[] |
| networkAcls | Règles régissant l’accessibilité du coffre de clés à partir d’emplacements réseau spécifiques. | MhsmNetworkRuleSet |
| publicNetworkAccess | Contrôler l’autorisation sur le HSM managé à partir de réseaux publics. | 'Désactivé' 'Enabled' |
| regions | Liste de toutes les régions associées au pool hsm managé. | MhsmGeoReplicatedRegion[] |
| 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}$ |
MhsmNetworkRuleSet
| Nom | Description | Valeur |
|---|---|---|
| ignorer | Indique le trafic qui peut contourner les règles réseau. Il peut s’agir de « AzureServices » ou « None ». 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 propriété n’est utilisée qu’après l’évaluation de la propriété bypass. | 'Autoriser' 'Deny' |
| ipRules | Liste des règles d’adresse IP. | MhsmipRule[] |
| virtualNetworkRules | Liste des règles de réseau virtuel. | MhsmVirtualNetworkRule[] |
MhsmipRule
| Nom | Description | Valeur |
|---|---|---|
| value | Une 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 qui commencent par 124.56.78). | string (obligatoire) |
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/subnets/subnets1 ». | string (obligatoire) |
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 |
| name | Nom de la région géorépliquée. | string |
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' 'Custom_B6' '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 d’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@2023-07-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
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"
}
sku = {
family = "B"
name = "string"
}
})
}
Valeurs de propriétés
managedHSMs
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.KeyVault/managedHSMs@2023-07-01 » |
| name | Nom de la ressource | string (obligatoire) |
| location | Emplacement Azure pris en charge où le pool HSM managé doit être créé. | string |
| parent_id | Pour effectuer un déploiement dans un groupe de ressources, utilisez l’ID de ce groupe de ressources. | string (obligatoire) |
| tags | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. |
| sku | Détails de la référence SKU | ManagedHsmSku |
| identité | Identité de service managée (identités affectées par le système et/ou par l’utilisateur) | ManagedServiceIdentity |
| properties | Propriétés du HSM managé | ManagedHsmProperties |
ManagedServiceIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). | « SystemAssigned » « SystemAssigned,UserAssigned » « UserAssigned » (obligatoire) |
| identity_ids | Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities sont des ID de ressource ARM au format : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs du dictionnaire peuvent être des objets vides ({}) dans les requêtes. | Tableau d’ID d’identité utilisateur. |
UserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | userAssignedIdentity |
userAssignedIdentity
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
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 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[] |
| 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 d’accès au HSM managé à partir de réseaux publics. | « Désactivé » « Activé » |
| regions | Liste de toutes les régions associées au pool hsm managé. | MhsmGeoReplicatedRegion[] |
| 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}$ |
MhsmNetworkRuleSet
| Nom | Description | Valeur |
|---|---|---|
| ignorer | Indique quel trafic peut contourner les règles réseau. Il peut s’agir de « 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 quand aucune règle d’ipRules et de virtualNetworkRules ne correspondent. Elle est utilisée uniquement après l’évaluation de la propriété bypass. | « Autoriser » « Refuser » |
| ipRules | Liste des règles d’adresse IP. | MhsmipRule[] |
| virtualNetworkRules | Liste des règles de réseau virtuel. | MhsmVirtualNetworkRule[] |
MhsmipRule
| Nom | Description | Valeur |
|---|---|---|
| value | Une 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 qui commencent par 124.56.78). | string (obligatoire) |
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/subnets/subnets1 ». | string (obligatoire) |
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 |
| name | Nom de la région géorépliquée. | string |
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 » « Custom_B6 » « Standard_B1 » (obligatoire) |
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour