HSMs gerenciados pelo Microsoft.KeyVault

Artigo
12/21/2024

Definição de recursos do bíceps

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2024-04-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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

Designação	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.	'Padrão' '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 rígida e irrecuperável. Ativar esta funcionalidade é irreversível.	Bool
enableSoftDelete	Propriedade para especificar se a funcionalidade 'exclusão suave' está habilitada para esse pool de HSM gerenciado. A exclusão suave é habilitada por padrão para todos os HSMs gerenciados e é imutável.	Bool
initialAdminObjectIds	Matriz de ids de objeto de administradores iniciais para este pool hsm gerenciado.	string[]
networkAcls	Regras que regem a acessibilidade do cofre de chaves a partir de locais de rede específicos.	MhsmNetworkRuleSet
publicNetworkAccess	Controle a permissão para o HSM gerenciado a partir de redes públicas.	'Desativado' 'Habilitado'
Regiões	Lista de todas as regiões associadas ao pool hsm gerenciado.	MhsmGeoReplicatedRegion []
softDeleteRetentionInDays	Dias de retenção de dados apagados suavemente. Quando você exclui 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. Aceita valores entre 7 e 90.	Int
inquilinoId	A ID de locatário do Azure Ative Directory que deve ser usada para autenticar solicitações para o pool de HSM gerenciado.	string 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

Designação	Descrição	Valor

ManagedHsmSku

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

ManagedServiceIdentity

Designação	Descrição	Valor
tipo	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).	'Nenhuma' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obrigatório)
userAssignedIdentities	O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações.	UserAssignedIdentities

MhsmGeoReplicatedRegion

Designação	Descrição	Valor
isPrimário	Um valor booleano que indica se a região é a região primária ou secundária.	Bool
Designação	Nome da região replicada geograficamente.	string

MhsmipRule

Designação	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).	string (obrigatório)

MhsmNetworkRuleSet

Designação	Descrição	Valor
Desvio	Informa qual 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' 'Nenhuma'
defaultAction	A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass foi avaliada.	'Permitir' 'Negar'
ipRegras	A lista de regras de endereço IP.	MhsmipRule[]
virtualNetworkRules	A lista de regras de rede virtual.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Designação	Descrição	Valor
ID	ID de recurso completo de uma sub-rede vnet, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.	string (obrigatório)

Microsoft.KeyVault/managedHSMs

Designação	Descrição	Valor
identidade	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)	ManagedServiceIdentity
Localização	O local do Azure com suporte onde o Pool HSM gerenciado deve ser criado.	string
Designação	O nome do recurso	string (obrigatório)
propriedades	Propriedades do HSM gerenciado	ManagedHsmProperties
SKU	Detalhes do SKU	ManagedHsmSku
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos

UserAssignedIdentities

Designação	Descrição	Valor

UserAssignedIdentity

Designação	Descrição	Valor

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	Este modelo cria um HSM gerenciado do Azure Key Vault.

Definição de recurso de modelo ARM

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

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2024-04-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "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

Designação	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.	'Padrão' '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 rígida e irrecuperável. Ativar esta funcionalidade é irreversível.	Bool
enableSoftDelete	Propriedade para especificar se a funcionalidade 'exclusão suave' está habilitada para esse pool de HSM gerenciado. A exclusão suave é habilitada por padrão para todos os HSMs gerenciados e é imutável.	Bool
initialAdminObjectIds	Matriz de ids de objeto de administradores iniciais para este pool hsm gerenciado.	string[]
networkAcls	Regras que regem a acessibilidade do cofre de chaves a partir de locais de rede específicos.	MhsmNetworkRuleSet
publicNetworkAccess	Controle a permissão para o HSM gerenciado a partir de redes públicas.	'Desativado' 'Habilitado'
Regiões	Lista de todas as regiões associadas ao pool hsm gerenciado.	MhsmGeoReplicatedRegion []
softDeleteRetentionInDays	Dias de retenção de dados apagados suavemente. Quando você exclui 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. Aceita valores entre 7 e 90.	Int
inquilinoId	A ID de locatário do Azure Ative Directory que deve ser usada para autenticar solicitações para o pool de HSM gerenciado.	string 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

Designação	Descrição	Valor

ManagedHsmSku

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

ManagedServiceIdentity

Designação	Descrição	Valor
tipo	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).	'Nenhuma' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obrigatório)
userAssignedIdentities	O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações.	UserAssignedIdentities

MhsmGeoReplicatedRegion

Designação	Descrição	Valor
isPrimário	Um valor booleano que indica se a região é a região primária ou secundária.	Bool
Designação	Nome da região replicada geograficamente.	string

MhsmipRule

Designação	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).	string (obrigatório)

MhsmNetworkRuleSet

Designação	Descrição	Valor
Desvio	Informa qual 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' 'Nenhuma'
defaultAction	A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass foi avaliada.	'Permitir' 'Negar'
ipRegras	A lista de regras de endereço IP.	MhsmipRule[]
virtualNetworkRules	A lista de regras de rede virtual.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Designação	Descrição	Valor
ID	ID de recurso completo de uma sub-rede vnet, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.	string (obrigatório)

Microsoft.KeyVault/managedHSMs

Designação	Descrição	Valor
apiVersion	A versão api	'2024-04-01-pré-visualização'
identidade	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)	ManagedServiceIdentity
Localização	O local do Azure com suporte onde o Pool HSM gerenciado deve ser criado.	string
Designação	O nome do recurso	string (obrigatório)
propriedades	Propriedades do HSM gerenciado	ManagedHsmProperties
SKU	Detalhes do SKU	ManagedHsmSku
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo	O tipo de recurso	'Microsoft.KeyVault/managedHSMs'

UserAssignedIdentities

Designação	Descrição	Valor

UserAssignedIdentity

Designação	Descrição	Valor

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	Este modelo cria um HSM gerenciado do Azure Key Vault.

Definição de recursos Terraform (provedor AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2024-04-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  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

Designação	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.	'Padrão' '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 rígida e irrecuperável. Ativar esta funcionalidade é irreversível.	Bool
enableSoftDelete	Propriedade para especificar se a funcionalidade 'exclusão suave' está habilitada para esse pool de HSM gerenciado. A exclusão suave é habilitada por padrão para todos os HSMs gerenciados e é imutável.	Bool
initialAdminObjectIds	Matriz de ids de objeto de administradores iniciais para este pool hsm gerenciado.	string[]
networkAcls	Regras que regem a acessibilidade do cofre de chaves a partir de locais de rede específicos.	MhsmNetworkRuleSet
publicNetworkAccess	Controle a permissão para o HSM gerenciado a partir de redes públicas.	'Desativado' 'Habilitado'
Regiões	Lista de todas as regiões associadas ao pool hsm gerenciado.	MhsmGeoReplicatedRegion []
softDeleteRetentionInDays	Dias de retenção de dados apagados suavemente. Quando você exclui 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. Aceita valores entre 7 e 90.	Int
inquilinoId	A ID de locatário do Azure Ative Directory que deve ser usada para autenticar solicitações para o pool de HSM gerenciado.	string 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

Designação	Descrição	Valor

ManagedHsmSku

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

ManagedServiceIdentity

Designação	Descrição	Valor
tipo	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).	'Nenhuma' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obrigatório)
userAssignedIdentities	O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações.	UserAssignedIdentities

MhsmGeoReplicatedRegion

Designação	Descrição	Valor
isPrimário	Um valor booleano que indica se a região é a região primária ou secundária.	Bool
Designação	Nome da região replicada geograficamente.	string

MhsmipRule

Designação	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).	string (obrigatório)

MhsmNetworkRuleSet

Designação	Descrição	Valor
Desvio	Informa qual 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' 'Nenhuma'
defaultAction	A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass foi avaliada.	'Permitir' 'Negar'
ipRegras	A lista de regras de endereço IP.	MhsmipRule[]
virtualNetworkRules	A lista de regras de rede virtual.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Designação	Descrição	Valor
ID	ID de recurso completo de uma sub-rede vnet, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.	string (obrigatório)

Microsoft.KeyVault/managedHSMs

Designação	Descrição	Valor
identidade	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)	ManagedServiceIdentity
Localização	O local do Azure com suporte onde o Pool HSM gerenciado deve ser criado.	string
Designação	O nome do recurso	string (obrigatório)
propriedades	Propriedades do HSM gerenciado	ManagedHsmProperties
SKU	Detalhes do SKU	ManagedHsmSku
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags.
tipo	O tipo de recurso	"Microsoft.KeyVault/managedHSMs@2024-04-01-pré-visualização"

UserAssignedIdentities

Designação	Descrição	Valor

UserAssignedIdentity

Designação	Descrição	Valor

Partilhar via

HSMs gerenciados pelo Microsoft.KeyVault

Definição de recursos do bíceps

Formato do recurso

Valores de propriedade

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Exemplos de início rápido

Definição de recurso de modelo ARM

Formato do recurso

Valores de propriedade

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Modelos de início rápido

Definição de recursos Terraform (provedor AzAPI)

Formato do recurso

Valores de propriedade

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Comentários

Recursos adicionais