Microsoft.KeyVault/vaults/secrets - Bicep, ARM template & Terraform AzAPI reference

Definição de recurso do Bicep

O tipo de recurso cofres/segredos 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.

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.

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@2023-07-01' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    attributes: {
      enabled: bool
      exp: int
      nbf: int
    }
    contentType: 'string'
    value: 'string'
  }
}

Valores de propriedade

cofres/segredos

Nome	Descrição	Valor
nome	O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep.	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 127 Caracteres válidos: Alfanuméricos e hifens.
Tags	As marcas que serão atribuídas ao segredo.	Dicionário de nomes e valores de marca. Consulte 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
Propriedades	Propriedades do segredo	SecretProperties (obrigatório)

SecretProperties

Nome	Descrição	Valor
Atributos	Os atributos do segredo.	SecretAttributes
contentType	O tipo de conteúdo do segredo.	corda
valor	O valor do segredo. OBSERVAÇÃO: o 'valor' nunca será retornado do serviço, pois as APIs que usam esse modelo são destinadas ao uso interno em implantações do ARM. Os usuários devem usar o serviço REST do plano de dados para interação com segredos do cofre.	corda

SecretAttributes

Nome	Descrição	Valor
Habilitado	Determina se o objeto está habilitado.	Bool
Exp	Data de expiração em segundos desde 1970-01-01T00:00:00Z.	int
nbf	Não antes da data em segundos desde 1970-01-01T00:00:00Z.	int

Modelos de início rápido

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

Modelo	Descrição
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.
cria um cluster do Azure Stack HCI 23H2	Esse modelo cria um cluster Azure Stack HCI 23H2 usando um modelo do ARM.
cria um cluster do Azure Stack HCI 23H2	Este modelo cria um cluster do Azure Stack HCI 23H2 usando um modelo do ARM usando o IP de armazenamento personalizado
cria um cluster do Azure Stack HCI 23H2 no modo de rede de link duplo sem alternância	Esse modelo cria um cluster Azure Stack HCI 23H2 usando um modelo do ARM.
cria um cluster do Azure Stack HCI 23H2 no modo de rede Switchless-SingleLink	Esse modelo cria um cluster Azure Stack HCI 23H2 usando um modelo do ARM.
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
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 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 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.
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
Criar chaves ssh e armazenar no KeyVault	Esse modelo usa o recurso deploymentScript para gerar chaves ssh e armazena a chave privada no keyVault.
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.
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.

Definição de recurso de modelo do ARM

O tipo de recurso cofres/segredos 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.

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.

Formato de recurso

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

{
  "type": "Microsoft.KeyVault/vaults/secrets",
  "apiVersion": "2023-07-01",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "contentType": "string",
    "value": "string"
  }
}

Valores de propriedade

cofres/segredos

Nome	Descrição	Valor
tipo	O tipo de recurso	'Microsoft.KeyVault/vaults/secrets'
apiVersion	A versão da API do recurso	'2023-07-01'
nome	O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 127 Caracteres válidos: Alfanuméricos e hifens.
Tags	As marcas que serão atribuídas ao segredo.	Dicionário de nomes e valores de marca. Consulte Marcas em modelos
Propriedades	Propriedades do segredo	SecretProperties (obrigatório)

SecretProperties

Nome	Descrição	Valor
Atributos	Os atributos do segredo.	SecretAttributes
contentType	O tipo de conteúdo do segredo.	corda
valor	O valor do segredo. OBSERVAÇÃO: o 'valor' nunca será retornado do serviço, pois as APIs que usam esse modelo são destinadas ao uso interno em implantações do ARM. Os usuários devem usar o serviço REST do plano de dados para interação com segredos do cofre.	corda

SecretAttributes

Nome	Descrição	Valor
Habilitado	Determina se o objeto está habilitado.	Bool
Exp	Data de expiração em segundos desde 1970-01-01T00:00:00Z.	int
nbf	Não antes da data em segundos desde 1970-01-01T00:00:00Z.	int

Modelos de início rápido

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

Modelo	Descrição
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.
cria um cluster do Azure Stack HCI 23H2	Esse modelo cria um cluster Azure Stack HCI 23H2 usando um modelo do ARM.
cria um cluster do Azure Stack HCI 23H2	Este modelo cria um cluster do Azure Stack HCI 23H2 usando um modelo do ARM usando o IP de armazenamento personalizado
cria um cluster do Azure Stack HCI 23H2 no modo de rede de link duplo sem alternância	Esse modelo cria um cluster Azure Stack HCI 23H2 usando um modelo do ARM.
cria um cluster do Azure Stack HCI 23H2 no modo de rede Switchless-SingleLink	Esse modelo cria um cluster Azure Stack HCI 23H2 usando um modelo do ARM.
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
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 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 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.
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
Criar chaves ssh e armazenar no KeyVault	Esse modelo usa o recurso deploymentScript para gerar chaves ssh e armazena a chave privada no keyVault.
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.
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.

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/secrets@2023-07-01"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        nbf = int
      }
      contentType = "string"
      value = "string"
    }
  })
}

Valores de propriedade

cofres/segredos

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.KeyVault/vaults/secrets@2023-07-01"
nome	O nome do recurso	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 127 Caracteres válidos: Alfanuméricos e hifens.
parent_id	A ID do recurso que é o pai desse recurso.	ID do recurso do tipo: cofres
Tags	As marcas que serão atribuídas ao segredo.	Dicionário de nomes e valores de marca.
Propriedades	Propriedades do segredo	SecretProperties (obrigatório)

SecretProperties

Nome	Descrição	Valor
Atributos	Os atributos do segredo.	SecretAttributes
contentType	O tipo de conteúdo do segredo.	corda
valor	O valor do segredo. OBSERVAÇÃO: o 'valor' nunca será retornado do serviço, pois as APIs que usam esse modelo são destinadas ao uso interno em implantações do ARM. Os usuários devem usar o serviço REST do plano de dados para interação com segredos do cofre.	corda

SecretAttributes

Nome	Descrição	Valor
Habilitado	Determina se o objeto está habilitado.	Bool
Exp	Data de expiração em segundos desde 1970-01-01T00:00:00Z.	int
nbf	Não antes da data em segundos desde 1970-01-01T00:00:00Z.	int

Compartilhar via

Cofres/segredos microsoft.KeyVault

Definição de recurso do Bicep

Observações

Formato de recurso

Valores de propriedade

cofres/segredos

SecretProperties

SecretAttributes

Modelos de início rápido

Definição de recurso de modelo do ARM

Observações

Formato de recurso

Valores de propriedade

cofres/segredos

SecretProperties

SecretAttributes

Modelos de início rápido

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

Formato de recurso

Valores de propriedade

cofres/segredos

SecretProperties

SecretAttributes

Comentários

Recursos adicionais