Microsoft.KeyVault managedHSMs 2024-04-01-preview
Bicep 資源定義
ManagedHSMs 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.KeyVault/managedHSMs 資源，請將下列 Bicep 新增至範本。
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'
}
}
屬性值
ManagedHsmProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| createMode | 建立模式，指出正在建立或正在從已刪除的資源復原。 | 'default' 'recover' |
| enablePurgeProtection | 屬性，指定是否為此受控 HSM 集區啟用清除保護。 將此屬性設定為 true 會啟用保護，以防止清除此受控 HSM 集區及其內容 -- 只有受控 HSM 服務可能會起始硬式且無法復原的刪除。 啟用這項功能是無法復原的。 | bool |
| enableSoftDelete | 屬性，指定是否為此受控 HSM 集區啟用「虛刪除」功能。 默認會針對所有受控 HSM 啟用虛刪除，而且是不可變的。 | bool |
| initialAdminObjectIds | 這個受控 hsm 集區的初始系統管理員對象標識子陣列。 | string[] |
| networkAcls | 管理來自特定網路位置之金鑰保存庫存取範圍的規則。 | MhsmNetworkRuleSet |
| publicNetworkAccess | 從公用網路控制受控 HSM 的許可權。 | 'Disabled' 'Enabled' |
| 地區 | 與受控 hsm 集區相關聯的所有區域清單。 | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | 虛刪除的數據保留天數。 當您刪除 HSM 或金鑰時，它會在已設定的保留期間或預設的 90 天內保持可復原。 它會接受介於 7 到 90 之間的值。 | int |
| tenantId | 應該用來向受控 HSM 集區驗證要求的 Azure Active Directory 租使用者標識碼。 | 字串 約束： 最小長度 = 36 最大長度 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmResourceTags
| 名字 | 描述 | 價值 |
|---|
ManagedHsmSku
| 名字 | 描述 | 價值 |
|---|---|---|
| 家庭 | 受控 HSM 集區的 SKU 系列 | 'B' （必要） |
| 名字 | 受控 HSM 集區的 SKU | 'Custom_B32' 'Custom_B6' 'Standard_B1' （必要） |
ManagedServiceIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned' （必要） |
| userAssignedIdentities | 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件（{}）。 | UserAssignedIdentities |
MhsmGeoReplicatedRegion
| 名字 | 描述 | 價值 |
|---|---|---|
| isPrimary | 布爾值，指出區域是主要區域還是次要區域。 | bool |
| 名字 | 異地復寫區域的名稱。 | 字串 |
MhsmipRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 價值 | CIDR 表示法中的 IPv4 位址範圍，例如 '124.56.78.91' （簡單 IP 位址） 或 '124.56.78.0/24' （開頭為 124.56.78 的所有位址）。 | 字串 （必要） |
MhsmNetworkRuleSet
| 名字 | 描述 | 價值 |
|---|---|---|
| 旁路 | 告知哪些流量可以略過網路規則。 這可以是 'AzureServices' 或 'None'。 如果未指定，則預設值為 『AzureServices』。 | 'AzureServices' 'None' |
| defaultAction | 沒有來自ipRules和 virtualNetworkRules 相符的規則時的默認動作。 只有在評估略過屬性之後，才會使用此屬性。 | 'Allow' 'Deny' |
| ipRules | IP 位址規則的清單。 | MhsmipRule[] |
| virtualNetworkRules | 虛擬網路規則的清單。 | MhsmVirtualNetworkRule[] |
MhsmVirtualNetworkRule
| 名字 | 描述 | 價值 |
|---|---|---|
| id | vnet 子網的完整資源標識符，例如 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'。 | 字串 （必要） |
Microsoft.KeyVault/managedHSM
| 名字 | 描述 | 價值 |
|---|---|---|
| 身份 | 受控服務識別（系統指派和/或使用者指派的身分識別） | ManagedServiceIdentity |
| 位置 | 應該在其中建立受控 HSM 集區的支援 Azure 位置。 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 受控 HSM 的屬性 | ManagedHsmProperties |
| sku | SKU 詳細數據 | ManagedHsmSku |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
UserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
UserAssignedIdentity
| 名字 | 描述 | 價值 |
|---|
快速入門範例
下列快速入門範例會部署此資源類型。
| Bicep 檔案 | 描述 |
|---|---|
| 建立 Azure Key Vault 受控 HSM | 此範本會建立 Azure Key Vault 受控 HSM。 |
ARM 樣本資源定義
ManagedHSMs 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立Microsoft.KeyVault/managedHSM 資源，請將下列 JSON 新增至範本。
{
"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"
}
}
屬性值
ManagedHsmProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| createMode | 建立模式，指出正在建立或正在從已刪除的資源復原。 | 'default' 'recover' |
| enablePurgeProtection | 屬性，指定是否為此受控 HSM 集區啟用清除保護。 將此屬性設定為 true 會啟用保護，以防止清除此受控 HSM 集區及其內容 -- 只有受控 HSM 服務可能會起始硬式且無法復原的刪除。 啟用這項功能是無法復原的。 | bool |
| enableSoftDelete | 屬性，指定是否為此受控 HSM 集區啟用「虛刪除」功能。 默認會針對所有受控 HSM 啟用虛刪除，而且是不可變的。 | bool |
| initialAdminObjectIds | 這個受控 hsm 集區的初始系統管理員對象標識子陣列。 | string[] |
| networkAcls | 管理來自特定網路位置之金鑰保存庫存取範圍的規則。 | MhsmNetworkRuleSet |
| publicNetworkAccess | 從公用網路控制受控 HSM 的許可權。 | 'Disabled' 'Enabled' |
| 地區 | 與受控 hsm 集區相關聯的所有區域清單。 | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | 虛刪除的數據保留天數。 當您刪除 HSM 或金鑰時，它會在已設定的保留期間或預設的 90 天內保持可復原。 它會接受介於 7 到 90 之間的值。 | int |
| tenantId | 應該用來向受控 HSM 集區驗證要求的 Azure Active Directory 租使用者標識碼。 | 字串 約束： 最小長度 = 36 最大長度 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmResourceTags
| 名字 | 描述 | 價值 |
|---|
ManagedHsmSku
| 名字 | 描述 | 價值 |
|---|---|---|
| 家庭 | 受控 HSM 集區的 SKU 系列 | 'B' （必要） |
| 名字 | 受控 HSM 集區的 SKU | 'Custom_B32' 'Custom_B6' 'Standard_B1' （必要） |
ManagedServiceIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned' （必要） |
| userAssignedIdentities | 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件（{}）。 | UserAssignedIdentities |
MhsmGeoReplicatedRegion
| 名字 | 描述 | 價值 |
|---|---|---|
| isPrimary | 布爾值，指出區域是主要區域還是次要區域。 | bool |
| 名字 | 異地復寫區域的名稱。 | 字串 |
MhsmipRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 價值 | CIDR 表示法中的 IPv4 位址範圍，例如 '124.56.78.91' （簡單 IP 位址） 或 '124.56.78.0/24' （開頭為 124.56.78 的所有位址）。 | 字串 （必要） |
MhsmNetworkRuleSet
| 名字 | 描述 | 價值 |
|---|---|---|
| 旁路 | 告知哪些流量可以略過網路規則。 這可以是 'AzureServices' 或 'None'。 如果未指定，則預設值為 『AzureServices』。 | 'AzureServices' 'None' |
| defaultAction | 沒有來自ipRules和 virtualNetworkRules 相符的規則時的默認動作。 只有在評估略過屬性之後，才會使用此屬性。 | 'Allow' 'Deny' |
| ipRules | IP 位址規則的清單。 | MhsmipRule[] |
| virtualNetworkRules | 虛擬網路規則的清單。 | MhsmVirtualNetworkRule[] |
MhsmVirtualNetworkRule
| 名字 | 描述 | 價值 |
|---|---|---|
| id | vnet 子網的完整資源標識符，例如 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'。 | 字串 （必要） |
Microsoft.KeyVault/managedHSM
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2024-04-01-preview' |
| 身份 | 受控服務識別（系統指派和/或使用者指派的身分識別） | ManagedServiceIdentity |
| 位置 | 應該在其中建立受控 HSM 集區的支援 Azure 位置。 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 受控 HSM 的屬性 | ManagedHsmProperties |
| sku | SKU 詳細數據 | ManagedHsmSku |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 類型 | 資源類型 | 'Microsoft.KeyVault/managedHSMs' |
UserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
UserAssignedIdentity
| 名字 | 描述 | 價值 |
|---|
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
建立 Azure Key Vault 受控 HSM
|
此範本會建立 Azure Key Vault 受控 HSM。 |
Terraform （AzAPI 提供者） 資源定義
ManagedHSMs 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.KeyVault/managedHSMs 資源，請將下列 Terraform 新增至範本。
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"
}
})
}
屬性值
ManagedHsmProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| createMode | 建立模式，指出正在建立或正在從已刪除的資源復原。 | 'default' 'recover' |
| enablePurgeProtection | 屬性，指定是否為此受控 HSM 集區啟用清除保護。 將此屬性設定為 true 會啟用保護，以防止清除此受控 HSM 集區及其內容 -- 只有受控 HSM 服務可能會起始硬式且無法復原的刪除。 啟用這項功能是無法復原的。 | bool |
| enableSoftDelete | 屬性，指定是否為此受控 HSM 集區啟用「虛刪除」功能。 默認會針對所有受控 HSM 啟用虛刪除，而且是不可變的。 | bool |
| initialAdminObjectIds | 這個受控 hsm 集區的初始系統管理員對象標識子陣列。 | string[] |
| networkAcls | 管理來自特定網路位置之金鑰保存庫存取範圍的規則。 | MhsmNetworkRuleSet |
| publicNetworkAccess | 從公用網路控制受控 HSM 的許可權。 | 'Disabled' 'Enabled' |
| 地區 | 與受控 hsm 集區相關聯的所有區域清單。 | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | 虛刪除的數據保留天數。 當您刪除 HSM 或金鑰時，它會在已設定的保留期間或預設的 90 天內保持可復原。 它會接受介於 7 到 90 之間的值。 | int |
| tenantId | 應該用來向受控 HSM 集區驗證要求的 Azure Active Directory 租使用者標識碼。 | 字串 約束： 最小長度 = 36 最大長度 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
ManagedHsmResourceTags
| 名字 | 描述 | 價值 |
|---|
ManagedHsmSku
| 名字 | 描述 | 價值 |
|---|---|---|
| 家庭 | 受控 HSM 集區的 SKU 系列 | 'B' （必要） |
| 名字 | 受控 HSM 集區的 SKU | 'Custom_B32' 'Custom_B6' 'Standard_B1' （必要） |
ManagedServiceIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned' （必要） |
| userAssignedIdentities | 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件（{}）。 | UserAssignedIdentities |
MhsmGeoReplicatedRegion
| 名字 | 描述 | 價值 |
|---|---|---|
| isPrimary | 布爾值，指出區域是主要區域還是次要區域。 | bool |
| 名字 | 異地復寫區域的名稱。 | 字串 |
MhsmipRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 價值 | CIDR 表示法中的 IPv4 位址範圍，例如 '124.56.78.91' （簡單 IP 位址） 或 '124.56.78.0/24' （開頭為 124.56.78 的所有位址）。 | 字串 （必要） |
MhsmNetworkRuleSet
| 名字 | 描述 | 價值 |
|---|---|---|
| 旁路 | 告知哪些流量可以略過網路規則。 這可以是 'AzureServices' 或 'None'。 如果未指定，則預設值為 『AzureServices』。 | 'AzureServices' 'None' |
| defaultAction | 沒有來自ipRules和 virtualNetworkRules 相符的規則時的默認動作。 只有在評估略過屬性之後，才會使用此屬性。 | 'Allow' 'Deny' |
| ipRules | IP 位址規則的清單。 | MhsmipRule[] |
| virtualNetworkRules | 虛擬網路規則的清單。 | MhsmVirtualNetworkRule[] |
MhsmVirtualNetworkRule
| 名字 | 描述 | 價值 |
|---|---|---|
| id | vnet 子網的完整資源標識符，例如 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'。 | 字串 （必要） |
Microsoft.KeyVault/managedHSM
| 名字 | 描述 | 價值 |
|---|---|---|
| 身份 | 受控服務識別（系統指派和/或使用者指派的身分識別） | ManagedServiceIdentity |
| 位置 | 應該在其中建立受控 HSM 集區的支援 Azure 位置。 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 受控 HSM 的屬性 | ManagedHsmProperties |
| sku | SKU 詳細數據 | ManagedHsmSku |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 類型 | 資源類型 | “Microsoft.KeyVault/managedHSMs@2024-04-01-preview” |
UserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
UserAssignedIdentity
| 名字 | 描述 | 價值 |
|---|