Microsoft.計算快照集 2019-07-01

發行項
12/21/2024

Bicep 資源定義

快照集資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Compute/snapshots 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Compute/snapshots@2019-07-01' = {
  location: 'string'
  name: 'string'
  properties: {
    creationData: {
      createOption: 'string'
      imageReference: {
        id: 'string'
        lun: int
      }
      sourceResourceId: 'string'
      sourceUri: 'string'
      storageAccountId: 'string'
      uploadSizeBytes: int
    }
    diskSizeGB: int
    encryption: {
      diskEncryptionSetId: 'string'
      type: 'string'
    }
    encryptionSettingsCollection: {
      enabled: bool
      encryptionSettings: [
        {
          diskEncryptionKey: {
            secretUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
          keyEncryptionKey: {
            keyUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
        }
      ]
      encryptionSettingsVersion: 'string'
    }
    hyperVGeneration: 'string'
    incremental: bool
    osType: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

CreationData

名字	描述	價值
createOption	這會列舉磁碟建立的可能來源。	'Attach' 'Copy' 'Empty' 'FromImage' 'Import' 'Restore' 'Upload' （必要）
imageReference	磁碟來源資訊。	ImageDiskReference
sourceResourceId	如果 createOption 是 Copy，這是來源快照集或磁碟的 ARM 識別碼。	字串
sourceUri	如果 createOption 為 Import，這是要匯入受控磁碟之 Blob 的 URI。	字串
storageAccountId	如果 createOption 為 Import，則為必要專案。記憶體帳戶的 Azure Resource Manager 識別符，其中包含要匯入為磁碟的 Blob。	字串
uploadSizeBytes	如果 createOption 是 Upload，這是上傳的內容大小，包括 VHD 頁尾。此值應介於 20972032 （VHD 頁尾為 20 MiB + 512 位元元組）和 35183298347520 個字節之間（VHD 頁尾為 32 TiB + 512 位元組）。	int

加密

名字	描述	價值
diskEncryptionSetId	要用於啟用待用加密的磁碟加密集 ResourceId。	字串
類型	用來加密磁碟數據的金鑰類型。	'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformKey' （必要）

EncryptionSettingsCollection

名字	描述	價值
啟用	將此旗標設定為 true，並提供 DiskEncryptionKey 和選擇性 KeyEncryptionKey 以啟用加密。將此旗標設定為 false，並移除 DiskEncryptionKey 和 KeyEncryptionKey 以停用加密。如果 Request 物件中的 EncryptionSettings 為 Null，則現有的設定會保持不變。	布林（必要）
encryptionSettings	加密設定的集合，每個磁碟區各一個。	EncryptionSettingsElement[]
encryptionSettingsVersion	描述磁碟所使用的加密類型。設定此欄位之後，即無法覆寫。 '1.0' 對應至使用 AAD 應用程式的 Azure 磁碟加密。'1.1' 對應至 Azure 磁碟加密。	字串

EncryptionSettingsElement

名字	描述	價值
diskEncryptionKey	磁碟加密金鑰的 Key Vault 秘密 URL 和保存庫識別碼	KeyVaultAndSecretReference
keyEncryptionKey	金鑰保存庫金鑰 URL 和金鑰加密金鑰的保存庫識別碼。 KeyEncryptionKey 是選擇性的，而且提供時用來解除包裝磁碟加密密鑰。	KeyVaultAndKeyReference

ImageDiskReference

名字	描述	價值
id	包含平臺映像存放庫或使用者映像參考的相對 URI。	字串（必要）
倫	如果磁碟是從映射的數據磁碟建立的，這是一個索引，指出映射中要使用的數據磁碟。針對OS磁碟，此欄位為 null。	int

KeyVaultAndKeyReference

名字	描述	價值
keyUrl	指向 KeyVault 中金鑰或秘密的 URL	字串（必要）
sourceVault	包含金鑰或秘密之 KeyVault 的資源識別碼	SourceVault （必要）

KeyVaultAndSecretReference

名字	描述	價值
secretUrl	指向 KeyVault 中金鑰或秘密的 URL	字串（必要）
sourceVault	包含金鑰或秘密之 KeyVault 的資源識別碼	SourceVault （必要）

Microsoft.Compute/snapshots

名字	描述	價值
位置	資源位置	字串（必要）
名字	資源名稱	字串（必要）
性能	快照集資源屬性。	SnapshotProperties
sku	快照集 SKU 名稱。可以是Standard_LRS、Premium_LRS或Standard_ZRS。	SnapshotSku
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤

ResourceTags

名字	描述	價值

SnapshotProperties

名字	描述	價值
creationData	磁碟來源資訊。建立磁碟之後，無法變更 CreationData 資訊。	CreationData （必要）
diskSizeGB	如果 creationData.createOption 為 Empty，則此欄位為必要字段，並指出要建立的磁碟大小。如果此欄位存在以其他選項進行更新或建立，表示重設大小。只有在磁碟未連結至執行中的 VM 時，才允許重設大小，而且只能增加磁碟的大小。	int
加密	加密屬性可用來使用客戶管理的密鑰或平臺受控金鑰來加密待用數據。	加密
encryptionSettingsCollection	加密設定集合是 Azure 磁碟加密，可以包含每個磁碟或快照集的多個加密設定。	EncryptionSettingsCollection
hyperVGeneration	虛擬機的 Hypervisor 產生。僅適用於OS磁碟。	'V1' 'V2'
增量	快照集是否為累加式。相同磁碟上的累加快照集佔用的空間小於完整快照集，而且可能會有差異。	bool
osType	操作系統類型。	'Linux' 'Windows'

SnapshotSku

名字	描述	價值
名字	SKU 名稱。	'Premium_LRS' 'Standard_LRS' 'Standard_ZRS'

SourceVault

名字	描述	價值
id	資源標識碼	字串

ARM 樣本資源定義

快照集資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Compute/snapshots 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Compute/snapshots",
  "apiVersion": "2019-07-01",
  "name": "string",
  "location": "string",
  "properties": {
    "creationData": {
      "createOption": "string",
      "imageReference": {
        "id": "string",
        "lun": "int"
      },
      "sourceResourceId": "string",
      "sourceUri": "string",
      "storageAccountId": "string",
      "uploadSizeBytes": "int"
    },
    "diskSizeGB": "int",
    "encryption": {
      "diskEncryptionSetId": "string",
      "type": "string"
    },
    "encryptionSettingsCollection": {
      "enabled": "bool",
      "encryptionSettings": [
        {
          "diskEncryptionKey": {
            "secretUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          },
          "keyEncryptionKey": {
            "keyUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          }
        }
      ],
      "encryptionSettingsVersion": "string"
    },
    "hyperVGeneration": "string",
    "incremental": "bool",
    "osType": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

CreationData

名字	描述	價值
createOption	這會列舉磁碟建立的可能來源。	'Attach' 'Copy' 'Empty' 'FromImage' 'Import' 'Restore' 'Upload' （必要）
imageReference	磁碟來源資訊。	ImageDiskReference
sourceResourceId	如果 createOption 是 Copy，這是來源快照集或磁碟的 ARM 識別碼。	字串
sourceUri	如果 createOption 為 Import，這是要匯入受控磁碟之 Blob 的 URI。	字串
storageAccountId	如果 createOption 為 Import，則為必要專案。記憶體帳戶的 Azure Resource Manager 識別符，其中包含要匯入為磁碟的 Blob。	字串
uploadSizeBytes	如果 createOption 是 Upload，這是上傳的內容大小，包括 VHD 頁尾。此值應介於 20972032 （VHD 頁尾為 20 MiB + 512 位元元組）和 35183298347520 個字節之間（VHD 頁尾為 32 TiB + 512 位元組）。	int

加密

名字	描述	價值
diskEncryptionSetId	要用於啟用待用加密的磁碟加密集 ResourceId。	字串
類型	用來加密磁碟數據的金鑰類型。	'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformKey' （必要）

EncryptionSettingsCollection

名字	描述	價值
啟用	將此旗標設定為 true，並提供 DiskEncryptionKey 和選擇性 KeyEncryptionKey 以啟用加密。將此旗標設定為 false，並移除 DiskEncryptionKey 和 KeyEncryptionKey 以停用加密。如果 Request 物件中的 EncryptionSettings 為 Null，則現有的設定會保持不變。	布林（必要）
encryptionSettings	加密設定的集合，每個磁碟區各一個。	EncryptionSettingsElement[]
encryptionSettingsVersion	描述磁碟所使用的加密類型。設定此欄位之後，即無法覆寫。 '1.0' 對應至使用 AAD 應用程式的 Azure 磁碟加密。'1.1' 對應至 Azure 磁碟加密。	字串

EncryptionSettingsElement

名字	描述	價值
diskEncryptionKey	磁碟加密金鑰的 Key Vault 秘密 URL 和保存庫識別碼	KeyVaultAndSecretReference
keyEncryptionKey	金鑰保存庫金鑰 URL 和金鑰加密金鑰的保存庫識別碼。 KeyEncryptionKey 是選擇性的，而且提供時用來解除包裝磁碟加密密鑰。	KeyVaultAndKeyReference

ImageDiskReference

名字	描述	價值
id	包含平臺映像存放庫或使用者映像參考的相對 URI。	字串（必要）
倫	如果磁碟是從映射的數據磁碟建立的，這是一個索引，指出映射中要使用的數據磁碟。針對OS磁碟，此欄位為 null。	int

KeyVaultAndKeyReference

名字	描述	價值
keyUrl	指向 KeyVault 中金鑰或秘密的 URL	字串（必要）
sourceVault	包含金鑰或秘密之 KeyVault 的資源識別碼	SourceVault （必要）

KeyVaultAndSecretReference

名字	描述	價值
secretUrl	指向 KeyVault 中金鑰或秘密的 URL	字串（必要）
sourceVault	包含金鑰或秘密之 KeyVault 的資源識別碼	SourceVault （必要）

Microsoft.Compute/snapshots

名字	描述	價值
apiVersion	API 版本	'2019-07-01'
位置	資源位置	字串（必要）
名字	資源名稱	字串（必要）
性能	快照集資源屬性。	SnapshotProperties
sku	快照集 SKU 名稱。可以是Standard_LRS、Premium_LRS或Standard_ZRS。	SnapshotSku
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
類型	資源類型	'Microsoft.Compute/snapshots'

ResourceTags

名字	描述	價值

SnapshotProperties

名字	描述	價值
creationData	磁碟來源資訊。建立磁碟之後，無法變更 CreationData 資訊。	CreationData （必要）
diskSizeGB	如果 creationData.createOption 為 Empty，則此欄位為必要字段，並指出要建立的磁碟大小。如果此欄位存在以其他選項進行更新或建立，表示重設大小。只有在磁碟未連結至執行中的 VM 時，才允許重設大小，而且只能增加磁碟的大小。	int
加密	加密屬性可用來使用客戶管理的密鑰或平臺受控金鑰來加密待用數據。	加密
encryptionSettingsCollection	加密設定集合是 Azure 磁碟加密，可以包含每個磁碟或快照集的多個加密設定。	EncryptionSettingsCollection
hyperVGeneration	虛擬機的 Hypervisor 產生。僅適用於OS磁碟。	'V1' 'V2'
增量	快照集是否為累加式。相同磁碟上的累加快照集佔用的空間小於完整快照集，而且可能會有差異。	bool
osType	操作系統類型。	'Linux' 'Windows'

SnapshotSku

名字	描述	價值
名字	SKU 名稱。	'Premium_LRS' 'Standard_LRS' 'Standard_ZRS'

SourceVault

名字	描述	價值
id	資源標識碼	字串

Terraform （AzAPI 提供者）資源定義

快照集資源類型可以使用目標作業來部署：

資源群組

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Compute/snapshots 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/snapshots@2019-07-01"
  name = "string"
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      creationData = {
        createOption = "string"
        imageReference = {
          id = "string"
          lun = int
        }
        sourceResourceId = "string"
        sourceUri = "string"
        storageAccountId = "string"
        uploadSizeBytes = int
      }
      diskSizeGB = int
      encryption = {
        diskEncryptionSetId = "string"
        type = "string"
      }
      encryptionSettingsCollection = {
        enabled = bool
        encryptionSettings = [
          {
            diskEncryptionKey = {
              secretUrl = "string"
              sourceVault = {
                id = "string"
              }
            }
            keyEncryptionKey = {
              keyUrl = "string"
              sourceVault = {
                id = "string"
              }
            }
          }
        ]
        encryptionSettingsVersion = "string"
      }
      hyperVGeneration = "string"
      incremental = bool
      osType = "string"
    }
  })
}

屬性值

CreationData

名字	描述	價值
createOption	這會列舉磁碟建立的可能來源。	'Attach' 'Copy' 'Empty' 'FromImage' 'Import' 'Restore' 'Upload' （必要）
imageReference	磁碟來源資訊。	ImageDiskReference
sourceResourceId	如果 createOption 是 Copy，這是來源快照集或磁碟的 ARM 識別碼。	字串
sourceUri	如果 createOption 為 Import，這是要匯入受控磁碟之 Blob 的 URI。	字串
storageAccountId	如果 createOption 為 Import，則為必要專案。記憶體帳戶的 Azure Resource Manager 識別符，其中包含要匯入為磁碟的 Blob。	字串
uploadSizeBytes	如果 createOption 是 Upload，這是上傳的內容大小，包括 VHD 頁尾。此值應介於 20972032 （VHD 頁尾為 20 MiB + 512 位元元組）和 35183298347520 個字節之間（VHD 頁尾為 32 TiB + 512 位元組）。	int

加密

名字	描述	價值
diskEncryptionSetId	要用於啟用待用加密的磁碟加密集 ResourceId。	字串
類型	用來加密磁碟數據的金鑰類型。	'EncryptionAtRestWithCustomerKey' 'EncryptionAtRestWithPlatformKey' （必要）

EncryptionSettingsCollection

名字	描述	價值
啟用	將此旗標設定為 true，並提供 DiskEncryptionKey 和選擇性 KeyEncryptionKey 以啟用加密。將此旗標設定為 false，並移除 DiskEncryptionKey 和 KeyEncryptionKey 以停用加密。如果 Request 物件中的 EncryptionSettings 為 Null，則現有的設定會保持不變。	布林（必要）
encryptionSettings	加密設定的集合，每個磁碟區各一個。	EncryptionSettingsElement[]
encryptionSettingsVersion	描述磁碟所使用的加密類型。設定此欄位之後，即無法覆寫。 '1.0' 對應至使用 AAD 應用程式的 Azure 磁碟加密。'1.1' 對應至 Azure 磁碟加密。	字串

EncryptionSettingsElement

名字	描述	價值
diskEncryptionKey	磁碟加密金鑰的 Key Vault 秘密 URL 和保存庫識別碼	KeyVaultAndSecretReference
keyEncryptionKey	金鑰保存庫金鑰 URL 和金鑰加密金鑰的保存庫識別碼。 KeyEncryptionKey 是選擇性的，而且提供時用來解除包裝磁碟加密密鑰。	KeyVaultAndKeyReference

ImageDiskReference

名字	描述	價值
id	包含平臺映像存放庫或使用者映像參考的相對 URI。	字串（必要）
倫	如果磁碟是從映射的數據磁碟建立的，這是一個索引，指出映射中要使用的數據磁碟。針對OS磁碟，此欄位為 null。	int

KeyVaultAndKeyReference

名字	描述	價值
keyUrl	指向 KeyVault 中金鑰或秘密的 URL	字串（必要）
sourceVault	包含金鑰或秘密之 KeyVault 的資源識別碼	SourceVault （必要）

KeyVaultAndSecretReference

名字	描述	價值
secretUrl	指向 KeyVault 中金鑰或秘密的 URL	字串（必要）
sourceVault	包含金鑰或秘密之 KeyVault 的資源識別碼	SourceVault （必要）

Microsoft.Compute/snapshots

名字	描述	價值
位置	資源位置	字串（必要）
名字	資源名稱	字串（必要）
性能	快照集資源屬性。	SnapshotProperties
sku	快照集 SKU 名稱。可以是Standard_LRS、Premium_LRS或Standard_ZRS。	SnapshotSku
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.Compute/snapshots@2019-07-01”

ResourceTags

名字	描述	價值

SnapshotProperties

名字	描述	價值
creationData	磁碟來源資訊。建立磁碟之後，無法變更 CreationData 資訊。	CreationData （必要）
diskSizeGB	如果 creationData.createOption 為 Empty，則此欄位為必要字段，並指出要建立的磁碟大小。如果此欄位存在以其他選項進行更新或建立，表示重設大小。只有在磁碟未連結至執行中的 VM 時，才允許重設大小，而且只能增加磁碟的大小。	int
加密	加密屬性可用來使用客戶管理的密鑰或平臺受控金鑰來加密待用數據。	加密
encryptionSettingsCollection	加密設定集合是 Azure 磁碟加密，可以包含每個磁碟或快照集的多個加密設定。	EncryptionSettingsCollection
hyperVGeneration	虛擬機的 Hypervisor 產生。僅適用於OS磁碟。	'V1' 'V2'
增量	快照集是否為累加式。相同磁碟上的累加快照集佔用的空間小於完整快照集，而且可能會有差異。	bool
osType	操作系統類型。	'Linux' 'Windows'

SnapshotSku

名字	描述	價值
名字	SKU 名稱。	'Premium_LRS' 'Standard_LRS' 'Standard_ZRS'

SourceVault

名字	描述	價值
id	資源標識碼	字串

共用方式為

Microsoft.計算快照集 2019-07-01

Bicep 資源定義

資源格式

屬性值

CreationData

加密

EncryptionSettingsCollection

EncryptionSettingsElement

ImageDiskReference

KeyVaultAndKeyReference

KeyVaultAndSecretReference

Microsoft.Compute/snapshots

ResourceTags

SnapshotProperties

SnapshotSku

SourceVault

ARM 樣本資源定義

資源格式

屬性值

CreationData

加密

EncryptionSettingsCollection

EncryptionSettingsElement

ImageDiskReference

KeyVaultAndKeyReference

KeyVaultAndSecretReference

Microsoft.Compute/snapshots

ResourceTags

SnapshotProperties

SnapshotSku

SourceVault

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

CreationData

加密

EncryptionSettingsCollection

EncryptionSettingsElement

ImageDiskReference

KeyVaultAndKeyReference

KeyVaultAndSecretReference

Microsoft.Compute/snapshots

ResourceTags

SnapshotProperties

SnapshotSku

SourceVault

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義