Partilhar via


Cofres/chaves Microsoft.KeyVault 2019-09-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/keys pode ser implantado com operações que visam:

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/keys, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2019-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    attributes: {
      enabled: bool
      exp: int
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

KeyAttributes

Designação Descrição Valor
ativado Determina se o objeto está habilitado ou não. 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

KeyCreateParametersTags

Designação Descrição Valor

KeyProperties

Designação Descrição Valor
atributos Os atributos da chave. KeyAttributes
curveName O nome da curva elíptica. Para valores válidos, consulte JsonWebKeyCurveName. «P-256»
«P-256K»
«P-384»
«P-521»
keyOps Matriz de cadeia de caracteres contendo qualquer uma das:
'desencriptar'
'encriptar'
«Importação»
'sinal'
'desembrulhar'
'verificar'
'Chave de embrulho'
keySize O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA. Int
KTY O tipo da chave. Para valores válidos, consulte JsonWebKeyType. «CE»
«EC-HSM»
«RSA»
'RSA-HSM'

Microsoft.KeyVault/cofres/chaves

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 As propriedades da chave a ser criada. KeyProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

Exemplos de início rápido

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

Arquivo Bicep Descrição
Criptografia de Conta de Armazenamento do Azure com chave gerenciada pelo cliente Este modelo implanta uma Conta de Armazenamento com uma chave gerenciada pelo cliente para criptografia gerada e colocada dentro de um Cofre de Chaves.

Definição de recurso de modelo ARM

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

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/keys, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2019-09-01",
  "name": "string",
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

KeyAttributes

Designação Descrição Valor
ativado Determina se o objeto está habilitado ou não. 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

KeyCreateParametersTags

Designação Descrição Valor

KeyProperties

Designação Descrição Valor
atributos Os atributos da chave. KeyAttributes
curveName O nome da curva elíptica. Para valores válidos, consulte JsonWebKeyCurveName. «P-256»
«P-256K»
«P-384»
«P-521»
keyOps Matriz de cadeia de caracteres contendo qualquer uma das:
'desencriptar'
'encriptar'
«Importação»
'sinal'
'desembrulhar'
'verificar'
'Chave de embrulho'
keySize O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA. Int
KTY O tipo da chave. Para valores válidos, consulte JsonWebKeyType. «CE»
«EC-HSM»
«RSA»
'RSA-HSM'

Microsoft.KeyVault/cofres/chaves

Designação Descrição Valor
apiVersion A versão api '2019-09-01'
Designação O nome do recurso string

Restrições:
Padrão = ^[a-zA-Z0-9-]{1,127}$ (obrigatório)
propriedades As propriedades da chave a ser criada. KeyProperties (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/chaves'

Modelos de início rápido

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

Modelo Descrição
Criptografia de Conta de Armazenamento do Azure com chave gerenciada pelo cliente

Implantar no Azure
Este modelo implanta uma Conta de Armazenamento com uma chave gerenciada pelo cliente para criptografia gerada e colocada dentro de um Cofre de Chaves.
Criar uma chave no do Azure KeyVault

Implantar no Azure
Este módulo permite que você crie uma chave em um KeyVault existente.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso vaults/keys 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/keys, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2019-09-01"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
    }
  })
}

Valores de propriedade

KeyAttributes

Designação Descrição Valor
ativado Determina se o objeto está habilitado ou não. 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

KeyCreateParametersTags

Designação Descrição Valor

KeyProperties

Designação Descrição Valor
atributos Os atributos da chave. KeyAttributes
curveName O nome da curva elíptica. Para valores válidos, consulte JsonWebKeyCurveName. «P-256»
«P-256K»
«P-384»
«P-521»
keyOps Matriz de cadeia de caracteres contendo qualquer uma das:
'desencriptar'
'encriptar'
«Importação»
'sinal'
'desembrulhar'
'verificar'
'Chave de embrulho'
keySize O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA. Int
KTY O tipo da chave. Para valores válidos, consulte JsonWebKeyType. «CE»
«EC-HSM»
«RSA»
'RSA-HSM'

Microsoft.KeyVault/cofres/chaves

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 As propriedades da chave a ser criada. KeyProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.KeyVault/vaults/keys@2019-09-01"