你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Compute snapshots 2023-10-02

项目
08/17/2024

Bicep 资源定义

可以使用目标操作部署快照资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Compute/snapshots 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Compute/snapshots@2023-10-02' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  extendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  properties: {
    completionPercent: int
    copyCompletionError: {
      errorCode: 'CopySourceNotFound'
      errorMessage: 'string'
    }
    creationData: {
      createOption: 'string'
      elasticSanResourceId: 'string'
      galleryImageReference: {
        communityGalleryImageId: 'string'
        id: 'string'
        lun: int
        sharedGalleryImageId: 'string'
      }
      imageReference: {
        communityGalleryImageId: 'string'
        id: 'string'
        lun: int
        sharedGalleryImageId: 'string'
      }
      logicalSectorSize: int
      performancePlus: bool
      provisionedBandwidthCopySpeed: 'string'
      securityDataUri: 'string'
      sourceResourceId: 'string'
      sourceUri: 'string'
      storageAccountId: 'string'
      uploadSizeBytes: int
    }
    dataAccessAuthMode: 'string'
    diskAccessId: 'string'
    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
    networkAccessPolicy: 'string'
    osType: 'string'
    publicNetworkAccess: 'string'
    purchasePlan: {
      name: 'string'
      product: 'string'
      promotionCode: 'string'
      publisher: 'string'
    }
    securityProfile: {
      secureVMDiskEncryptionSetId: 'string'
      securityType: 'string'
    }
    supportedCapabilities: {
      acceleratedNetwork: bool
      architecture: 'string'
      diskControllerTypes: 'string'
    }
    supportsHibernation: bool
  }
}

属性值

快照

名字	描述	价值
名字	资源名称	string （必需）字符限制：1-80 有效字符：字母数字、下划线、句点和连字符。从字母数字开始。以字母数字或下划线结尾。
位置	资源位置	string （必需）
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
sku	快照 SKU 名称。可以是Standard_LRS、Premium_LRS或Standard_ZRS。这是增量快照的可选参数，默认行为是 SKU 将设置为与上一快照相同的 SKU	SnapshotSku
extendedLocation	将在其中创建快照的扩展位置。无法更改扩展位置。	ExtendedLocation
性能	快照资源属性。	SnapshotProperties

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	字符串
类型	扩展位置的类型。	“EdgeZone”

SnapshotProperties

名字	描述	价值
completionPercent	通过 CopyStart 操作创建资源时后台副本完成的百分比。	int
copyCompletionError	指示错误详细信息，如果通过 CopyStart 操作创建的资源的后台副本失败。	CopyCompletionError
creationData	磁盘源信息。创建磁盘后，无法更改 CreationData 信息。	CreationData （必需）
dataAccessAuthMode	导出或上传到磁盘或快照时的其他身份验证要求。	“AzureActiveDirectory” “None”
diskAccessId	磁盘上使用专用终结点的 DiskAccess 资源的 ARM ID。	字符串
diskSizeGB	如果 creationData.createOption 为 Empty，则此字段是必需的，并指示要创建的磁盘的大小。如果此字段可用于更新或创建其他选项，则表示调整大小。仅当磁盘未附加到正在运行的 VM 时，才允许重设大小，并且只能增加磁盘的大小。	int
加密	加密属性可用于使用客户托管密钥或平台托管密钥加密静态数据。	加密
encryptionSettingsCollection	使用加密设置集合是 Azure 磁盘加密，可以包含每个磁盘或快照的多个加密设置。	EncryptionSettingsCollection
hyperVGeneration	虚拟机的虚拟机监控程序生成。仅适用于 OS 磁盘。	“V1” “V2”
增量	快照是否为增量快照。同一磁盘上的增量快照占用的空间少于完整快照，并且可以差异。	bool
networkAccessPolicy	通过网络访问磁盘的策略。	“AllowAll” “AllowPrivate” “DenyAll”
osType	操作系统类型。	“Linux” “Windows”
publicNetworkAccess	用于控制磁盘上的导出的策略。	“Disabled” “Enabled”
purchasePlan	最初创建快照源磁盘的映像的购买计划信息。	PurchasePlan
securityProfile	包含资源的安全相关信息。	DiskSecurityProfile
supportedCapabilities	最初创建快照源磁盘的映像支持的功能列表。	SupportedCapabilities
supportsHibernation	指示快照上的 OS 支持休眠。	bool

CopyCompletionError

名字	描述	价值
errorCode	如果通过 CopyStart 操作创建的资源的后台副本失败，则指示错误代码。	“CopySourceNotFound”（必需）
errorMessage	如果通过 CopyStart 操作创建的资源的后台副本失败，则指示错误消息。	string （必需）

CreationData

名字	描述	价值
createOption	这会枚举磁盘创建可能的源。	“Attach” “Copy” “CopyFromSanSnapshot” “CopyStart” “Empty” “FromImage” “导入” “ImportSecure” “还原” “Upload” “UploadPreparedSecure”（必需）
elasticSanResourceId	如果 createOption 为 CopyFromSanSnapshot，则是必需的。这是源弹性 san 卷快照的 ARM ID。	字符串
galleryImageReference	从库映像创建时是必需的。 ImageDiskReference 的 id/sharedGalleryImageId/communityGalleryImageId 将是要从中创建磁盘的共享 galley 映像版本的 ARM ID。	ImageDiskReference
imageReference	PIR 或用户映像的磁盘源信息。	ImageDiskReference
logicalSectorSize	超级磁盘的逻辑扇区大小（以字节为单位）。支持的值为 512 ad 4096。 4096 是默认值。	int
performancePlus	将此标志设置为 true 以提升部署的磁盘的性能目标，请参阅此处的相应性能目标。此标志只能在磁盘创建时设置，在启用后不能禁用。	bool
provisionedBandwidthCopySpeed	如果在快照上设置了此字段，并且 createOption 为 CopyStart，则会以更快的速度复制快照。	“增强” “None”
securityDataUri	如果 createOption 为 ImportSecure，则这是要导入 VM 来宾状态的 Blob 的 URI。	字符串
sourceResourceId	如果 createOption 为 Copy，则这是源快照或磁盘的 ARM ID。	字符串
sourceUri	如果 createOption 为 Import，则这是要导入到托管磁盘中的 Blob 的 URI。	字符串
storageAccountId	如果 createOption 为 Import，则为必需。包含要作为磁盘导入的 Blob 的存储帐户的 Azure 资源管理器标识符。	字符串
uploadSizeBytes	如果 createOption 为 Upload，则这是上传内容的大小，包括 VHD 页脚。此值应介于 20972032（VHD 页脚的 20 MiB + 512 字节）和35183298347520字节（VHD 页脚的 32 TiB + 512 字节）。	int

ImageDiskReference

名字	描述	价值
communityGalleryImageId	包含社区 Azure 计算库映像引用的相对 URI。	字符串
id	包含平台映像存储库、用户映像或 Azure 计算库映像引用的相对 URI。	字符串
伦	如果磁盘是从映像的数据磁盘创建的，则这是一个索引，指示要使用的映像中的数据磁盘。对于 OS 磁盘，此字段为 null。	int
sharedGalleryImageId	包含直接共享 Azure 计算库映像引用的相对 URI。	字符串

加密

名字	描述	价值
diskEncryptionSetId	用于启用静态加密的磁盘加密集的 ResourceId。	字符串
类型	用于加密磁盘数据的密钥类型。	“EncryptionAtRestWithCustomerKey” “EncryptionAtRestWithPlatformAndCustomerKeys” “EncryptionAtRestWithPlatformKey”

EncryptionSettingsCollection

名字	描述	价值
启用	将此标志设置为 true，并提供 DiskEncryptionKey 和可选 KeyEncryptionKey 以启用加密。将此标志设置为 false，并删除 DiskEncryptionKey 和 KeyEncryptionKey 以禁用加密。如果 Request 对象中的 EncryptionSettings 为 null，则现有设置保持不变。	bool （必需）
encryptionSettings	加密设置的集合，每个磁盘卷各有一个。	EncryptionSettingsElement[]
encryptionSettingsVersion	描述磁盘使用哪种类型的加密。设置此字段后，无法覆盖它。 “1.0”对应于 AAD 应用的 Azure 磁盘加密。“1.1”对应于 Azure 磁盘加密。	字符串

EncryptionSettingsElement

名字	描述	价值
diskEncryptionKey	磁盘加密密钥的 Key Vault 机密 URL 和保管库 ID	KeyVaultAndSecretReference
keyEncryptionKey	密钥保管库密钥 URL 和密钥加密密钥的保管库 ID。 KeyEncryptionKey 是可选的，当提供用于解包磁盘加密密钥时。	KeyVaultAndKeyReference

KeyVaultAndSecretReference

名字	描述	价值
secretUrl	指向 KeyVault 中的密钥或机密的 URL	string （必需）
sourceVault	包含密钥或机密的 KeyVault 的资源 ID	SourceVault （必需）

SourceVault

名字	描述	价值
id	资源 ID	字符串

KeyVaultAndKeyReference

名字	描述	价值
keyUrl	指向 KeyVault 中的密钥或机密的 URL	string （必需）
sourceVault	包含密钥或机密的 KeyVault 的资源 ID	SourceVault （必需）

PurchasePlan

名字	描述	价值
名字	计划 ID。	string （必需）
产品	指定来自市场的映像的产品。此值与 imageReference 元素下的 Offer 相同。	string （必需）
promotionCode	产品/服务促销代码。	字符串
发行人	发布者 ID。	string （必需）

DiskSecurityProfile

名字	描述	价值
secureVMDiskEncryptionSetId	与使用客户托管密钥加密的机密 VM 支持的磁盘关联的磁盘加密集的 ResourceId	字符串
securityType	指定 VM 的 SecurityType。仅适用于 OS 磁盘。	“ConfidentialVM_DiskEncryptedWithCustomerKey” “ConfidentialVM_DiskEncryptedWithPlatformKey” “ConfidentialVM_NonPersistedTPM” “ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey” “TrustedLaunch”

SupportedCapabilities

名字	描述	价值
acceleratedNetwork	如此如果从中创建 OS 磁盘的映像支持加速网络。	bool
建筑	OS 磁盘支持的 CPU 体系结构。	“Arm64” “x64”
diskControllerTypes	OS 磁盘支持的磁盘控制器。如果将其设置为 SCSI 或 SCSI、NVME 或 NVME、SCSI。	字符串

SnapshotSku

名字	描述	价值
名字	SKU 名称。	“Premium_LRS” “Standard_LRS” “Standard_ZRS”

ARM 模板资源定义

可以使用目标操作部署快照资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Compute/snapshots 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Compute/snapshots",
  "apiVersion": "2023-10-02",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "extendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "properties": {
    "completionPercent": "int",
    "copyCompletionError": {
      "errorCode": "CopySourceNotFound",
      "errorMessage": "string"
    },
    "creationData": {
      "createOption": "string",
      "elasticSanResourceId": "string",
      "galleryImageReference": {
        "communityGalleryImageId": "string",
        "id": "string",
        "lun": "int",
        "sharedGalleryImageId": "string"
      },
      "imageReference": {
        "communityGalleryImageId": "string",
        "id": "string",
        "lun": "int",
        "sharedGalleryImageId": "string"
      },
      "logicalSectorSize": "int",
      "performancePlus": "bool",
      "provisionedBandwidthCopySpeed": "string",
      "securityDataUri": "string",
      "sourceResourceId": "string",
      "sourceUri": "string",
      "storageAccountId": "string",
      "uploadSizeBytes": "int"
    },
    "dataAccessAuthMode": "string",
    "diskAccessId": "string",
    "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",
    "networkAccessPolicy": "string",
    "osType": "string",
    "publicNetworkAccess": "string",
    "purchasePlan": {
      "name": "string",
      "product": "string",
      "promotionCode": "string",
      "publisher": "string"
    },
    "securityProfile": {
      "secureVMDiskEncryptionSetId": "string",
      "securityType": "string"
    },
    "supportedCapabilities": {
      "acceleratedNetwork": "bool",
      "architecture": "string",
      "diskControllerTypes": "string"
    },
    "supportsHibernation": "bool"
  }
}

属性值

快照

名字	描述	价值
类型	资源类型	“Microsoft.Compute/snapshots”
apiVersion	资源 API 版本	'2023-10-02'
名字	资源名称	string （必需）字符限制：1-80 有效字符：字母数字、下划线、句点和连字符。从字母数字开始。以字母数字或下划线结尾。
位置	资源位置	string （必需）
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
sku	快照 SKU 名称。可以是Standard_LRS、Premium_LRS或Standard_ZRS。这是增量快照的可选参数，默认行为是 SKU 将设置为与上一快照相同的 SKU	SnapshotSku
extendedLocation	将在其中创建快照的扩展位置。无法更改扩展位置。	ExtendedLocation
性能	快照资源属性。	SnapshotProperties

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	字符串
类型	扩展位置的类型。	“EdgeZone”

SnapshotProperties

名字	描述	价值
completionPercent	通过 CopyStart 操作创建资源时后台副本完成的百分比。	int
copyCompletionError	指示错误详细信息，如果通过 CopyStart 操作创建的资源的后台副本失败。	CopyCompletionError
creationData	磁盘源信息。创建磁盘后，无法更改 CreationData 信息。	CreationData （必需）
dataAccessAuthMode	导出或上传到磁盘或快照时的其他身份验证要求。	“AzureActiveDirectory” “None”
diskAccessId	磁盘上使用专用终结点的 DiskAccess 资源的 ARM ID。	字符串
diskSizeGB	如果 creationData.createOption 为 Empty，则此字段是必需的，并指示要创建的磁盘的大小。如果此字段可用于更新或创建其他选项，则表示调整大小。仅当磁盘未附加到正在运行的 VM 时，才允许重设大小，并且只能增加磁盘的大小。	int
加密	加密属性可用于使用客户托管密钥或平台托管密钥加密静态数据。	加密
encryptionSettingsCollection	使用加密设置集合是 Azure 磁盘加密，可以包含每个磁盘或快照的多个加密设置。	EncryptionSettingsCollection
hyperVGeneration	虚拟机的虚拟机监控程序生成。仅适用于 OS 磁盘。	“V1” “V2”
增量	快照是否为增量快照。同一磁盘上的增量快照占用的空间少于完整快照，并且可以差异。	bool
networkAccessPolicy	通过网络访问磁盘的策略。	“AllowAll” “AllowPrivate” “DenyAll”
osType	操作系统类型。	“Linux” “Windows”
publicNetworkAccess	用于控制磁盘上的导出的策略。	“Disabled” “Enabled”
purchasePlan	最初创建快照源磁盘的映像的购买计划信息。	PurchasePlan
securityProfile	包含资源的安全相关信息。	DiskSecurityProfile
supportedCapabilities	最初创建快照源磁盘的映像支持的功能列表。	SupportedCapabilities
supportsHibernation	指示快照上的 OS 支持休眠。	bool

CopyCompletionError

名字	描述	价值
errorCode	如果通过 CopyStart 操作创建的资源的后台副本失败，则指示错误代码。	“CopySourceNotFound”（必需）
errorMessage	如果通过 CopyStart 操作创建的资源的后台副本失败，则指示错误消息。	string （必需）

CreationData

名字	描述	价值
createOption	这会枚举磁盘创建可能的源。	“Attach” “Copy” “CopyFromSanSnapshot” “CopyStart” “Empty” “FromImage” “导入” “ImportSecure” “还原” “Upload” “UploadPreparedSecure”（必需）
elasticSanResourceId	如果 createOption 为 CopyFromSanSnapshot，则是必需的。这是源弹性 san 卷快照的 ARM ID。	字符串
galleryImageReference	从库映像创建时是必需的。 ImageDiskReference 的 id/sharedGalleryImageId/communityGalleryImageId 将是要从中创建磁盘的共享 galley 映像版本的 ARM ID。	ImageDiskReference
imageReference	PIR 或用户映像的磁盘源信息。	ImageDiskReference
logicalSectorSize	超级磁盘的逻辑扇区大小（以字节为单位）。支持的值为 512 ad 4096。 4096 是默认值。	int
performancePlus	将此标志设置为 true 以提升部署的磁盘的性能目标，请参阅此处的相应性能目标。此标志只能在磁盘创建时设置，在启用后不能禁用。	bool
provisionedBandwidthCopySpeed	如果在快照上设置了此字段，并且 createOption 为 CopyStart，则会以更快的速度复制快照。	“增强” “None”
securityDataUri	如果 createOption 为 ImportSecure，则这是要导入 VM 来宾状态的 Blob 的 URI。	字符串
sourceResourceId	如果 createOption 为 Copy，则这是源快照或磁盘的 ARM ID。	字符串
sourceUri	如果 createOption 为 Import，则这是要导入到托管磁盘中的 Blob 的 URI。	字符串
storageAccountId	如果 createOption 为 Import，则为必需。包含要作为磁盘导入的 Blob 的存储帐户的 Azure 资源管理器标识符。	字符串
uploadSizeBytes	如果 createOption 为 Upload，则这是上传内容的大小，包括 VHD 页脚。此值应介于 20972032（VHD 页脚的 20 MiB + 512 字节）和35183298347520字节（VHD 页脚的 32 TiB + 512 字节）。	int

ImageDiskReference

名字	描述	价值
communityGalleryImageId	包含社区 Azure 计算库映像引用的相对 URI。	字符串
id	包含平台映像存储库、用户映像或 Azure 计算库映像引用的相对 URI。	字符串
伦	如果磁盘是从映像的数据磁盘创建的，则这是一个索引，指示要使用的映像中的数据磁盘。对于 OS 磁盘，此字段为 null。	int
sharedGalleryImageId	包含直接共享 Azure 计算库映像引用的相对 URI。	字符串

加密

名字	描述	价值
diskEncryptionSetId	用于启用静态加密的磁盘加密集的 ResourceId。	字符串
类型	用于加密磁盘数据的密钥类型。	“EncryptionAtRestWithCustomerKey” “EncryptionAtRestWithPlatformAndCustomerKeys” “EncryptionAtRestWithPlatformKey”

EncryptionSettingsCollection

名字	描述	价值
启用	将此标志设置为 true，并提供 DiskEncryptionKey 和可选 KeyEncryptionKey 以启用加密。将此标志设置为 false，并删除 DiskEncryptionKey 和 KeyEncryptionKey 以禁用加密。如果 Request 对象中的 EncryptionSettings 为 null，则现有设置保持不变。	bool （必需）
encryptionSettings	加密设置的集合，每个磁盘卷各有一个。	EncryptionSettingsElement[]
encryptionSettingsVersion	描述磁盘使用哪种类型的加密。设置此字段后，无法覆盖它。 “1.0”对应于 AAD 应用的 Azure 磁盘加密。“1.1”对应于 Azure 磁盘加密。	字符串

EncryptionSettingsElement

名字	描述	价值
diskEncryptionKey	磁盘加密密钥的 Key Vault 机密 URL 和保管库 ID	KeyVaultAndSecretReference
keyEncryptionKey	密钥保管库密钥 URL 和密钥加密密钥的保管库 ID。 KeyEncryptionKey 是可选的，当提供用于解包磁盘加密密钥时。	KeyVaultAndKeyReference

KeyVaultAndSecretReference

名字	描述	价值
secretUrl	指向 KeyVault 中的密钥或机密的 URL	string （必需）
sourceVault	包含密钥或机密的 KeyVault 的资源 ID	SourceVault （必需）

SourceVault

名字	描述	价值
id	资源 ID	字符串

KeyVaultAndKeyReference

名字	描述	价值
keyUrl	指向 KeyVault 中的密钥或机密的 URL	string （必需）
sourceVault	包含密钥或机密的 KeyVault 的资源 ID	SourceVault （必需）

PurchasePlan

名字	描述	价值
名字	计划 ID。	string （必需）
产品	指定来自市场的映像的产品。此值与 imageReference 元素下的 Offer 相同。	string （必需）
promotionCode	产品/服务促销代码。	字符串
发行人	发布者 ID。	string （必需）

DiskSecurityProfile

名字	描述	价值
secureVMDiskEncryptionSetId	与使用客户托管密钥加密的机密 VM 支持的磁盘关联的磁盘加密集的 ResourceId	字符串
securityType	指定 VM 的 SecurityType。仅适用于 OS 磁盘。	“ConfidentialVM_DiskEncryptedWithCustomerKey” “ConfidentialVM_DiskEncryptedWithPlatformKey” “ConfidentialVM_NonPersistedTPM” “ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey” “TrustedLaunch”

SupportedCapabilities

名字	描述	价值
acceleratedNetwork	如此如果从中创建 OS 磁盘的映像支持加速网络。	bool
建筑	OS 磁盘支持的 CPU 体系结构。	“Arm64” “x64”
diskControllerTypes	OS 磁盘支持的磁盘控制器。如果将其设置为 SCSI 或 SCSI、NVME 或 NVME、SCSI。	字符串

SnapshotSku

名字	描述	价值
名字	SKU 名称。	“Premium_LRS” “Standard_LRS” “Standard_ZRS”

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署快照资源类型：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Compute/snapshots 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/snapshots@2023-10-02"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      completionPercent = int
      copyCompletionError = {
        errorCode = "CopySourceNotFound"
        errorMessage = "string"
      }
      creationData = {
        createOption = "string"
        elasticSanResourceId = "string"
        galleryImageReference = {
          communityGalleryImageId = "string"
          id = "string"
          lun = int
          sharedGalleryImageId = "string"
        }
        imageReference = {
          communityGalleryImageId = "string"
          id = "string"
          lun = int
          sharedGalleryImageId = "string"
        }
        logicalSectorSize = int
        performancePlus = bool
        provisionedBandwidthCopySpeed = "string"
        securityDataUri = "string"
        sourceResourceId = "string"
        sourceUri = "string"
        storageAccountId = "string"
        uploadSizeBytes = int
      }
      dataAccessAuthMode = "string"
      diskAccessId = "string"
      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
      networkAccessPolicy = "string"
      osType = "string"
      publicNetworkAccess = "string"
      purchasePlan = {
        name = "string"
        product = "string"
        promotionCode = "string"
        publisher = "string"
      }
      securityProfile = {
        secureVMDiskEncryptionSetId = "string"
        securityType = "string"
      }
      supportedCapabilities = {
        acceleratedNetwork = bool
        architecture = "string"
        diskControllerTypes = "string"
      }
      supportsHibernation = bool
    }
    sku = {
      name = "string"
    }
    extendedLocation = {
      name = "string"
      type = "EdgeZone"
    }
  })
}

属性值

快照

名字	描述	价值
类型	资源类型	“Microsoft.Compute/snapshots@2023-10-02”
名字	资源名称	string （必需）字符限制：1-80 有效字符：字母数字、下划线、句点和连字符。从字母数字开始。以字母数字或下划线结尾。
位置	资源位置	string （必需）
parent_id	若要部署到资源组，请使用该资源组的 ID。	string （必需）
标签	资源标记	标记名称和值的字典。
sku	快照 SKU 名称。可以是Standard_LRS、Premium_LRS或Standard_ZRS。这是增量快照的可选参数，默认行为是 SKU 将设置为与上一快照相同的 SKU	SnapshotSku
extendedLocation	将在其中创建快照的扩展位置。无法更改扩展位置。	ExtendedLocation
性能	快照资源属性。	SnapshotProperties

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	字符串
类型	扩展位置的类型。	“EdgeZone”

SnapshotProperties

名字	描述	价值
completionPercent	通过 CopyStart 操作创建资源时后台副本完成的百分比。	int
copyCompletionError	指示错误详细信息，如果通过 CopyStart 操作创建的资源的后台副本失败。	CopyCompletionError
creationData	磁盘源信息。创建磁盘后，无法更改 CreationData 信息。	CreationData （必需）
dataAccessAuthMode	导出或上传到磁盘或快照时的其他身份验证要求。	“AzureActiveDirectory” “None”
diskAccessId	磁盘上使用专用终结点的 DiskAccess 资源的 ARM ID。	字符串
diskSizeGB	如果 creationData.createOption 为 Empty，则此字段是必需的，并指示要创建的磁盘的大小。如果此字段可用于更新或创建其他选项，则表示调整大小。仅当磁盘未附加到正在运行的 VM 时，才允许重设大小，并且只能增加磁盘的大小。	int
加密	加密属性可用于使用客户托管密钥或平台托管密钥加密静态数据。	加密
encryptionSettingsCollection	使用加密设置集合是 Azure 磁盘加密，可以包含每个磁盘或快照的多个加密设置。	EncryptionSettingsCollection
hyperVGeneration	虚拟机的虚拟机监控程序生成。仅适用于 OS 磁盘。	“V1” “V2”
增量	快照是否为增量快照。同一磁盘上的增量快照占用的空间少于完整快照，并且可以差异。	bool
networkAccessPolicy	通过网络访问磁盘的策略。	“AllowAll” “AllowPrivate” “DenyAll”
osType	操作系统类型。	“Linux” “Windows”
publicNetworkAccess	用于控制磁盘上的导出的策略。	“Disabled” “已启用”
purchasePlan	最初创建快照源磁盘的映像的购买计划信息。	PurchasePlan
securityProfile	包含资源的安全相关信息。	DiskSecurityProfile
supportedCapabilities	最初创建快照源磁盘的映像支持的功能列表。	SupportedCapabilities
supportsHibernation	指示快照上的 OS 支持休眠。	bool

CopyCompletionError

名字	描述	价值
errorCode	如果通过 CopyStart 操作创建的资源的后台副本失败，则指示错误代码。	“CopySourceNotFound”（必需）
errorMessage	如果通过 CopyStart 操作创建的资源的后台副本失败，则指示错误消息。	string （必需）

CreationData

名字	描述	价值
createOption	这会枚举磁盘创建可能的源。	“附加” “Copy” “CopyFromSanSnapshot” “CopyStart” “空” “FromImage” “导入” “ImportSecure” “还原” “上传” “UploadPreparedSecure”（必需）
elasticSanResourceId	如果 createOption 为 CopyFromSanSnapshot，则是必需的。这是源弹性 san 卷快照的 ARM ID。	字符串
galleryImageReference	从库映像创建时是必需的。 ImageDiskReference 的 id/sharedGalleryImageId/communityGalleryImageId 将是要从中创建磁盘的共享 galley 映像版本的 ARM ID。	ImageDiskReference
imageReference	PIR 或用户映像的磁盘源信息。	ImageDiskReference
logicalSectorSize	超级磁盘的逻辑扇区大小（以字节为单位）。支持的值为 512 ad 4096。 4096 是默认值。	int
performancePlus	将此标志设置为 true 以提升部署的磁盘的性能目标，请参阅此处的相应性能目标。此标志只能在磁盘创建时设置，在启用后不能禁用。	bool
provisionedBandwidthCopySpeed	如果在快照上设置了此字段，并且 createOption 为 CopyStart，则会以更快的速度复制快照。	“增强” “None”
securityDataUri	如果 createOption 为 ImportSecure，则这是要导入 VM 来宾状态的 Blob 的 URI。	字符串
sourceResourceId	如果 createOption 为 Copy，则这是源快照或磁盘的 ARM ID。	字符串
sourceUri	如果 createOption 为 Import，则这是要导入到托管磁盘中的 Blob 的 URI。	字符串
storageAccountId	如果 createOption 为 Import，则为必需。包含要作为磁盘导入的 Blob 的存储帐户的 Azure 资源管理器标识符。	字符串
uploadSizeBytes	如果 createOption 为 Upload，则这是上传内容的大小，包括 VHD 页脚。此值应介于 20972032（VHD 页脚的 20 MiB + 512 字节）和35183298347520字节（VHD 页脚的 32 TiB + 512 字节）。	int

ImageDiskReference

名字	描述	价值
communityGalleryImageId	包含社区 Azure 计算库映像引用的相对 URI。	字符串
id	包含平台映像存储库、用户映像或 Azure 计算库映像引用的相对 URI。	字符串
伦	如果磁盘是从映像的数据磁盘创建的，则这是一个索引，指示要使用的映像中的数据磁盘。对于 OS 磁盘，此字段为 null。	int
sharedGalleryImageId	包含直接共享 Azure 计算库映像引用的相对 URI。	字符串

加密

名字	描述	价值
diskEncryptionSetId	用于启用静态加密的磁盘加密集的 ResourceId。	字符串
类型	用于加密磁盘数据的密钥类型。	“EncryptionAtRestWithCustomerKey” “EncryptionAtRestWithPlatformAndCustomerKeys” “EncryptionAtRestWithPlatformKey”

EncryptionSettingsCollection

名字	描述	价值
启用	将此标志设置为 true，并提供 DiskEncryptionKey 和可选 KeyEncryptionKey 以启用加密。将此标志设置为 false，并删除 DiskEncryptionKey 和 KeyEncryptionKey 以禁用加密。如果 Request 对象中的 EncryptionSettings 为 null，则现有设置保持不变。	bool （必需）
encryptionSettings	加密设置的集合，每个磁盘卷各有一个。	EncryptionSettingsElement[]
encryptionSettingsVersion	描述磁盘使用哪种类型的加密。设置此字段后，无法覆盖它。 “1.0”对应于 AAD 应用的 Azure 磁盘加密。“1.1”对应于 Azure 磁盘加密。	字符串

EncryptionSettingsElement

名字	描述	价值
diskEncryptionKey	磁盘加密密钥的 Key Vault 机密 URL 和保管库 ID	KeyVaultAndSecretReference
keyEncryptionKey	密钥保管库密钥 URL 和密钥加密密钥的保管库 ID。 KeyEncryptionKey 是可选的，当提供用于解包磁盘加密密钥时。	KeyVaultAndKeyReference

KeyVaultAndSecretReference

名字	描述	价值
secretUrl	指向 KeyVault 中的密钥或机密的 URL	string （必需）
sourceVault	包含密钥或机密的 KeyVault 的资源 ID	SourceVault （必需）

SourceVault

名字	描述	价值
id	资源 ID	字符串

KeyVaultAndKeyReference

名字	描述	价值
keyUrl	指向 KeyVault 中的密钥或机密的 URL	string （必需）
sourceVault	包含密钥或机密的 KeyVault 的资源 ID	SourceVault （必需）

PurchasePlan

名字	描述	价值
名字	计划 ID。	string （必需）
产品	指定来自市场的映像的产品。此值与 imageReference 元素下的 Offer 相同。	string （必需）
promotionCode	产品/服务促销代码。	字符串
发行人	发布者 ID。	string （必需）

DiskSecurityProfile

名字	描述	价值
secureVMDiskEncryptionSetId	与使用客户托管密钥加密的机密 VM 支持的磁盘关联的磁盘加密集的 ResourceId	字符串
securityType	指定 VM 的 SecurityType。仅适用于 OS 磁盘。	“ConfidentialVM_DiskEncryptedWithCustomerKey” “ConfidentialVM_DiskEncryptedWithPlatformKey” “ConfidentialVM_NonPersistedTPM” “ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey” “TrustedLaunch”

SupportedCapabilities

名字	描述	价值
acceleratedNetwork	如此如果从中创建 OS 磁盘的映像支持加速网络。	bool
建筑	OS 磁盘支持的 CPU 体系结构。	“Arm64” “x64”
diskControllerTypes	OS 磁盘支持的磁盘控制器。如果将其设置为 SCSI 或 SCSI、NVME 或 NVME、SCSI。	字符串

SnapshotSku

名字	描述	价值
名字	SKU 名称。	“Premium_LRS” “Standard_LRS” “Standard_ZRS”

通过

Microsoft.Compute snapshots 2023-10-02

Bicep 资源定义

资源格式

属性值

快照

ExtendedLocation

SnapshotProperties

CopyCompletionError

CreationData

ImageDiskReference

加密

EncryptionSettingsCollection

EncryptionSettingsElement

KeyVaultAndSecretReference

SourceVault

KeyVaultAndKeyReference

PurchasePlan

DiskSecurityProfile

SupportedCapabilities

SnapshotSku

ARM 模板资源定义

资源格式

属性值

快照

ExtendedLocation

SnapshotProperties

CopyCompletionError

CreationData

ImageDiskReference

加密

EncryptionSettingsCollection

EncryptionSettingsElement

KeyVaultAndSecretReference

SourceVault

KeyVaultAndKeyReference

PurchasePlan

DiskSecurityProfile

SupportedCapabilities

SnapshotSku

Terraform （AzAPI 提供程序）资源定义

资源格式

属性值

快照

ExtendedLocation

SnapshotProperties

CopyCompletionError

CreationData

ImageDiskReference

加密

EncryptionSettingsCollection

EncryptionSettingsElement

KeyVaultAndSecretReference

SourceVault

KeyVaultAndKeyReference

PurchasePlan

DiskSecurityProfile

SupportedCapabilities

SnapshotSku

反馈

其他资源