Microsoft.KeyVault managedHSMs 2020-04-01-preview
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@2020-04-01-preview' = {
location: 'string'
name: 'string'
properties: {
createMode: 'string'
enablePurgeProtection: bool
enableSoftDelete: bool
initialAdminObjectIds: [
'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[] |
| 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" "Standard_B1" (wymagane) |
Microsoft.KeyVault/managedHSMs
| Nazwa | Opis | Wartość |
|---|---|---|
| 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 |
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": "2020-04-01-preview",
"name": "string",
"location": "string",
"properties": {
"createMode": "string",
"enablePurgeProtection": "bool",
"enableSoftDelete": "bool",
"initialAdminObjectIds": [ "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[] |
| 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" "Standard_B1" (wymagane) |
Microsoft.KeyVault/managedHSMs
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2020-04-01-preview" |
| 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" |
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@2020-04-01-preview"
name = "string"
location = "string"
sku = {
family = "string"
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
createMode = "string"
enablePurgeProtection = bool
enableSoftDelete = bool
initialAdminObjectIds = [
"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[] |
| 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" "Standard_B1" (wymagane) |
Microsoft.KeyVault/managedHSMs
| Nazwa | Opis | Wartość |
|---|---|---|
| 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@2020-04-01-preview" |