Udostępnij za pośrednictwem


Microsoft.KeyVault managedHSMs

Definicja zasobu Bicep

Typ zasobu managedHSMs można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.KeyVault/managedHSMs, dodaj następujący kod Bicep do szablonu.

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'
  }
}

Wartości właściwości

zarządzane maszynyHSM

Nazwa Opis Wartość
name Nazwa zasobu ciąg (wymagany)
location Obsługiwana lokalizacja platformy Azure, w której powinna zostać utworzona zarządzana pula modułów HSM. ciąg
tags Tagi zasobów Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
sku Szczegóły jednostki SKU ManagedHsmSku
identity Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub przypisane przez użytkownika) Identyfikator usługi zarządzanej
properties Właściwości zarządzanego modułu HSM ManagedHsmProperties

Identyfikator usługi zarządzanej

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
userAssignedIdentities Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. UserAssignedIdentities

UserAssignedIdentities

Nazwa Opis Wartość
{niestandardowa właściwość} UserAssignedIdentity

UserAssignedIdentity

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

ManagedHsmProperties

Nazwa Opis Wartość
createMode Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu. "default"
"odzyskaj"
enablePurgeProtection Właściwość określająca, czy ochrona przed przeczyszczeniem jest włączona dla tej zarządzanej puli modułów HSM. Ustawienie tej właściwości na wartość true aktywuje ochronę przed przeczyszczeniem dla tej zarządzanej puli modułów HSM i jej zawartości — tylko zarządzana usługa HSM może zainicjować twarde, nieodzyskiwalne usunięcie. Włączenie tej funkcji jest nieodwracalne. bool
enableSoftDelete Właściwość określająca, czy dla tej zarządzanej puli modułów HSM włączono funkcję usuwania nietrwałego. Usuwanie nietrwałe jest domyślnie włączone dla wszystkich zarządzanych modułów HSM i jest niezmienne. bool
initialAdminObjectIds Tablica początkowych identyfikatorów obiektów administratorów dla tej zarządzanej puli hsm. ciąg[]
networkAcls Reguły dotyczące ułatwień dostępu magazynu kluczy z określonych lokalizacji sieciowych. MhsmNetworkRuleSet
publicNetworkAccess Kontrolowanie uprawnień do zarządzanego modułu HSM z sieci publicznych. "Wyłączone"
"Włączone"
Regionów Lista wszystkich regionów skojarzonych z zarządzaną pulą modułów HSM. MhsmGeoReplicatedRegion[]
softDeleteRetentionInDays Nietrwałe usunięte dni przechowywania danych. Usunięcie modułu HSM lub klucza pozostanie możliwe do odzyskania przez skonfigurowany okres przechowywania lub domyślny okres 90 dni. Akceptuje wartości z zakresu od 7 do 90. int
tenantId Identyfikator dzierżawy usługi Azure Active Directory, który powinien być używany do uwierzytelniania żądań do zarządzanej puli modułów HSM. ciąg

Ograniczenia:
Minimalna długość = 36
Maksymalna długość = 36
Wzorzec = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

MhsmNetworkRuleSet

Nazwa Opis Wartość
obejście Informuje, jaki ruch może pominąć reguły sieci. Może to być wartość "AzureServices" lub "None". Jeśli nie określono wartości domyślnej, to "AzureServices". "AzureServices"
"Brak"
defaultAction Akcja domyślna, gdy nie jest zgodna żadna reguła z reguł ipRules i virtualNetworkRules. Jest to używane tylko po ocenie właściwości obejścia. "Zezwalaj"
"Odmów"
ipRules Lista reguł adresów IP. MhsmipRule[]
virtualNetworkRules Lista reguł sieci wirtualnej. MhsmVirtualNetworkRule[]

MhsmipRule

Nazwa Opis Wartość
wartość Zakres adresów IPv4 w notacji CIDR, taki jak "124.56.78.91" (prosty adres IP) lub "124.56.78.0/24" (wszystkie adresy rozpoczynające się od 124.56.78). ciąg (wymagany)

MhsmVirtualNetworkRule

Nazwa Opis Wartość
identyfikator Pełny identyfikator zasobu podsieci sieci wirtualnej, taki jak "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". ciąg (wymagany)

MhsmGeoReplicatedRegion

Nazwa Opis Wartość
isPrimary Wartość logiczna wskazująca, czy region jest regionem podstawowym, czy regionem pomocniczym. bool
name Nazwa zreplikowanego regionu geograficznego. ciąg

ManagedHsmSku

Nazwa Opis Wartość
rodzina Rodzina jednostek SKU zarządzanej puli modułów HSM "B" (wymagane)
name Jednostka SKU zarządzanej puli modułów HSM "Custom_B32"
"Custom_B6"
"Standard_B1" (wymagane)

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template Opis
Tworzenie zarządzanego modułu HSM platformy Azure Key Vault

Wdróż na platformie Azure
Ten szablon tworzy zarządzany moduł HSM platformy Azure Key Vault.

Definicja zasobu szablonu usługi ARM

Typ zasobu managedHSMs można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.KeyVault/managedHSMs, dodaj następujący kod JSON do szablonu.

{
  "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"
  }
}

Wartości właściwości

zarządzane maszynyHSM

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.KeyVault/managedHSMs"
apiVersion Wersja interfejsu API zasobów '2023-07-01'
name Nazwa zasobu ciąg (wymagany)
location Obsługiwana lokalizacja platformy Azure, w której powinna zostać utworzona zarządzana pula modułów HSM. ciąg
tags Tagi zasobów Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
sku Szczegóły jednostki SKU ManagedHsmSku
identity Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub przypisane przez użytkownika) ManagedServiceIdentity
properties Właściwości zarządzanego modułu HSM ManagedHsmProperties

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
userAssignedIdentities Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. UserAssignedIdentities

UserAssignedIdentities

Nazwa Opis Wartość
{niestandardowa właściwość} UserAssignedIdentity

UserAssignedIdentity

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

ManagedHsmProperties

Nazwa Opis Wartość
createMode Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu. "default"
"odzyskiwanie"
enablePurgeProtection Właściwość określająca, czy włączono ochronę przed przeczyszczeniem dla tej zarządzanej puli modułów HSM. Ustawienie tej właściwości na wartość true powoduje aktywowanie ochrony przed przeczyszczeniem dla tej zarządzanej puli modułów HSM i jej zawartości — tylko zarządzana usługa HSM może zainicjować twarde, nieodwracalne usunięcie. Włączenie tej funkcji jest nieodwracalne. bool
enableSoftDelete Właściwość określająca, czy funkcja usuwania nietrwałego jest włączona dla tej zarządzanej puli modułów HSM. Usuwanie nietrwałe jest domyślnie włączone dla wszystkich zarządzanych modułów HSM i jest niezmienne. bool
initialAdminObjectIds Tablica początkowych identyfikatorów obiektów administratorów dla tej zarządzanej puli hsm. ciąg[]
networkAcls Reguły rządzące ułatwieniami dostępu magazynu kluczy z określonych lokalizacji sieciowych. MhsmNetworkRuleSet
publicNetworkAccess Kontrolowanie uprawnień do zarządzanego modułu HSM z sieci publicznych. "Wyłączone"
"Włączone"
Regionów Lista wszystkich regionów skojarzonych z zarządzaną pulą modułów HSM. MhsmGeoReplicatedRegion[]
softDeleteRetentionInDays Dni przechowywania danych usuniętych nietrwale. Usunięcie modułu HSM lub klucza pozostanie możliwe do odzyskania przez skonfigurowany okres przechowywania lub domyślny okres 90 dni. Akceptuje wartości z zakresu od 7 do 90. int
tenantId Identyfikator dzierżawy usługi Azure Active Directory, który powinien być używany do uwierzytelniania żądań do zarządzanej puli modułów HSM. ciąg

Ograniczenia:
Minimalna długość = 36
Maksymalna długość = 36
Wzorzec = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

MhsmNetworkRuleSet

Nazwa Opis Wartość
obejście Informuje, jaki ruch może pomijać reguły sieci. Może to być wartość "AzureServices" lub "Brak". Jeśli nie określono wartości domyślnej to "AzureServices". "AzureServices"
"Brak"
defaultAction Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia. "Zezwalaj"
"Odmów"
adresy IPRules Lista reguł adresów IP. MhsmipRule[]
virtualNetworkRules Lista reguł sieci wirtualnej. MhsmVirtualNetworkRule[]

MhsmipRule

Nazwa Opis Wartość
wartość Zakres adresów IPv4 w notacji CIDR, taki jak "124.56.78.91" (prosty adres IP) lub "124.56.78.0/24" (wszystkie adresy rozpoczynające się od 124.56.78). ciąg (wymagany)

MhsmVirtualNetworkRule

Nazwa Opis Wartość
identyfikator Pełny identyfikator zasobu podsieci sieci wirtualnej, taki jak "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". ciąg (wymagany)

MhsmGeoReplicatedRegion

Nazwa Opis Wartość
isPrimary Wartość logiczna wskazująca, czy region jest regionem podstawowym, czy regionem pomocniczym. bool
name Nazwa zreplikowanego regionu geograficznego. ciąg

ManagedHsmSku

Nazwa Opis Wartość
rodzina Rodzina jednostek SKU zarządzanej puli modułów HSM "B" (wymagane)
name Jednostka SKU zarządzanej puli modułów HSM "Custom_B32"
"Custom_B6"
"Standard_B1" (wymagane)

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template Opis
Tworzenie zarządzanego modułu HSM platformy Azure Key Vault

Wdróż na platformie Azure
Ten szablon tworzy zarządzany moduł HSM platformy Azure Key Vault.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu managedHSMs można wdrożyć z operacjami docelowymi:

  • Grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.KeyVault/managedHSMs, dodaj następujący program Terraform do szablonu.

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"
    }
  })
}

Wartości właściwości

zarządzane maszynyHSM

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.KeyVault/managedHSMs@2023-07-01"
name Nazwa zasobu ciąg (wymagany)
location Obsługiwana lokalizacja platformy Azure, w której powinna zostać utworzona zarządzana pula modułów HSM. ciąg
parent_id Aby wdrożyć w grupie zasobów, użyj identyfikatora tej grupy zasobów. ciąg (wymagany)
tags Tagi zasobów Słownik nazw tagów i wartości.
sku Szczegóły jednostki SKU ManagedHsmSku
identity Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub przypisane przez użytkownika) Identyfikator usługi zarządzanej
properties Właściwości zarządzanego modułu HSM ManagedHsmProperties

Identyfikator usługi zarządzanej

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
identity_ids Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. Tablica identyfikatorów tożsamości użytkownika.

UserAssignedIdentities

Nazwa Opis Wartość
{niestandardowa właściwość} UserAssignedIdentity

UserAssignedIdentity

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

ManagedHsmProperties

Nazwa Opis Wartość
createMode Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu. "default"
"odzyskaj"
enablePurgeProtection Właściwość określająca, czy ochrona przed przeczyszczeniem jest włączona dla tej zarządzanej puli modułów HSM. Ustawienie tej właściwości na wartość true aktywuje ochronę przed przeczyszczeniem dla tej zarządzanej puli modułów HSM i jej zawartości — tylko zarządzana usługa HSM może zainicjować twarde, nieodzyskiwalne usunięcie. Włączenie tej funkcji jest nieodwracalne. bool
enableSoftDelete Właściwość określająca, czy dla tej zarządzanej puli modułów HSM włączono funkcję usuwania nietrwałego. Usuwanie nietrwałe jest domyślnie włączone dla wszystkich zarządzanych modułów HSM i jest niezmienne. bool
initialAdminObjectIds Tablica początkowych identyfikatorów obiektów administratorów dla tej zarządzanej puli hsm. ciąg[]
networkAcls Reguły dotyczące ułatwień dostępu magazynu kluczy z określonych lokalizacji sieciowych. MhsmNetworkRuleSet
publicNetworkAccess Kontrolowanie uprawnień do zarządzanego modułu HSM z sieci publicznych. "Wyłączone"
"Włączone"
Regionów Lista wszystkich regionów skojarzonych z zarządzaną pulą modułów HSM. MhsmGeoReplicatedRegion[]
softDeleteRetentionInDays Nietrwałe usunięte dni przechowywania danych. Usunięcie modułu HSM lub klucza pozostanie możliwe do odzyskania przez skonfigurowany okres przechowywania lub domyślny okres 90 dni. Akceptuje wartości z zakresu od 7 do 90. int
tenantId Identyfikator dzierżawy usługi Azure Active Directory, który powinien być używany do uwierzytelniania żądań do zarządzanej puli modułów HSM. ciąg

Ograniczenia:
Minimalna długość = 36
Maksymalna długość = 36
Wzorzec = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

MhsmNetworkRuleSet

Nazwa Opis Wartość
obejście Informuje, jaki ruch może pominąć reguły sieci. Może to być wartość "AzureServices" lub "None". Jeśli nie określono wartości domyślnej, to "AzureServices". "AzureServices"
"Brak"
defaultAction Akcja domyślna, gdy nie jest zgodna żadna reguła z reguł ipRules i virtualNetworkRules. Jest to używane tylko po ocenie właściwości obejścia. "Zezwalaj"
"Odmów"
ipRules Lista reguł adresów IP. MhsmipRule[]
virtualNetworkRules Lista reguł sieci wirtualnej. MhsmVirtualNetworkRule[]

MhsmipRule

Nazwa Opis Wartość
wartość Zakres adresów IPv4 w notacji CIDR, taki jak "124.56.78.91" (prosty adres IP) lub "124.56.78.0/24" (wszystkie adresy rozpoczynające się od 124.56.78). ciąg (wymagany)

MhsmVirtualNetworkRule

Nazwa Opis Wartość
identyfikator Pełny identyfikator zasobu podsieci sieci wirtualnej, taki jak "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". ciąg (wymagany)

MhsmGeoReplicatedRegion

Nazwa Opis Wartość
isPrimary Wartość logiczna wskazująca, czy region jest regionem podstawowym, czy regionem pomocniczym. bool
name Nazwa zreplikowanego regionu geograficznego. ciąg

ManagedHsmSku

Nazwa Opis Wartość
rodzina Rodzina jednostek SKU zarządzanej puli modułów HSM "B" (wymagane)
name Jednostka SKU zarządzanej puli modułów HSM "Custom_B32"
"Custom_B6"
"Standard_B1" (wymagane)