Microsoft.KeyVault/managedHSMs/chaves 2023-07-01 - Bicep, ARM template & Terraform AzAPI reference

Definição de recursos do bíceps

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs/keys@2023-07-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 de propriedade

Microsoft.KeyVault/managedHSMs/chaves

Designação	Descrição	Valor
Designação	O nome do recurso	cadeia de caracteres 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 recurso do tipo: managedHSMs
propriedades	As propriedades da chave a ser criada.	ManagedHsmKeyProperties (obrigatório)
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos

ManagedHsmAction

Designação	Descrição	Valor
tipo	O tipo de ação.	«notificar» 'girar'

ManagedHsmKeyAttributes

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
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

Designação	Descrição	Valor

ManagedHsmKeyProperties

Designação	Descrição	Valor
atributos	Os atributos da chave.	ManagedHsmKeyAttributes
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» 'Lançamento' 'sinal' 'desembrulhar' 'verificar' 'Chave de embrulho'
tamanho da chave	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'
release_policy	Política de lançamento de chaves em resposta. Ele será usado tanto para saída quanto para entrada. Omitido se vazio	ManagedHsmKeyReleasePolicy
Política de rotação	Política de rotação de chaves em resposta. Ele será usado tanto para saída quanto para entrada. Omitido se vazio	ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

Designação	Descrição	Valor
TipoDeConteúdo	Tipo de conteúdo e versão da política de liberação de chaves	corda
dados	Blob codificando as regras de política sob as quais a chave pode ser liberada.	corda

ManagedHsmKeyRotationPolicyAttributes

Designação	Descrição	Valor
expiryTime	O tempo de expiração para a nova versão de chave. Deve ser em ISO8601 formato. Por exemplo: 'P90D', 'P1Y'.	corda

ManagedHsmLifetimeAction

Designação	Descrição	Valor
ação	A ação do tempo de vida da política de rotação de chavesAction.	ManagedHsmAction
gatilho	O gatilho do tempo de vida da política de rotação de chavesAction.	ManagedHsmTrigger

ManagedHsmRotationPolicy

Designação	Descrição	Valor
atributos	Os atributos da política de rotação de chaves.	ManagedHsmKeyRotationPolicyAttributes
Ações vitalícias	O lifetimeActions para a ação de rotação de chaves.	ManagedHsmLifetimeAction []

ManagedHsmTrigger

Designação	Descrição	Valor
timeAfterCriar	A duração do tempo após a criação da chave para girar a chave. Aplica-se apenas à rotação. Será no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'.	corda
timeBeforeExpiry	A duração do tempo antes da chave expirar para girar ou notificar. Será no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'.	corda

Definição de recurso de modelo ARM

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

{
  "type": "Microsoft.KeyVault/managedHSMs/keys",
  "apiVersion": "2023-07-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 de propriedade

Microsoft.KeyVault/managedHSMs/chaves

Designação	Descrição	Valor
Versão da API	A versão api	'2023-07-01'
Designação	O nome do recurso	cadeia de caracteres Restrições: Padrão = `^[a-zA-Z0-9-]{1,127}$` (obrigatório)
propriedades	As propriedades da chave a ser criada.	ManagedHsmKeyProperties (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/managedHSMs/chaves'

ManagedHsmAction

Designação	Descrição	Valor
tipo	O tipo de ação.	«notificar» 'girar'

ManagedHsmKeyAttributes

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
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

Designação	Descrição	Valor

ManagedHsmKeyProperties

Designação	Descrição	Valor
atributos	Os atributos da chave.	ManagedHsmKeyAttributes
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» 'Lançamento' 'sinal' 'desembrulhar' 'verificar' 'Chave de embrulho'
tamanho da chave	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'
release_policy	Política de lançamento de chaves em resposta. Ele será usado tanto para saída quanto para entrada. Omitido se vazio	ManagedHsmKeyReleasePolicy
Política de rotação	Política de rotação de chaves em resposta. Ele será usado tanto para saída quanto para entrada. Omitido se vazio	ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

Designação	Descrição	Valor
TipoDeConteúdo	Tipo de conteúdo e versão da política de liberação de chaves	corda
dados	Blob codificando as regras de política sob as quais a chave pode ser liberada.	corda

ManagedHsmKeyRotationPolicyAttributes

Designação	Descrição	Valor
expiryTime	O tempo de expiração para a nova versão de chave. Deve ser em ISO8601 formato. Por exemplo: 'P90D', 'P1Y'.	corda

ManagedHsmLifetimeAction

Designação	Descrição	Valor
ação	A ação do tempo de vida da política de rotação de chavesAction.	ManagedHsmAction
gatilho	O gatilho do tempo de vida da política de rotação de chavesAction.	ManagedHsmTrigger

ManagedHsmRotationPolicy

Designação	Descrição	Valor
atributos	Os atributos da política de rotação de chaves.	ManagedHsmKeyRotationPolicyAttributes
Ações vitalícias	O lifetimeActions para a ação de rotação de chaves.	ManagedHsmLifetimeAction []

ManagedHsmTrigger

Designação	Descrição	Valor
timeAfterCriar	A duração do tempo após a criação da chave para girar a chave. Aplica-se apenas à rotação. Será no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'.	corda
timeBeforeExpiry	A duração do tempo antes da chave expirar para girar ou notificar. Será no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'.	corda

Exemplos de uso

Definição de recursos Terraform (provedor AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs/keys@2023-07-01"
  name = "string"
  parent_id = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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 de propriedade

Microsoft.KeyVault/managedHSMs/chaves

Designação	Descrição	Valor
Designação	O nome do recurso	cadeia de caracteres 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 para recurso do tipo: gerenciadoHSMs
propriedades	As propriedades da chave a ser criada.	ManagedHsmKeyProperties (obrigatório)
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags.
tipo	O tipo de recurso	"Microsoft.KeyVault/managedHSMs/keys@2023-07-01"

ManagedHsmAction

Designação	Descrição	Valor
tipo	O tipo de ação.	«notificar» 'girar'

ManagedHsmKeyAttributes

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
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

Designação	Descrição	Valor

ManagedHsmKeyProperties

Designação	Descrição	Valor
atributos	Os atributos da chave.	ManagedHsmKeyAttributes
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» 'Lançamento' 'sinal' 'desembrulhar' 'verificar' 'Chave de embrulho'
tamanho da chave	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'
release_policy	Política de lançamento de chaves em resposta. Ele será usado tanto para saída quanto para entrada. Omitido se vazio	ManagedHsmKeyReleasePolicy
Política de rotação	Política de rotação de chaves em resposta. Ele será usado tanto para saída quanto para entrada. Omitido se vazio	ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

Designação	Descrição	Valor
TipoDeConteúdo	Tipo de conteúdo e versão da política de liberação de chaves	corda
dados	Blob codificando as regras de política sob as quais a chave pode ser liberada.	corda

ManagedHsmKeyRotationPolicyAttributes

Designação	Descrição	Valor
expiryTime	O tempo de expiração para a nova versão de chave. Deve ser em ISO8601 formato. Por exemplo: 'P90D', 'P1Y'.	corda

ManagedHsmLifetimeAction

Designação	Descrição	Valor
ação	A ação do tempo de vida da política de rotação de chavesAction.	ManagedHsmAction
gatilho	O gatilho do tempo de vida da política de rotação de chavesAction.	ManagedHsmTrigger

ManagedHsmRotationPolicy

Designação	Descrição	Valor
atributos	Os atributos da política de rotação de chaves.	ManagedHsmKeyRotationPolicyAttributes
Ações vitalícias	O lifetimeActions para a ação de rotação de chaves.	ManagedHsmLifetimeAction []

ManagedHsmTrigger

Designação	Descrição	Valor
timeAfterCriar	A duração do tempo após a criação da chave para girar a chave. Aplica-se apenas à rotação. Será no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'.	corda
timeBeforeExpiry	A duração do tempo antes da chave expirar para girar ou notificar. Será no formato de duração ISO 8601. Por exemplo: 'P90D', 'P1Y'.	corda

Partilhar via

HSMs/chaves gerenciadas Microsoft.KeyVault 2023-07-01

Definição de recursos do bíceps

Formato do recurso

Valores de propriedade

Microsoft.KeyVault/managedHSMs/chaves

ManagedHsmAction

ManagedHsmKeyAttributes

ManagedHsmKeyCreateParametersTags

ManagedHsmKeyProperties

ManagedHsmKeyReleasePolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmRotationPolicy

ManagedHsmTrigger

Definição de recurso de modelo ARM

Formato do recurso

Valores de propriedade

Microsoft.KeyVault/managedHSMs/chaves

ManagedHsmAction

ManagedHsmKeyAttributes

ManagedHsmKeyCreateParametersTags

ManagedHsmKeyProperties

ManagedHsmKeyReleasePolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmRotationPolicy

ManagedHsmTrigger

Exemplos de uso

Definição de recursos Terraform (provedor AzAPI)

Formato do recurso

Valores de propriedade

Microsoft.KeyVault/managedHSMs/chaves

ManagedHsmAction

ManagedHsmKeyAttributes

ManagedHsmKeyCreateParametersTags

ManagedHsmKeyProperties

ManagedHsmKeyReleasePolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmRotationPolicy

ManagedHsmTrigger

Comentários

Recursos adicionais