Cofres/chaves Microsoft.KeyVault

Definição de recurso do Bicep

O tipo de recurso cofres/chaves pode ser implementado com operações que visam:

• Grupos de recursos – veja comandos de implementação de grupos de recursos

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

Observações

Para obter orientações sobre como utilizar cofres de chaves para valores seguros, veja Gerir segredos com o Bicep.

Para obter um início rápido sobre a criação de um segredo, veja Início Rápido: Definir e obter um segredo do Azure Key Vault através de um modelo do ARM.

Para obter um início rápido sobre a criação de uma chave, veja Início Rápido: Criar um cofre de chaves do Azure e uma chave com o modelo do ARM.

Formato do recurso

Para criar um recurso Microsoft.KeyVault/vaults/keys, adicione o seguinte Bicep ao seu 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

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Ação

Acionador

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Criar uma Chave no Azure KeyVault	Este módulo permite-lhe criar uma chave num KeyVault existente.
Encriptação de Conta de Armazenamento do Azure com chave gerida pelo cliente	Este modelo implementa uma Conta de Armazenamento com uma chave gerida pelo cliente para encriptação gerada e colocada dentro de um Key Vault.

Definição de recurso de modelo do ARM

O tipo de recurso cofres/chaves pode ser implementado com operações que visam:

• Grupos de recursos – veja comandos de implementação de grupos de recursos

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

Observações

Para obter orientações sobre como utilizar cofres de chaves para valores seguros, veja Gerir segredos com o Bicep.

Para obter um início rápido sobre a criação de um segredo, veja Início Rápido: Definir e obter um segredo do Azure Key Vault através de um modelo do ARM.

Para obter um início rápido sobre a criação de uma chave, veja Início Rápido: Criar um cofre de chaves do Azure e uma chave com o modelo do ARM.

Formato do recurso

Para criar um recurso Microsoft.KeyVault/vaults/keys, adicione o seguinte JSON ao seu 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

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Ação

Acionador

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Criar uma Chave no Azure KeyVault	Este módulo permite-lhe criar uma chave num KeyVault existente.
Encriptação da Conta de Armazenamento do Azure com chave gerida pelo cliente	Este modelo implementa uma Conta de Armazenamento com uma chave gerida pelo cliente para encriptação gerada e colocada dentro de um Key Vault.

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso cofres/chaves pode ser implementado com operações que visam:

• Grupos de recursos

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

Formato do recurso

Para criar um recurso Microsoft.KeyVault/vaults/keys, adicione o seguinte Terraform ao seu 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

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Ação

Acionador