Microsoft.KeyVault managedHSMs 2020-04-01-preview
Bicep 資源定義
ManagedHSMs 資源類型可以使用目標作業進行部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.KeyVault/managedHSMs 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.KeyVault/managedHSMs@2020-04-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'
]
softDeleteRetentionInDays: int
tenantId: 'string'
}
}
屬性值
managedHSMs
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 | 字串 (必要) |
| location | 應該在其中建立受控 HSM 集區的受支援 Azure 位置。 | 字串 |
| tags | 資源標籤 | 標記名稱和值的字典。 請參閱 範本中的標記 |
| sku | SKU 詳細資料 | ManagedHsmSku |
| properties | Managed HSM 的屬性 | ManagedHsmProperties |
ManagedHsmProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| createMode | 建立模式，指出正在建立資源或正在從已刪除的資源復原。 | 'default' 'recover' |
| enablePurgeProtection | 屬性，指定是否為此受控 HSM 集區啟用清除保護。 將此屬性設定為 true 可啟用保護，以防止清除此受控 HSM 集區和其內容-只有受控 HSM 服務可能會起始硬式且無法復原的刪除。 啟用這項功能無法復原。 | bool |
| enableSoftDelete | 屬性，指定是否為此受控 HSM 集區啟用「虛刪除」功能。 默認會針對所有受控 HSM 啟用虛刪除，而且是不可變的。 | bool |
| initialAdminObjectIds | 這個受控 hsm 集區的初始系統管理員對象標識子陣列。 | string[] |
| softDeleteRetentionInDays | 虛刪除的數據保留天數。 當您刪除 HSM 或金鑰時，它會在設定的保留期間或預設的 90 天內保持可復原。 它接受介於 7 到 90 之間的值。 | int |
| tenantId | 應該用來向受控 HSM 集區驗證要求的 Azure Active Directory 租使用者標識碼。 | 字串 約束： 最小長度 = 36 最大長度 = 36 模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmSku
| 名稱 | 描述 | 值 |
|---|---|---|
| family | 受控 HSM 集區的 SKU 系列 | 'B' (必要) |
| NAME | 受控 HSM 集區的 SKU | 'Custom_B32' 需要 『Standard_B1』 () |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
建立 Azure 金鑰保存庫 受控 HSM |
此範本會建立 Azure 金鑰保存庫 受控 HSM。 |
ARM 範本資源定義
ManagedHSMs 資源類型可以使用目標作業進行部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.KeyVault/managedHSMs 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.KeyVault/managedHSMs",
"apiVersion": "2020-04-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" ],
"softDeleteRetentionInDays": "int",
"tenantId": "string"
}
}
屬性值
managedHSMs
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.KeyVault/managedHSMs' |
| apiVersion | 資源 API 版本 | '2020-04-01-preview' |
| NAME | 資源名稱 | 字串 (必要) |
| location | 應該在其中建立受控 HSM 集區的受支援 Azure 位置。 | 字串 |
| tags | 資源標籤 | 標記名稱和值的字典。 請參閱 範本中的標記 |
| sku | SKU 詳細資料 | ManagedHsmSku |
| properties | Managed HSM 的屬性 | ManagedHsmProperties |
ManagedHsmProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| createMode | 建立模式，指出正在建立資源或正在從已刪除的資源復原。 | 'default' 'recover' |
| enablePurgeProtection | 屬性，指定是否為此受控 HSM 集區啟用清除保護。 將此屬性設定為 true 可啟用保護，以防止清除此受控 HSM 集區和其內容-只有受控 HSM 服務可能會起始硬式且無法復原的刪除。 啟用這項功能無法復原。 | bool |
| enableSoftDelete | 屬性，指定是否為此受控 HSM 集區啟用「虛刪除」功能。 默認會針對所有受控 HSM 啟用虛刪除，而且是不可變的。 | bool |
| initialAdminObjectIds | 這個受控 hsm 集區的初始系統管理員對象標識子陣列。 | string[] |
| softDeleteRetentionInDays | 虛刪除的數據保留天數。 當您刪除 HSM 或金鑰時，它會在設定的保留期間或預設的 90 天內保持可復原。 它接受介於 7 到 90 之間的值。 | int |
| tenantId | 應該用來向受控 HSM 集區驗證要求的 Azure Active Directory 租使用者標識碼。 | 字串 約束： 最小長度 = 36 最大長度 = 36 模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmSku
| 名稱 | 描述 | 值 |
|---|---|---|
| family | 受控 HSM 集區的 SKU 系列 | 'B' (必要) |
| NAME | 受控 HSM 集區的 SKU | 'Custom_B32' 需要 『Standard_B1』 () |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
| 建立 Azure 金鑰保存庫 受控 HSM |
此範本會建立 Azure 金鑰保存庫 受控 HSM。 |
Terraform (AzAPI 提供者) 資源定義
ManagedHSMs 資源類型可以使用目標作業進行部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.KeyVault/managedHSMs 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/managedHSMs@2020-04-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"
]
softDeleteRetentionInDays = int
tenantId = "string"
}
sku = {
family = "B"
name = "string"
}
})
}
屬性值
managedHSMs
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.KeyVault/managedHSMs@2020-04-01-preview” |
| NAME | 資源名稱 | 字串 (必要) |
| location | 應該在其中建立受控 HSM 集區的受支援 Azure 位置。 | 字串 |
| parent_id | 若要部署至資源群組，請使用該資源群組的標識碼。 | 字串 (必要) |
| tags | 資源標籤 | 標記名稱和值的字典。 |
| sku | SKU 詳細資料 | ManagedHsmSku |
| properties | Managed HSM 的屬性 | ManagedHsmProperties |
ManagedHsmProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| createMode | 建立模式，指出正在建立資源或正在從已刪除的資源復原。 | "default" “recover” |
| enablePurgeProtection | 屬性，指定是否為此受控 HSM 集區啟用清除保護。 將此屬性設定為 true 可啟用保護，以防止清除此受控 HSM 集區和其內容-只有受控 HSM 服務可能會起始硬式且無法復原的刪除。 啟用這項功能無法復原。 | bool |
| enableSoftDelete | 屬性，指定是否為此受控 HSM 集區啟用「虛刪除」功能。 默認會針對所有受控 HSM 啟用虛刪除，而且是不可變的。 | bool |
| initialAdminObjectIds | 這個受控 hsm 集區的初始系統管理員對象標識子陣列。 | string[] |
| softDeleteRetentionInDays | 虛刪除的數據保留天數。 當您刪除 HSM 或金鑰時，它會在設定的保留期間或預設的 90 天內保持可復原。 它接受介於 7 到 90 之間的值。 | int |
| tenantId | 應該用來向受控 HSM 集區驗證要求的 Azure Active Directory 租使用者標識碼。 | 字串 約束： 最小長度 = 36 最大長度 = 36 模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmSku
| 名稱 | 描述 | 值 |
|---|---|---|
| family | 受控 HSM 集區的 SKU 系列 | “B” (必要) |
| NAME | 受控 HSM 集區的 SKU | “Custom_B32” 必要) (“Standard_B1” |