Partager via


Microsoft.KeyVault managedHSMs/keys 2023-07-01

Définition de ressource Bicep

Le type de ressource managedHSMs/keys peut être déployé avec des opérations qui ciblent :

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/keys, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.KeyVault/managedHSMs/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

managedHSMs/clés

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 : managedHSMs
properties Propriétés de la clé à créer. ManagedHsmKeyProperties (obligatoire)

ManagedHsmKeyProperties

Nom Description Valeur
attributs Attributs de la clé. ManagedHsmKeyAttributes
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 ManagedHsmKeyReleasePolicy
rotationPolicy Stratégie de rotation des clés en réponse. Il sera utilisé pour la sortie et l’entrée. Omis si vide ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

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

ManagedHsmKeyReleasePolicy

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

ManagedHsmRotationPolicy

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

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

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

ManagedHsmAction

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

ManagedHsmTrigger

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

Définition de ressources de modèle ARM

Le type de ressource managedHSMs/keys 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 des ressources

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

{
  "type": "Microsoft.KeyVault/managedHSMs/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

managedHSM/keys

Nom Description Valeur
type Type de ressource « Microsoft.KeyVault/managedHSMs/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.
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. ManagedHsmKeyProperties (obligatoire)

ManagedHsmKeyProperties

Nom Description Valeur
attributs Attributs de la clé. ManagedHsmKeyAttributes
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 ManagedHsmKeyReleasePolicy
rotationPolicy Stratégie de rotation des clés en réponse. Il sera utilisé pour la sortie et l’entrée. Omis si vide ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

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

ManagedHsmKeyReleasePolicy

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

ManagedHsmRotationPolicy

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

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

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

ManagedHsmAction

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

ManagedHsmTrigger

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

Définition de ressource Terraform (fournisseur AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs/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

managedHSM/keys

Nom Description Valeur
type Type de ressource « Microsoft.KeyVault/managedHSMs/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 : managedHSM
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. ManagedHsmKeyProperties (obligatoire)

ManagedHsmKeyProperties

Nom Description Valeur
attributs Attributs de la clé. ManagedHsmKeyAttributes
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 obtenir des 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é à la fois pour la sortie et l’entrée. Omis si vide ManagedHsmKeyReleasePolicy
rotationPolicy Stratégie de rotation des clés en réponse. Il sera utilisé à la fois pour la sortie et l’entrée. Omis si vide ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

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

ManagedHsmKeyReleasePolicy

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

ManagedHsmRotationPolicy

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

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

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

ManagedHsmAction

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

ManagedHsmTrigger

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