Ler em inglês

Compartilhar via

Microsoft.KeyVault managedHSMs/keys 2024-11-01

  • Artigo
Escolher um idioma de implantação

Definição de recurso do Bicep

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs/keys@2024-11-01' = {
  parent: resourceSymbolicName
  name: 'string'
  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'
          }
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores da propriedade

ManagedHsmAction

Nome Descrição Valor
tipo O tipo de ação. 'notify'
'girar'

ManagedHsmKeyAttributes

Nome Descrição Valor
Habilitado Determina se o objeto está habilitado ou não. Bool
Exp Data de expiração 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

ManagedHsmKeyCreateParametersTags

Nome Descrição Valor

ManagedHsmKeyProperties

Nome Descrição Valor
Atributos Os atributos da chave. ManagedHsmKeyAttributes
curveName O nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. O padrão para chaves EC e EC-HSM é P-256 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Matriz de cadeia de caracteres que contém qualquer um dos:
'descriptografar'
'encrypt'
'importar'
'release'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA. O padrão para chaves RSA e RSA-HSM é 2048. Exceção feita para trazer sua própria chave (BYOK), chaves de troca de chaves padrão para 4096. int
kty O tipo da chave. Para obter valores válidos, consulte JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'
release_policy Política de liberação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio ManagedHsmKeyReleasePolicy
rotationPolicy Política de rotação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

Nome Descrição Valor
contentType Tipo de conteúdo e versão da política de versão de chave corda
dados Codificação de blob das regras de política sob as quais a chave pode ser liberada. corda

ManagedHsmKeyRotationPolicyAttributes

Nome Descrição Valor
expiryTime A hora de expiração da nova versão da chave. Ele deve estar no formato ISO8601. Por exemplo: 'P90D', 'P1Y'. corda

ManagedHsmLifetimeAction

Nome Descrição Valor
ação A ação da política de rotação de chaves lifetimeAction. ManagedHsmAction
gatilho O gatilho do lifetimeAction da política de rotação de chaves. ManagedHsmTrigger

ManagedHsmRotationPolicy

Nome Descrição Valor
Atributos Os atributos da política de rotação de chaves. ManagedHsmKeyRotationPolicyAttributes
lifetimeActions O lifetimeActions para a ação de rotação de chave. ManagedHsmLifetimeAction []

ManagedHsmTrigger

Nome Descrição Valor
timeAfterCreate A duração do tempo após a criação da chave para girar a chave. Ele só se aplica à rotação. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda
timeBeforeExpiry A duração do tempo antes da expiração da chave para girar ou notificar. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda

Microsoft.KeyVault/managedHSMs/keys

Nome Descrição Valor
nome O nome do recurso corda

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 do recurso do tipo: managedHSMs
Propriedades As propriedades da chave a ser criada. ManagedHsmKeyProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

Definição de recurso de modelo do ARM

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

{
  "type": "Microsoft.KeyVault/managedHSMs/keys",
  "apiVersion": "2024-11-01",
  "name": "string",
  "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"
          }
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores da propriedade

ManagedHsmAction

Nome Descrição Valor
tipo O tipo de ação. 'notify'
'girar'

ManagedHsmKeyAttributes

Nome Descrição Valor
Habilitado Determina se o objeto está habilitado ou não. Bool
Exp Data de expiração 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

ManagedHsmKeyCreateParametersTags

Nome Descrição Valor

ManagedHsmKeyProperties

Nome Descrição Valor
Atributos Os atributos da chave. ManagedHsmKeyAttributes
curveName O nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. O padrão para chaves EC e EC-HSM é P-256 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Matriz de cadeia de caracteres que contém qualquer um dos:
'descriptografar'
'encrypt'
'importar'
'release'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA. O padrão para chaves RSA e RSA-HSM é 2048. Exceção feita para trazer sua própria chave (BYOK), chaves de troca de chaves padrão para 4096. int
kty O tipo da chave. Para obter valores válidos, consulte JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'
release_policy Política de liberação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio ManagedHsmKeyReleasePolicy
rotationPolicy Política de rotação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

Nome Descrição Valor
contentType Tipo de conteúdo e versão da política de versão de chave corda
dados Codificação de blob das regras de política sob as quais a chave pode ser liberada. corda

ManagedHsmKeyRotationPolicyAttributes

Nome Descrição Valor
expiryTime A hora de expiração da nova versão da chave. Ele deve estar no formato ISO8601. Por exemplo: 'P90D', 'P1Y'. corda

ManagedHsmLifetimeAction

Nome Descrição Valor
ação A ação da política de rotação de chaves lifetimeAction. ManagedHsmAction
gatilho O gatilho do lifetimeAction da política de rotação de chaves. ManagedHsmTrigger

ManagedHsmRotationPolicy

Nome Descrição Valor
Atributos Os atributos da política de rotação de chaves. ManagedHsmKeyRotationPolicyAttributes
lifetimeActions O lifetimeActions para a ação de rotação de chave. ManagedHsmLifetimeAction []

ManagedHsmTrigger

Nome Descrição Valor
timeAfterCreate A duração do tempo após a criação da chave para girar a chave. Ele só se aplica à rotação. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda
timeBeforeExpiry A duração do tempo antes da expiração da chave para girar ou notificar. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda

Microsoft.KeyVault/managedHSMs/keys

Nome Descrição Valor
apiVersion A versão da API '2024-11-01'
nome O nome do recurso corda

Restrições:
Padrão = ^[a-zA-Z0-9-]{1,127}$ (obrigatório)
Propriedades As propriedades da chave a ser criada. ManagedHsmKeyProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.KeyVault/managedHSMs/keys'

Exemplos de uso

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs/keys@2024-11-01"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  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 da propriedade

ManagedHsmAction

Nome Descrição Valor
tipo O tipo de ação. 'notify'
'girar'

ManagedHsmKeyAttributes

Nome Descrição Valor
Habilitado Determina se o objeto está habilitado ou não. Bool
Exp Data de expiração 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

ManagedHsmKeyCreateParametersTags

Nome Descrição Valor

ManagedHsmKeyProperties

Nome Descrição Valor
Atributos Os atributos da chave. ManagedHsmKeyAttributes
curveName O nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. O padrão para chaves EC e EC-HSM é P-256 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps Matriz de cadeia de caracteres que contém qualquer um dos:
'descriptografar'
'encrypt'
'importar'
'release'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA. O padrão para chaves RSA e RSA-HSM é 2048. Exceção feita para trazer sua própria chave (BYOK), chaves de troca de chaves padrão para 4096. int
kty O tipo da chave. Para obter valores válidos, consulte JsonWebKeyType. 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'
release_policy Política de liberação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio ManagedHsmKeyReleasePolicy
rotationPolicy Política de rotação de chave em resposta. Ele será usado para saída e entrada. Omitido se vazio ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

Nome Descrição Valor
contentType Tipo de conteúdo e versão da política de versão de chave corda
dados Codificação de blob das regras de política sob as quais a chave pode ser liberada. corda

ManagedHsmKeyRotationPolicyAttributes

Nome Descrição Valor
expiryTime A hora de expiração da nova versão da chave. Ele deve estar no formato ISO8601. Por exemplo: 'P90D', 'P1Y'. corda

ManagedHsmLifetimeAction

Nome Descrição Valor
ação A ação da política de rotação de chaves lifetimeAction. ManagedHsmAction
gatilho O gatilho do lifetimeAction da política de rotação de chaves. ManagedHsmTrigger

ManagedHsmRotationPolicy

Nome Descrição Valor
Atributos Os atributos da política de rotação de chaves. ManagedHsmKeyRotationPolicyAttributes
lifetimeActions O lifetimeActions para a ação de rotação de chave. ManagedHsmLifetimeAction []

ManagedHsmTrigger

Nome Descrição Valor
timeAfterCreate A duração do tempo após a criação da chave para girar a chave. Ele só se aplica à rotação. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda
timeBeforeExpiry A duração do tempo antes da expiração da chave para girar ou notificar. Ele estará no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'. corda

Microsoft.KeyVault/managedHSMs/keys

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Padrão = ^[a-zA-Z0-9-]{1,127}$ (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: managedHSMs
Propriedades As propriedades da chave a ser criada. ManagedHsmKeyProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.KeyVault/managedHSMs/keys@2024-11-01"