Microsoft.KeyVault managedHSMs
Definição de recurso do Bicep
O tipo de recurso managedHSMs pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.KeyVault/managedHSMs, adicione o Bicep a seguir ao modelo.
resource symbolicname 'Microsoft.KeyVault/managedHSMs@2023-07-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
family: 'B'
name: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
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
managedHSMs
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia de caracteres (obrigatório) |
| local | O local do Azure com suporte em que o pool de HSM gerenciado deve ser criado. | string |
| marcas | Marcações de recursos | Dicionário de nomes e valores de marcas. Confira Marcas em modelos |
| sku | Detalhes do SKU | ManagedHsmSku |
| identidade | Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário) | ManagedServiceIdentity |
| properties | Propriedades do HSM gerenciado | ManagedHsmProperties |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de identidade de serviço gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos). | 'None' '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 do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações. | UserAssignedIdentities |
UserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | UserAssignedIdentity |
UserAssignedIdentity
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
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' 'recover' |
| 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 | Controlar a permissão para o HSM gerenciado de redes públicas. | 'Desabilitado' 'Enabled' |
| regions | Lista de todas as regiões associadas ao pool de hsm gerenciado. | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | Dias de retenção de dados excluídos temporariamente. 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 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}$ |
MhsmNetworkRuleSet
| Nome | Descrição | Valor |
|---|---|---|
| ignorar | 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' 'None' |
| Defaultaction | A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade de bypass é avaliada. | 'Allow' 'Deny' |
| ipRules | A lista de regras de endereço IP. | MhsmipRule[] |
| virtualNetworkRules | A lista de regras de rede virtual. | MhsmVirtualNetworkRule[] |
MhsmipRule
| Nome | Descrição | Valor |
|---|---|---|
| value | 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) |
MhsmVirtualNetworkRule
| Nome | Descrição | Valor |
|---|---|---|
| id | ID de recurso completa de uma sub-rede vnet, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. | cadeia de caracteres (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 |
| name | Nome da região replicada geograficamente. | string |
ManagedHsmSku
| Nome | Descrição | Valor |
|---|---|---|
| família | Família de SKU do pool de HSM gerenciado | 'B' (obrigatório) |
| name | SKU do pool de HSM gerenciado | 'Custom_B32' 'Custom_B6' 'Standard_B1' (obrigatório) |
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 recurso de modelo do ARM
O tipo de recurso managedHSMs pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte 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-07-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"family": "B",
"name": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"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
managedHSMs
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.KeyVault/managedHSMs' |
| apiVersion | A versão da API do recurso | '2023-07-01' |
| name | O nome do recurso | cadeia de caracteres (obrigatório) |
| local | O local do Azure com suporte em que o pool de HSM gerenciado deve ser criado. | string |
| marcas | Marcações de recursos | Dicionário de nomes e valores de marcas. Consulte Marcas em modelos |
| sku | Detalhes do SKU | ManagedHsmSku |
| identidade | Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário) | ManagedServiceIdentity |
| properties | Propriedades do HSM gerenciado | ManagedHsmProperties |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de identidade de serviço gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos). | 'None' '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 do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações. | UserAssignedIdentities |
UserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | UserAssignedIdentity |
UserAssignedIdentity
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
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 "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' 'Enabled' |
| regions | Lista de todas as regiões associadas ao pool de hsm gerenciado. | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | Dias de retenção de dados excluídos temporariamente. 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. | 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}$ |
MhsmNetworkRuleSet
| Nome | Descrição | Valor |
|---|---|---|
| ignorar | 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' '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. | 'Allow' 'Deny' |
| ipRules | A lista de regras de endereço IP. | MhsmipRule[] |
| virtualNetworkRules | A lista de regras de rede virtual. | MhsmVirtualNetworkRule[] |
MhsmipRule
| Nome | Descrição | Valor |
|---|---|---|
| value | 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) |
MhsmVirtualNetworkRule
| Nome | Descrição | Valor |
|---|---|---|
| id | ID de recurso completa de uma sub-rede vnet, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. | cadeia de caracteres (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 |
| name | Nome da região replicada geograficamente. | string |
ManagedHsmSku
| Nome | Descrição | Valor |
|---|---|---|
| família | Família de SKU do pool de HSM gerenciado | 'B' (obrigatório) |
| name | SKU do pool de HSM gerenciado | 'Custom_B32' 'Custom_B6' 'Standard_B1' (obrigatório) |
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 recurso do Terraform (provedor AzAPI)
O tipo de recurso managedHSMs pode ser implantado com operações direcionadas:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.KeyVault/managedHSMs, adicione o Terraform a seguir ao modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/managedHSMs@2023-07-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
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"
}
sku = {
family = "B"
name = "string"
}
})
}
Valores de propriedade
managedHSMs
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.KeyVault/managedHSMs@2023-07-01" |
| name | O nome do recurso | cadeia de caracteres (obrigatório) |
| local | O local do Azure com suporte em que o pool de HSM gerenciado deve ser criado. | string |
| parent_id | Para implantar em um grupo de recursos, use a ID desse grupo de recursos. | cadeia de caracteres (obrigatório) |
| marcas | Marcações de recursos | Dicionário de nomes e valores de marcas. |
| sku | Detalhes do SKU | ManagedHsmSku |
| identidade | Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário) | ManagedServiceIdentity |
| properties | Propriedades do HSM gerenciado | ManagedHsmProperties |
ManagedServiceIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de identidade de serviço gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos). | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (obrigatório) |
| identity_ids | O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações. | Matriz de IDs de identidade do usuário. |
UserAssignedIdentities
| Nome | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | UserAssignedIdentity |
UserAssignedIdentity
Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
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 "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" |
| regions | Lista de todas as regiões associadas ao pool de hsm gerenciado. | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | Dias de retenção de dados excluídos temporariamente. 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. | 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}$ |
MhsmNetworkRuleSet
| Nome | Descrição | Valor |
|---|---|---|
| ignorar | 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" "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[] |
MhsmipRule
| Nome | Descrição | Valor |
|---|---|---|
| value | 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) |
MhsmVirtualNetworkRule
| Nome | Descrição | Valor |
|---|---|---|
| id | ID de recurso completa de uma sub-rede vnet, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. | cadeia de caracteres (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 |
| name | Nome da região replicada geograficamente. | string |
ManagedHsmSku
| Nome | Descrição | Valor |
|---|---|---|
| família | Família de SKU do pool de HSM gerenciado | "B" (obrigatório) |
| name | SKU do pool de HSM gerenciado | "Custom_B32" "Custom_B6" "Standard_B1" (obrigatório) |
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de