Cofres/chaves Microsoft.KeyVault

Definição de recurso 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 de propriedades alteradas em cada versão da API, consulte de log de alterações.

Exemplos de uso

Amostras de Bicep

Um exemplo básico de implantação do Key Vault Keys.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource vault 'Microsoft.KeyVault/vaults@2023-02-01' = {
  name: resourceName
  location: location
  properties: {
    sku: {
      family: 'A'
      name: 'standard'
    }
    accessPolicies: []
    enableSoftDelete: true
    enablePurgeProtection: true
    tenantId: tenant().tenantId
  }
}

resource putAccesspolicy 'Microsoft.KeyVault/vaults/accessPolicies@2023-02-01' = {
  name: 'add'
  parent: vault
  properties: {
    accessPolicies: [
      {
        objectId: deployer().objectId
        permissions: {
          certificates: [
            'ManageContacts'
          ]
          keys: [
            'Get'
            'Create'
            'Delete'
            'List'
            'Restore'
            'Recover'
            'UnwrapKey'
            'WrapKey'
            'Purge'
            'Encrypt'
            'Decrypt'
            'Sign'
            'Verify'
          ]
          secrets: [
            'Get'
          ]
          storage: []
        }
        tenantId: tenant().tenantId
      }
    ]
  }
}

resource putKey 'Microsoft.KeyVault/vaults/keys@2023-02-01' = {
  name: resourceName
  parent: vault
  dependsOn: [
    putAccesspolicy
  ]
  properties: {
    keyOps: [
      'encrypt'
      'decrypt'
      'sign'
      'verify'
      'wrapKey'
      'unwrapKey'
    ]
    keySize: 2048
    kty: 'RSA'
  }
}

Módulos verificados do Azure

Os seguintes módulos Azure Verificados podem ser usados para implantar esse tipo de recurso.

Exemplos de Início Rápido do Azure

Os seguintes modelos Azure Quickstart contêm Bicep exemplos para implantar esse tipo de recurso.

Formato de recurso

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

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2026-03-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

Microsoft.KeyVault/cofres/chaves

Ação

Atributos-chave

KeyCreateParametersTags

Propriedades-chave

KeyReleasePolicy

Atributos KeyRotationPolicyAttributes

Ação vitalícia

Política de rotação

Gatilho

Definição de recurso de modelo do ARM

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

• Grupos de recursos - Veja comandos de implantação de grupos de recursos Para uma lista de propriedades alteradas em cada versão da API, veja registro de alterações.

Exemplos de uso

Modelos de Início Rápido do Azure

Os seguintes modelos Azure Quickstart implantam esse tipo de recurso.

Modelo	Descrição
Armazenamento do Azure Criptografia de Conta com chave gerenciada pelo cliente	Esse modelo implanta uma Conta de Armazenamento com uma chave gerenciada pelo cliente para criptografia, que é gerada e colocada dentro de um Key Vault.
Crie uma chave no Azure KeyVault	Este módulo permite que você crie uma chave em um KeyVault existente.

Formato de recurso

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

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

Microsoft.KeyVault/cofres/chaves

Ação

Atributos-chave

KeyCreateParametersTags

Propriedades-chave

KeyReleasePolicy

Atributos KeyRotationPolicyAttributes

Ação vitalícia

Política de rotação

Gatilho

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 uma lista das propriedades alteradas em cada versão da API, veja o registro de alterações.

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do Key Vault Keys.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
    azurerm = {
      source = "hashicorp/azurerm"
    }
  }
}

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

data "azurerm_client_config" "current" {
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "vault" {
  type      = "Microsoft.KeyVault/vaults@2023-02-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      sku = {
        family = "A"
        name   = "standard"
      }
      accessPolicies        = []
      enableSoftDelete      = true
      enablePurgeProtection = true
      tenantId              = data.azurerm_client_config.current.tenant_id
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  lifecycle {
    ignore_changes = [body.properties.accessPolicies]
  }
}

resource "azapi_resource_action" "put_accessPolicy" {
  type        = "Microsoft.KeyVault/vaults/accessPolicies@2023-02-01"
  resource_id = "${azapi_resource.vault.id}/accessPolicies/add"
  method      = "PUT"
  body = {
    properties = {
      accessPolicies = [
        {
          objectId = data.azurerm_client_config.current.object_id
          permissions = {
            certificates = [
              "ManageContacts",
            ]
            keys = [
              "Get", "Create", "Delete", "List", "Restore", "Recover", "UnwrapKey", "WrapKey", "Purge", "Encrypt", "Decrypt", "Sign", "Verify"
            ]
            secrets = [
              "Get",
            ]
            storage = [
            ]
          }
          tenantId = data.azurerm_client_config.current.tenant_id
        },
      ]
    }
  }
  response_export_values = ["*"]
}

data "azapi_resource_id" "key" {
  type      = "Microsoft.KeyVault/vaults/keys@2023-02-01"
  parent_id = azapi_resource.vault.id
  name      = var.resource_name
}

resource "azapi_resource_action" "put_key" {
  type        = "Microsoft.KeyVault/vaults/keys@2023-02-01"
  resource_id = data.azapi_resource_id.key.id
  method      = "PUT"
  body = {
    properties = {
      keySize = 2048
      kty     = "RSA"
      keyOps  = ["encrypt", "decrypt", "sign", "verify", "wrapKey", "unwrapKey"]
    }
  }
  response_export_values = ["*"]
  depends_on             = [azapi_resource_action.put_accessPolicy]
}

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@2026-03-01-preview"
  name = "string"
  parent_id = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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

Microsoft.KeyVault/cofres/chaves

Ação

Atributos-chave

KeyCreateParametersTags

Propriedades-chave

KeyReleasePolicy

Atributos KeyRotationPolicyAttributes

Ação vitalícia

Política de rotação

Gatilho