Compartilhar via

Microsoft.KeyVault managedHSMs 2023-02-01

  • Artigo

Definição de recurso do Bicep

O tipo de recurso managedHSMs pode ser implantado com operações de destino:

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2023-02-01' = {
  location: 'string'
  name: 'string'
  properties: {
    createMode: 'string'
    enablePurgeProtection: bool
    enableSoftDelete: bool
    initialAdminObjectIds: [
      'string'
    ]
    networkAcls: {
      bypass: 'string'
      defaultAction: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
      virtualNetworkRules: [
        {
          id: 'string'
        }
      ]
    }
    publicNetworkAccess: 'string'
    regions: [
      {
        isPrimary: bool
        name: 'string'
      }
    ]
    softDeleteRetentionInDays: int
    tenantId: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

ManagedHsmProperties

Nome Descrição Valor
createMode O modo de criação para indicar se o recurso está sendo criado ou está sendo recuperado de um recurso excluído. 'default'
'recuperar'
enablePurgeProtection Propriedade que especifica se a proteção contra limpeza está habilitada para esse pool de HSM gerenciado. Definir essa propriedade como true ativa a proteção contra limpeza para esse pool de HSM gerenciado e seu conteúdo – somente o serviço HSM Gerenciado pode iniciar uma exclusão dura e irrecuperável. Habilitar essa funcionalidade é irreversível. Bool
enableSoftDelete Propriedade para especificar se a funcionalidade de "exclusão reversível" está habilitada para esse pool de HSM gerenciado. A exclusão reversível é habilitada por padrão para todos os HSMs gerenciados e é imutável. Bool
initialAdminObjectIds Matriz de IDs de objeto de administradores iniciais para esse pool de hsm gerenciado. string[]
networkAcls Regras que regem a acessibilidade do cofre de chaves de locais de rede específicos. MhsmNetworkRuleSet
publicNetworkAccess Controle a permissão para o HSM gerenciado de redes públicas. 'Desabilitado'
'Habilitado'
Regiões Lista de todas as regiões associadas ao pool de hsm gerenciado. MhsmGeoReplicatedRegion []
softDeleteRetentionInDays Dias de retenção de dados excluídos suavemente. Quando você excluir um HSM ou uma chave, ele permanecerá recuperável pelo período de retenção configurado ou por um período padrão de 90 dias. Ele aceita valores entre 7 e 90. int
tenantId A ID de locatário do Azure Active Directory que deve ser usada para autenticar solicitações no pool de HSM gerenciado. corda

Restrições:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

Nome Descrição Valor

ManagedHsmSku

Nome Descrição Valor
família Família de SKU do pool de HSM gerenciado 'B' (obrigatório)
nome SKU do pool de HSM gerenciado 'Custom_B32'
'Custom_B6'
'Standard_B1' (obrigatório)

MhsmGeoReplicatedRegion

Nome Descrição Valor
isPrimary Um valor booliano que indica se a região é a região primária ou uma região secundária. Bool
nome Nome da região replicada geograficamente. corda

MhsmipRule

Nome Descrição Valor
valor Um intervalo de endereços IPv4 na notação CIDR, como '124.56.78.91' (endereço IP simples) ou '124.56.78.0/24' (todos os endereços que começam com 124.56.78). cadeia de caracteres (obrigatório)

MhsmNetworkRuleSet

Nome Descrição Valor
contornar Informa o que o tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'. 'AzureServices'
'None'
defaultAction A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass é avaliada. 'Permitir'
'Negar'
ipRules A lista de regras de endereço IP. mhsmipRule[]
virtualNetworkRules A lista de regras de rede virtual. MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nome Descrição Valor
id ID de recurso completa de uma sub-rede de rede virtual, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. cadeia de caracteres (obrigatório)

Microsoft.KeyVault/managedHSMs

Nome Descrição Valor
localização O local do Azure com suporte em que o Pool de HSM gerenciado deve ser criado. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades do HSM gerenciado ManagedHsmProperties
Sku Detalhes da SKU ManagedHsmSku
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas 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
criar um HSM gerenciado do Azure Key Vault Esse modelo cria um HSM gerenciado do Azure Key Vault.

Definição de recurso de modelo do ARM

O tipo de recurso managedHSMs pode ser implantado com operações de destino:

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, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2023-02-01",
  "name": "string",
  "location": "string",
  "properties": {
    "createMode": "string",
    "enablePurgeProtection": "bool",
    "enableSoftDelete": "bool",
    "initialAdminObjectIds": [ "string" ],
    "networkAcls": {
      "bypass": "string",
      "defaultAction": "string",
      "ipRules": [
        {
          "value": "string"
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "string"
        }
      ]
    },
    "publicNetworkAccess": "string",
    "regions": [
      {
        "isPrimary": "bool",
        "name": "string"
      }
    ],
    "softDeleteRetentionInDays": "int",
    "tenantId": "string"
  },
  "sku": {
    "family": "string",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

ManagedHsmProperties

Nome Descrição Valor
createMode O modo de criação para indicar se o recurso está sendo criado ou está sendo recuperado de um recurso excluído. 'default'
'recuperar'
enablePurgeProtection Propriedade que especifica se a proteção contra limpeza está habilitada para esse pool de HSM gerenciado. Definir essa propriedade como true ativa a proteção contra limpeza para esse pool de HSM gerenciado e seu conteúdo – somente o serviço HSM Gerenciado pode iniciar uma exclusão dura e irrecuperável. Habilitar essa funcionalidade é irreversível. Bool
enableSoftDelete Propriedade para especificar se a funcionalidade de "exclusão reversível" está habilitada para esse pool de HSM gerenciado. A exclusão reversível é habilitada por padrão para todos os HSMs gerenciados e é imutável. Bool
initialAdminObjectIds Matriz de IDs de objeto de administradores iniciais para esse pool de hsm gerenciado. string[]
networkAcls Regras que regem a acessibilidade do cofre de chaves de locais de rede específicos. MhsmNetworkRuleSet
publicNetworkAccess Controle a permissão para o HSM gerenciado de redes públicas. 'Desabilitado'
'Habilitado'
Regiões Lista de todas as regiões associadas ao pool de hsm gerenciado. MhsmGeoReplicatedRegion []
softDeleteRetentionInDays Dias de retenção de dados excluídos suavemente. Quando você excluir um HSM ou uma chave, ele permanecerá recuperável pelo período de retenção configurado ou por um período padrão de 90 dias. Ele aceita valores entre 7 e 90. int
tenantId A ID de locatário do Azure Active Directory que deve ser usada para autenticar solicitações no pool de HSM gerenciado. corda

Restrições:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

Nome Descrição Valor

ManagedHsmSku

Nome Descrição Valor
família Família de SKU do pool de HSM gerenciado 'B' (obrigatório)
nome SKU do pool de HSM gerenciado 'Custom_B32'
'Custom_B6'
'Standard_B1' (obrigatório)

MhsmGeoReplicatedRegion

Nome Descrição Valor
isPrimary Um valor booliano que indica se a região é a região primária ou uma região secundária. Bool
nome Nome da região replicada geograficamente. corda

MhsmipRule

Nome Descrição Valor
valor Um intervalo de endereços IPv4 na notação CIDR, como '124.56.78.91' (endereço IP simples) ou '124.56.78.0/24' (todos os endereços que começam com 124.56.78). cadeia de caracteres (obrigatório)

MhsmNetworkRuleSet

Nome Descrição Valor
contornar Informa o que o tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'. 'AzureServices'
'None'
defaultAction A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass é avaliada. 'Permitir'
'Negar'
ipRules A lista de regras de endereço IP. mhsmipRule[]
virtualNetworkRules A lista de regras de rede virtual. MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nome Descrição Valor
id ID de recurso completa de uma sub-rede de rede virtual, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. cadeia de caracteres (obrigatório)

Microsoft.KeyVault/managedHSMs

Nome Descrição Valor
apiVersion A versão da API '2023-02-01'
localização O local do Azure com suporte em que o Pool de HSM gerenciado deve ser criado. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades do HSM gerenciado ManagedHsmProperties
Sku Detalhes da SKU ManagedHsmSku
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.KeyVault/managedHSMs'

Modelos de início rápido

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

Modelo Descrição
criar um HSM gerenciado do Azure Key Vault

Implantar no Azure 		Esse modelo cria um HSM gerenciado do Azure Key Vault.

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

O tipo de recurso managedHSMs pode ser implantado com operações de destino:

  • 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, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2023-02-01"
  name = "string"
  location = "string"
  sku = {
    family = "string"
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      createMode = "string"
      enablePurgeProtection = bool
      enableSoftDelete = bool
      initialAdminObjectIds = [
        "string"
      ]
      networkAcls = {
        bypass = "string"
        defaultAction = "string"
        ipRules = [
          {
            value = "string"
          }
        ]
        virtualNetworkRules = [
          {
            id = "string"
          }
        ]
      }
      publicNetworkAccess = "string"
      regions = [
        {
          isPrimary = bool
          name = "string"
        }
      ]
      softDeleteRetentionInDays = int
      tenantId = "string"
    }
  })
}

Valores de propriedade

ManagedHsmProperties

Nome Descrição Valor
createMode O modo de criação para indicar se o recurso está sendo criado ou está sendo recuperado de um recurso excluído. 'default'
'recuperar'
enablePurgeProtection Propriedade que especifica se a proteção contra limpeza está habilitada para esse pool de HSM gerenciado. Definir essa propriedade como true ativa a proteção contra limpeza para esse pool de HSM gerenciado e seu conteúdo – somente o serviço HSM Gerenciado pode iniciar uma exclusão dura e irrecuperável. Habilitar essa funcionalidade é irreversível. Bool
enableSoftDelete Propriedade para especificar se a funcionalidade de "exclusão reversível" está habilitada para esse pool de HSM gerenciado. A exclusão reversível é habilitada por padrão para todos os HSMs gerenciados e é imutável. Bool
initialAdminObjectIds Matriz de IDs de objeto de administradores iniciais para esse pool de hsm gerenciado. string[]
networkAcls Regras que regem a acessibilidade do cofre de chaves de locais de rede específicos. MhsmNetworkRuleSet
publicNetworkAccess Controle a permissão para o HSM gerenciado de redes públicas. 'Desabilitado'
'Habilitado'
Regiões Lista de todas as regiões associadas ao pool de hsm gerenciado. MhsmGeoReplicatedRegion []
softDeleteRetentionInDays Dias de retenção de dados excluídos suavemente. Quando você excluir um HSM ou uma chave, ele permanecerá recuperável pelo período de retenção configurado ou por um período padrão de 90 dias. Ele aceita valores entre 7 e 90. int
tenantId A ID de locatário do Azure Active Directory que deve ser usada para autenticar solicitações no pool de HSM gerenciado. corda

Restrições:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

Nome Descrição Valor

ManagedHsmSku

Nome Descrição Valor
família Família de SKU do pool de HSM gerenciado 'B' (obrigatório)
nome SKU do pool de HSM gerenciado 'Custom_B32'
'Custom_B6'
'Standard_B1' (obrigatório)

MhsmGeoReplicatedRegion

Nome Descrição Valor
isPrimary Um valor booliano que indica se a região é a região primária ou uma região secundária. Bool
nome Nome da região replicada geograficamente. corda

MhsmipRule

Nome Descrição Valor
valor Um intervalo de endereços IPv4 na notação CIDR, como '124.56.78.91' (endereço IP simples) ou '124.56.78.0/24' (todos os endereços que começam com 124.56.78). cadeia de caracteres (obrigatório)

MhsmNetworkRuleSet

Nome Descrição Valor
contornar Informa o que o tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'. 'AzureServices'
'None'
defaultAction A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass é avaliada. 'Permitir'
'Negar'
ipRules A lista de regras de endereço IP. mhsmipRule[]
virtualNetworkRules A lista de regras de rede virtual. MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Nome Descrição Valor
id ID de recurso completa de uma sub-rede de rede virtual, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. cadeia de caracteres (obrigatório)

Microsoft.KeyVault/managedHSMs

Nome Descrição Valor
localização O local do Azure com suporte em que o Pool de HSM gerenciado deve ser criado. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades do HSM gerenciado ManagedHsmProperties
Sku Detalhes da SKU ManagedHsmSku
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.KeyVault/managedHSMs@2023-02-01"