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

Snapshots - List By Resource Group

Lists资源组下的快照。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots?api-version=2023-10-02

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

SnapshotList

确定

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

List all snapshots in a resource group.

示例请求

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots?api-version=2023-10-02

示例响应

{
  "value": [
    {
      "properties": {
        "osType": "Windows",
        "creationData": {
          "createOption": "Copy",
          "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
        },
        "diskSizeGB": 200,
        "encryptionSettingsCollection": {
          "enabled": true,
          "encryptionSettings": [
            {
              "diskEncryptionKey": {
                "sourceVault": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault"
                },
                "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}"
              },
              "keyEncryptionKey": {
                "sourceVault": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault"
                },
                "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}"
              }
            }
          ]
        },
        "encryption": {
          "type": "EncryptionAtRestWithPlatformKey"
        },
        "timeCreated": "2016-12-28T04:41:35.9278721+00:00",
        "provisioningState": "Succeeded"
      },
      "type": "Microsoft.Compute/snapshots",
      "location": "westus",
      "tags": {
        "department": "Development",
        "project": "Snapshots"
      },
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot",
      "name": "mySnapshot"
    }
  ]
}

定义

名称 说明
Architecture

OS 磁盘支持的 CPU 体系结构。

CopyCompletionError

指示通过 CopyStart 操作创建的资源的后台副本失败时的错误详细信息。

CopyCompletionErrorReason

指示通过 CopyStart 操作创建的资源的后台副本失败时错误代码。

CreationData

创建磁盘时使用的数据。

DataAccessAuthMode

导出或上传到磁盘或快照时的其他身份验证要求。

DiskCreateOption

这会枚举创建磁盘的可能源。

DiskSecurityProfile

包含资源的安全相关信息。

DiskSecurityTypes

指定 VM 的 SecurityType。 仅适用于 OS 磁盘。

DiskState

这会枚举磁盘的可能状态。

Encryption

磁盘或快照的静态加密设置

EncryptionSettingsCollection

磁盘或快照的加密设置

EncryptionSettingsElement

一个磁盘卷的加密设置。

EncryptionType

用于加密磁盘数据的密钥类型。

ExtendedLocation

扩展位置的复杂类型。

ExtendedLocationTypes

扩展位置的类型。

HyperVGeneration

虚拟机的虚拟机监控程序生成。 仅适用于 OS 磁盘。

ImageDiskReference

用于创建磁盘的源映像。

KeyVaultAndKeyReference

密钥保管库 KeK 的密钥 URL 和保管库 ID,KeK 是可选的,提供时用于解包 encryptionKey

KeyVaultAndSecretReference

密钥保管库加密密钥的机密 URL 和保管库 ID

NetworkAccessPolicy

用于通过网络访问磁盘的策略。

OperatingSystemTypes

操作系统类型。

ProvisionedBandwidthCopyOption

如果此字段在快照上设置,而 createOption 为 CopyStart,则将以更快的速度复制快照。

PublicNetworkAccess

用于控制磁盘导出的策略。

PurchasePlan

用于通过 MarketPlace 建立任何第三方项目的购买上下文。

Snapshot

快照资源。

SnapshotList

列出快照操作响应。

SnapshotSku

快照 SKU 名称。 可以是Standard_LRS、Premium_LRS或Standard_ZRS。 这是增量快照的可选参数,默认行为是 SKU 将设置为与上一个 sku 相同的 sku 快照

SnapshotStorageAccountTypes

SKU 名称。

SourceVault

保管库 ID 是 Azure 资源管理器资源 ID,格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

SupportedCapabilities

磁盘资源上保留的受支持功能列表,以供 VM 使用。

Architecture

OS 磁盘支持的 CPU 体系结构。

名称 类型 说明
Arm64

string

x64

string

CopyCompletionError

指示通过 CopyStart 操作创建的资源的后台副本失败时的错误详细信息。

名称 类型 说明
errorCode

CopyCompletionErrorReason

指示通过 CopyStart 操作创建的资源的后台副本失败时错误代码。

errorMessage

string

指示通过 CopyStart 操作创建的资源的后台副本失败时出现错误消息。

CopyCompletionErrorReason

指示通过 CopyStart 操作创建的资源的后台副本失败时错误代码。

名称 类型 说明
CopySourceNotFound

string

指示在通过 CopyStart 操作创建的资源的后台副本正在进行时删除了源快照。

CreationData

创建磁盘时使用的数据。

名称 类型 说明
createOption

DiskCreateOption

这会枚举创建磁盘的可能来源。

elasticSanResourceId

string

如果 createOption 为 CopyFromSanSnapshot,则为必需。 这是源弹性 san 卷快照的 ARM ID。

galleryImageReference

ImageDiskReference

如果从库映像创建,则为必需项。 ImageDiskReference 的 id/sharedGalleryImageId/communityGalleryImageId 将是要从中创建磁盘的共享映像版本的 ARM ID。

imageReference

ImageDiskReference

PIR 或用户映像的磁盘源信息。

logicalSectorSize

integer

超级磁盘的逻辑扇区大小(以字节为单位)。 支持的值为 512 和 4096。 4096 是默认值。

performancePlus

boolean

将此标志设置为 true 可提高所部署磁盘的性能目标,请参阅此处的相应性能目标。 此标志只能在磁盘创建时设置,启用后不能禁用。

provisionedBandwidthCopySpeed

ProvisionedBandwidthCopyOption

如果在快照上设置了此字段,并且 createOption 为 CopyStart,则将以更快的速度复制快照。

securityDataUri

string

如果 createOption 为 ImportSecure,则这是要导入到 VM 来宾状态的 Blob 的 URI。

sourceResourceId

string

如果 createOption 为 Copy,则这是源快照或磁盘的 ARM ID。

sourceUniqueId

string

如果设置了此字段,则这是标识此资源源的唯一 ID。

sourceUri

string

如果 createOption 为 Import,则这是要导入到托管磁盘的 Blob 的 URI。

storageAccountId

string

如果 createOption 为 Import,则为必需项。 包含要导入为磁盘的 Blob 的存储帐户的 Azure 资源管理器标识符。

uploadSizeBytes

integer

如果 createOption 为 Upload,则这是上传内容(包括 VHD 页脚)的大小。 对于 VHD 页脚) ,此值应介于 20972032 (20 MiB + 512 字节之间,对于 VHD 页脚) ,此值应介于 32 TiB + 512 字节 (35183298347520字节之间。

DataAccessAuthMode

导出或上传到磁盘或快照时的其他身份验证要求。

名称 类型 说明
AzureActiveDirectory

string

使用导出/上传 URL 时,系统会检查用户是否在 Azure Active Directory 中具有标识,并且是否具有导出/上传数据的必要权限。 请参阅 aka.ms/DisksAzureADAuth。

None

string

访问导出/上传 URL 时,不会执行任何其他身份验证。

DiskCreateOption

这会枚举创建磁盘的可能源。

名称 类型 说明
Attach

string

磁盘将附加到 VM。

Copy

string

通过从给定 sourceResourceId 指定的磁盘或快照复制来创建新磁盘或快照。

CopyFromSanSnapshot

string

通过从弹性 san 卷导出创建新磁盘快照

CopyStart

string

使用深度复制过程创建新磁盘,只有在从源复制所有数据后,资源创建才被视为已完成。

Empty

string

创建由 diskSizeGB 提供大小的空数据磁盘。

FromImage

string

从给定 imageReference 或 galleryImageReference 指定的平台映像创建新磁盘。

Import

string

通过在 storageAccountId 指定的存储帐户中从 sourceUri 指定的 Blob 导入来创建磁盘。

ImportSecure

string

类似于“导入创建”选项。 通过在 storageAccountId 指定的存储帐户中导入 securityDataUri 指定的 VM 来宾状态,创建新的受信任的启动 VM 或机密 VM 支持的磁盘

Restore

string

通过从备份恢复点复制创建新磁盘。

Upload

string

通过获取写入令牌并使用它直接上传磁盘内容来创建新磁盘。

UploadPreparedSecure

string

类似于“上传创建”选项。 创建新的受信任的启动 VM 或机密 VM 支持的磁盘,并在磁盘和 VM 来宾状态下使用写入令牌进行上传

DiskSecurityProfile

包含资源的安全相关信息。

名称 类型 说明
secureVMDiskEncryptionSetId

string

与使用客户管理的密钥加密的机密 VM 支持的磁盘关联的磁盘加密集的 ResourceId

securityType

DiskSecurityTypes

指定 VM 的 SecurityType。 仅适用于 OS 磁盘。

DiskSecurityTypes

指定 VM 的 SecurityType。 仅适用于 OS 磁盘。

名称 类型 说明
ConfidentialVM_DiskEncryptedWithCustomerKey

string

指示使用客户管理的密钥加密的 OS 磁盘和 VM 来宾状态的机密 VM 磁盘

ConfidentialVM_DiskEncryptedWithPlatformKey

string

指示使用平台管理的密钥加密的 OS 磁盘和 VM 来宾状态的机密 VM 磁盘

ConfidentialVM_NonPersistedTPM

string

指示具有临时 vTPM 的机密 VM 磁盘。 vTPM 状态在 VM 重启后不会持久保存。

ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey

string

指示仅加密 VM 来宾状态的机密 VM 磁盘

TrustedLaunch

string

受信任的启动提供安全功能,例如安全启动和虚拟受信任的平台模块 (vTPM)

DiskState

这会枚举磁盘的可能状态。

名称 类型 说明
ActiveSAS

string

磁盘当前具有与之关联的活动 SAS URI。

ActiveSASFrozen

string

磁盘附加到处于休眠状态的 VM,并具有与之关联的活动 SAS URI。

ActiveUpload

string

创建用于上传的磁盘,并颁发了写入令牌以上传到该磁盘。

Attached

string

磁盘当前已附加到正在运行的 VM。

Frozen

string

磁盘附加到处于休眠状态的 VM。

ReadyToUpload

string

可以通过请求写入令牌上传来创建磁盘。

Reserved

string

磁盘附加到已停止解除分配的 VM。

Unattached

string

磁盘未使用,可以附加到 VM。

Encryption

磁盘或快照的静态加密设置

名称 类型 说明
diskEncryptionSetId

string

要用于启用静态加密的磁盘加密集的 ResourceId。

type

EncryptionType

用于加密磁盘数据的密钥类型。

EncryptionSettingsCollection

磁盘或快照的加密设置

名称 类型 说明
enabled

boolean

将此标志设置为 true,并提供 DiskEncryptionKey 和可选的 KeyEncryptionKey 以启用加密。 将此标志设置为 false 并删除 DiskEncryptionKey 和 KeyEncryptionKey 以禁用加密。 如果请求对象中的 EncryptionSettings 为 null,则现有设置保持不变。

encryptionSettings

EncryptionSettingsElement[]

加密设置的集合,每个磁盘卷各一个。

encryptionSettingsVersion

string

描述磁盘使用的加密类型。 设置此字段后,无法覆盖它。 “1.0”对应于使用 AAD 应用的 Azure 磁盘加密。“1.1”对应于 Azure 磁盘加密。

EncryptionSettingsElement

一个磁盘卷的加密设置。

名称 类型 说明
diskEncryptionKey

KeyVaultAndSecretReference

密钥保管库磁盘加密密钥的机密 URL 和保管库 ID

keyEncryptionKey

KeyVaultAndKeyReference

密钥保管库密钥加密密钥的密钥 URL 和保管库 ID。 KeyEncryptionKey 是可选的,提供时用于解包磁盘加密密钥。

EncryptionType

用于加密磁盘数据的密钥类型。

名称 类型 说明
EncryptionAtRestWithCustomerKey

string

磁盘使用客户管理的密钥进行静态加密,客户可以更改和吊销这些密钥。

EncryptionAtRestWithPlatformAndCustomerKeys

string

磁盘使用 2 层加密进行静态加密。 其中一个密钥是客户管理的,另一个密钥是平台管理的。

EncryptionAtRestWithPlatformKey

string

磁盘使用平台托管密钥进行静态加密。 它是默认加密类型。 对于磁盘加密集,这不是有效的加密类型。

ExtendedLocation

扩展位置的复杂类型。

名称 类型 说明
name

string

扩展位置的名称。

type

ExtendedLocationTypes

扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

名称 类型 说明
EdgeZone

string

HyperVGeneration

虚拟机的虚拟机监控程序生成。 仅适用于 OS 磁盘。

名称 类型 说明
V1

string

V2

string

ImageDiskReference

用于创建磁盘的源映像。

名称 类型 说明
communityGalleryImageId

string

包含社区 Azure 计算库映像引用的相对 URI。

id

string

包含平台映像存储库、用户映像或 Azure Compute Gallery 映像引用的相对 URI。

lun

integer

如果磁盘是从映像的数据磁盘创建的,则此索引指示要使用的映像中的数据磁盘。 对于 OS 磁盘,此字段为 null。

sharedGalleryImageId

string

包含直接共享 Azure 计算库映像引用的相对 URI。

KeyVaultAndKeyReference

密钥保管库 KeK 的密钥 URL 和保管库 ID,KeK 是可选的,提供时用于解包 encryptionKey

名称 类型 说明
keyUrl

string

指向 KeyVault 中的密钥或机密的 URL

sourceVault

SourceVault

包含密钥或机密的 KeyVault 的资源 ID

KeyVaultAndSecretReference

密钥保管库加密密钥的机密 URL 和保管库 ID

名称 类型 说明
secretUrl

string

指向 KeyVault 中的密钥或机密的 URL

sourceVault

SourceVault

包含密钥或机密的 KeyVault 的资源 ID

NetworkAccessPolicy

用于通过网络访问磁盘的策略。

名称 类型 说明
AllowAll

string

磁盘可以从任何网络导出或上传到。

AllowPrivate

string

可以使用 DiskAccess 资源的专用终结点导出或上传到磁盘。

DenyAll

string

无法导出磁盘。

OperatingSystemTypes

操作系统类型。

名称 类型 说明
Linux

string

Windows

string

ProvisionedBandwidthCopyOption

如果此字段在快照上设置,而 createOption 为 CopyStart,则将以更快的速度复制快照。

名称 类型 说明
Enhanced

string

None

string

PublicNetworkAccess

用于控制磁盘导出的策略。

名称 类型 说明
Disabled

string

即使 NetworkAccessPolicy 设置为 AllowAll,也无法在 Internet 上公开访问磁盘的基础数据。 仅当 NetworkAccessPolicy 设置为 AllowPrivate 时,才能从受信任的 Azure VNET 通过 SAS URI 访问数据。

Enabled

string

当 NetworkAccessPolicy 设置为 AllowAll 时,可以生成 SAS URI 以在 Internet 上公开访问磁盘的基础数据。 仅当 NetworkAccessPolicy 设置为 AllowPrivate 时,才能从受信任的 Azure VNET 通过 SAS URI 访问数据。

PurchasePlan

用于通过 MarketPlace 建立任何第三方项目的购买上下文。

名称 类型 说明
name

string

计划 ID。

product

string

指定市场中映像的乘积。 此值与 imageReference 元素下的 Offer 值相同。

promotionCode

string

产品/服务促销代码。

publisher

string

发布者 ID。

Snapshot

快照资源。

名称 类型 说明
extendedLocation

ExtendedLocation

将在其中创建快照的扩展位置。 无法更改扩展位置。

id

string

资源 ID

location

string

资源位置

managedBy

string

未使用。 始终为 Null。

name

string

资源名称

properties.completionPercent

number

通过 CopyStart 操作创建资源时后台副本的完成百分比。

properties.copyCompletionError

CopyCompletionError

指示通过 CopyStart 操作创建的资源的后台副本失败时的错误详细信息。

properties.creationData

CreationData

磁盘源信息。 创建磁盘后,无法更改创建数据信息。

properties.dataAccessAuthMode

DataAccessAuthMode

导出或上传到磁盘或快照时的其他身份验证要求。

properties.diskAccessId

string

用于在磁盘上使用专用终结点的 DiskAccess 资源的 ARM ID。

properties.diskSizeBytes

integer

磁盘的大小(以字节为单位)。 该字段是只读字段。

properties.diskSizeGB

integer

如果 creationData.createOption 为 Empty,则此字段是必需的,它指示要创建的磁盘的大小。 如果此字段可用于使用其他选项进行更新或创建,则表示调整大小。 仅当磁盘未附加到正在运行的 VM 时,才允许重设大小,并且只能增加磁盘的大小。

properties.diskState

DiskState

快照的状态。

properties.encryption

Encryption

加密属性可用于使用客户管理的密钥或平台管理的密钥加密静态数据。

properties.encryptionSettingsCollection

EncryptionSettingsCollection

加密设置集合是 Azure 磁盘加密,可以包含每个磁盘或快照的多个加密设置。

properties.hyperVGeneration

HyperVGeneration

虚拟机的虚拟机监控程序生成。 仅适用于 OS 磁盘。

properties.incremental

boolean

快照是否为增量。 同一磁盘上的增量快照比完整快照占用的空间少,可以进行差异。

properties.incrementalSnapshotFamilyId

string

磁盘的增量快照共享增量快照系列 ID。只能在具有相同系列 ID 的增量快照上调用获取页面范围差异 API。

properties.networkAccessPolicy

NetworkAccessPolicy

用于通过网络访问磁盘的策略。

properties.osType

OperatingSystemTypes

操作系统类型。

properties.provisioningState

string

磁盘预配状态。

properties.publicNetworkAccess

PublicNetworkAccess

用于控制磁盘上的导出的策略。

properties.purchasePlan

PurchasePlan

最初从中创建快照源磁盘的映像的购买计划信息。

properties.securityProfile

DiskSecurityProfile

包含资源的安全相关信息。

properties.supportedCapabilities

SupportedCapabilities

最初从中创建快照源磁盘的映像支持的功能列表。

properties.supportsHibernation

boolean

指示快照上的 OS 支持休眠。

properties.timeCreated

string

创建快照的时间。

properties.uniqueId

string

标识资源的唯一 Guid。

sku

SnapshotSku

快照 SKU 名称。 可以是Standard_LRS、Premium_LRS或Standard_ZRS。 这是增量快照的可选参数,默认行为是 SKU 将设置为与上一个 sku 相同的 sku 快照

tags

object

资源标记

type

string

资源类型

SnapshotList

列出快照操作响应。

名称 类型 说明
nextLink

string

用于提取下一页快照的 URI。 调用 ListNext () 以提取快照的下一页。

value

Snapshot[]

快照列表。

SnapshotSku

快照 SKU 名称。 可以是Standard_LRS、Premium_LRS或Standard_ZRS。 这是增量快照的可选参数,默认行为是 SKU 将设置为与上一个 sku 相同的 sku 快照

名称 类型 说明
name

SnapshotStorageAccountTypes

SKU 名称。

tier

string

SKU 层。

SnapshotStorageAccountTypes

SKU 名称。

名称 类型 说明
Premium_LRS

string

高级 SSD 本地冗余存储

Standard_LRS

string

标准 HDD 本地冗余存储

Standard_ZRS

string

标准区域冗余存储

SourceVault

保管库 ID 是 Azure 资源管理器资源 ID,格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

名称 类型 说明
id

string

资源 ID

SupportedCapabilities

磁盘资源上保留的受支持功能列表,以供 VM 使用。

名称 类型 说明
acceleratedNetwork

boolean

如果从中创建 OS 磁盘的映像支持加速网络,则其值为 True。

architecture

Architecture

OS 磁盘支持的 CPU 体系结构。

diskControllerTypes

string

OS 磁盘支持的磁盘控制器。 如果设置,它可以是 SCSI 或 SCSI、NVME 或 NVME、SCSI。