Cofres/segredos microsoft.KeyVault

Definição de recurso do Bicep

O tipo de recurso cofres/segredos 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/secrets, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2025-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    attributes: {
      enabled: bool
      exp: int
      nbf: int
    }
    contentType: 'string'
    value: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores da propriedade

Microsoft.KeyVault/vaults/secrets

Atributos secretos

SecretCreateOrUpdateParametersTags

Propriedades secretas

Exemplos de uso

Exemplos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar esse tipo de recurso.

Definição de recurso de modelo do ARM

O tipo de recurso cofres/segredos 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/secrets, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.KeyVault/vaults/secrets",
  "apiVersion": "2025-05-01",
  "name": "string",
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "contentType": "string",
    "value": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores da propriedade

Microsoft.KeyVault/vaults/secrets

Atributos secretos

SecretCreateOrUpdateParametersTags

Propriedades secretas

Exemplos de uso

Modelos de início rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.

Modelo	Descrição
Gateway de Aplicativo com gerenciamento de API interno e de aplicativo Web	Gateway de Aplicativo roteando o tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno), que atende a uma API Web hospedada em um Aplicativo Web do Azure.
aplicativo de funções do Azure e uma função disparada por HTTP	Este exemplo implanta um aplicativo de funções do Azure e uma função disparada por HTTP embutida no modelo. Ele também implanta um Key Vault e preenche um segredo com a chave de host do aplicativo de funções.
Conectar-se a um Key Vault por meio de de ponto de extremidade privado	Este exemplo mostra como usar a configuração de uma rede virtual e uma zona DNS privada para acessar o Key Vault por meio do ponto de extremidade privado.
criar um Key Vault e uma lista de segredos	Esse modelo cria um Key Vault e uma lista de segredos dentro do cofre de chaves, conforme passado junto com os parâmetros
Criar um serviço de Gerenciamento de API com SSL do KeyVault	Esse modelo implanta um serviço de Gerenciamento de API configurado com a Identidade Atribuída pelo Usuário. Ele usa essa identidade para buscar o certificado SSL do KeyVault e o mantém atualizado verificando a cada 4 horas.
criar um Gateway de Aplicativo V2 com o Key Vault	Este modelo implanta um Gateway de Aplicativo V2 em uma Rede Virtual, uma identidade definida pelo usuário, Key Vault, um segredo (dados de certificado) e uma política de acesso no Key Vault e no Gateway de Aplicativo.
criar um Azure Key Vault e um secreto	Esse modelo cria um Azure Key Vault e um segredo.
criar um Azure Key Vault com RBAC e um secreto	Esse modelo cria um Azure Key Vault e um segredo. Em vez de depender de políticas de acesso, ele aproveita o RBAC do Azure para gerenciar a autorização em segredos
criar um token SAS do Azure Mapas armazenado em um do Azure Key Vault	Este modelo implanta e conta do Azure Mapas e lista um token Sas com base na identidade atribuída pelo usuário fornecida para ser armazenado em um segredo do Azure Key Vault.
Criar chaves ssh e armazenar no KeyVault	Esse modelo usa o recurso deploymentScript para gerar chaves ssh e armazena a chave privada no keyVault.
do hub FinOps	Esse modelo cria uma nova instância do hub FinOps, incluindo Data Explorer, Data Lake Storage e Data Factory.
Ambiente de teste de para o Firewall do Azure Premium	Este modelo cria um Firewall do Azure Premium e uma Política de Firewall com recursos premium, como IDPS (Detecção de Inspeção de Intrusão), inspeção do TLS e filtragem de Categoria da Web

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

O tipo de recurso cofres/segredos 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/secrets, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/secrets@2025-05-01"
  name = "string"
  parent_id = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      attributes = {
        enabled = bool
        exp = int
        nbf = int
      }
      contentType = "string"
      value = "string"
    }
  }
}

Valores da propriedade

Microsoft.KeyVault/vaults/secrets

Atributos secretos

SecretCreateOrUpdateParametersTags

Propriedades secretas

Exemplos de uso

Exemplos do Terraform

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

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
      tenantId         = data.azurerm_client_config.current.tenant_id
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  lifecycle {
    ignore_changes = [body.properties.accessPolicies]
  }
}

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

resource "azapi_resource_action" "put_secret" {
  type        = "Microsoft.KeyVault/vaults/secrets@2023-02-01"
  resource_id = data.azapi_resource_id.secret.id
  method      = "PUT"
  body = {
    properties = {
      value = "szechuan"
    }
  }
  response_export_values = ["*"]
}