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

Microsoft.Compute snapshots 2020-06-30

项目
12/20/2024

Bicep 资源定义

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

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

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

资源格式

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

resource symbolicname 'Microsoft.Compute/snapshots@2020-06-30' = {
  location: 'string'
  name: 'string'
  properties: {
    creationData: {
      createOption: 'string'
      galleryImageReference: {
        id: 'string'
        lun: int
      }
      imageReference: {
        id: 'string'
        lun: int
      }
      logicalSectorSize: int
      sourceResourceId: 'string'
      sourceUri: 'string'
      storageAccountId: 'string'
      uploadSizeBytes: int
    }
    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'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

CreationData

名字	描述	价值
createOption	这会枚举磁盘创建可能的源。	“Attach” “Copy” “Empty” “FromImage” “导入” “还原” “上传”（必需）
galleryImageReference	从库映像创建时是必需的。 ImageDiskReference 的 ID 将是要从中创建磁盘的共享 galley 映像版本的 ARM ID。	ImageDiskReference
imageReference	磁盘源信息。	ImageDiskReference
logicalSectorSize	超级磁盘的逻辑扇区大小（以字节为单位）。支持的值为 512 ad 4096。 4096 是默认值。	int
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

加密

名字	描述	价值
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

ImageDiskReference

名字	描述	价值
id	包含平台映像存储库或用户映像引用的相对 URI。	string （必需）
伦	如果磁盘是从映像的数据磁盘创建的，则这是一个索引，指示要使用的映像中的数据磁盘。对于 OS 磁盘，此字段为 null。	int

KeyVaultAndKeyReference

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

KeyVaultAndSecretReference

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

Microsoft.Compute/snapshots

名字	描述	价值
位置	资源位置	string （必需）
名字	资源名称	string （必需）
性能	快照资源属性。	SnapshotProperties
sku	快照 SKU 名称。可以是Standard_LRS、Premium_LRS或Standard_ZRS。	SnapshotSku
标签	资源标记	标记名称和值的字典。请参阅模板中的标记

ResourceTags

名字	描述	价值

SnapshotProperties

名字	描述	价值
creationData	磁盘源信息。创建磁盘后，无法更改 CreationData 信息。	CreationData （必需）
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”

SnapshotSku

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

SourceVault

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

ARM 模板资源定义

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

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

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

资源格式

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

{
  "type": "Microsoft.Compute/snapshots",
  "apiVersion": "2020-06-30",
  "name": "string",
  "location": "string",
  "properties": {
    "creationData": {
      "createOption": "string",
      "galleryImageReference": {
        "id": "string",
        "lun": "int"
      },
      "imageReference": {
        "id": "string",
        "lun": "int"
      },
      "logicalSectorSize": "int",
      "sourceResourceId": "string",
      "sourceUri": "string",
      "storageAccountId": "string",
      "uploadSizeBytes": "int"
    },
    "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"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

CreationData

名字	描述	价值
createOption	这会枚举磁盘创建可能的源。	“Attach” “Copy” “Empty” “FromImage” “导入” “还原” “上传”（必需）
galleryImageReference	从库映像创建时是必需的。 ImageDiskReference 的 ID 将是要从中创建磁盘的共享 galley 映像版本的 ARM ID。	ImageDiskReference
imageReference	磁盘源信息。	ImageDiskReference
logicalSectorSize	超级磁盘的逻辑扇区大小（以字节为单位）。支持的值为 512 ad 4096。 4096 是默认值。	int
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

加密

名字	描述	价值
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

ImageDiskReference

名字	描述	价值
id	包含平台映像存储库或用户映像引用的相对 URI。	string （必需）
伦	如果磁盘是从映像的数据磁盘创建的，则这是一个索引，指示要使用的映像中的数据磁盘。对于 OS 磁盘，此字段为 null。	int

KeyVaultAndKeyReference

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

KeyVaultAndSecretReference

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

Microsoft.Compute/snapshots

名字	描述	价值
apiVersion	API 版本	'2020-06-30'
位置	资源位置	string （必需）
名字	资源名称	string （必需）
性能	快照资源属性。	SnapshotProperties
sku	快照 SKU 名称。可以是Standard_LRS、Premium_LRS或Standard_ZRS。	SnapshotSku
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.Compute/snapshots”

ResourceTags

名字	描述	价值

SnapshotProperties

名字	描述	价值
creationData	磁盘源信息。创建磁盘后，无法更改 CreationData 信息。	CreationData （必需）
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”

SnapshotSku

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

SourceVault

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

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

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

资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/snapshots@2020-06-30"
  name = "string"
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      creationData = {
        createOption = "string"
        galleryImageReference = {
          id = "string"
          lun = int
        }
        imageReference = {
          id = "string"
          lun = int
        }
        logicalSectorSize = int
        sourceResourceId = "string"
        sourceUri = "string"
        storageAccountId = "string"
        uploadSizeBytes = int
      }
      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"
    }
  })
}

属性值

CreationData

名字	描述	价值
createOption	这会枚举磁盘创建可能的源。	“Attach” “Copy” “Empty” “FromImage” “导入” “还原” “上传”（必需）
galleryImageReference	从库映像创建时是必需的。 ImageDiskReference 的 ID 将是要从中创建磁盘的共享 galley 映像版本的 ARM ID。	ImageDiskReference
imageReference	磁盘源信息。	ImageDiskReference
logicalSectorSize	超级磁盘的逻辑扇区大小（以字节为单位）。支持的值为 512 ad 4096。 4096 是默认值。	int
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

加密

名字	描述	价值
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

ImageDiskReference

名字	描述	价值
id	包含平台映像存储库或用户映像引用的相对 URI。	string （必需）
伦	如果磁盘是从映像的数据磁盘创建的，则这是一个索引，指示要使用的映像中的数据磁盘。对于 OS 磁盘，此字段为 null。	int

KeyVaultAndKeyReference

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

KeyVaultAndSecretReference

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

Microsoft.Compute/snapshots

名字	描述	价值
位置	资源位置	string （必需）
名字	资源名称	string （必需）
性能	快照资源属性。	SnapshotProperties
sku	快照 SKU 名称。可以是Standard_LRS、Premium_LRS或Standard_ZRS。	SnapshotSku
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Compute/snapshots@2020-06-30”

ResourceTags

名字	描述	价值

SnapshotProperties

名字	描述	价值
creationData	磁盘源信息。创建磁盘后，无法更改 CreationData 信息。	CreationData （必需）
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”

SnapshotSku

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

SourceVault

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

通过

Microsoft.Compute snapshots 2020-06-30

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

反馈

其他资源