Compartilhar via

Cofres/chaves Microsoft.KeyVault

  • Artigo

Observações

Para obter diretrizes sobre como usar cofres de chaves para valores seguros, consulte Gerenciar segredos usando o Bicep.

Para obter um início rápido sobre como criar um segredo, consulte Início Rápido: Definir e recuperar um segredo do Azure Key Vault usando um modelo do ARM.

Para obter um início rápido sobre como criar uma chave, consulte Início Rápido: Criar um cofre de chaves do Azure e uma chave usando o modelo do ARM.

Definição de recurso do Bicep

O tipo de recurso vaults/keys pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.KeyVault/vaults/keys, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2024-12-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 propriedade

Ação

Nome Descrição Valor
tipo O tipo de ação. 'notify'
'girar'

KeyAttributes

Nome Descrição Valor
Habilitado Determina se o objeto está habilitado ou não. Bool
Exp Data de expiração em segundos desde 1970-01-01T00:00:00Z. int
Exportável Indica se a chave privada pode ser exportada. Bool
nbf Não antes da data em segundos desde 1970-01-01T00:00:00Z. int

KeyCreateParametersTags

Nome Descrição Valor

KeyProperties

Nome Descrição Valor
Atributos Os atributos da chave. KeyAttributes
curveName O nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. O padrão para chaves EC e EC-HSM é P-256 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Matriz de cadeia de caracteres que contém qualquer um dos:
'descriptografar'
'encrypt'
'importar'
'release'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA. O padrão para chaves RSA e RSA-HSM é 2048. Exceção feita para trazer sua própria chave (BYOK), chaves de troca de chaves padrão para 4096. int
kty O tipo da chave. Para obter valores válidos, consulte JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'
release_policy Política de liberação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio KeyReleasePolicy
rotationPolicy Política de rotação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio RotationPolicy

KeyReleasePolicy

Nome Descrição Valor
contentType Tipo de conteúdo e versão da política de versão de chave corda
dados Codificação de blob das regras de política sob as quais a chave pode ser liberada. corda

KeyRotationPolicyAttributes

Nome Descrição Valor
expiryTime A hora de expiração da nova versão da chave. Ele deve estar no formato ISO8601. Por exemplo: 'P90D', 'P1Y'. corda

LifetimeAction

Nome Descrição Valor
ação A ação da política de rotação de chaves lifetimeAction. de Ação
gatilho O gatilho do lifetimeAction da política de rotação de chaves. de gatilho

Microsoft.KeyVault/vaults/keys

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Padrão = ^[a-zA-Z0-9-]{1,127}$ (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para o recurso do tipo: cofres
Propriedades As propriedades da chave a ser criada. KeyProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

RotationPolicy

Nome Descrição Valor
Atributos Os atributos da política de rotação de chaves. KeyRotationPolicyAttributes
lifetimeActions O lifetimeActions para a ação de rotação de chave. LifetimeAction []

Gatilho

Nome Descrição Valor
timeAfterCreate A duração do tempo após a criação da chave para girar a chave. Ele só se aplica à rotação. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda
timeBeforeExpiry A duração do tempo antes da expiração da chave para girar ou notificar. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
a Criptografia da Conta de Armazenamento do Azure com de chave gerenciada pelo cliente Esse modelo implanta uma conta de armazenamento com uma chave gerenciada pelo cliente para criptografia gerada e colocada dentro de um Key Vault.

Definição de recurso de modelo do ARM

O tipo de recurso vaults/keys pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.KeyVault/vaults/keys, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2024-12-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 propriedade

Ação

Nome Descrição Valor
tipo O tipo de ação. 'notify'
'girar'

KeyAttributes

Nome Descrição Valor
Habilitado Determina se o objeto está habilitado ou não. Bool
Exp Data de expiração em segundos desde 1970-01-01T00:00:00Z. int
Exportável Indica se a chave privada pode ser exportada. Bool
nbf Não antes da data em segundos desde 1970-01-01T00:00:00Z. int

KeyCreateParametersTags

Nome Descrição Valor

KeyProperties

Nome Descrição Valor
Atributos Os atributos da chave. KeyAttributes
curveName O nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. O padrão para chaves EC e EC-HSM é P-256 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Matriz de cadeia de caracteres que contém qualquer um dos:
'descriptografar'
'encrypt'
'importar'
'release'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA. O padrão para chaves RSA e RSA-HSM é 2048. Exceção feita para trazer sua própria chave (BYOK), chaves de troca de chaves padrão para 4096. int
kty O tipo da chave. Para obter valores válidos, consulte JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'
release_policy Política de liberação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio KeyReleasePolicy
rotationPolicy Política de rotação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio RotationPolicy

KeyReleasePolicy

Nome Descrição Valor
contentType Tipo de conteúdo e versão da política de versão de chave corda
dados Codificação de blob das regras de política sob as quais a chave pode ser liberada. corda

KeyRotationPolicyAttributes

Nome Descrição Valor
expiryTime A hora de expiração da nova versão da chave. Ele deve estar no formato ISO8601. Por exemplo: 'P90D', 'P1Y'. corda

LifetimeAction

Nome Descrição Valor
ação A ação da política de rotação de chaves lifetimeAction. de Ação
gatilho O gatilho do lifetimeAction da política de rotação de chaves. de gatilho

Microsoft.KeyVault/vaults/keys

Nome Descrição Valor
apiVersion A versão da API '2024-12-01-preview'
nome O nome do recurso corda

Restrições:
Padrão = ^[a-zA-Z0-9-]{1,127}$ (obrigatório)
Propriedades As propriedades da chave a ser criada. KeyProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.KeyVault/vaults/keys'

RotationPolicy

Nome Descrição Valor
Atributos Os atributos da política de rotação de chaves. KeyRotationPolicyAttributes
lifetimeActions O lifetimeActions para a ação de rotação de chave. LifetimeAction []

Gatilho

Nome Descrição Valor
timeAfterCreate A duração do tempo após a criação da chave para girar a chave. Ele só se aplica à rotação. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda
timeBeforeExpiry A duração do tempo antes da expiração da chave para girar ou notificar. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
a Criptografia da Conta de Armazenamento do Azure com de chave gerenciada pelo cliente

Implantar no Azure 		Esse modelo implanta uma conta de armazenamento com uma chave gerenciada pelo cliente para criptografia gerada e colocada dentro de um Key Vault.
criar uma chave no Azure KeyVault

Implantar no Azure 		Este módulo permite que você crie uma chave em um KeyVault existente.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso vaults/keys pode ser implantado com operações direcionadas:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.KeyVault/vaults/keys, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2024-12-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 propriedade

Ação

Nome Descrição Valor
tipo O tipo de ação. 'notify'
'girar'

KeyAttributes

Nome Descrição Valor
Habilitado Determina se o objeto está habilitado ou não. Bool
Exp Data de expiração em segundos desde 1970-01-01T00:00:00Z. int
Exportável Indica se a chave privada pode ser exportada. Bool
nbf Não antes da data em segundos desde 1970-01-01T00:00:00Z. int

KeyCreateParametersTags

Nome Descrição Valor

KeyProperties

Nome Descrição Valor
Atributos Os atributos da chave. KeyAttributes
curveName O nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. O padrão para chaves EC e EC-HSM é P-256 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Matriz de cadeia de caracteres que contém qualquer um dos:
'descriptografar'
'encrypt'
'importar'
'release'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA. O padrão para chaves RSA e RSA-HSM é 2048. Exceção feita para trazer sua própria chave (BYOK), chaves de troca de chaves padrão para 4096. int
kty O tipo da chave. Para obter valores válidos, consulte JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'
release_policy Política de liberação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio KeyReleasePolicy
rotationPolicy Política de rotação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio RotationPolicy

KeyReleasePolicy

Nome Descrição Valor
contentType Tipo de conteúdo e versão da política de versão de chave corda
dados Codificação de blob das regras de política sob as quais a chave pode ser liberada. corda

KeyRotationPolicyAttributes

Nome Descrição Valor
expiryTime A hora de expiração da nova versão da chave. Ele deve estar no formato ISO8601. Por exemplo: 'P90D', 'P1Y'. corda

LifetimeAction

Nome Descrição Valor
ação A ação da política de rotação de chaves lifetimeAction. de Ação
gatilho O gatilho do lifetimeAction da política de rotação de chaves. de gatilho

Microsoft.KeyVault/vaults/keys

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Padrão = ^[a-zA-Z0-9-]{1,127}$ (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: cofres
Propriedades As propriedades da chave a ser criada. KeyProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.KeyVault/vaults/keys@2024-12-01-preview"

RotationPolicy

Nome Descrição Valor
Atributos Os atributos da política de rotação de chaves. KeyRotationPolicyAttributes
lifetimeActions O lifetimeActions para a ação de rotação de chave. LifetimeAction []

Gatilho

Nome Descrição Valor
timeAfterCreate A duração do tempo após a criação da chave para girar a chave. Ele só se aplica à rotação. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda
timeBeforeExpiry A duração do tempo antes da expiração da chave para girar ou notificar. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda