Microsoft.KeyVault managedHSMs 2024-04-01-preview

Artykuł
12/21/2024

Definicja zasobu Bicep

Typ zasobu managedHSMs można wdrożyć przy użyciu operacji docelowych:

grupy zasobów — zobacz polecenia wdrażania grupy zasobów

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

Format zasobu

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2024-04-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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'
    regions: [
      {
        isPrimary: bool
        name: 'string'
      }
    ]
    softDeleteRetentionInDays: int
    tenantId: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

ManagedHsmProperties

Nazwa	Opis	Wartość
createMode	Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu.	"wartość domyślna" "Odzyskaj"
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 true aktywuje ochronę przed przeczyszczeniem dla tej zarządzanej puli 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 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.	string[]
networkAcls	Reguły regulujące dostępność 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 nietrwałych danych usuniętych. 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.	struna 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}$`

ManagedHsmResourceTags

Nazwa	Opis	Wartość

ManagedHsmSku

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

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

MhsmGeoReplicatedRegion

Nazwa	Opis	Wartość
isPrimary	Wartość logiczna wskazująca, czy region jest regionem podstawowym, czy regionem pomocniczym.	Bool
nazwa	Nazwa zreplikowanego geograficznie regionu.	struna

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)

MhsmNetworkRuleSet

Nazwa	Opis	Wartość
ominąć	Informuje, jaki ruch może pomijać 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	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"
ipRules	Lista reguł adresów IP.	MhsmipRule[]
virtualNetworkRules	Lista reguł sieci wirtualnej.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

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

Microsoft.KeyVault/managedHSMs

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

UserAssignedIdentities

Nazwa	Opis	Wartość

UserAssignedIdentity

Nazwa	Opis	Wartość

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep	Opis
Tworzenie zarządzanego modułu HSM usługi Azure Key Vault	Ten szablon tworzy zarządzany moduł HSM usługi Azure Key Vault.

Definicja zasobu szablonu usługi ARM

Typ zasobu managedHSMs można wdrożyć przy użyciu operacji docelowych:

grupy zasobów — zobacz polecenia wdrażania grupy zasobów

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

Format zasobu

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

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2024-04-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "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": "string",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

ManagedHsmProperties

Nazwa	Opis	Wartość
createMode	Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu.	"wartość domyślna" "Odzyskaj"
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 true aktywuje ochronę przed przeczyszczeniem dla tej zarządzanej puli 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 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.	string[]
networkAcls	Reguły regulujące dostępność 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 nietrwałych danych usuniętych. 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.	struna 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}$`

ManagedHsmResourceTags

Nazwa	Opis	Wartość

ManagedHsmSku

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

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

MhsmGeoReplicatedRegion

Nazwa	Opis	Wartość
isPrimary	Wartość logiczna wskazująca, czy region jest regionem podstawowym, czy regionem pomocniczym.	Bool
nazwa	Nazwa zreplikowanego geograficznie regionu.	struna

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)

MhsmNetworkRuleSet

Nazwa	Opis	Wartość
ominąć	Informuje, jaki ruch może pomijać 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	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"
ipRules	Lista reguł adresów IP.	MhsmipRule[]
virtualNetworkRules	Lista reguł sieci wirtualnej.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

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

Microsoft.KeyVault/managedHSMs

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

UserAssignedIdentities

Nazwa	Opis	Wartość

UserAssignedIdentity

Nazwa	Opis	Wartość

Szablony szybkiego startu

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

Szablon	Opis
Tworzenie zarządzanego modułu HSM usługi Azure Key Vault wdrażanie	Ten szablon tworzy zarządzany moduł HSM usługi Azure Key Vault.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu managedHSMs można wdrożyć przy użyciu operacji docelowych:

grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika 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@2024-04-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  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"
      regions = [
        {
          isPrimary = bool
          name = "string"
        }
      ]
      softDeleteRetentionInDays = int
      tenantId = "string"
    }
  })
}

Wartości właściwości

ManagedHsmProperties

Nazwa	Opis	Wartość
createMode	Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu.	"wartość domyślna" "Odzyskaj"
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 true aktywuje ochronę przed przeczyszczeniem dla tej zarządzanej puli 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 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.	string[]
networkAcls	Reguły regulujące dostępność 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 nietrwałych danych usuniętych. 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.	struna 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}$`

ManagedHsmResourceTags

Nazwa	Opis	Wartość

ManagedHsmSku

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

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

MhsmGeoReplicatedRegion

Nazwa	Opis	Wartość
isPrimary	Wartość logiczna wskazująca, czy region jest regionem podstawowym, czy regionem pomocniczym.	Bool
nazwa	Nazwa zreplikowanego geograficznie regionu.	struna

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)

MhsmNetworkRuleSet

Nazwa	Opis	Wartość
ominąć	Informuje, jaki ruch może pomijać 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	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"
ipRules	Lista reguł adresów IP.	MhsmipRule[]
virtualNetworkRules	Lista reguł sieci wirtualnej.	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

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

Microsoft.KeyVault/managedHSMs

Nazwa	Opis	Wartość
tożsamość	Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika)	ManagedServiceIdentity
lokalizacja	Obsługiwana lokalizacja platformy Azure, w której powinna zostać utworzona zarządzana pula modułów HSM.	struna
nazwa	Nazwa zasobu	ciąg (wymagany)
Właściwości	Właściwości zarządzanego modułu HSM	ManagedHsmProperties
Numer jednostki magazynowej	Szczegóły jednostki SKU	ManagedHsmSku
Tagi	Tagi zasobów	Słownik nazw tagów i wartości.
typ	Typ zasobu	"Microsoft.KeyVault/managedHSMs@2024-04-01-preview"

UserAssignedIdentities

Nazwa	Opis	Wartość

UserAssignedIdentity

Nazwa	Opis	Wartość

Udostępnij za pośrednictwem

Microsoft.KeyVault managedHSMs 2024-04-01-preview

Definicja zasobu Bicep

Format zasobu

Wartości właściwości

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Przykłady z przewodnika Szybki start

Definicja zasobu szablonu usługi ARM

Format zasobu

Wartości właściwości

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Szablony szybkiego startu

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Format zasobu

Wartości właściwości

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Opinia

Dodatkowe zasoby