Cofres/chaves do Microsoft.KeyVault

Artigo
04/18/2024

Definição de recurso do Bicep

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

Grupos de recursos – Consulte comandos de implantação do grupo de recursos

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

Comentários

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.

Formato de recurso

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

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

Valores de propriedade

cofres/chaves

Nome	Descrição	Valor
name	O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep.	cadeia de caracteres (obrigatório)
marcas	As marcas que serão atribuídas à chave.	Dicionário de nomes e valores de marcas. Confira Marcas em modelos
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
properties	As propriedades da chave a ser criada.	KeyProperties (obrigatório)

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.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Matriz de cadeia de caracteres que contém qualquer um dos: 'descriptografar' 'encrypt' 'import' 'release' 'sign' 'unwrapKey' 'verify' 'wrapKey'
keySize	O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA.	INT
kty	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 estiver vazio	KeyReleasePolicy
rotationPolicy	Política de rotação de chaves em resposta. Ele será usado para saída e entrada. Omitido se estiver vazio	RotationPolicy

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

KeyReleasePolicy

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

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[]

KeyRotationPolicyAttributes

Nome	Descrição	Valor
expiryTime	O tempo de expiração para a nova versão da chave. Ele deve estar no formato ISO8601. Por exemplo: 'P90D', 'P1Y'.	string

LifetimeAction

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

Ação

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

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'.	string
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'.	string

Modelos de início rápido

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

Modelo	Descrição
Criar uma chave no Azure KeyVault	Este módulo permite que você crie uma chave em um KeyVault existente.
Criptografia de Conta de Armazenamento do Azure com chave gerenciada pelo cliente	Este 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:

Grupos de recursos – Consulte comandos de implantação do grupo de recursos

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

Comentários

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.

Formato de recurso

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

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

Valores de propriedade

cofres/chaves

Nome	Descrição	Valor
tipo	O tipo de recurso	'Microsoft.KeyVault/vaults/keys'
apiVersion	A versão da API de recursos	'2023-07-01'
name	O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.	cadeia de caracteres (obrigatório)
marcas	As marcas que serão atribuídas à chave.	Dicionário de nomes e valores de marcas. Confira Marcas em modelos
properties	As propriedades da chave a ser criada.	KeyProperties (obrigatório)

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.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Matriz de cadeia de caracteres que contém qualquer um dos: 'descriptografar' 'encrypt' 'import' 'release' 'sign' 'unwrapKey' 'verify' 'wrapKey'
keySize	O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA.	INT
kty	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 estiver vazio	KeyReleasePolicy
rotationPolicy	Política de rotação de chaves em resposta. Ele será usado para saída e entrada. Omitido se estiver vazio	RotationPolicy

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

KeyReleasePolicy

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

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 chaves.	LifetimeAction[]

KeyRotationPolicyAttributes

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

LifetimeAction

Nome	Descrição	Valor
ação	A ação do tempo de vida da política de rotação de chavesAction.	Ação
gatilho	O gatilho do tempo de vida da política de rotação de chavesAction.	Gatilho

Ação

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

Gatilho

Nome	Descrição	Valor
timeAfterCreate	A duração do tempo após a criação da chave para girar a chave. Aplica-se apenas à rotação. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'.	string
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'.	string

Modelos de início rápido

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

Modelo	Descrição
Criar uma chave no Azure KeyVault	Este módulo permite que você crie uma chave em um KeyVault existente.
Criptografia da Conta de Armazenamento do Azure com chave gerenciada pelo cliente	Este 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 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 das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

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

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

Valores de propriedade

cofres/chaves

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.KeyVault/vaults/keys@2023-07-01"
name	O nome do recurso	cadeia de caracteres (obrigatório)
parent_id	A ID do recurso que é o pai desse recurso.	ID do recurso do tipo: cofres
marcas	As marcas que serão atribuídas à chave.	Dicionário de nomes e valores de marcas.
properties	As propriedades da chave a ser criada.	KeyProperties (obrigatório)

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.	"P-256" "P-256K" "P-384" "P-521"
keyOps		Matriz de cadeia de caracteres que contém qualquer um dos: "descriptografar" "criptografar" "importar" "release" "sign" "unwrapKey" "verificar" "wrapKey"
keySize	O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA.	INT
kty	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 estiver vazio	KeyReleasePolicy
rotationPolicy	Política de rotação de chaves em resposta. Ele será usado para saída e entrada. Omitido se estiver vazio	RotationPolicy

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

KeyReleasePolicy

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

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 chaves.	LifetimeAction[]

KeyRotationPolicyAttributes

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

LifetimeAction

Nome	Descrição	Valor
ação	A ação do tempo de vida da política de rotação de chavesAction.	Ação
gatilho	O gatilho do tempo de vida da política de rotação de chavesAction.	Gatilho

Ação

Nome	Descrição	Valor
tipo	O tipo de ação.	"notificar" "girar"

Gatilho

Nome	Descrição	Valor
timeAfterCreate	A duração do tempo após a criação da chave para girar a chave. Aplica-se apenas à rotação. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'.	string
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'.	string

Compartilhar via

Cofres/chaves do Microsoft.KeyVault

Definição de recurso do Bicep

Comentários

Formato de recurso

Valores de propriedade

cofres/chaves

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Ação

Gatilho

Modelos de início rápido

Definição de recurso de modelo do ARM

Comentários

Formato de recurso

Valores de propriedade

cofres/chaves

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Ação

Gatilho

Modelos de início rápido

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

Formato de recurso

Valores de propriedade

cofres/chaves

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Ação

Gatilho

Comentários

Recursos adicionais