Partager via


Coffres/clés Microsoft.KeyVault 2021-10-01

Remarques

Pour obtenir des conseils sur l’utilisation de coffres de clés pour des valeurs sécurisées, consultez Gérer les secrets à l’aide de Bicep.

Pour obtenir un guide de démarrage rapide sur la création d’un secret, consultez Démarrage rapide : Définir et récupérer un secret à partir d’Azure Key Vault à l’aide d’un modèle ARM.

Pour obtenir un guide de démarrage rapide sur la création d’une clé, consultez Démarrage rapide : Créer un coffre de clés Azure et une clé à l’aide d’un modèle ARM.

Définition de ressource Bicep

Le type de ressource coffres/clés 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/vaults/keys, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2021-10-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    attributes: {
      enabled: bool
      exp: int
      exportable: bool
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

KeyAttributes

Nom Description Valeur
Activé Détermine si l’objet est activé ou non. Bool
Exp Date d’expiration en secondes depuis 1970-01-01T00:00:00Z. Int
Exportables Indique si la clé privée peut être exportée. Bool
nbf Pas avant la date en secondes depuis 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Nom Description Valeur

KeyProperties

Nom Description Valeur
Attributs Attributs de la clé. KeyAttributes
curveName Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName. 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Tableau de chaînes contenant l’un des éléments suivants :
'déchiffrer'
'chiffrer'
'import'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize Taille de clé en bits. Par exemple : 2048, 3072 ou 4096 pour RSA. Int
kty Type de la clé. Pour obtenir des valeurs valides, consultez JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'

Microsoft.KeyVault/vaults/keys

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Modèle = ^[a-zA-Z0-9-]{1,127}$ (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.
Nom symbolique de la ressource de type : coffres
Propriétés Propriétés de la clé à créer. KeyProperties (obligatoire)
é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
chiffrement de compte de stockage Azure avec de clé gérée par le client Ce modèle déploie un compte de stockage avec une clé gérée par le client pour le chiffrement généré et placé dans un coffre de clés.

Définition de ressource de modèle ARM

Le type de ressource coffres/clés 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/vaults/keys, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2021-10-01",
  "name": "string",
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "exportable": "bool",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

KeyAttributes

Nom Description Valeur
Activé Détermine si l’objet est activé ou non. Bool
Exp Date d’expiration en secondes depuis 1970-01-01T00:00:00Z. Int
Exportables Indique si la clé privée peut être exportée. Bool
nbf Pas avant la date en secondes depuis 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Nom Description Valeur

KeyProperties

Nom Description Valeur
Attributs Attributs de la clé. KeyAttributes
curveName Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName. 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Tableau de chaînes contenant l’un des éléments suivants :
'déchiffrer'
'chiffrer'
'import'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize Taille de clé en bits. Par exemple : 2048, 3072 ou 4096 pour RSA. Int
kty Type de la clé. Pour obtenir des valeurs valides, consultez JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'

Microsoft.KeyVault/vaults/keys

Nom Description Valeur
apiVersion Version de l’API '2021-10-01'
nom Nom de la ressource corde

Contraintes:
Modèle = ^[a-zA-Z0-9-]{1,127}$ (obligatoire)
Propriétés Propriétés de la clé à créer. KeyProperties (obligatoire)
é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/vaults/keys'

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
chiffrement de compte de stockage Azure avec de clé gérée par le client

Déployer sur Azure
Ce modèle déploie un compte de stockage avec une clé gérée par le client pour le chiffrement généré et placé dans un coffre de clés.
créer une clé dans Azure KeyVault

Déployer sur Azure
Ce module vous permet de créer une clé dans un coffre de clés existant.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource coffres/clés 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/vaults/keys, ajoutez terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2021-10-01"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        exportable = bool
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
    }
  })
}

Valeurs de propriété

KeyAttributes

Nom Description Valeur
Activé Détermine si l’objet est activé ou non. Bool
Exp Date d’expiration en secondes depuis 1970-01-01T00:00:00Z. Int
Exportables Indique si la clé privée peut être exportée. Bool
nbf Pas avant la date en secondes depuis 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Nom Description Valeur

KeyProperties

Nom Description Valeur
Attributs Attributs de la clé. KeyAttributes
curveName Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName. 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Tableau de chaînes contenant l’un des éléments suivants :
'déchiffrer'
'chiffrer'
'import'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize Taille de clé en bits. Par exemple : 2048, 3072 ou 4096 pour RSA. Int
kty Type de la clé. Pour obtenir des valeurs valides, consultez JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'

Microsoft.KeyVault/vaults/keys

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Modèle = ^[a-zA-Z0-9-]{1,127}$ (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : coffres
Propriétés Propriétés de la clé à créer. KeyProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.KeyVault/vaults/keys@2021-10-01 »