Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
- nejnovější
- 2026-06-01-preview
- 2026-05-15
- 2026-02-01
- 2025-05-01
- 12. 12. 2024 ve verzi Preview
- 11. 11. 2024
-
2024-04-01-preview -
2023-07-01 - 2023-02-01
- 11. 11. 2022
-
2022-07-07 -
2022-022-01-preview -
11. 11. 2021 ve verzi Preview - 10. 10. 2021
-
2021-06-01-preview -
2021-04-01-preview -
2020-04-01-preview
Definice zdroje Bicep
Typ prostředku managedHSMs je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Příklady použití
Vzorky Bicepsu
Základní příklad nasazení modulu Key Vault Managed Hardware Security Module.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource managedHSM 'Microsoft.KeyVault/managedHSMs@2021-10-01' = {
name: 'kvHsm230630033342437496'
location: location
sku: {
family: 'B'
name: 'Standard_B1'
}
properties: {
createMode: 'default'
enablePurgeProtection: false
enableSoftDelete: true
initialAdminObjectIds: [
deployer().objectId
]
publicNetworkAccess: 'Enabled'
softDeleteRetentionInDays: 90
tenantId: tenant().tenantId
}
}
Ukázky rychlého startu Azure
Následující šablony Azure Quickstart obsahují Bicep vzorky pro nasazení tohoto typu zdroje.
| Soubor Bicep | Popis |
|---|---|
| Vytvořit Azure Key Vault spravovaný HSM | Tato šablona vytváří Azure Key Vault Managed HSM. |
Formát prostředku
Pro vytvoření zdroje Microsoft.KeyVault/managedHSMs přidejte do šablony následující Bicep.
resource symbolicname 'Microsoft.KeyVault/managedHSMs@2021-10-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'
softDeleteRetentionInDays: int
tenantId: 'string'
}
sku: {
family: 'string'
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Hodnoty vlastností
Microsoft.KeyVault/managedHSM
| Jméno | Popis | Hodnota |
|---|---|---|
| poloha | Podporované Azure místo, kde by měl být vytvořen spravovaný HSM pool. | řetězec |
| Jméno | Název prostředku | string (povinné) |
| vlastnosti | Vlastnosti spravovaného HSM | ManagedHsmProperties |
| SKU (identifikátor zboží) | Podrobnosti skladové položky | ManagedHsmSku |
| visačky | Značky prostředků | Slovník názvů a hodnot značek Viz Značky v šablonách |
ManagedHsmProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| Režim createMode | Režim vytvoření označující, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku. | Výchozí "obnovit" |
| enablePurgeProtection | Vlastnost určující, zda je pro tento spravovaný fond HSM povolená ochrana proti vymazání. Nastavení této vlastnosti na true aktivuje ochranu proti vymazání pro tento spravovaný fond HSM a jeho obsah – pouze spravovaná služba HSM může zahájit obtížné a nenapravitelné odstranění. Povolení této funkce je nevratné. | Bool |
| enableSoftDelete | Vlastnost určující, jestli je pro tento spravovaný fond HSM povolená funkce obnovitelného odstranění. Obnovitelné odstranění je ve výchozím nastavení povolené pro všechny spravované moduly HSM a je neměnné. | Bool |
| initialAdminObjectIds | Pole ID objektů počátečních správců pro tento spravovaný fond hsm | řetězec[] |
| networkAcls | Pravidla, která řídí přístupnost trezoru klíčů z konkrétních síťových umístění. | MhsmNetworkRuleSet |
| přístup k veřejné síti | Řízení oprávnění ke spravovanému HSM z veřejných sítí | Zakázáno Povoleno |
| softDeleteRetentionInDays | Dny uchovávání obnovitelně odstraněných dat Když odstraníte HSM nebo klíč, zůstane obnovitelný pro nakonfigurovanou dobu uchovávání nebo pro výchozí období 90 dnů. Přijímá hodnoty od 7 do 90. | Int |
| ID nájemce | Tenant ID Azure Active Directory, které by mělo být použito pro autentizaci požadavků do spravovaného HSM poolu. | řetězec Omezení: Minimální délka = 36 Maximální délka = 36 Model = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmResourceTags
| Jméno | Popis | Hodnota |
|---|
ManagedHsmSku
| Jméno | Popis | Hodnota |
|---|---|---|
| Rodina | Řada skladových položek spravovaného fondu HSM | "B" (povinné) |
| Jméno | Skladová položka spravovaného fondu HSM | "Custom_B32" Custom_B6 "Standard_B1" (povinné) |
MhsmipRule
| Jméno | Popis | Hodnota |
|---|---|---|
| hodnota | Rozsah adres IPv4 v zápisu CIDR, například 124.56.78.91 (jednoduchá IP adresa) nebo 124.56.78.0/24 (všechny adresy začínající 124.56.78). | string (povinné) |
MhsmNetworkRuleSet
| Jméno | Popis | Hodnota |
|---|---|---|
| obejít | Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud nezadáte výchozí hodnotu AzureServices. | AzureServices None (Žádný) |
| Výchozí akce | Výchozí akce, pokud se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Tento parametr se použije až po vyhodnocení vlastnosti bypass. | Povolit "Odepřít" |
| IpRules | Seznam pravidel IP adres. | MhsmipRule[] |
| VirtualNetworkRules | Seznam pravidel virtuální sítě | MhsmVirtualNetworkRule[] |
MhsmVirtualNetworkRule
| Jméno | Popis | Hodnota |
|---|---|---|
| identifikační číslo | Úplné ID prostředku podsítě virtuální sítě, například /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1. | string (povinné) |
Definice prostředku šablony ARM
Typ prostředku managedHSMs je možné nasadit s operacemi, které cílí:
- Skupiny zdrojů – viz příkazy pro nasazení skupin zdrojů Pro seznam změněných vlastností v každé verzi API viz log změn.
Příklady použití
šablony pro rychlý start pro Azure
Následující Azure Šablony Quickstart nasazují tento typ zdroje.
| Šablona | Popis |
|---|---|
|
Vytvořit Azure Key Vault spravovaný HSM |
Tato šablona vytváří Azure Key Vault Managed HSM. |
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.KeyVault/managedHSMs, přidejte do šablony následující JSON.
{
"type": "Microsoft.KeyVault/managedHSMs",
"apiVersion": "2021-10-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",
"softDeleteRetentionInDays": "int",
"tenantId": "string"
},
"sku": {
"family": "string",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Hodnoty vlastností
Microsoft.KeyVault/managedHSM
| Jméno | Popis | Hodnota |
|---|---|---|
| Verze rozhraní apiVersion | Verze rozhraní API | '2021-10-01' |
| poloha | Podporované Azure místo, kde by měl být vytvořen spravovaný HSM pool. | řetězec |
| Jméno | Název prostředku | string (povinné) |
| vlastnosti | Vlastnosti spravovaného HSM | ManagedHsmProperties |
| SKU (identifikátor zboží) | Podrobnosti skladové položky | ManagedHsmSku |
| visačky | Značky prostředků | Slovník názvů a hodnot značek Viz Značky v šablonách |
| typ | Typ prostředku | Microsoft.KeyVault/managedHSMs |
ManagedHsmProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| Režim createMode | Režim vytvoření označující, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku. | Výchozí "obnovit" |
| enablePurgeProtection | Vlastnost určující, zda je pro tento spravovaný fond HSM povolená ochrana proti vymazání. Nastavení této vlastnosti na true aktivuje ochranu proti vymazání pro tento spravovaný fond HSM a jeho obsah – pouze spravovaná služba HSM může zahájit obtížné a nenapravitelné odstranění. Povolení této funkce je nevratné. | Bool |
| enableSoftDelete | Vlastnost určující, jestli je pro tento spravovaný fond HSM povolená funkce obnovitelného odstranění. Obnovitelné odstranění je ve výchozím nastavení povolené pro všechny spravované moduly HSM a je neměnné. | Bool |
| initialAdminObjectIds | Pole ID objektů počátečních správců pro tento spravovaný fond hsm | řetězec[] |
| networkAcls | Pravidla, která řídí přístupnost trezoru klíčů z konkrétních síťových umístění. | MhsmNetworkRuleSet |
| přístup k veřejné síti | Řízení oprávnění ke spravovanému HSM z veřejných sítí | Zakázáno Povoleno |
| softDeleteRetentionInDays | Dny uchovávání obnovitelně odstraněných dat Když odstraníte HSM nebo klíč, zůstane obnovitelný pro nakonfigurovanou dobu uchovávání nebo pro výchozí období 90 dnů. Přijímá hodnoty od 7 do 90. | Int |
| ID nájemce | Tenant ID Azure Active Directory, které by mělo být použito pro autentizaci požadavků do spravovaného HSM poolu. | řetězec Omezení: Minimální délka = 36 Maximální délka = 36 Model = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmResourceTags
| Jméno | Popis | Hodnota |
|---|
ManagedHsmSku
| Jméno | Popis | Hodnota |
|---|---|---|
| Rodina | Řada skladových položek spravovaného fondu HSM | "B" (povinné) |
| Jméno | Skladová položka spravovaného fondu HSM | "Custom_B32" Custom_B6 "Standard_B1" (povinné) |
MhsmipRule
| Jméno | Popis | Hodnota |
|---|---|---|
| hodnota | Rozsah adres IPv4 v zápisu CIDR, například 124.56.78.91 (jednoduchá IP adresa) nebo 124.56.78.0/24 (všechny adresy začínající 124.56.78). | string (povinné) |
MhsmNetworkRuleSet
| Jméno | Popis | Hodnota |
|---|---|---|
| obejít | Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud nezadáte výchozí hodnotu AzureServices. | AzureServices None (Žádný) |
| Výchozí akce | Výchozí akce, pokud se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Tento parametr se použije až po vyhodnocení vlastnosti bypass. | Povolit "Odepřít" |
| IpRules | Seznam pravidel IP adres. | MhsmipRule[] |
| VirtualNetworkRules | Seznam pravidel virtuální sítě | MhsmVirtualNetworkRule[] |
MhsmVirtualNetworkRule
| Jméno | Popis | Hodnota |
|---|---|---|
| identifikační číslo | Úplné ID prostředku podsítě virtuální sítě, například /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1. | string (povinné) |
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku managedHSMs je možné nasadit s operacemi, které cílí:
- Skupiny zdrojů Pro seznam změněných vlastností v každé verzi API viz log změn.
Příklady použití
Ukázky Terraformu
Základní příklad nasazení modulu Key Vault Managed Hardware Security Module.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
azurerm = {
source = "hashicorp/azurerm"
}
}
}
provider "azurerm" {
features {
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
data "azurerm_client_config" "current" {
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "managedHSM" {
type = "Microsoft.KeyVault/managedHSMs@2021-10-01"
parent_id = azapi_resource.resourceGroup.id
name = "kvHsm230630033342437496"
location = var.location
body = {
properties = {
createMode = "default"
enablePurgeProtection = false
enableSoftDelete = true
initialAdminObjectIds = [
data.azurerm_client_config.current.object_id,
]
publicNetworkAccess = "Enabled"
softDeleteRetentionInDays = 90
tenantId = data.azurerm_client_config.current.tenant_id
}
sku = {
family = "B"
name = "Standard_B1"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Ověřené moduly Azure
K nasazení tohoto typu prostředku je možné použít následující ověřené moduly Azure.
| Module | Popis |
|---|---|
| Spravovaný HSM služby Key Vault | AVM Resource Module pro Key Vault Managed HSM |
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.KeyVault/managedHSMs, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/managedHSMs@2021-10-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
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 = "string"
name = "string"
}
}
}
Hodnoty vlastností
Microsoft.KeyVault/managedHSM
| Jméno | Popis | Hodnota |
|---|---|---|
| poloha | Podporované Azure místo, kde by měl být vytvořen spravovaný HSM pool. | řetězec |
| Jméno | Název prostředku | string (povinné) |
| vlastnosti | Vlastnosti spravovaného HSM | ManagedHsmProperties |
| SKU (identifikátor zboží) | Podrobnosti skladové položky | ManagedHsmSku |
| visačky | Značky prostředků | Slovník názvů a hodnot značek |
| typ | Typ prostředku | Microsoft.KeyVault/managedHSMs@2021-10-01 |
ManagedHsmProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| Režim createMode | Režim vytvoření označující, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku. | Výchozí "obnovit" |
| enablePurgeProtection | Vlastnost určující, zda je pro tento spravovaný fond HSM povolená ochrana proti vymazání. Nastavení této vlastnosti na true aktivuje ochranu proti vymazání pro tento spravovaný fond HSM a jeho obsah – pouze spravovaná služba HSM může zahájit obtížné a nenapravitelné odstranění. Povolení této funkce je nevratné. | Bool |
| enableSoftDelete | Vlastnost určující, jestli je pro tento spravovaný fond HSM povolená funkce obnovitelného odstranění. Obnovitelné odstranění je ve výchozím nastavení povolené pro všechny spravované moduly HSM a je neměnné. | Bool |
| initialAdminObjectIds | Pole ID objektů počátečních správců pro tento spravovaný fond hsm | řetězec[] |
| networkAcls | Pravidla, která řídí přístupnost trezoru klíčů z konkrétních síťových umístění. | MhsmNetworkRuleSet |
| přístup k veřejné síti | Řízení oprávnění ke spravovanému HSM z veřejných sítí | Zakázáno Povoleno |
| softDeleteRetentionInDays | Dny uchovávání obnovitelně odstraněných dat Když odstraníte HSM nebo klíč, zůstane obnovitelný pro nakonfigurovanou dobu uchovávání nebo pro výchozí období 90 dnů. Přijímá hodnoty od 7 do 90. | Int |
| ID nájemce | Tenant ID Azure Active Directory, které by mělo být použito pro autentizaci požadavků do spravovaného HSM poolu. | řetězec Omezení: Minimální délka = 36 Maximální délka = 36 Model = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmResourceTags
| Jméno | Popis | Hodnota |
|---|
ManagedHsmSku
| Jméno | Popis | Hodnota |
|---|---|---|
| Rodina | Řada skladových položek spravovaného fondu HSM | "B" (povinné) |
| Jméno | Skladová položka spravovaného fondu HSM | "Custom_B32" Custom_B6 "Standard_B1" (povinné) |
MhsmipRule
| Jméno | Popis | Hodnota |
|---|---|---|
| hodnota | Rozsah adres IPv4 v zápisu CIDR, například 124.56.78.91 (jednoduchá IP adresa) nebo 124.56.78.0/24 (všechny adresy začínající 124.56.78). | string (povinné) |
MhsmNetworkRuleSet
| Jméno | Popis | Hodnota |
|---|---|---|
| obejít | Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud nezadáte výchozí hodnotu AzureServices. | AzureServices None (Žádný) |
| Výchozí akce | Výchozí akce, pokud se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Tento parametr se použije až po vyhodnocení vlastnosti bypass. | Povolit "Odepřít" |
| IpRules | Seznam pravidel IP adres. | MhsmipRule[] |
| VirtualNetworkRules | Seznam pravidel virtuální sítě | MhsmVirtualNetworkRule[] |
MhsmVirtualNetworkRule
| Jméno | Popis | Hodnota |
|---|---|---|
| identifikační číslo | Úplné ID prostředku podsítě virtuální sítě, například /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1. | string (povinné) |