Almacenes o claves de Microsoft.KeyVault

Artículo
12/21/2024

Observaciones

Para obtener instrucciones sobre el uso de almacenes de claves para valores seguros, consulte Administración de secretos mediante Bicep.

Para ver un inicio rápido sobre cómo crear un secreto, consulte inicio rápido : Establecimiento y recuperación de un secreto de Azure Key Vault mediante una plantilla de ARM.

Para ver un inicio rápido sobre cómo crear una clave, consulte inicio rápido : Creación de un almacén de claves de Azure y una clave mediante la plantilla de ARM.

Definición de recursos de Bicep

El tipo de recurso vaults/keys se puede implementar con operaciones que tienen como destino:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.KeyVault/vaults/keys, agregue lo siguiente a la plantilla de Bicep.

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

Valores de propiedad

Acción

Nombre	Descripción	Valor
tipo	Tipo de acción.	'notify' 'girar'

KeyAttributes

Nombre	Descripción	Valor
Habilitado	Determina si el objeto está habilitado o no.	Bool
Exp	Fecha de expiración en segundos desde 1970-01-01T00:00:00Z.	Int
exportable	Indica si se puede exportar la clave privada.	Bool
nbf	No antes de la fecha en segundos desde 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Nombre	Descripción	Valor

KeyProperties

Nombre	Descripción	Valor
Atributos	Atributos de la clave.	KeyAttributes
curveName	Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Matriz de cadenas que contiene cualquiera de: 'descifrado' 'encrypt' 'import' 'release' 'sign' 'unwrapKey' 'verify' 'wrapKey'
keySize	Tamaño de clave en bits. Por ejemplo: 2048, 3072 o 4096 para RSA.	Int
kty	Tipo de la clave. Para obtener valores válidos, consulte JsonWebKeyType.	'CE' "EC-HSM" 'RSA' "RSA-HSM"
release_policy	Directiva de versión de clave en respuesta. Se usará tanto para la salida como para la entrada. Se omite si está vacío	KeyReleasePolicy
rotationPolicy	Directiva de rotación de claves en respuesta. Se usará tanto para la salida como para la entrada. Se omite si está vacío	rotationPolicy de

KeyReleasePolicy

Nombre	Descripción	Valor
contentType	Tipo de contenido y versión de la directiva de versión de clave	cuerda
datos	Codificación de blobs con las reglas de directiva en las que se puede liberar la clave.	cuerda

KeyRotationPolicyAttributes

Nombre	Descripción	Valor
expiryTime	Hora de expiración de la nueva versión de la clave. Debe estar en formato ISO8601. Por ejemplo: 'P90D', 'P1Y'.	cuerda

LifetimeAction

Nombre	Descripción	Valor
acción	Acción de la vigencia de la directiva de rotación de clavesAction.	de acción de
detonante	Desencadenador de la vigencia de la directiva de rotación de clavesAction.	desencadenador de

Microsoft.KeyVault/vaults/keys

Nombre	Descripción	Valor
nombre	El nombre del recurso	cuerda Restricciones: Patrón = `^[a-zA-Z0-9-]{1,127}$` (obligatorio)
padre	En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para obtener más información, consulte recurso secundario fuera del recurso primario.	Nombre simbólico del recurso de tipo: almacenes de
Propiedades	Propiedades de la clave que se va a crear.	keyProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

RotationPolicy

Nombre	Descripción	Valor
Atributos	Atributos de la directiva de rotación de claves.	keyRotationPolicyAttributes
lifetimeActions	LifetimeActions para la acción de rotación de claves.	LifetimeAction[]

Detonante

Nombre	Descripción	Valor
timeAfterCreate	Duración del tiempo después de la creación de la clave para girar la clave. Solo se aplica a la rotación. Estará en formato de duración ISO 8601. Por ejemplo: 'P90D', 'P1Y'.	cuerda
timeBeforeExpiry	Duración del tiempo antes de que expire la clave para rotar o notificar. Estará en formato de duración ISO 8601. Por ejemplo: 'P90D', 'P1Y'.	cuerda

Ejemplos de inicio rápido

En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.

Archivo de Bicep	Descripción
Cifrado de cuentas de Azure Storage con clave administrada por el cliente	Esta plantilla implementa una cuenta de almacenamiento con una clave administrada por el cliente para el cifrado generado y colocado dentro de un almacén de claves.

Definición de recursos de plantilla de ARM

El tipo de recurso vaults/keys se puede implementar con operaciones que tienen como destino:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.KeyVault/vaults/keys, agregue el siguiente JSON a la plantilla.

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

Valores de propiedad

Acción

Nombre	Descripción	Valor
tipo	Tipo de acción.	'notify' 'girar'

KeyAttributes

Nombre	Descripción	Valor
Habilitado	Determina si el objeto está habilitado o no.	Bool
Exp	Fecha de expiración en segundos desde 1970-01-01T00:00:00Z.	Int
exportable	Indica si se puede exportar la clave privada.	Bool
nbf	No antes de la fecha en segundos desde 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Nombre	Descripción	Valor

KeyProperties

Nombre	Descripción	Valor
Atributos	Atributos de la clave.	KeyAttributes
curveName	Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Matriz de cadenas que contiene cualquiera de: 'descifrado' 'encrypt' 'import' 'release' 'sign' 'unwrapKey' 'verify' 'wrapKey'
keySize	Tamaño de clave en bits. Por ejemplo: 2048, 3072 o 4096 para RSA.	Int
kty	Tipo de la clave. Para obtener valores válidos, consulte JsonWebKeyType.	'CE' "EC-HSM" 'RSA' "RSA-HSM"
release_policy	Directiva de versión de clave en respuesta. Se usará tanto para la salida como para la entrada. Se omite si está vacío	KeyReleasePolicy
rotationPolicy	Directiva de rotación de claves en respuesta. Se usará tanto para la salida como para la entrada. Se omite si está vacío	rotationPolicy de

KeyReleasePolicy

Nombre	Descripción	Valor
contentType	Tipo de contenido y versión de la directiva de versión de clave	cuerda
datos	Codificación de blobs con las reglas de directiva en las que se puede liberar la clave.	cuerda

KeyRotationPolicyAttributes

Nombre	Descripción	Valor
expiryTime	Hora de expiración de la nueva versión de la clave. Debe estar en formato ISO8601. Por ejemplo: 'P90D', 'P1Y'.	cuerda

LifetimeAction

Nombre	Descripción	Valor
acción	Acción de la vigencia de la directiva de rotación de clavesAction.	de acción de
detonante	Desencadenador de la vigencia de la directiva de rotación de clavesAction.	desencadenador de

Microsoft.KeyVault/vaults/keys

Nombre	Descripción	Valor
apiVersion	La versión de api	'2024-04-01-preview'
nombre	El nombre del recurso	cuerda Restricciones: Patrón = `^[a-zA-Z0-9-]{1,127}$` (obligatorio)
Propiedades	Propiedades de la clave que se va a crear.	keyProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo	El tipo de recurso	"Microsoft.KeyVault/vaults/keys"

RotationPolicy

Nombre	Descripción	Valor
Atributos	Atributos de la directiva de rotación de claves.	keyRotationPolicyAttributes
lifetimeActions	LifetimeActions para la acción de rotación de claves.	LifetimeAction[]

Detonante

Nombre	Descripción	Valor
timeAfterCreate	Duración del tiempo después de la creación de la clave para girar la clave. Solo se aplica a la rotación. Estará en formato de duración ISO 8601. Por ejemplo: 'P90D', 'P1Y'.	cuerda
timeBeforeExpiry	Duración del tiempo antes de que expire la clave para rotar o notificar. Estará en formato de duración ISO 8601. Por ejemplo: 'P90D', 'P1Y'.	cuerda

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla	Descripción
Cifrado de cuentas de Azure Storage con clave administrada por el cliente	Esta plantilla implementa una cuenta de almacenamiento con una clave administrada por el cliente para el cifrado generado y colocado dentro de un almacén de claves.
Creación de una clave en azure KeyVault	Este módulo le permite crear una clave en una instancia de KeyVault existente.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso vaults/keys se puede implementar con operaciones que tienen como destino:

grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.KeyVault/vaults/keys, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/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"
            }
          }
        ]
      }
    }
  })
}

Valores de propiedad

Acción

Nombre	Descripción	Valor
tipo	Tipo de acción.	'notify' 'girar'

KeyAttributes

Nombre	Descripción	Valor
Habilitado	Determina si el objeto está habilitado o no.	Bool
Exp	Fecha de expiración en segundos desde 1970-01-01T00:00:00Z.	Int
exportable	Indica si se puede exportar la clave privada.	Bool
nbf	No antes de la fecha en segundos desde 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Nombre	Descripción	Valor

KeyProperties

Nombre	Descripción	Valor
Atributos	Atributos de la clave.	KeyAttributes
curveName	Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Matriz de cadenas que contiene cualquiera de: 'descifrado' 'encrypt' 'import' 'release' 'sign' 'unwrapKey' 'verify' 'wrapKey'
keySize	Tamaño de clave en bits. Por ejemplo: 2048, 3072 o 4096 para RSA.	Int
kty	Tipo de la clave. Para obtener valores válidos, consulte JsonWebKeyType.	'CE' "EC-HSM" 'RSA' "RSA-HSM"
release_policy	Directiva de versión de clave en respuesta. Se usará tanto para la salida como para la entrada. Se omite si está vacío	KeyReleasePolicy
rotationPolicy	Directiva de rotación de claves en respuesta. Se usará tanto para la salida como para la entrada. Se omite si está vacío	rotationPolicy de

KeyReleasePolicy

Nombre	Descripción	Valor
contentType	Tipo de contenido y versión de la directiva de versión de clave	cuerda
datos	Codificación de blobs con las reglas de directiva en las que se puede liberar la clave.	cuerda

KeyRotationPolicyAttributes

Nombre	Descripción	Valor
expiryTime	Hora de expiración de la nueva versión de la clave. Debe estar en formato ISO8601. Por ejemplo: 'P90D', 'P1Y'.	cuerda

LifetimeAction

Nombre	Descripción	Valor
acción	Acción de la vigencia de la directiva de rotación de clavesAction.	de acción de
detonante	Desencadenador de la vigencia de la directiva de rotación de clavesAction.	desencadenador de

Microsoft.KeyVault/vaults/keys

Nombre	Descripción	Valor
nombre	El nombre del recurso	cuerda Restricciones: Patrón = `^[a-zA-Z0-9-]{1,127}$` (obligatorio)
parent_id	Identificador del recurso que es el elemento primario de este recurso.	Identificador del recurso de tipo: almacenes de
Propiedades	Propiedades de la clave que se va a crear.	keyProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta.
tipo	El tipo de recurso	"Microsoft.KeyVault/vaults/keys@2024-04-01-preview"

RotationPolicy

Nombre	Descripción	Valor
Atributos	Atributos de la directiva de rotación de claves.	keyRotationPolicyAttributes
lifetimeActions	LifetimeActions para la acción de rotación de claves.	LifetimeAction[]

Detonante

Nombre	Descripción	Valor
timeAfterCreate	Duración del tiempo después de la creación de la clave para girar la clave. Solo se aplica a la rotación. Estará en formato de duración ISO 8601. Por ejemplo: 'P90D', 'P1Y'.	cuerda
timeBeforeExpiry	Duración del tiempo antes de que expire la clave para rotar o notificar. Estará en formato de duración ISO 8601. Por ejemplo: 'P90D', 'P1Y'.	cuerda

Compartir a través de

Almacenes o claves de Microsoft.KeyVault

Observaciones

Definición de recursos de Bicep

Formato de recurso

Valores de propiedad

Acción

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

Detonante

Ejemplos de inicio rápido

Definición de recursos de plantilla de ARM

Formato de recurso

Valores de propiedad

Acción

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

Detonante

Plantillas de inicio rápido

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Valores de propiedad

Acción

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

Detonante

Comentarios

Recursos adicionales