Almacenes o claves de Microsoft.KeyVault

Definición de recursos de Bicep

El tipo de recurso vaults/keys se puede implementar en:

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

Comentarios

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

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 una plantilla de ARM.

Formato de los recursos

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

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

Valores de propiedades

vaults/keys

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.
string (obligatorio)
etiquetas Las etiquetas que se asignarán a la clave. Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
primario 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 más información, consulte Recurso secundario fuera del recurso primario.
Nombre simbólico del recurso de tipo: almacenes
properties Propiedades de la clave que se va a crear. KeyProperties (obligatorio)

KeyProperties

Nombre Descripción Valor
attributes 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:
'decrypt'
'encrypt'
'import'
'release'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize Tamaño de la 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 liberación de claves 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

KeyAttributes

Nombre Descripción Valor
enabled 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

KeyReleasePolicy

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

RotationPolicy

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

KeyRotationPolicyAttributes

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

LifetimeAction

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

Acción

Nombre Descripción Value
type Tipo de acción. 'notify'
'girar'

Desencadenador

Nombre Descripción Valor
timeAfterCreate Duración del tiempo después de la creación de la clave para rotar la clave. Solo se aplica a la rotación. Estará en formato de duración ISO 8601. Por ejemplo: 'P90D', 'P1Y'. string
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'. string

Plantillas de inicio rápido

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

Plantilla Descripción
Creación de una clave en Azure KeyVault

Implementación en Azure
Este módulo permite crear una clave en un almacén de claves existente.
Cifrado de cuentas de Azure Storage con clave administrada por el cliente

Implementación en Azure
Esta plantilla implementa una cuenta de almacenamiento con una clave administrada por el cliente para el cifrado que se genera y se coloca dentro de un Key Vault.

Definición de recursos de plantilla de ARM

El tipo de recurso vaults/keys se puede implementar en:

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

Comentarios

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

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 una plantilla de ARM.

Formato de los recursos

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

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2022-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"
          }
        }
      ]
    }
  }
}

Valores de propiedades

vaults/keys

Nombre Descripción Value
type Tipo de recurso "Microsoft.KeyVault/vaults/keys"
apiVersion La versión de la API de recursos '2022-07-01'
name El nombre del recurso

Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.
string (obligatorio)
etiquetas Las etiquetas que se asignarán a la clave. Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
properties Propiedades de la clave que se va a crear. KeyProperties (obligatorio)

KeyProperties

Nombre Descripción Valor
attributes 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:
'decrypt'
'encrypt'
'import'
'release'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize Tamaño de la 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 liberación de claves 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

KeyAttributes

Nombre Descripción Valor
enabled 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

KeyReleasePolicy

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

RotationPolicy

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

KeyRotationPolicyAttributes

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

LifetimeAction

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

Acción

Nombre Descripción Value
type Tipo de acción. 'notify'
'girar'

Desencadenador

Nombre Descripción Valor
timeAfterCreate Duración del tiempo después de la creación de la clave para rotar la clave. Solo se aplica a la rotación. Estará en formato de duración ISO 8601. Por ejemplo: "P90D", "P1Y". string
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". string

Plantillas de inicio rápido

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

Plantilla Descripción
Creación de una clave en Azure KeyVault

Implementación en Azure
Este módulo permite crear una clave en un keyVault existente.
Cifrado de cuenta de Azure Storage con clave administrada por el cliente

Implementación en Azure
Esta plantilla implementa una cuenta de almacenamiento con una clave administrada por el cliente para el cifrado generado y colocado dentro de un Key Vault.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso vaults/keys se puede implementar en:

  • Grupos de recursos

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

Formato de los recursos

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

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

Valores de propiedades

vaults/keys

Nombre Descripción Value
type Tipo de recurso "Microsoft.KeyVault/vaults/keys@2022-07-01"
name El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: almacenes
etiquetas Etiquetas que se asignarán a la clave. Diccionario de nombres y valores de etiqueta.
properties Propiedades de la clave que se va a crear. KeyProperties (obligatorio)

KeyProperties

Nombre Descripción Valor
attributes 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:
"descifrar"
"cifrar"
"import"
"release"
"sign"
"unwrapKey"
"verify"
"wrapKey"
keySize Tamaño de la 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 liberación de claves 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

KeyAttributes

Nombre Descripción Valor
enabled 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

KeyReleasePolicy

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

RotationPolicy

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

KeyRotationPolicyAttributes

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

LifetimeAction

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

Acción

Nombre Descripción Value
type Tipo de acción. "notificar"
"girar"

Desencadenador

Nombre Descripción Valor
timeAfterCreate Duración del tiempo después de la creación de la clave para rotar la clave. Solo se aplica a la rotación. Estará en formato de duración ISO 8601. Por ejemplo: 'P90D', 'P1Y'. string
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'. string