Microsoft.KeyVault managedHSMs/keys

Article
12/20/2024

Définition de ressource Bicep

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

groupes de ressources - Consultez 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 de ressource

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs/keys@2024-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  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'
          }
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

ManagedHsmAction

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

ManagedHsmKeyAttributes

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

ManagedHsmKeyCreateParametersTags

Nom	Description	Valeur

ManagedHsmKeyProperties

Nom	Description	Valeur
Attributs	Attributs de la clé.	ManagedHsmKeyAttributes
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' 'release' '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'
release_policy	Stratégie de mise en production de clé en réponse. Elle sera utilisée à la fois pour la sortie et l’entrée. Omis s’il est vide	ManagedHsmKeyReleasePolicy
rotationPolicy	Stratégie de rotation de clé en réponse. Elle sera utilisée à la fois pour la sortie et l’entrée. Omis s’il est vide	ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

Nom	Description	Valeur
contentType	Type de contenu et version de la stratégie de mise en production de clé	corde
données	Encodage d’objets blob des règles de stratégie sous lesquelles la clé peut être libérée.	corde

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

Nom	Description	Valeur
action	Action de la stratégie de rotation de clé lifetimeAction.	ManagedHsmAction
gâchette	Déclencheur de la durée de vie de la stratégie de rotation de cléAction.	ManagedHsmTrigger

ManagedHsmRotationPolicy

Nom	Description	Valeur
Attributs	Attributs de la stratégie de rotation de clé.	ManagedHsmKeyRotationPolicyAttributes
lifetimeActions	Actions de durée de vie pour l’action de rotation de clé.	ManagedHsmLifetimeAction[]

ManagedHsmTrigger

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'.	corde
timeBeforeExpiry	Durée avant l’expiration de la clé pour faire pivoter ou notifier. Il sera au format de durée ISO 8601. Par exemple : 'P90D', 'P1Y'.	corde

Microsoft.KeyVault/managedHSMs/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 : managedHSMs
Propriétés	Propriétés de la clé à créer.	ManagedHsmKeyProperties (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

Définition de ressource de modèle ARM

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

groupes de ressources - Consultez 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 de ressource

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

{
  "type": "Microsoft.KeyVault/managedHSMs/keys",
  "apiVersion": "2024-04-01-preview",
  "name": "string",
  "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"
          }
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

ManagedHsmAction

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

ManagedHsmKeyAttributes

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

ManagedHsmKeyCreateParametersTags

Nom	Description	Valeur

ManagedHsmKeyProperties

Nom	Description	Valeur
Attributs	Attributs de la clé.	ManagedHsmKeyAttributes
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' 'release' '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'
release_policy	Stratégie de mise en production de clé en réponse. Elle sera utilisée à la fois pour la sortie et l’entrée. Omis s’il est vide	ManagedHsmKeyReleasePolicy
rotationPolicy	Stratégie de rotation de clé en réponse. Elle sera utilisée à la fois pour la sortie et l’entrée. Omis s’il est vide	ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

Nom	Description	Valeur
contentType	Type de contenu et version de la stratégie de mise en production de clé	corde
données	Encodage d’objets blob des règles de stratégie sous lesquelles la clé peut être libérée.	corde

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

Nom	Description	Valeur
action	Action de la stratégie de rotation de clé lifetimeAction.	ManagedHsmAction
gâchette	Déclencheur de la durée de vie de la stratégie de rotation de cléAction.	ManagedHsmTrigger

ManagedHsmRotationPolicy

Nom	Description	Valeur
Attributs	Attributs de la stratégie de rotation de clé.	ManagedHsmKeyRotationPolicyAttributes
lifetimeActions	Actions de durée de vie pour l’action de rotation de clé.	ManagedHsmLifetimeAction[]

ManagedHsmTrigger

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'.	corde
timeBeforeExpiry	Durée avant l’expiration de la clé pour faire pivoter ou notifier. Il sera au format de durée ISO 8601. Par exemple : 'P90D', 'P1Y'.	corde

Microsoft.KeyVault/managedHSMs/keys

Nom	Description	Valeur
apiVersion	Version de l’API	'2024-04-01-preview'
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.	ManagedHsmKeyProperties (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/managedHSMs/keys'

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 de ressource

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@2024-04-01-preview"
  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"
      release_policy = {
        contentType = "string"
        data = "string"
      }
      rotationPolicy = {
        attributes = {
          expiryTime = "string"
        }
        lifetimeActions = [
          {
            action = {
              type = "string"
            }
            trigger = {
              timeAfterCreate = "string"
              timeBeforeExpiry = "string"
            }
          }
        ]
      }
    }
  })
}

Valeurs de propriété

ManagedHsmAction

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

ManagedHsmKeyAttributes

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

ManagedHsmKeyCreateParametersTags

Nom	Description	Valeur

ManagedHsmKeyProperties

Nom	Description	Valeur
Attributs	Attributs de la clé.	ManagedHsmKeyAttributes
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' 'release' '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'
release_policy	Stratégie de mise en production de clé en réponse. Elle sera utilisée à la fois pour la sortie et l’entrée. Omis s’il est vide	ManagedHsmKeyReleasePolicy
rotationPolicy	Stratégie de rotation de clé en réponse. Elle sera utilisée à la fois pour la sortie et l’entrée. Omis s’il est vide	ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

Nom	Description	Valeur
contentType	Type de contenu et version de la stratégie de mise en production de clé	corde
données	Encodage d’objets blob des règles de stratégie sous lesquelles la clé peut être libérée.	corde

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

Nom	Description	Valeur
action	Action de la stratégie de rotation de clé lifetimeAction.	ManagedHsmAction
gâchette	Déclencheur de la durée de vie de la stratégie de rotation de cléAction.	ManagedHsmTrigger

ManagedHsmRotationPolicy

Nom	Description	Valeur
Attributs	Attributs de la stratégie de rotation de clé.	ManagedHsmKeyRotationPolicyAttributes
lifetimeActions	Actions de durée de vie pour l’action de rotation de clé.	ManagedHsmLifetimeAction[]

ManagedHsmTrigger

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'.	corde
timeBeforeExpiry	Durée avant l’expiration de la clé pour faire pivoter ou notifier. Il sera au format de durée ISO 8601. Par exemple : 'P90D', 'P1Y'.	corde

Microsoft.KeyVault/managedHSMs/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 : managedHSMs
Propriétés	Propriétés de la clé à créer.	ManagedHsmKeyProperties (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.KeyVault/managedHSMs/keys@2024-04-01-preview »

Partager via

Microsoft.KeyVault managedHSMs/keys

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

ManagedHsmAction

ManagedHsmKeyAttributes

ManagedHsmKeyCreateParametersTags

ManagedHsmKeyProperties

ManagedHsmKeyReleasePolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmRotationPolicy

ManagedHsmTrigger

Microsoft.KeyVault/managedHSMs/keys

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

ManagedHsmAction

ManagedHsmKeyAttributes

ManagedHsmKeyCreateParametersTags

ManagedHsmKeyProperties

ManagedHsmKeyReleasePolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmRotationPolicy

ManagedHsmTrigger

Microsoft.KeyVault/managedHSMs/keys

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

ManagedHsmAction

ManagedHsmKeyAttributes

ManagedHsmKeyCreateParametersTags

ManagedHsmKeyProperties

ManagedHsmKeyReleasePolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmRotationPolicy

ManagedHsmTrigger

Microsoft.KeyVault/managedHSMs/keys

Commentaires

Ressources supplémentaires