Cofres/chaves Microsoft.KeyVault
Definição de recurso bicep
O tipo de recurso de abóbadas/chaves pode ser implantado para:
- Grupos de recursos - Ver comandos de implantação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão API, consulte o registo de alteração.
Observações
Para obter orientações sobre a utilização de cofres-chave para obter valores seguros, consulte Gerir segredos utilizando o Bicep.
Para iniciar rapidamente a criação de um segredo, consulte Quickstart: set and recupere um segredo do Azure Key Vault usando um modelo ARM.
Para iniciar rapidamente a criação de uma chave, consulte Quickstart: Crie um cofre de chave Azure e uma chave utilizando o modelo ARM.
Formato de recursos
Para criar um recurso Microsoft.KeyVault/vaults/keys, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.KeyVault/vaults/keys@2022-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 imobiliários
cofres/chaves
Nome | Descrição | Valor |
---|---|---|
name | O nome do recurso Veja como definir nomes e tipos de recursos para crianças em Bicep. |
corda (necessária) |
etiquetas | As etiquetas que serão atribuídas à chave. | Dicionário de nomes e valores de etiquetas. Ver Tags em modelos |
pai | Em Bicep, pode especificar o recurso principal para um recurso infantil. Só precisa de adicionar esta propriedade quando o recurso da criança for declarado fora do recurso principal. Para obter mais informações, consulte o recurso Child fora do recurso dos pais. |
Nome simbólico para recurso do tipo: abóbadas |
propriedades | As propriedades da chave a ser criada. | KeyProperties (necessárias) |
KeyProperties
Nome | Descrição | Valor |
---|---|---|
atributos | Os atributos da chave. | KeyAttributes |
nome curva | O nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. | 'P-256' 'P-256K' 'P-384' 'P-521' |
keyOps | Matriz de cordas que contém qualquer um dos seguintes: 'desencriptação' 'encriptar' «Importação» 'lançamento' 'sinal' 'Desembrulhar aKey' 'verificar' 'wrapKey' |
|
keySize | O tamanho da chave em pedaços. Por exemplo: 2048, 3072 ou 4096 para RSA. | int |
kty | O tipo da chave. Para obter valores válidos, consulte JsonWebKeyType. | «CE» 'EC-HSM' 'RSA' 'RSA-HSM' |
release_policy | Política de libertação chave em resposta. Será utilizado tanto para a saída como para a entrada. Omitido se vazio | Política keyRelease |
rotaçãoPolícia | Política de rotação chave em resposta. Será utilizado tanto para a saída como para a entrada. Omitido se vazio | RotaçãoPolítica |
KeyAttributes
Nome | Descrição | Valor |
---|---|---|
ativado | Determina se o objeto está ou não ativado. | bool |
exp | Data de validade em segundos desde 1970-01-01T00:00:00Z. | int |
exportável | Indica se a chave privada pode ser exportada. | bool |
nbf | Não antes da data em segundos desde 1970-01-01T00:00:00Z. | int |
Política keyRelease
Nome | Descrição | Valor |
---|---|---|
conteúdoType | Tipo de conteúdo e versão da política de lançamento chave | string |
dados | Blob codificando as regras políticas segundo as quais a chave pode ser liberada. | string |
RotaçãoPolítica
Nome | Descrição | Valor |
---|---|---|
atributos | Os atributos da política de rotação chave. | KeyRotationPolicyAttributes |
lifetimeActions | As 40 00as para a ação de rotação de chaves. | LifetimeAction[] |
KeyRotationPolicyAttributes
Nome | Descrição | Valor |
---|---|---|
prazo de validade Tempo | O tempo de validade para a nova versão chave. Deve estar no formato ISO8601. Por exemplo: 'P90D', 'P1Y'. | string |
Reação vitalícia
Nome | Descrição | Valor |
---|---|---|
action | A ação da chave rotação política de vidaAcção. | Ação |
gatilho | O gatilho da chave rotação da política de vidaAcção. | Acionador |
Ação
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de ação. | 'notificar' 'rodar' |
Acionador
Nome | Descrição | Valor |
---|---|---|
timeAfterCreate | A duração do tempo após a criação da chave para rodar a chave. Só se aplica a rodar. Estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. | string |
tempoBeforeExpiry | A duração do tempo antes da chave expirar para rodar ou notificar. Estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. | string |
Modelos de início rápido
Os seguintes modelos de arranque rápido implementam este tipo de recurso.
Modelo | Descrição |
---|---|
Criar uma chave em Azure KeyVault |
Este módulo permite-lhe criar uma chave num KeyVault existente. |
Encriptação da conta de armazenamento Azure com chave gerida pelo cliente |
Este modelo implementa uma Conta de Armazenamento com uma chave gerida pelo cliente para encriptação que é gerada e colocada dentro de uma Key Vault. |
Definição de recurso de modelo DE ARM
O tipo de recurso de abóbadas/chaves pode ser implantado para:
- Grupos de recursos - Ver comandos de implantação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão API, consulte o registo de alteração.
Observações
Para obter orientações sobre a utilização de cofres-chave para obter valores seguros, consulte Gerir segredos utilizando o Bicep.
Para iniciar rapidamente a criação de um segredo, consulte Quickstart: set and recupere um segredo do Azure Key Vault usando um modelo ARM.
Para iniciar rapidamente a criação de uma chave, consulte Quickstart: Crie um cofre de chave Azure e uma chave utilizando o modelo ARM.
Formato de recursos
Para criar um recurso Microsoft.KeyVault/vaults/keys, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.KeyVault/vaults/keys",
"apiVersion": "2022-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 imobiliários
cofres/chaves
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | 'Microsoft.KeyVault/vaults/keys' |
apiVersion | A versão api de recurso | '2022-07-01' |
name | O nome do recurso Veja como definir nomes e tipos de recursos para crianças em modelos JSON ARM. |
corda (necessária) |
etiquetas | As etiquetas que serão atribuídas à chave. | Dicionário de nomes e valores de etiquetas. Ver Tags em modelos |
propriedades | As propriedades da chave a ser criada. | KeyProperties (necessárias) |
KeyProperties
Nome | Descrição | Valor |
---|---|---|
atributos | Os atributos da chave. | KeyAttributes |
nome curva | O nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. | 'P-256' 'P-256K' 'P-384' 'P-521' |
keyOps | Matriz de cordas que contém qualquer um dos seguintes: 'desencriptação' 'encriptar' «Importação» 'lançamento' 'sinal' 'Desembrulhar aKey' 'verificar' 'wrapKey' |
|
keySize | O tamanho da chave em pedaços. Por exemplo: 2048, 3072 ou 4096 para RSA. | int |
kty | O tipo da chave. Para obter valores válidos, consulte JsonWebKeyType. | «CE» 'EC-HSM' 'RSA' 'RSA-HSM' |
release_policy | Política de libertação chave em resposta. Será utilizado tanto para a saída como para a entrada. Omitido se vazio | Política keyRelease |
rotaçãoPolícia | Política de rotação chave em resposta. Será utilizado tanto para a saída como para a entrada. Omitido se vazio | RotaçãoPolítica |
KeyAttributes
Nome | Descrição | Valor |
---|---|---|
ativado | Determina se o objeto está ou não ativado. | bool |
exp | Data de validade em segundos desde 1970-01-01T00:00:00Z. | int |
exportável | Indica se a chave privada pode ser exportada. | bool |
nbf | Não antes da data em segundos desde 1970-01-01T00:00:00Z. | int |
Política keyRelease
Nome | Descrição | Valor |
---|---|---|
conteúdoType | Tipo de conteúdo e versão da política de lançamento chave | string |
dados | Blob codificando as regras políticas segundo as quais a chave pode ser liberada. | string |
RotaçãoPolítica
Nome | Descrição | Valor |
---|---|---|
atributos | Os atributos da política de rotação chave. | KeyRotationPolicyAttributes |
lifetimeActions | As 40 00as para a ação de rotação de chaves. | LifetimeAction[] |
KeyRotationPolicyAttributes
Nome | Descrição | Valor |
---|---|---|
prazo de validade Tempo | O tempo de validade para a nova versão chave. Deve estar no formato ISO8601. Por exemplo: 'P90D', 'P1Y'. | string |
Reação vitalícia
Nome | Descrição | Valor |
---|---|---|
action | A ação da chave rotação política de vidaAcção. | Ação |
gatilho | O gatilho da chave rotação da política de vidaAcção. | Acionador |
Ação
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de ação. | 'notificar' 'rodar' |
Acionador
Nome | Descrição | Valor |
---|---|---|
timeAfterCreate | A duração do tempo após a criação da chave para rodar a chave. Só se aplica a rodar. Estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. | string |
tempoBeforeExpiry | A duração do tempo antes da chave expirar para rodar ou notificar. Estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. | string |
Modelos de início rápido
Os seguintes modelos de arranque rápido implementam este tipo de recurso.
Modelo | Descrição |
---|---|
Criar uma chave em Azure KeyVault |
Este módulo permite-lhe criar uma chave num KeyVault existente. |
Encriptação da conta de armazenamento Azure com chave gerida pelo cliente |
Este modelo implementa uma Conta de Armazenamento com uma chave gerida pelo cliente para encriptação que é gerada e colocada dentro de uma Key Vault. |
Definição de recursos Terraform (fornecedor AzAPI)
O tipo de recurso de abóbadas/chaves pode ser implantado para:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão API, consulte o registo de alteração.
Formato de recursos
Para criar um recurso Microsoft.KeyVault/vaults/keys, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/keys@2022-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 imobiliários
cofres/chaves
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | "Microsoft.KeyVault/vaults/keys@2022-07-01" |
name | O nome do recurso | corda (necessária) |
parent_id | A identificação do recurso que é o pai deste recurso. | ID para recurso do tipo: cofres |
etiquetas | As etiquetas que serão atribuídas à chave. | Dicionário de nomes e valores de etiquetas. |
propriedades | As propriedades da chave a ser criada. | KeyProperties (necessárias) |
KeyProperties
Nome | Descrição | Valor |
---|---|---|
atributos | Os atributos da chave. | KeyAttributes |
nome curva | O nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. | "P-256" "P-256K" "P-384" "P-521" |
keyOps | Matriz de cordas que contém qualquer um dos seguintes: "desencriptação" "encriptar" "importação" "lançamento" "sinal" "DesembrulharKey" "verificar" "wrapKey" |
|
keySize | O tamanho da chave em pedaços. Por exemplo: 2048, 3072 ou 4096 para RSA. | int |
kty | O tipo da chave. Para obter valores válidos, consulte JsonWebKeyType. | "CE" "EC-HSM" "RSA" "RSA-HSM" |
release_policy | Política de libertação chave em resposta. Será utilizado tanto para a saída como para a entrada. Omitido se vazio | Política keyRelease |
rotaçãoPolícia | Política de rotação chave em resposta. Será utilizado tanto para a saída como para a entrada. Omitido se vazio | RotaçãoPolítica |
KeyAttributes
Nome | Descrição | Valor |
---|---|---|
ativado | Determina se o objeto está ou não ativado. | bool |
exp | Data de validade em segundos desde 1970-01-01T00:00:00Z. | int |
exportável | Indica se a chave privada pode ser exportada. | bool |
nbf | Não antes da data em segundos desde 1970-01-01T00:00:00Z. | int |
Política keyRelease
Nome | Descrição | Valor |
---|---|---|
conteúdoType | Tipo de conteúdo e versão da política de lançamento chave | string |
dados | Blob codificando as regras políticas segundo as quais a chave pode ser liberada. | string |
RotaçãoPolítica
Nome | Descrição | Valor |
---|---|---|
atributos | Os atributos da política de rotação chave. | KeyRotationPolicyAttributes |
lifetimeActions | As 40 00as para a ação de rotação de chaves. | LifetimeAction[] |
KeyRotationPolicyAttributes
Nome | Descrição | Valor |
---|---|---|
prazo de validade Tempo | O tempo de validade para a nova versão chave. Deve estar no formato ISO8601. Por exemplo: 'P90D', 'P1Y'. | string |
Reação vitalícia
Nome | Descrição | Valor |
---|---|---|
action | A ação da chave rotação política de vidaAcção. | Ação |
gatilho | O gatilho da chave rotação da política de vidaAcção. | Acionador |
Ação
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de ação. | "notificar" "rodar" |
Acionador
Nome | Descrição | Valor |
---|---|---|
timeAfterCreate | A duração do tempo após a criação da chave para rodar a chave. Só se aplica a rodar. Estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. | string |
tempoBeforeExpiry | A duração do tempo antes da chave expirar para rodar ou notificar. Estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. | string |
Comentários
https://aka.ms/ContentUserFeedback.
Brevemente: ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja:Submeter e ver comentários