Cofres/segredos Microsoft.KeyVault 2023-02-01
Comentários
Para obter orientação sobre como usar cofres de chaves para valores seguros, consulte Gerenciar segredos usando o Bicep.
Para obter um início rápido na criação de um segredo, consulte Guia de início rápido: definir e recuperar um segredo do Cofre de Chaves do Azure usando um modelo ARM.
Para obter um início rápido na criação de uma chave, consulte Guia de início rápido : criar um cofre de chaves do Azure e uma chave usando o modelo ARM.
Definição de recursos do bíceps
O tipo de recurso vaults/secrets pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.KeyVault/vaults/secrets, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2023-02-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
attributes: {
enabled: bool
exp: int
nbf: int
}
contentType: 'string'
value: 'string'
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
Microsoft.KeyVault/cofres/segredos
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | string Restrições: Padrão = ^[a-zA-Z0-9-]{1,127}$ (obrigatório) |
| 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: vaults |
| propriedades | Propriedades do segredo | SecretProperties (obrigatório) |
| Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
SecretAttributes
| Designação | Descrição | Valor |
|---|---|---|
| ativado | Determina se o objeto está habilitado. | Bool |
| exp | Data de validade em segundos desde 1970-01-01T00:00:00Z. | Int |
| NBF | Não antes da data em segundos desde 1970-01-01T00:00:00Z. | Int |
SecretCreateOrUpdateParametersTags
| Designação | Descrição | Valor |
|---|
SecretProperties
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
| Arquivo Bicep | Descrição |
|---|---|
| Application Gateway com gerenciamento interno de API e de aplicativos Web | Gateway de Aplicativo roteando tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno) que atende uma API Web hospedada em um Aplicativo Web do Azure. |
| aplicativo Azure Function e uma função acionada por HTTP | Este exemplo implanta um aplicativo Azure Function e uma função acionada por HTTP embutida no modelo. Ele também implanta um Cofre de Chaves e preenche um segredo com a chave de host do aplicativo de função. |
| Criar um Cofre de Chaves e uma lista de segredos | Este modelo cria um Cofre de Chaves e uma lista de segredos dentro do Cofre de Chaves conforme passados junto com os parâmetros |
| Criar um serviço de gerenciamento de API com SSL a partir do KeyVault | Este modelo implanta um serviço de Gerenciamento de API configurado com 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 Cofre de Chaves do Azure e um secreto | Este modelo cria um Cofre da Chave do Azure e um segredo. |
| Criar um Cofre de Chaves do Azure com RBAC e um secreto | Este modelo cria um Cofre da Chave do Azure 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 |
| hub FinOps | Este modelo cria uma nova instância de hub FinOps, incluindo armazenamento Data Lake e um Data Factory. |
| Ambiente de teste para o Azure Firewall Premium | Este modelo cria uma Política de Firewall Premium e de Firewall do Azure com recursos premium, como IDPS (Intrusion Inspection Detection), inspeção TLS e filtragem de Categoria da Web |
Definição de recurso de modelo ARM
O tipo de recurso vaults/secrets pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.KeyVault/vaults/secrets, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.KeyVault/vaults/secrets",
"apiVersion": "2023-02-01",
"name": "string",
"properties": {
"attributes": {
"enabled": "bool",
"exp": "int",
"nbf": "int"
},
"contentType": "string",
"value": "string"
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
Microsoft.KeyVault/cofres/segredos
| Designação | Descrição | Valor |
|---|---|---|
| apiVersion | A versão api | '2023-02-01' |
| Designação | O nome do recurso | string Restrições: Padrão = ^[a-zA-Z0-9-]{1,127}$ (obrigatório) |
| propriedades | Propriedades do segredo | SecretProperties (obrigatório) |
| Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
| tipo | O tipo de recurso | 'Microsoft.KeyVault/cofres/segredos' |
SecretAttributes
| Designação | Descrição | Valor |
|---|---|---|
| ativado | Determina se o objeto está habilitado. | Bool |
| exp | Data de validade em segundos desde 1970-01-01T00:00:00Z. | Int |
| NBF | Não antes da data em segundos desde 1970-01-01T00:00:00Z. | Int |
SecretCreateOrUpdateParametersTags
| Designação | Descrição | Valor |
|---|
SecretProperties
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
Application Gateway com gerenciamento interno de API e de aplicativos Web
|
Gateway de Aplicativo roteando tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno) que atende uma API Web hospedada em um Aplicativo Web do Azure. |
|
aplicativo Azure Function e uma função acionada por HTTP
|
Este exemplo implanta um aplicativo Azure Function e uma função acionada por HTTP embutida no modelo. Ele também implanta um Cofre de Chaves e preenche um segredo com a chave de host do aplicativo de função. |
|
Conecte-se a um Cofre de Chaves por meio de de ponto final privado
|
Este exemplo mostra como usar configurar uma rede virtual e uma zona DNS privada para acessar o Cofre da Chave por meio do ponto de extremidade privado. |
|
Criar um Cofre de Chaves e uma lista de segredos
|
Este modelo cria um Cofre de Chaves e uma lista de segredos dentro do Cofre de Chaves conforme passados junto com os parâmetros |
|
Criar um serviço de gerenciamento de API com SSL a partir do KeyVault
|
Este modelo implanta um serviço de Gerenciamento de API configurado com 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 Application Gateway V2 com o Key Vault
|
Este modelo implanta um Application Gateway V2 em uma rede virtual, uma identidade definida pelo usuário, o Cofre da Chave, um segredo (dados cert) e uma política de acesso no Cofre da Chave e no Application Gateway. |
|
Criar um Cofre de Chaves do Azure e um secreto
|
Este modelo cria um Cofre da Chave do Azure e um segredo. |
|
Criar um Cofre de Chaves do Azure com RBAC e um secreto
|
Este modelo cria um Cofre da Chave do Azure 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 token SAS do Azure Maps armazenado em um Cofre de Chaves do Azure
|
Este modelo implanta a conta do Azure Maps e lista um token Sas com base na identidade atribuída ao usuário fornecida para ser armazenado em um segredo do Cofre da Chave do Azure. |
|
Crie chaves ssh e armazene no KeyVault
|
Este modelo usa o recurso deploymentScript para gerar chaves ssh e armazena a chave privada no keyVault. |
|
cria um cluster HCI 23H2 do Azure Stack
|
Este modelo cria um cluster HCI 23H2 do Azure Stack usando um modelo ARM, usando IP de armazenamento personalizado |
|
cria um cluster HCI 23H2 do Azure Stack
|
Este modelo cria um cluster HCI 23H2 do Azure Stack usando um modelo ARM. |
|
cria um cluster HCI 23H2 do Azure Stack no modo de rede Switchless-Dual-link
|
Este modelo cria um cluster HCI 23H2 do Azure Stack usando um modelo ARM. |
|
cria um cluster HCI 23H2 do Azure Stack no modo de rede Switchless-SingleLink
|
Este modelo cria um cluster HCI 23H2 do Azure Stack usando um modelo ARM. |
|
hub FinOps
|
Este modelo cria uma nova instância de hub FinOps, incluindo armazenamento Data Lake e um Data Factory. |
|
Ambiente de teste para o Azure Firewall Premium
|
Este modelo cria uma Política de Firewall Premium e de Firewall do Azure com recursos premium, como IDPS (Intrusion Inspection Detection), inspeção TLS e filtragem de Categoria da Web |
|
atualiza um cluster HCI 22H2 do Azure Stack para o cluster 23H2
|
Este modelo atualiza um cluster HCI 22H2 do Azure Stack para um cluster 23H2 usando um modelo ARM. |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso vaults/secrets pode ser implantado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.KeyVault/vaults/secrets, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/secrets@2023-02-01"
name = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
attributes = {
enabled = bool
exp = int
nbf = int
}
contentType = "string"
value = "string"
}
})
}
Valores de propriedade
Microsoft.KeyVault/cofres/segredos
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso | string Restrições: Padrão = ^[a-zA-Z0-9-]{1,127}$ (obrigatório) |
| parent_id | A ID do recurso que é o pai para este recurso. | ID do recurso do tipo: cofres |
| propriedades | Propriedades do segredo | SecretProperties (obrigatório) |
| Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. |
| tipo | O tipo de recurso | "Microsoft.KeyVault/vaults/secrets@2023-02-01" |
SecretAttributes
| Designação | Descrição | Valor |
|---|---|---|
| ativado | Determina se o objeto está habilitado. | Bool |
| exp | Data de validade em segundos desde 1970-01-01T00:00:00Z. | Int |
| NBF | Não antes da data em segundos desde 1970-01-01T00:00:00Z. | Int |
SecretCreateOrUpdateParametersTags
| Designação | Descrição | Valor |
|---|