Sdílet prostřednictvím


Microsoft.KeyVault managedHSMs 2022-02-01-preview

Definice prostředku Bicep

Typ prostředku managedHSMs je možné nasadit s operacemi, které cílí na:

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-02-01-preview' = {
  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'
  }
}

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
properties Vlastnosti spravovaného modulu HSM ManagedHsmProperties

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'
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é)

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

Nasazení do Azure
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:

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": "2022-02-01-preview",
  "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"
  }
}

Hodnoty vlastností

managedHSMs

Název Description Hodnota
typ Typ prostředku Microsoft.KeyVault/managedHSMs
apiVersion Verze rozhraní API prostředků '2022-02-01-preview'
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
properties Vlastnosti spravovaného modulu HSM ManagedHsmProperties

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'
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é)

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

Nasazení do Azure
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@2022-02-01-preview"
  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"
    }
  })
}

Hodnoty vlastností

managedHSMs

Název Description Hodnota
typ Typ prostředku Microsoft.KeyVault/managedHSMs@2022-02-01-preview
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
properties Vlastnosti spravovaného modulu HSM ManagedHsmProperties

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 služba Managed HSM může zahájit tvrdé a neopravitelné odstranění. Povolení této funkce je nevratné. bool
enableSoftDelete Vlastnost, která 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é HSM a je neměnné. bool
initialAdminObjectIds Pole ID počátečních objektů administrators pro tento fond spravovaných hsm string[]
seznam síťových seznamů 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 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 možné ho obnovit po nakonfigurovanou dobu uchovávání nebo po výchozí období 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ů do spravovaného fondu HSM. řetězec

Omezení:
Minimální délka = 36
Maximální délka = 36
Vzor = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

MhsmNetworkRuleSet

Název Description Hodnota
Vynechání Říká, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud není zadaný, výchozí hodnota je AzureServices. "AzureServices"
"Žádné"
výchozí akce Výchozí akce, když se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Použije se až po vyhodnocení vlastnosti bypass. "Povolit"
"Odepřít"
pravidla ipRules Seznam pravidel IP adres. MhsmipRule[]
virtualNetworkRules Seznam pravidel virtuální sítě. MhsmVirtualNetworkRule[]

MhsmipRule

Název Description 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, které začínají 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é)

SpravovanáHsmSku

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é)