Spravované HSMs Microsoft.KeyVault
Definice prostředku Bicep
Typ prostředku managedHSMs je možné nasadit s operacemi, které cílí na:
- 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@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'
}
}
Hodnoty vlastností
managedHSMs
| Název | Description | Hodnota |
|---|---|---|
| name | Název prostředku | string (povinné) |
| location | Podporované umístění Azure, ve kterém by se měl vytvořit spravovaný fond HSM. | řetězec |
| tags | Značky prostředků | Slovník názvů značek a hodnot. Viz Značky v šablonách |
| Sku | Podrobnosti o skladové pořidce | ManagedHsmSku |
| identity | Identita spravované služby (identity přiřazené systémem nebo uživatelem) | ManagedServiceIdentity |
| properties | Vlastnosti spravovaného modulu HSM | ManagedHsmProperties |
ManagedServiceIdentity
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned). | 'Žádný' 'SystemAssigned' 'SystemAssigned,UserAssigned' UserAssigned (povinné) |
| userAssignedIdentity | Sada identit přiřazených uživatelem přidružených k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formátu /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích. | UserAssignedIdentities |
UserAssignedIdentities
| Název | Description | Hodnota |
|---|---|---|
| {přizpůsobená vlastnost} | UserAssignedIdentity |
UserAssignedIdentity
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.
ManagedHsmProperties
| Název | Description | Hodnota |
|---|---|---|
| createMode | Režim vytvoření, který označuje, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku. | 'výchozí' 'obnovit' |
| enablePurgeProtection | Vlastnost určující, jestli je pro tento spravovaný fond HSM povolená ochrana před vymazáním. Nastavení této vlastnosti na hodnotu true aktivuje ochranu před vymazáním pro tento spravovaný fond HSM a jeho obsah – pouze spravovaná služba HSM může zahájit tvrdé a neodstranitelné odstranění. Povolení této funkce je nevratné. | bool |
| enableSoftDelete | Vlastnost určuje, 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 POČÁTEČNÍCH ID objektů správců pro tento spravovaný fond hsm | string[] |
| networkAcls | Pravidla pro přístupnost trezoru klíčů z konkrétních síťových umístění | MhsmNetworkRuleSet |
| publicNetworkAccess | Řízení oprávnění ke spravovanému modulu HSM z veřejných sítí | Zakázáno 'Povoleno' |
| Regiony | Seznam všech oblastí přidružených ke spravovanému fondu hsm | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | Dny uchovávání obnovitelného odstranění dat. Když odstraníte HSM nebo klíč, zůstane možné ho obnovit po nakonfigurovanou dobu uchovávání nebo po výchozí dobu 90 dnů. Přijímá hodnoty mezi 7 a 90. | int |
| id tenanta | ID tenanta Azure Active Directory, které by se mělo použít k ověřování požadavků na spravovaný fond HSM. | řetězec Omezení: Minimální délka = 36 Maximální délka = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
MhsmNetworkRuleSet
| Název | Description | Hodnota |
|---|---|---|
| Vynechání | Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud není zadáno, výchozí hodnota je AzureServices. | AzureServices 'Žádný' |
| defaultAction | Výchozí akce, pokud se žádné pravidlo z ipRules a z virtualNetworkRules neshoduje. Použije se pouze po vyhodnocení vlastnosti bypass. | 'Povolit' "Odepřít" |
| ipRules | Seznam pravidel IP adres. | MhsmipRule[] |
| virtualNetworkRules | Seznam pravidel virtuální sítě. | MhsmVirtualNetworkRule[] |
MhsmipRule
| Název | Description | Hodnota |
|---|---|---|
| hodnota | Rozsah IPv4 adres v zápisu CIDR, například "124.56.78.91" (jednoduchá IP adresa) nebo "124.56.78.0/24" (všechny adresy, které začínají na 124.56.78). | string (povinné) |
MhsmVirtualNetworkRule
| Název | Description | 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é) |
MhsmGeoReplicatedRegion
| Název | Description | Hodnota |
|---|---|---|
| isPrimary | Logická hodnota, která označuje, jestli je oblast primární nebo sekundární oblastí. | bool |
| name | Název geograficky replikované oblasti | řetězec |
ManagedHsmSku
| Název | Description | Hodnota |
|---|---|---|
| family | Řada skladových položek spravovaného fondu HSM | "B" (povinné) |
| name | Skladová položka spravovaného fondu HSM | 'Custom_B32' 'Custom_B6' "Standard_B1" (povinné) |
Šablony pro rychlý start
Následující šablony rychlého startu nasadí tento typ prostředku.
| Template (Šablona) | Description |
|---|---|
Vytvoření spravovaného modulu HSM azure Key Vault |
Tato šablona vytvoří spravovaný modul HSM azure Key Vault. |
Definice prostředku šablony ARM
Typ prostředku managedHSMs je možné nasadit s operacemi, které cílí na:
- 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í kód JSON.
{
"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"
}
}
Hodnoty vlastností
managedHSMs
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.KeyVault/managedHSMs |
| apiVersion | Verze rozhraní API prostředků | '2023-07-01' |
| name | Název prostředku | string (povinné) |
| location | Podporované umístění Azure, ve kterém by se měl vytvořit spravovaný fond HSM. | řetězec |
| tags | Značky prostředků | Slovník názvů značek a hodnot. Viz Značky v šablonách |
| Sku | Podrobnosti o skladové pořidce | ManagedHsmSku |
| identity | Identita spravované služby (identity přiřazené systémem nebo uživatelem) | ManagedServiceIdentity |
| properties | Vlastnosti spravovaného modulu HSM | ManagedHsmProperties |
ManagedServiceIdentity
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned). | 'Žádný' 'SystemAssigned' 'SystemAssigned,UserAssigned' UserAssigned (povinné) |
| userAssignedIdentity | Sada identit přiřazených uživatelem přidružených k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formátu /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích. | UserAssignedIdentities |
UserAssignedIdentities
| Název | Description | Hodnota |
|---|---|---|
| {přizpůsobená vlastnost} | UserAssignedIdentity |
UserAssignedIdentity
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.
ManagedHsmProperties
| Název | Description | Hodnota |
|---|---|---|
| createMode | Režim vytvoření, který označuje, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku. | 'výchozí' 'obnovit' |
| enablePurgeProtection | Vlastnost určující, jestli je pro tento spravovaný fond HSM povolená ochrana před vymazáním. Nastavení této vlastnosti na hodnotu true aktivuje ochranu před vymazáním pro tento spravovaný fond HSM a jeho obsah – pouze spravovaná služba HSM může zahájit tvrdé a neodstranitelné odstranění. Povolení této funkce je nevratné. | bool |
| enableSoftDelete | Vlastnost určuje, 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 POČÁTEČNÍCH ID objektů správců pro tento spravovaný fond hsm | string[] |
| networkAcls | Pravidla pro přístupnost trezoru klíčů z konkrétních síťových umístění | MhsmNetworkRuleSet |
| publicNetworkAccess | Řízení oprávnění ke spravovanému modulu HSM z veřejných sítí | Zakázáno 'Povoleno' |
| Regiony | Seznam všech oblastí přidružených ke spravovanému fondu hsm | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | Dny uchovávání obnovitelného odstranění dat. Když odstraníte HSM nebo klíč, zůstane možné ho obnovit po nakonfigurovanou dobu uchovávání nebo po výchozí dobu 90 dnů. Přijímá hodnoty mezi 7 a 90. | int |
| id tenanta | ID tenanta Azure Active Directory, které by se mělo použít k ověřování požadavků na spravovaný fond HSM. | řetězec Omezení: Minimální délka = 36 Maximální délka = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
MhsmNetworkRuleSet
| Název | Description | Hodnota |
|---|---|---|
| Vynechání | Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud není zadáno, výchozí hodnota je AzureServices. | AzureServices 'Žádný' |
| defaultAction | Výchozí akce, pokud se žádné pravidlo z ipRules a z virtualNetworkRules neshoduje. Použije se pouze po vyhodnocení vlastnosti bypass. | 'Povolit' "Odepřít" |
| ipRules | Seznam pravidel IP adres. | MhsmipRule[] |
| virtualNetworkRules | Seznam pravidel virtuální sítě. | MhsmVirtualNetworkRule[] |
MhsmipRule
| Název | Description | Hodnota |
|---|---|---|
| hodnota | Rozsah IPv4 adres v zápisu CIDR, například "124.56.78.91" (jednoduchá IP adresa) nebo "124.56.78.0/24" (všechny adresy, které začínají na 124.56.78). | string (povinné) |
MhsmVirtualNetworkRule
| Název | Description | 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é) |
MhsmGeoReplicatedRegion
| Název | Description | Hodnota |
|---|---|---|
| isPrimary | Logická hodnota, která označuje, jestli je oblast primární nebo sekundární oblastí. | bool |
| name | Název geograficky replikované oblasti | řetězec |
ManagedHsmSku
| Název | Description | Hodnota |
|---|---|---|
| family | Řada skladových položek spravovaného fondu HSM | "B" (povinné) |
| name | Skladová položka spravovaného fondu HSM | 'Custom_B32' 'Custom_B6' "Standard_B1" (povinné) |
Šablony pro rychlý start
Následující šablony rychlého startu nasadí tento typ prostředku.
| Template (Šablona) | Description |
|---|---|
| Vytvoření spravovaného modulu HSM azure Key Vault |
Tato šablona vytvoří spravovaný modul HSM azure Key Vault. |
Definice prostředku Terraformu (zprostředkovatele AzAPI)
Typ prostředku managedHSMs je možné nasadit s operacemi, které cílí na:
- 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@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"
}
})
}
Hodnoty vlastností
managedHSMs
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.KeyVault/managedHSMs@2023-07-01 |
| name | Název prostředku | string (povinné) |
| location | Podporované umístění Azure, ve kterém by se měl vytvořit spravovaný fond HSM. | řetězec |
| parent_id | K nasazení do skupiny prostředků použijte ID této skupiny prostředků. | string (povinné) |
| tags | Značky prostředků | Slovník názvů značek a hodnot. |
| Sku | Podrobnosti o skladové pořidce | ManagedHsmSku |
| identity | Identita spravované služby (identity přiřazené systémem nebo uživatelem) | ManagedServiceIdentity |
| properties | Vlastnosti spravovaného modulu HSM | ManagedHsmProperties |
ManagedServiceIdentity
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned). | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (povinné) |
| identity_ids | Sada identit přiřazených uživatelem přidružených k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formátu /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích. | Pole ID identit uživatelů |
UserAssignedIdentities
| Název | Description | Hodnota |
|---|---|---|
| {přizpůsobená vlastnost} | UserAssignedIdentity |
UserAssignedIdentity
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.
ManagedHsmProperties
| Název | Description | Hodnota |
|---|---|---|
| createMode | Režim vytvoření, který označuje, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku. | "výchozí" "obnovit" |
| enablePurgeProtection | Vlastnost určující, jestli je pro tento spravovaný fond HSM povolená ochrana před vymazáním. Nastavení této vlastnosti na hodnotu true aktivuje ochranu před vymazáním pro tento spravovaný fond HSM a jeho obsah – pouze spravovaná služba HSM může zahájit tvrdé a neodstranitelné odstranění. Povolení této funkce je nevratné. | bool |
| enableSoftDelete | Vlastnost určuje, 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 POČÁTEČNÍCH ID objektů správců pro tento spravovaný fond hsm | string[] |
| networkAcls | Pravidla pro přístupnost trezoru klíčů z konkrétních síťových umístění | MhsmNetworkRuleSet |
| publicNetworkAccess | Řízení oprávnění ke spravovanému modulu HSM z veřejných sítí | "Zakázáno" "Povoleno" |
| Regiony | Seznam všech oblastí přidružených ke spravovanému fondu hsm | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | Dny uchovávání obnovitelného odstranění dat. Když odstraníte HSM nebo klíč, zůstane možné ho obnovit po nakonfigurovanou dobu uchovávání nebo po výchozí dobu 90 dnů. Přijímá hodnoty mezi 7 a 90. | int |
| id tenanta | ID tenanta Azure Active Directory, které by se mělo použít k ověřování požadavků na spravovaný fond HSM. | řetězec Omezení: Minimální délka = 36 Maximální délka = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
MhsmNetworkRuleSet
| Název | Description | Hodnota |
|---|---|---|
| Vynechání | Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud není zadáno, výchozí hodnota je AzureServices. | "AzureServices" "Žádné" |
| defaultAction | Výchozí akce, pokud se žádné pravidlo z ipRules a z virtualNetworkRules neshoduje. Použije se pouze po vyhodnocení vlastnosti bypass. | "Povolit" "Odepřít" |
| ipRules | Seznam pravidel IP adres. | MhsmipRule[] |
| virtualNetworkRules | Seznam pravidel virtuální sítě. | MhsmVirtualNetworkRule[] |
MhsmipRule
| Název | Description | Hodnota |
|---|---|---|
| hodnota | Rozsah IPv4 adres v zápisu CIDR, například "124.56.78.91" (jednoduchá IP adresa) nebo "124.56.78.0/24" (všechny adresy, které začínají na 124.56.78). | string (povinné) |
MhsmVirtualNetworkRule
| Název | Description | 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é) |
MhsmGeoReplicatedRegion
| Název | Description | Hodnota |
|---|---|---|
| isPrimary | Logická hodnota, která označuje, jestli je oblast primární nebo sekundární oblastí. | bool |
| name | Název geograficky replikované oblasti | řetězec |
ManagedHsmSku
| Název | Description | Hodnota |
|---|---|---|
| family | Řada skladových položek spravovaného fondu HSM | "B" (povinné) |
| name | Skladová položka spravovaného fondu HSM | "Custom_B32" "Custom_B6" "Standard_B1" (povinné) |
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro