Coffres/clés Microsoft.KeyVault

Article
04/20/2024

Définition de ressource Bicep

Le type de ressource coffres/clés 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.

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.

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@2023-07-01' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    attributes: {
      enabled: bool
      exp: int
      exportable: bool
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
    release_policy: {
      contentType: 'string'
      data: 'string'
    }
    rotationPolicy: {
      attributes: {
        expiryTime: 'string'
      }
      lifetimeActions: [
        {
          action: {
            type: 'string'
          }
          trigger: {
            timeAfterCreate: 'string'
            timeBeforeExpiry: '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.	string (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 : 'decrypt' 'encrypt' 'import' 'release' '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 connaître les valeurs valides, consultez JsonWebKeyType.	'EC' 'EC-HSM' 'RSA' 'RSA-HSM'
release_policy	Stratégie de mise en production de clé en réponse. Il sera utilisé pour la sortie et l’entrée. Omis si vide	KeyReleasePolicy
rotationPolicy	Stratégie de rotation des clés en réponse. Il sera utilisé pour la sortie et l’entrée. Omis si vide	RotationPolicy

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
Exportables	Indique si la clé privée peut être exportée.	bool
nbf	Date antérieure en secondes depuis 1970-01-01T00 :00 :00Z.	int

KeyReleasePolicy

Nom	Description	Valeur
contentType	Type de contenu et version de la stratégie de mise en production de clé	string
data	Encodage d’objets blob les règles de stratégie en vertu desquelles la clé peut être libérée.	string

RotationPolicy

Nom	Description	Valeur
attributs	Attributs de la stratégie de rotation de clé.	KeyRotationPolicyAttributes
lifetimeActions	Action de rotation de clé lifetimeActions.	LifetimeAction[]

KeyRotationPolicyAttributes

Nom	Description	Valeur
expiryTime	Heure d’expiration de la nouvelle version de clé. Il doit être au format ISO8601. Par exemple : 'P90D', 'P1Y'.	string

LifetimeAction

Nom	Description	Valeur
action	Action de la stratégie de rotation de clé lifetimeAction.	Action
déclencheur	Déclencheur de la stratégie de rotation de clé lifetimeAction.	Déclencheur

Action

Nom	Description	Valeur
type	Type d’action.	'notifier' 'pivoter'

Déclencheur

Nom	Description	Valeur
timeAfterCreate	Durée après la création de la clé pour faire pivoter la clé. Il s’applique uniquement à la rotation. Il sera au format de durée ISO 8601. Par exemple : 'P90D', 'P1Y'.	string
timeBeforeExpiry	Durée avant l’expiration de la clé pour effectuer une rotation ou une notification. Il sera au format de durée ISO 8601. Par exemple : 'P90D', 'P1Y'.	string

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	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	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 :

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.

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": "2023-07-01",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "exportable": "bool",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string",
    "release_policy": {
      "contentType": "string",
      "data": "string"
    },
    "rotationPolicy": {
      "attributes": {
        "expiryTime": "string"
      },
      "lifetimeActions": [
        {
          "action": {
            "type": "string"
          },
          "trigger": {
            "timeAfterCreate": "string",
            "timeBeforeExpiry": "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	'2023-07-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.	string (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 : 'decrypt' 'encrypt' 'import' 'release' '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 connaître les valeurs valides, consultez JsonWebKeyType.	'EC' 'EC-HSM' 'RSA' 'RSA-HSM'
release_policy	Stratégie de mise en production de clé en réponse. Il sera utilisé pour la sortie et l’entrée. Omis si vide	KeyReleasePolicy
rotationPolicy	Stratégie de rotation des clés en réponse. Il sera utilisé pour la sortie et l’entrée. Omis si vide	RotationPolicy

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
Exportables	Indique si la clé privée peut être exportée.	bool
nbf	Date antérieure en secondes depuis 1970-01-01T00 :00 :00Z.	int

KeyReleasePolicy

Nom	Description	Valeur
contentType	Type de contenu et version de la stratégie de mise en production de clé	string
data	Encodage d’objet blob les règles de stratégie sous lesquelles la clé peut être libérée.	string

RotationPolicy

Nom	Description	Valeur
attributs	Attributs de la stratégie de rotation des clés.	KeyRotationPolicyAttributes
lifetimeActions	LifetimeActions pour l’action de rotation de clé.	LifetimeAction[]

KeyRotationPolicyAttributes

Nom	Description	Valeur
expiryTime	Délai d’expiration de la nouvelle version de clé. Il doit être au format ISO8601. Par exemple : 'P90D', 'P1Y'.	string

LifetimeAction

Nom	Description	Valeur
action	Action de la stratégie de rotation de clé lifetimeAction.	Action
déclencheur	Déclencheur de la stratégie de rotation de clé lifetimeAction.	Déclencheur

Action

Nom	Description	Valeur
type	Type d’action.	'notifier' 'pivoter'

Déclencheur

Nom	Description	Valeur
timeAfterCreate	Durée après la création de la clé pour faire pivoter la clé. Il s’applique uniquement à la rotation. Il sera au format de durée ISO 8601. Par exemple : 'P90D', 'P1Y'.	string
timeBeforeExpiry	Durée avant l’expiration de la clé pour effectuer une rotation ou une notification. Il sera au format de durée ISO 8601. Par exemple : 'P90D', 'P1Y'.	string

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	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	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@2023-07-01"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        exportable = bool
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
      release_policy = {
        contentType = "string"
        data = "string"
      }
      rotationPolicy = {
        attributes = {
          expiryTime = "string"
        }
        lifetimeActions = [
          {
            action = {
              type = "string"
            }
            trigger = {
              timeAfterCreate = "string"
              timeBeforeExpiry = "string"
            }
          }
        ]
      }
    }
  })
}

Valeurs de propriétés

vaults/keys

Nom	Description	Valeur
type	Type de ressource	« Microsoft.KeyVault/vaults/keys@2023-07-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 » « release » « 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 connaître les valeurs valides, consultez JsonWebKeyType.	« EC » « EC-HSM » « RSA » « RSA-HSM »
release_policy	Stratégie de mise en production de clé en réponse. Il sera utilisé pour la sortie et l’entrée. Omis si vide	KeyReleasePolicy
rotationPolicy	Stratégie de rotation des clés en réponse. Il sera utilisé pour la sortie et l’entrée. Omis si vide	RotationPolicy

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
Exportables	Indique si la clé privée peut être exportée.	bool
nbf	Date antérieure en secondes depuis 1970-01-01T00 :00 :00Z.	int

KeyReleasePolicy

Nom	Description	Valeur
contentType	Type de contenu et version de la stratégie de mise en production de clé	string
data	Encodage d’objet blob les règles de stratégie sous lesquelles la clé peut être libérée.	string

RotationPolicy

Nom	Description	Valeur
attributs	Attributs de la stratégie de rotation des clés.	KeyRotationPolicyAttributes
lifetimeActions	LifetimeActions pour l’action de rotation de clé.	LifetimeAction[]

KeyRotationPolicyAttributes

Nom	Description	Valeur
expiryTime	Délai d’expiration de la nouvelle version de clé. Il doit être au format ISO8601. Par exemple : 'P90D', 'P1Y'.	string

LifetimeAction

Nom	Description	Valeur
action	Action de la stratégie de rotation des clés lifetimeAction.	Action
déclencheur	Déclencheur de la stratégie de rotation des clés lifetimeAction.	Déclencheur

Action

Nom	Description	Valeur
type	Type d’action.	« notifier » « pivoter »

Déclencheur

Nom	Description	Valeur
timeAfterCreate	Durée après la création de la clé pour faire pivoter la clé. Elle s’applique uniquement à la rotation. Il sera au format de durée ISO 8601. Par exemple : 'P90D', 'P1Y'.	string
timeBeforeExpiry	Durée avant l’expiration de la clé pour effectuer une rotation ou une notification. Il sera au format de durée ISO 8601. Par exemple : 'P90D', 'P1Y'.	string

Partager via

Coffres/clés Microsoft.KeyVault

Définition de ressource Bicep

Remarques

Format des ressources

Valeurs de propriétés

vaults/keys

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Action

Déclencheur

Modèles de démarrage rapide

Définition de ressources de modèle ARM

Remarques

Format des ressources

Valeurs de propriétés

vaults/keys

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Action

Déclencheur

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Valeurs de propriétés

vaults/keys

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Action

Déclencheur

Commentaires

Ressources supplémentaires