Partager via

Coffres/clés Microsoft.KeyVault 01-09-2019

  • Article

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.

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 un 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.

Format des ressources

Pour créer une ressource Microsoft.KeyVault/vaults/keys, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2019-09-01' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    attributes: {
      enabled: bool
      exp: int
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
  }
}

Valeurs de propriétés

vaults/keys

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 chaîne (obligatoire)
tags Balises qui seront affectées à la clé. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
parent Dans Bicep, vous pouvez spécifier la ressource parente pour 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
properties Propriétés de la clé à créer. KeyProperties (obligatoire)

KeyProperties

Nom Description Valeur
attributs Attributs de la clé. KeyAttributes
curveName Nom de la courbe elliptique. Pour connaître les 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'
'chiffre'
'import'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize Taille de la 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'

KeyAttributes

Nom Description Valeur
enabled Détermine si l’objet est activé ou non. bool
exp Date d’expiration en secondes depuis 1970-01-01T00 :00 :00Z. int
nbf Date antérieure en secondes depuis 1970-01-01T00 :00 :00Z. int

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 une clé dans Azure KeyVault

Déployer sur Azure 		Ce module vous permet de créer une clé dans un KeyVault existant.
Chiffrement de compte de stockage Azure avec 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é à l’intérieur d’un Key Vault.

Définition de ressources 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.

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 un 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.

Format des ressources

Pour créer une ressource Microsoft.KeyVault/vaults/keys, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2019-09-01",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string"
  }
}

Valeurs de propriétés

vaults/keys

Nom Description Valeur
type Type de ressource « Microsoft.KeyVault/vaults/keys »
apiVersion Version de l’API de ressource '2019-09-01'
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.		 chaîne (obligatoire)
tags Balises qui seront affectées à la clé. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés de la clé à créer. KeyProperties (obligatoire)

KeyProperties

Nom Description Valeur
attributs Attributs de la clé. KeyAttributes
curveName Nom de la courbe elliptique. Pour connaître les 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'
'chiffre'
'import'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize Taille de la 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'

KeyAttributes

Nom Description Valeur
enabled Détermine si l’objet est activé ou non. bool
exp Date d’expiration en secondes depuis 1970-01-01T00 :00 :00Z. int
nbf Date antérieure en secondes depuis 1970-01-01T00 :00 :00Z. int

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 une clé dans Azure KeyVault

Déployer sur Azure 		Ce module vous permet de créer une clé dans un KeyVault existant.
Chiffrement de compte de stockage Azure avec 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é à l’intérieur d’un Key Vault.

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 des ressources

Pour créer une ressource Microsoft.KeyVault/vaults/keys, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2019-09-01"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
    }
  })
}

Valeurs de propriétés

vaults/keys

Nom Description Valeur
type Type de ressource « Microsoft.KeyVault/vaults/keys@2019-09-01 »
name Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : coffres
tags Balises qui seront affectées à la clé. Dictionnaire de noms et de valeurs d’étiquettes.
properties Propriétés de la clé à créer. KeyProperties (obligatoire)

KeyProperties

Nom Description Valeur
attributs Attributs de la clé. KeyAttributes
curveName Nom de la courbe elliptique. Pour connaître les 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 »
« signe »
« unwrapKey »
« vérifier »
« wrapKey »
keySize Taille de la 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 »

KeyAttributes

Nom Description Valeur
enabled Détermine si l’objet est activé ou non. bool
exp Date d’expiration en secondes depuis 1970-01-01T00 :00 :00Z. int
nbf Date antérieure en secondes depuis 1970-01-01T00 :00 :00Z. int