Microsoft.KeyVault managedHSMs 2022-11-01
- nejnovější
-
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 prostředku 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.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.KeyVault/managedHSMs, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.KeyVault/managedHSMs@2022-11-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í
ManagedHsmProperties
Jméno | Popis | Hodnota |
---|---|---|
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 | string[] |
networkAcls | Pravidla, která řídí přístupnost trezoru klíčů z konkrétních síťových umístění. | MhsmNetworkRuleSet |
publicNetworkAccess | Ří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 |
tenantId | ID tenanta Azure Active Directory, které by se mělo použít k ověřování požadavků ve spravovaném fondu HSM. | ř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ý) |
defaultAction | 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 |
---|---|---|
id | Ú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é) |
Microsoft.KeyVault/managedHSMs
Jméno | Popis | Hodnota |
---|---|---|
umístění | Podporované umístění Azure, ve kterém by se měl vytvořit spravovaný fond HSM. | řetězec |
Jméno | Název prostředku | string (povinné) |
vlastnosti | Vlastnosti spravovaného HSM | ManagedHsmProperties |
sku | 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 |
Ukázky rychlého startu
Následující ukázky rychlého startu nasadí tento typ prostředku.
Soubor Bicep | Popis |
---|---|
vytvoření spravovaného hsm služby Azure Key Vault | Tato šablona vytvoří spravovaný HSM služby Azure Key Vault. |
Definice prostředku šablony ARM
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.
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": "2022-11-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í
ManagedHsmProperties
Jméno | Popis | Hodnota |
---|---|---|
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 | string[] |
networkAcls | Pravidla, která řídí přístupnost trezoru klíčů z konkrétních síťových umístění. | MhsmNetworkRuleSet |
publicNetworkAccess | Ří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 |
tenantId | ID tenanta Azure Active Directory, které by se mělo použít k ověřování požadavků ve spravovaném fondu HSM. | ř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ý) |
defaultAction | 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 |
---|---|---|
id | Ú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é) |
Microsoft.KeyVault/managedHSMs
Jméno | Popis | Hodnota |
---|---|---|
apiVersion | Verze rozhraní API | '2022-11-01' |
umístění | Podporované umístění Azure, ve kterém by se měl vytvořit spravovaný fond HSM. | řetězec |
Jméno | Název prostředku | string (povinné) |
vlastnosti | Vlastnosti spravovaného HSM | ManagedHsmProperties |
sku | 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 |
Šablony pro rychlý start
Následující šablony pro rychlý start nasazují tento typ prostředku.
Šablona | Popis |
---|---|
vytvoření spravovaného hsm služby Azure Key Vault nasazení |
Tato šablona vytvoří spravovaný HSM služby Azure Key Vault. |
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku managedHSMs je možné nasadit s operacemi, které cílí:
- skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
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@2022-11-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"
softDeleteRetentionInDays = int
tenantId = "string"
}
})
}
Hodnoty vlastností
ManagedHsmProperties
Jméno | Popis | Hodnota |
---|---|---|
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 | string[] |
networkAcls | Pravidla, která řídí přístupnost trezoru klíčů z konkrétních síťových umístění. | MhsmNetworkRuleSet |
publicNetworkAccess | Ří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 |
tenantId | ID tenanta Azure Active Directory, které by se mělo použít k ověřování požadavků ve spravovaném fondu HSM. | ř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ý) |
defaultAction | 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 |
---|---|---|
id | Ú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é) |
Microsoft.KeyVault/managedHSMs
Jméno | Popis | Hodnota |
---|---|---|
umístění | Podporované umístění Azure, ve kterém by se měl vytvořit spravovaný fond HSM. | řetězec |
Jméno | Název prostředku | string (povinné) |
vlastnosti | Vlastnosti spravovaného HSM | ManagedHsmProperties |
sku | 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@2022-11-01 |