Disks - Get

服务:

Compute

API 版本:

2020-12-01

获取有关磁盘的信息。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}?api-version=2020-12-01

URI 参数

名称	在	必需	类型	说明
diskName	path	True	string	正在创建的托管磁盘的名称。 创建磁盘后，无法更改该名称。 名称支持的字符为 a-z、A-Z、0-9 和 _。 最大名称长度为 80 个字符。
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	唯一标识 azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	Disk	还行

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get information about a managed disk.

示例请求

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk?api-version=2020-12-01

示例响应

状态代码:

200

{
  "managedBy": "/subscriptions/123caaa-123v-v211-a49f-f88ccac5bf88/resourceGroups/ResourceGroupName/providers/Microsoft.Compute/virtualMachines/TestVM414689371c88843d65ec",
  "sku": {
    "name": "Standard_LRS"
  },
  "properties": {
    "osType": "Windows",
    "hyperVGeneration": "V1",
    "purchasePlan": {
      "name": "test_sku",
      "publisher": "test_test_pmc2pc1",
      "product": "marketplace_vm_test"
    },
    "supportsHibernation": true,
    "securityProfile": {
      "securityType": "TrustedLaunch"
    },
    "creationData": {
      "createOption": "FromImage",
      "imageReference": {
        "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0"
      }
    },
    "diskSizeGB": 10,
    "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.079872+00:00",
    "provisioningState": "Succeeded"
  },
  "type": "Microsoft.Compute/disks",
  "location": "westus",
  "tags": {
    "department": "Development",
    "project": "ManagedDisks"
  },
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk",
  "name": "myManagedDisk"
}

定义

名称	说明
CreationData	创建磁盘时使用的数据。
Disk	磁盘资源。
DiskCreateOption	这会枚举磁盘创建可能的源。
DiskSecurityProfile	包含资源的安全相关信息。
DiskSecurityTypes	指定 VM 的 SecurityType。 仅适用于 OS 磁盘。
DiskSku	磁盘 SKU 名称。 可以是Standard_LRS、Premium_LRS、StandardSSD_LRS、UltraSSD_LRS、Premium_ZRS或StandardSSD_ZRS。
DiskState	这会枚举磁盘的可能状态。
DiskStorageAccountTypes	SKU 名称。
Encryption	磁盘或快照的静态加密设置
EncryptionSettingsCollection	磁盘或快照的加密设置
EncryptionSettingsElement	一个磁盘卷的加密设置。
EncryptionType	用于加密磁盘数据的密钥类型。
ExtendedLocation	扩展位置的复杂类型。
ExtendedLocationTypes	扩展位置的类型。
HyperVGeneration	虚拟机的虚拟机监控程序生成。 仅适用于 OS 磁盘。
ImageDiskReference	用于创建磁盘的源映像。
KeyVaultAndKeyReference	KeK 的 Key Vault 密钥 URL 和保管库 ID 是可选的，当提供用于解包 encryptionKey 时
KeyVaultAndSecretReference	加密密钥的 Key Vault 机密 URL 和保管库 ID
NetworkAccessPolicy	通过网络访问磁盘的策略。
OperatingSystemTypes	作系统类型。
PropertyUpdatesInProgress	要为其挂起更新的磁盘的属性。
PurchasePlan	用于通过 MarketPlace 建立任何第三方项目的购买上下文。
ShareInfoElement
SourceVault	保管库 ID 是 Azure 资源管理器资源 ID，格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

CreationData

Object

创建磁盘时使用的数据。

名称	类型	说明
createOption	DiskCreateOption	这会枚举磁盘创建可能的源。
galleryImageReference	ImageDiskReference	从库映像创建时是必需的。 ImageDiskReference 的 ID 将是要从中创建磁盘的共享 galley 映像版本的 ARM ID。
imageReference	ImageDiskReference	磁盘源信息。
logicalSectorSize	integer (int32)	超级磁盘的逻辑扇区大小（以字节为单位）。 支持的值为 512 ad 4096。 4096 是默认值。
sourceResourceId	string	如果 createOption 为 Copy，则这是源快照或磁盘的 ARM ID。
sourceUniqueId	string	如果设置了此字段，则这是标识此资源源的唯一 ID。
sourceUri	string	如果 createOption 为 Import，则这是要导入到托管磁盘中的 Blob 的 URI。
storageAccountId	string	如果 createOption 为 Import，则为必需。 包含要作为磁盘导入的 Blob 的存储帐户的 Azure 资源管理器标识符。
uploadSizeBytes	integer (int64)	如果 createOption 为 Upload，则这是上传内容的大小，包括 VHD 页脚。 此值应介于 20972032（VHD 页脚的 20 MiB + 512 字节）和35183298347520字节（VHD 页脚的 32 TiB + 512 字节）。

Disk

Object

磁盘资源。

名称	类型	说明
extendedLocation	ExtendedLocation	将创建磁盘的扩展位置。 无法更改扩展位置。
id	string	资源 ID
location	string	资源位置
managedBy	string	包含附加磁盘的 VM 的 ID 的相对 URI。
managedByExtended	string[]	包含附加了磁盘的 VM 的 ID 的相对 URI 列表。 maxShares 应设置为大于一个值，以便磁盘允许将它们附加到多个 VM。
name	string	资源名称
properties.burstingEnabled	boolean	设置为 true 以启用超出磁盘预配性能目标的突发。 默认情况下禁用突发。 不适用于超级磁盘。
properties.creationData	CreationData	磁盘源信息。 创建磁盘后，无法更改 CreationData 信息。
properties.diskAccessId	string	磁盘上使用专用终结点的 DiskAccess 资源的 ARM ID。
properties.diskIOPSReadOnly	integer (int64)	将允许在所有 VM 中以 ReadOnly 身份装载共享磁盘的 IOPS 总数。 一个作可以在 4k 到 256k 字节之间传输。
properties.diskIOPSReadWrite	integer (int64)	此磁盘允许的 IOPS 数;只能为 UltraSSD 磁盘设置。 一个作可以在 4k 到 256k 字节之间传输。
properties.diskMBpsReadOnly	integer (int64)	所有装载共享磁盘的 VM（MBps）的总吞吐量（MBps）将作为 ReadOnly 装载。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法，其幂为 10。
properties.diskMBpsReadWrite	integer (int64)	此磁盘允许的带宽;只能为 UltraSSD 磁盘设置。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法，其幂为 10。
properties.diskSizeBytes	integer (int64)	磁盘的大小（以字节为单位）。 此字段为只读。
properties.diskSizeGB	integer (int32)	如果 creationData.createOption 为 Empty，则此字段是必需的，并指示要创建的磁盘的大小。 如果此字段可用于更新或创建其他选项，则表示调整大小。 仅当磁盘未附加到正在运行的 VM 时，才允许重设大小，并且只能增加磁盘的大小。
properties.diskState	DiskState	磁盘的状态。
properties.encryption	Encryption	加密属性可用于使用客户托管密钥或平台托管密钥加密静态数据。
properties.encryptionSettingsCollection	EncryptionSettingsCollection	用于 Azure 磁盘加密的加密设置集合可以包含每个磁盘或快照的多个加密设置。
properties.hyperVGeneration	HyperVGeneration	虚拟机的虚拟机监控程序生成。 仅适用于 OS 磁盘。
properties.maxShares	integer (int32)	可以同时附加到磁盘的最大 VM 数。 大于一个值表示可以同时装载到多个 VM 上的磁盘。
properties.networkAccessPolicy	NetworkAccessPolicy	通过网络访问磁盘的策略。
properties.osType	OperatingSystemTypes	作系统类型。
properties.propertyUpdatesInProgress	PropertyUpdatesInProgress	要为其挂起更新的磁盘的属性。
properties.provisioningState	string	磁盘预配状态。
properties.purchasePlan	PurchasePlan	为从中创建 OS 磁盘的映像购买计划信息。 例如 - {name： 2019-Datacenter， publisher： MicrosoftWindowsServer， product： WindowsServer}
properties.securityProfile	DiskSecurityProfile	包含资源的安全相关信息。
properties.shareInfo	ShareInfoElement[]	附加了磁盘的所有 VM 的列表的详细信息。 maxShares 应设置为大于一个值，以便磁盘允许将它们附加到多个 VM。
properties.supportsHibernation	boolean	指示磁盘上的 OS 支持休眠。
properties.tier	string	磁盘的性能层（例如 P4、S10）如下所述：https://azure.microsoft.com/en-us/pricing/details/managed-disks/。 不适用于超级磁盘。
properties.timeCreated	string (date-time)	创建磁盘的时间。
properties.uniqueId	string	标识资源的唯一 Guid。
sku	DiskSku	磁盘 SKU 名称。 可以是Standard_LRS、Premium_LRS、StandardSSD_LRS、UltraSSD_LRS、Premium_ZRS或StandardSSD_ZRS。
tags	object	资源标记
type	string	资源类型
zones	string[]	磁盘的逻辑区域列表。

DiskCreateOption

枚举

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

值	说明
Attach	磁盘将附加到 VM。
Copy	通过从给定 sourceResourceId 指定的磁盘或快照复制来创建新的磁盘或快照。
Empty	创建由 diskSizeGB 提供大小的空数据磁盘。
FromImage	从给定 imageReference 或 galleryImageReference 指定的平台映像创建新磁盘。
Import	通过在 storageAccountId 指定的存储帐户中从 sourceUri 指定的 Blob 导入来创建磁盘。
Restore	通过从备份恢复点复制来创建新磁盘。
Upload	通过获取写入令牌并使用它直接上传磁盘的内容来创建新磁盘。

DiskSecurityProfile

Object

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

名称	类型	说明
securityType	DiskSecurityTypes	指定 VM 的 SecurityType。 仅适用于 OS 磁盘。

DiskSecurityTypes

枚举

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

值	说明
TrustedLaunch	受信任的启动提供安全功能，例如安全启动和虚拟受信任平台模块 （vTPM）

DiskSku

Object

磁盘 SKU 名称。 可以是Standard_LRS、Premium_LRS、StandardSSD_LRS、UltraSSD_LRS、Premium_ZRS或StandardSSD_ZRS。

名称	类型	说明
name	DiskStorageAccountTypes	SKU 名称。
tier	string	SKU 层。

DiskState

枚举

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

值	说明
ActiveSAS	磁盘当前具有与之关联的活动 SAS URI。
ActiveUpload	创建用于上传的磁盘，并颁发了写入令牌以上传到该磁盘。
Attached	磁盘当前装载到正在运行的 VM。
ReadyToUpload	通过请求写入令牌，可以上传磁盘。
Reserved	磁盘装载到已停止解除分配的 VM
Unattached	磁盘未使用，可以附加到 VM。

DiskStorageAccountTypes

枚举

SKU 名称。

值	说明
Premium_LRS	高级 SSD 本地冗余存储。 最适合生产和性能敏感的工作负荷。
Premium_ZRS	高级 SSD 区域冗余存储。 最适合需要针对区域故障进行存储复原的生产工作负荷。
StandardSSD_LRS	标准 SSD 本地冗余存储。 最适合 Web 服务器、轻型企业应用程序和开发/测试。
StandardSSD_ZRS	标准 SSD 区域冗余存储。 最适合用于 Web 服务器、轻型企业应用程序和开发/测试，这些应用程序需要针对区域故障的存储复原能力。
Standard_LRS	标准 HDD 本地冗余存储。 最适合备份、非关键访问和不经常访问。
UltraSSD_LRS	超级 SSD 本地冗余存储。 最适合 IO 密集型工作负荷，例如 SAP HANA、顶层数据库（例如 SQL、Oracle）和其他事务密集型工作负荷。

Encryption

Object

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

名称	类型	说明
diskEncryptionSetId	string	用于启用静态加密的磁盘加密集的 ResourceId。
type	EncryptionType	用于加密磁盘数据的密钥类型。

EncryptionSettingsCollection

Object

磁盘或快照的加密设置

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

EncryptionSettingsElement

Object

一个磁盘卷的加密设置。

名称	类型	说明
diskEncryptionKey	KeyVaultAndSecretReference	磁盘加密密钥的 Key Vault 机密 URL 和保管库 ID
keyEncryptionKey	KeyVaultAndKeyReference	密钥保管库密钥 URL 和密钥加密密钥的保管库 ID。 KeyEncryptionKey 是可选的，当提供用于解包磁盘加密密钥时。

EncryptionType

枚举

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

值	说明
EncryptionAtRestWithCustomerKey	磁盘使用客户管理的密钥进行静态加密，客户可以更改和吊销。
EncryptionAtRestWithPlatformAndCustomerKeys	磁盘使用 2 层加密进行静态加密。 其中一个密钥是客户管理的，另一个密钥是平台管理的。
EncryptionAtRestWithPlatformKey	磁盘使用平台托管密钥进行静态加密。 它是默认加密类型。 这不是磁盘加密集的有效加密类型。

ExtendedLocation

Object

扩展位置的复杂类型。

名称	类型	说明
name	string	扩展位置的名称。
type	ExtendedLocationTypes	扩展位置的类型。

ExtendedLocationTypes

枚举

扩展位置的类型。

值	说明
EdgeZone

HyperVGeneration

枚举

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

值	说明
V1
V2

ImageDiskReference

Object

用于创建磁盘的源映像。

名称	类型	说明
id	string	包含平台映像存储库或用户映像引用的相对 URI。
lun	integer (int32)	如果磁盘是从映像的数据磁盘创建的，则这是一个索引，指示要使用的映像中的数据磁盘。 对于 OS 磁盘，此字段为 null。

KeyVaultAndKeyReference

Object

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

名称	类型	说明
keyUrl	string	指向 KeyVault 中的密钥或机密的 URL
sourceVault	SourceVault	包含密钥或机密的 KeyVault 的资源 ID

KeyVaultAndSecretReference

Object

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

名称	类型	说明
secretUrl	string	指向 KeyVault 中的密钥或机密的 URL
sourceVault	SourceVault	包含密钥或机密的 KeyVault 的资源 ID

NetworkAccessPolicy

枚举

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

值	说明
AllowAll	磁盘可以导出或上传到任何网络。
AllowPrivate	可以使用 DiskAccess 资源的专用终结点导出或上传到该磁盘。
DenyAll	无法导出磁盘。

OperatingSystemTypes

枚举

作系统类型。

值	说明
Linux
Windows

PropertyUpdatesInProgress

Object

要为其挂起更新的磁盘的属性。

名称	类型	说明
targetTier	string	如果正在进行层更改作，则磁盘的目标性能层。

PurchasePlan

Object

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

名称	类型	说明
name	string	计划 ID。
product	string	指定来自市场的映像的产品。 此值与 imageReference 元素下的 Offer 相同。
promotionCode	string	产品/服务促销代码。
publisher	string	发布者 ID。

ShareInfoElement

Object

名称	类型	说明
vmUri	string	包含附加磁盘的 VM 的 ID 的相对 URI。

SourceVault

Object

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

名称	类型	说明
id	string	资源 ID