Microsoft.Compute diskEncryptionSets 2023-04-02
Bicep 資源定義
diskEncryptionSets 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Compute/diskEncryptionSets 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Compute/diskEncryptionSets@2023-04-02' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
activeKey: {
keyUrl: 'string'
sourceVault: {
id: 'string'
}
}
encryptionType: 'string'
federatedClientId: 'string'
rotationToLatestKeyVersionEnabled: bool
}
}
屬性值
diskEncryptionSets
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 （必要） 字元限制：1-80 合法字元： 英數位元、底線和連字元。 |
| 位置 | 資源位置 | 字串 （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 身份 | 磁碟加密集的受控識別。 它應該授與金鑰保存庫的許可權，才能用來加密磁碟。 | EncryptionSetIdentity |
| 性能 | EncryptionSetProperties |
EncryptionSetIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | DiskEncryptionSet 所使用的受控識別類型。 新建立僅支援 SystemAssigned。 在將訂用帳戶移轉至新的 Azure Active Directory 租用戶期間，可以使用身分識別類型 None 更新磁碟加密集;這會導致加密的資源失去金鑰的存取權。 | 'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned' |
| userAssignedIdentities | 與磁碟加密集相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | UserAssignedIdentities |
UserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|---|---|
| {自定義屬性} | UserAssignedIdentitiesValue |
UserAssignedIdentitiesValue
此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。
EncryptionSetProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| activeKey | 此磁碟加密集目前使用的金鑰保存庫金鑰。 | KeyForDiskEncryptionSet |
| encryptionType | 用來加密磁碟數據的金鑰類型。 | 'ConfidentialVmEncryptedWithCustomerKey' 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' |
| federatedClientId | 多租使用者應用程式用戶端識別碼，以存取不同租使用者中的密鑰保存庫。 將值設定為 『None』 將會清除 屬性。 | 字串 |
| rotationToLatestKeyVersionEnabled | 將此旗標設定為 true，以啟用此磁碟加密設定為最新密鑰版本的自動更新。 | bool |
KeyForDiskEncryptionSet
| 名字 | 描述 | 價值 |
|---|---|---|
| keyUrl | 指向 KeyVault 中金鑰的完整版本金鑰 URL。 不論 rotationToLatestKeyVersionEnabled 值為何，都需要 URL 的版本區段。 | 字串 （必要） |
| sourceVault | 包含金鑰或秘密之 KeyVault 的資源識別碼。 此屬性是選擇性的，如果 KeyVault 訂用帳戶與磁碟加密集訂用帳戶不同，則無法使用此屬性。 | SourceVault |
SourceVault
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源標識碼 | 字串 |
ARM 樣本資源定義
diskEncryptionSets 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Compute/diskEncryptionSets 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Compute/diskEncryptionSets",
"apiVersion": "2023-04-02",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"activeKey": {
"keyUrl": "string",
"sourceVault": {
"id": "string"
}
},
"encryptionType": "string",
"federatedClientId": "string",
"rotationToLatestKeyVersionEnabled": "bool"
}
}
屬性值
diskEncryptionSets
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.Compute/diskEncryptionSets' |
| apiVersion | 資源 API 版本 | '2023-04-02' |
| 名字 | 資源名稱 | 字串 （必要） 字元限制：1-80 合法字元： 英數位元、底線和連字元。 |
| 位置 | 資源位置 | 字串 （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 身份 | 磁碟加密集的受控識別。 它應該授與金鑰保存庫的許可權，才能用來加密磁碟。 | EncryptionSetIdentity |
| 性能 | EncryptionSetProperties |
EncryptionSetIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | DiskEncryptionSet 所使用的受控識別類型。 新建立僅支援 SystemAssigned。 在將訂用帳戶移轉至新的 Azure Active Directory 租用戶期間，可以使用身分識別類型 None 更新磁碟加密集;這會導致加密的資源失去金鑰的存取權。 | 'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned' |
| userAssignedIdentities | 與磁碟加密集相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | UserAssignedIdentities |
UserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|---|---|
| {自定義屬性} | UserAssignedIdentitiesValue |
UserAssignedIdentitiesValue
此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。
EncryptionSetProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| activeKey | 此磁碟加密集目前使用的金鑰保存庫金鑰。 | KeyForDiskEncryptionSet |
| encryptionType | 用來加密磁碟數據的金鑰類型。 | 'ConfidentialVmEncryptedWithCustomerKey' 'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformAndCustomerKeys' |
| federatedClientId | 多租使用者應用程式用戶端識別碼，以存取不同租使用者中的密鑰保存庫。 將值設定為 『None』 將會清除 屬性。 | 字串 |
| rotationToLatestKeyVersionEnabled | 將此旗標設定為 true，以啟用此磁碟加密設定為最新密鑰版本的自動更新。 | bool |
KeyForDiskEncryptionSet
| 名字 | 描述 | 價值 |
|---|---|---|
| keyUrl | 指向 KeyVault 中金鑰的完整版本金鑰 URL。 不論 rotationToLatestKeyVersionEnabled 值為何，都需要 URL 的版本區段。 | 字串 （必要） |
| sourceVault | 包含金鑰或秘密之 KeyVault 的資源識別碼。 此屬性是選擇性的，如果 KeyVault 訂用帳戶與磁碟加密集訂用帳戶不同，則無法使用此屬性。 | SourceVault |
SourceVault
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源標識碼 | 字串 |
Terraform （AzAPI 提供者） 資源定義
diskEncryptionSets 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Compute/diskEncryptionSets 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/diskEncryptionSets@2023-04-02"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
activeKey = {
keyUrl = "string"
sourceVault = {
id = "string"
}
}
encryptionType = "string"
federatedClientId = "string"
rotationToLatestKeyVersionEnabled = bool
}
})
}
屬性值
diskEncryptionSets
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.Compute/diskEncryptionSets@2023-04-02” |
| 名字 | 資源名稱 | 字串 （必要） 字元限制：1-80 合法字元： 英數位元、底線和連字元。 |
| 位置 | 資源位置 | 字串 （必要） |
| parent_id | 若要部署至資源群組，請使用該資源群組的標識碼。 | 字串 （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 身份 | 磁碟加密集的受控識別。 它應該授與金鑰保存庫的許可權，才能用來加密磁碟。 | EncryptionSetIdentity |
| 性能 | EncryptionSetProperties |
EncryptionSetIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | DiskEncryptionSet 所使用的受控識別類型。 新建立僅支援 SystemAssigned。 在將訂用帳戶移轉至新的 Azure Active Directory 租用戶期間，可以使用身分識別類型 None 更新磁碟加密集;這會導致加密的資源失去金鑰的存取權。 | “SystemAssigned” “SystemAssigned， UserAssigned” “UserAssigned” |
| identity_ids | 與磁碟加密集相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | 使用者身分識別標識碼的陣列。 |
UserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|---|---|
| {自定義屬性} | UserAssignedIdentitiesValue |
UserAssignedIdentitiesValue
此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。
EncryptionSetProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| activeKey | 此磁碟加密集目前使用的金鑰保存庫金鑰。 | KeyForDiskEncryptionSet |
| encryptionType | 用來加密磁碟數據的金鑰類型。 | “ConfidentialVmEncryptedWithCustomerKey” “EncryptionAtRestWithCustomerKey” “EncryptionAtRestWithPlatformAndCustomerKeys” |
| federatedClientId | 多租使用者應用程式用戶端識別碼，以存取不同租使用者中的密鑰保存庫。 將值設定為 『None』 將會清除 屬性。 | 字串 |
| rotationToLatestKeyVersionEnabled | 將此旗標設定為 true，以啟用此磁碟加密設定為最新密鑰版本的自動更新。 | bool |
KeyForDiskEncryptionSet
| 名字 | 描述 | 價值 |
|---|---|---|
| keyUrl | 指向 KeyVault 中金鑰的完整版本金鑰 URL。 不論 rotationToLatestKeyVersionEnabled 值為何，都需要 URL 的版本區段。 | 字串 （必要） |
| sourceVault | 包含金鑰或秘密之 KeyVault 的資源識別碼。 此屬性是選擇性的，如果 KeyVault 訂用帳戶與磁碟加密集訂用帳戶不同，則無法使用此屬性。 | SourceVault |
SourceVault
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源標識碼 | 字串 |