Microsoft.KeyVault managedHSMs 2022-07-01
Definição de recurso do Bicep
O tipo de recurso managedHSMs pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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@2022-07-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
family: 'B'
name: 'string'
}
properties: {
createMode: 'string'
enablePurgeProtection: bool
enableSoftDelete: bool
initialAdminObjectIds: [
'string'
]
networkAcls: {
bypass: 'string'
defaultAction: 'string'
ipRules: [
{
value: 'string'
}
]
virtualNetworkRules: [
{
id: 'string'
}
]
}
publicNetworkAccess: 'string'
softDeleteRetentionInDays: int
tenantId: 'string'
}
}
Valores de propriedade
managedHSMs
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia (obrigatório) |
| localização | A localização suportada do Azure onde deve ser criado o Conjunto de HSM gerido. | string |
| etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| sku | Detalhes do SKU | ManagedHsmSku |
| propriedades | Propriedades do HSM gerido | ManagedHsmProperties |
ManagedHsmProperties
| Nome | Descrição | Valor |
|---|---|---|
| createMode | O modo de criação para indicar se o recurso está a ser criado ou se está a ser recuperado de um recurso eliminado. | "predefinição" "recuperar" |
| enablePurgeProtection | Propriedade que especifica se a proteção contra a remoção está ativada para este conjunto de HSM gerido. Definir esta propriedade como verdadeiro ativa a proteção contra remoção para este conjunto HSM gerido e o respetivo conteúdo – apenas o serviço HSM Gerido pode iniciar uma eliminação difícil e irrecuperável. Ativar esta funcionalidade é irreversível. | bool |
| enableSoftDelete | Propriedade para especificar se a funcionalidade "eliminação recuperável" está ativada para este conjunto HSM gerido. A eliminação recuperável está ativada por predefinição para todos os HSMs geridos e é imutável. | bool |
| initialAdminObjectIds | Matriz de IDs de objetos de administradores iniciais para este conjunto hsm gerido. | cadeia[] |
| networkAcls | Regras que regem a acessibilidade do cofre de chaves a partir de localizações de rede específicas. | MhsmNetworkRuleSet |
| publicNetworkAccess | Controlar a permissão para o HSM gerido a partir de redes públicas. | "Desativado" "Ativado" |
| softDeleteRetentionInDays | Dias de retenção de dados eliminados de forma recuperável. Quando elimina um HSM ou uma chave, este permanecerá recuperável durante o período de retenção configurado ou durante um período predefinido de 90 dias. Aceita valores entre 7 e 90. | int |
| tenantId | O ID de inquilino do Azure Active Directory que deve ser utilizado para autenticar pedidos no conjunto HSM gerido. | 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 | Indica que tráfego pode ignorar as regras de rede. Pode ser "AzureServices" ou "None". Se não for especificado, a predefinição é "AzureServices". | "AzureServices" "Nenhum" |
| defaultAction | A ação predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada. | "Permitir" 'Negar' |
| ipRules | A lista de regras de endereços IP. | MhsmipRule[] |
| virtualNetworkRules | A lista de regras de rede virtual. | MhsmVirtualNetworkRule[] |
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 (obrigatório) |
MhsmVirtualNetworkRule
| Nome | Descrição | Valor |
|---|---|---|
| ID | ID de recurso completo de uma sub-rede de vnet, como "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". | cadeia (obrigatório) |
ManagedHsmSku
| Nome | Descrição | Valor |
|---|---|---|
| família | Família de SKU do Conjunto de HSM gerido | "B" (obrigatório) |
| name | SKU do Conjunto de HSM gerido | 'Custom_B32' 'Custom_B6' "Standard_B1" (obrigatório) |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
Criar um HSM Gerido do Azure Key Vault |
Este modelo cria um Azure Key Vault HSM Gerido. |
Definição de recurso de modelo do ARM
O tipo de recurso managedHSMs pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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": "2022-07-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"family": "B",
"name": "string"
},
"properties": {
"createMode": "string",
"enablePurgeProtection": "bool",
"enableSoftDelete": "bool",
"initialAdminObjectIds": [ "string" ],
"networkAcls": {
"bypass": "string",
"defaultAction": "string",
"ipRules": [
{
"value": "string"
}
],
"virtualNetworkRules": [
{
"id": "string"
}
]
},
"publicNetworkAccess": "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 de recursos | '2022-07-01' |
| name | O nome do recurso | cadeia (obrigatório) |
| localização | A localização suportada do Azure onde deve ser criado o Conjunto de HSM gerido. | string |
| etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| sku | Detalhes do SKU | ManagedHsmSku |
| propriedades | Propriedades do HSM gerido | ManagedHsmProperties |
ManagedHsmProperties
| Nome | Descrição | Valor |
|---|---|---|
| createMode | O modo de criação para indicar se o recurso está a ser criado ou se está a ser recuperado de um recurso eliminado. | "predefinição" "recuperar" |
| enablePurgeProtection | Propriedade que especifica se a proteção contra a remoção está ativada para este conjunto de HSM gerido. Definir esta propriedade como verdadeiro ativa a proteção contra remoção para este conjunto HSM gerido e o respetivo conteúdo – apenas o serviço HSM Gerido pode iniciar uma eliminação difícil e irrecuperável. Ativar esta funcionalidade é irreversível. | bool |
| enableSoftDelete | Propriedade para especificar se a funcionalidade "eliminação recuperável" está ativada para este conjunto HSM gerido. A eliminação recuperável está ativada por predefinição para todos os HSMs geridos e é imutável. | bool |
| initialAdminObjectIds | Matriz de IDs de objetos de administradores iniciais para este conjunto hsm gerido. | cadeia[] |
| networkAcls | Regras que regem a acessibilidade do cofre de chaves a partir de localizações de rede específicas. | MhsmNetworkRuleSet |
| publicNetworkAccess | Controlar a permissão para o HSM gerido a partir de redes públicas. | "Desativado" "Ativado" |
| softDeleteRetentionInDays | Dias de retenção de dados eliminados de forma recuperável. Quando elimina um HSM ou uma chave, este permanecerá recuperável durante o período de retenção configurado ou durante um período predefinido de 90 dias. Aceita valores entre 7 e 90. | int |
| tenantId | O ID de inquilino do Azure Active Directory que deve ser utilizado para autenticar pedidos no conjunto de HSM gerido. | 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 | Indica que tráfego pode ignorar as regras de rede. Pode ser "AzureServices" ou "Nenhum". Se não for especificado, a predefinição é "AzureServices". | "AzureServices" "Nenhum" |
| defaultAction | A ação predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada. | "Permitir" "Negar" |
| ipRules | A lista de regras de endereços IP. | MhsmipRule[] |
| virtualNetworkRules | A lista de regras de rede virtual. | MhsmVirtualNetworkRule[] |
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 (obrigatório) |
MhsmVirtualNetworkRule
| Nome | 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". | cadeia (obrigatório) |
ManagedHsmSku
| Nome | Descrição | Valor |
|---|---|---|
| família | Família de SKU do Conjunto de HSM gerido | "B" (obrigatório) |
| name | SKU do Conjunto de HSM gerido | 'Custom_B32' 'Custom_B6' 'Standard_B1' (obrigatório) |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
| Criar um HSM Gerido do Azure Key Vault |
Este modelo cria um Azure Key Vault HSM Gerido. |
Definição de recurso terraform (fornecedor AzAPI)
O tipo de recurso managedHSMs pode ser implementado com operações que visam:
- Grupos de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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@2022-07-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
createMode = "string"
enablePurgeProtection = bool
enableSoftDelete = bool
initialAdminObjectIds = [
"string"
]
networkAcls = {
bypass = "string"
defaultAction = "string"
ipRules = [
{
value = "string"
}
]
virtualNetworkRules = [
{
id = "string"
}
]
}
publicNetworkAccess = "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@2022-07-01" |
| name | O nome do recurso | cadeia (obrigatório) |
| localização | A localização suportada do Azure onde deve ser criado o Conjunto de HSM gerido. | string |
| parent_id | Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de etiquetas. |
| sku | Detalhes do SKU | ManagedHsmSku |
| propriedades | Propriedades do HSM gerido | ManagedHsmProperties |
ManagedHsmProperties
| Nome | Descrição | Valor |
|---|---|---|
| createMode | O modo de criação para indicar se o recurso está a ser criado ou se está a ser recuperado de um recurso eliminado. | "predefinição" "recuperar" |
| enablePurgeProtection | Propriedade que especifica se a proteção contra remoção está ativada para este conjunto de HSM gerido. Definir esta propriedade como verdadeiro ativa a proteção contra a remoção deste conjunto de HSM gerido e o respetivo conteúdo – apenas o serviço HSM Gerido pode iniciar uma eliminação difícil e irrecuperável. Ativar esta funcionalidade é irreversível. | bool |
| enableSoftDelete | Propriedade para especificar se a funcionalidade "eliminação recuperável" está ativada para este conjunto de HSM gerido. A eliminação recuperável está ativada por predefinição para todos os HSMs geridos e é imutável. | bool |
| initialAdminObjectIds | Matriz de IDs de objeto de administradores iniciais para este conjunto hsm gerido. | string[] |
| networkAcls | Regras que regem a acessibilidade do cofre de chaves a partir de localizações de rede específicas. | MhsmNetworkRuleSet |
| publicNetworkAccess | Controlar a permissão para o HSM gerido a partir de redes públicas. | "Desativado" "Ativado" |
| softDeleteRetentionInDays | Dias de retenção de dados eliminados de forma recuperável. Quando elimina um HSM ou uma chave, este permanecerá recuperável durante o período de retenção configurado ou durante um período predefinido de 90 dias. Aceita valores entre 7 e 90. | int |
| tenantId | O ID de inquilino do Azure Active Directory que deve ser utilizado para autenticar pedidos no conjunto de HSM gerido. | 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 | Indica que tráfego pode ignorar as regras de rede. Pode ser "AzureServices" ou "Nenhum". Se não for especificado, a predefinição é "AzureServices". | "AzureServices" "Nenhum" |
| defaultAction | A ação predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada. | "Permitir" "Negar" |
| ipRules | A lista de regras de endereços IP. | MhsmipRule[] |
| virtualNetworkRules | A lista de regras de rede virtual. | MhsmVirtualNetworkRule[] |
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 (obrigatório) |
MhsmVirtualNetworkRule
| Nome | 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". | cadeia (obrigatório) |
ManagedHsmSku
| Nome | Descrição | Valor |
|---|---|---|
| família | Família de SKU do Conjunto de HSM gerido | "B" (obrigatório) |
| name | SKU do Conjunto de HSM gerido | "Custom_B32" "Custom_B6" "Standard_B1" (obrigatório) |
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários