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

Disks - Update

更新磁盘) (修补程序。

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

URI 参数

Name In Required Type Description
diskName
path True
  • string

正在创建的托管磁盘的名称。 创建磁盘后无法更改该名称。 名称支持的字符为 a-z、A-Z、0-9、_ 和 -。 名称最大长度为 80 个字符。

resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

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

api-version
query True
  • string

客户端 API 版本。

请求正文

Name Type Description
properties.burstingEnabled
  • boolean

设置为 true 以启用超出磁盘预配的性能目标的突发。 默认情况下,突发处于禁用状态。 不适用于超级磁盘。

properties.dataAccessAuthMode

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

properties.diskAccessId
  • string

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

properties.diskIOPSReadOnly
  • integer

将允许跨装载共享磁盘的所有 VM 作为 ReadOnly 的 IOPS 总数。 一个操作可以在 4k 到 256k 字节之间传输。

properties.diskIOPSReadWrite
  • integer

此磁盘允许的 IOPS 数;只能为 UltraSSD 磁盘设置。 一个操作可以在 4k 到 256k 字节之间传输。

properties.diskMBpsReadOnly
  • integer

MBps) 的总吞吐量 (,这些吞吐量将允许跨装载共享磁盘的所有 VM 作为 ReadOnly。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法,幂为 10。

properties.diskMBpsReadWrite
  • integer

此磁盘允许的带宽;只能为 UltraSSD 磁盘设置。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法,幂为 10。

properties.diskSizeGB
  • integer

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

properties.encryption

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

properties.encryptionSettingsCollection

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

properties.maxShares
  • integer

可以同时附加到磁盘的最大 VM 数。 大于一个值表示可以同时装载到多个 VM 上的磁盘。

properties.networkAccessPolicy

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

properties.osType

操作系统类型。

properties.publicNetworkAccess

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

properties.purchasePlan

要添加到 OS 磁盘上的购买计划信息

properties.supportedCapabilities

要添加到 OS 磁盘上的受支持功能列表。

properties.supportsHibernation
  • boolean

指示磁盘上的 OS 支持休眠。

properties.tier
  • string

磁盘的性能层 (,例如 P4、S10) ,如下所述: https://azure.microsoft.com/en-us/pricing/details/managed-disks/ 不适用于超级磁盘。

sku

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

tags
  • object

资源标记

响应

Name Type Description
200 OK

OK

202 Accepted

已接受

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Create or update a bursting enabled managed disk.
Update a managed disk to add accelerated networking.
Update a managed disk to add architecture.
Update a managed disk to add purchase plan.
Update a managed disk to add supportsHibernation.
Update a managed disk to change tier.
Update a managed disk to disable bursting.
Update managed disk to remove disk access resource association.

Create or update a bursting enabled managed disk.

Sample Request

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

{
  "properties": {
    "diskSizeGB": 1024,
    "burstingEnabled": true
  }
}

Sample Response

Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01
{
  "properties": {
    "creationData": {
      "createOption": "Empty"
    },
    "diskSizeGB": 1024,
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myDisk"
}
{
  "properties": {
    "creationData": {
      "createOption": "Empty"
    },
    "diskSizeGB": 1024,
    "burstingEnabled": true,
    "provisioningState": "Succeeded"
  },
  "location": "West US",
  "name": "myDisk"
}

Update a managed disk to add accelerated networking.

Sample Request

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

{
  "properties": {
    "supportedCapabilities": {
      "acceleratedNetwork": false
    }
  }
}

Sample Response

Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01
{
  "name": "myDisk",
  "location": "westus",
  "sku": {
    "name": "Standard_LRS",
    "tier": "Standard"
  },
  "properties": {
    "osType": "Windows",
    "hyperVGeneration": "V1",
    "supportedCapabilities": {
      "acceleratedNetwork": false
    },
    "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": 127,
    "provisioningState": "Updating"
  }
}
{
  "name": "myDisk",
  "location": "westus",
  "sku": {
    "name": "Standard_LRS",
    "tier": "Standard"
  },
  "properties": {
    "osType": "Windows",
    "hyperVGeneration": "V1",
    "supportedCapabilities": {
      "acceleratedNetwork": false
    },
    "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": 127,
    "provisioningState": "Succeeded"
  }
}

Update a managed disk to add architecture.

Sample Request

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

{
  "properties": {
    "supportedCapabilities": {
      "architecture": "Arm64"
    }
  }
}

Sample Response

Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-12-01
{
  "name": "myDisk",
  "location": "westus",
  "sku": {
    "name": "Standard_LRS",
    "tier": "Standard"
  },
  "properties": {
    "osType": "Windows",
    "hyperVGeneration": "V1",
    "supportedCapabilities": {
      "architecture": "Arm64"
    },
    "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": 127,
    "provisioningState": "Updating"
  }
}
{
  "name": "myDisk",
  "location": "westus",
  "sku": {
    "name": "Standard_LRS",
    "tier": "Standard"
  },
  "properties": {
    "osType": "Windows",
    "hyperVGeneration": "V1",
    "supportedCapabilities": {
      "architecture": "Arm64"
    },
    "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": 127,
    "provisioningState": "Succeeded"
  }
}

Update a managed disk to add purchase plan.

Sample Request

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

{
  "properties": {
    "purchasePlan": {
      "name": "myPurchasePlanName",
      "publisher": "myPurchasePlanPublisher",
      "product": "myPurchasePlanProduct",
      "promotionCode": "myPurchasePlanPromotionCode"
    }
  }
}

Sample Response

Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01
{
  "name": "myDisk",
  "location": "westus",
  "sku": {
    "name": "Standard_LRS",
    "tier": "Standard"
  },
  "properties": {
    "osType": "Windows",
    "hyperVGeneration": "V1",
    "purchasePlan": {
      "name": "myPurchasePlanName",
      "publisher": "myPurchasePlanPublisher",
      "product": "myPurchasePlanProduct",
      "promotionCode": "myPurchasePlanPromotionCode"
    },
    "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": 127,
    "provisioningState": "Updating"
  }
}
{
  "name": "myDisk",
  "location": "westus",
  "sku": {
    "name": "Standard_LRS",
    "tier": "Standard"
  },
  "properties": {
    "osType": "Windows",
    "hyperVGeneration": "V1",
    "purchasePlan": {
      "name": "myPurchasePlanName",
      "publisher": "myPurchasePlanPublisher",
      "product": "myPurchasePlanProduct",
      "promotionCode": "myPurchasePlanPromotionCode"
    },
    "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": 127,
    "provisioningState": "Succeeded"
  }
}

Update a managed disk to add supportsHibernation.

Sample Request

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

{
  "properties": {
    "supportsHibernation": true
  }
}

Sample Response

Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01
{
  "name": "myDisk",
  "location": "westus",
  "sku": {
    "name": "Standard_LRS",
    "tier": "Standard"
  },
  "properties": {
    "osType": "Windows",
    "hyperVGeneration": "V1",
    "supportsHibernation": true,
    "creationData": {
      "createOption": "Import",
      "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd"
    },
    "diskSizeGB": 127,
    "provisioningState": "Updating"
  }
}
{
  "name": "myDisk",
  "location": "westus",
  "sku": {
    "name": "Standard_LRS",
    "tier": "Standard"
  },
  "properties": {
    "osType": "Windows",
    "hyperVGeneration": "V1",
    "supportsHibernation": true,
    "creationData": {
      "createOption": "Import",
      "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd"
    },
    "diskSizeGB": 127,
    "provisioningState": "Succeeded"
  }
}

Update a managed disk to change tier.

Sample Request

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

{
  "properties": {
    "tier": "P30"
  }
}

Sample Response

Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01
{
  "properties": {
    "creationData": {
      "createOption": "Empty"
    },
    "provisioningState": "Updating",
    "tier": "P10",
    "propertyUpdatesInProgress": {
      "targetTier": "P30"
    }
  },
  "location": "West US",
  "name": "myDisk"
}
{
  "properties": {
    "creationData": {
      "createOption": "Empty"
    },
    "provisioningState": "Succeeded",
    "tier": "P30"
  },
  "location": "West US",
  "name": "myDisk"
}

Update a managed disk to disable bursting.

Sample Request

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

{
  "properties": {
    "burstingEnabled": false
  }
}

Sample Response

Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01
{
  "properties": {
    "creationData": {
      "createOption": "Empty"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myDisk"
}
{
  "properties": {
    "creationData": {
      "createOption": "Empty"
    },
    "provisioningState": "Succeeded"
  },
  "location": "West US",
  "name": "myDisk"
}

Update managed disk to remove disk access resource association.

Sample Request

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

{
  "properties": {
    "networkAccessPolicy": "AllowAll"
  }
}

Sample Response

Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01
{
  "properties": {
    "creationData": {
      "createOption": "Empty"
    },
    "diskSizeGB": 200,
    "provisioningState": "Updating",
    "networkAccessPolicy": "AllowAll"
  },
  "location": "West US",
  "name": "myDisk"
}
{
  "properties": {
    "creationData": {
      "createOption": "Empty"
    },
    "diskSizeGB": 200,
    "provisioningState": "Succeeded",
    "networkAccessPolicy": "AllowAll"
  },
  "location": "West US",
  "name": "myDisk"
}

定义

Architecture

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

CreationData

创建磁盘时使用的数据。

DataAccessAuthMode

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

Disk

磁盘资源。

DiskCreateOption

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

DiskSecurityProfile

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

DiskSecurityTypes

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

DiskSku

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

DiskState

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

DiskStorageAccountTypes

SKU 名称。

DiskUpdate

磁盘更新资源。

Encryption

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

EncryptionSettingsCollection

磁盘或快照的加密设置

EncryptionSettingsElement

一个磁盘卷的加密设置。

EncryptionType

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

ExtendedLocation

扩展位置的复杂类型。

ExtendedLocationTypes

扩展位置的类型。

HyperVGeneration

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

ImageDiskReference

用于创建磁盘的源映像。

KeyVaultAndKeyReference

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

KeyVaultAndSecretReference

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

NetworkAccessPolicy

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

OperatingSystemTypes

操作系统类型。

PropertyUpdatesInProgress

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

PublicNetworkAccess

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

PurchasePlan

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

ShareInfoElement
SourceVault

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

SupportedCapabilities

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

Architecture

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

Name Type Description
Arm64
  • string
x64
  • string

CreationData

创建磁盘时使用的数据。

Name Type Description
createOption

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

galleryImageReference

从库映像创建时是必需的。 ImageDiskReference 的 ID 将是要从中创建磁盘的共享 galley 映像版本的 ARM ID。

imageReference

磁盘源信息。

logicalSectorSize
  • integer

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

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 字节 35183298347520之间, (VHD 页脚的 32 TiB + 512 字节) 。

DataAccessAuthMode

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

Name Type Description
AzureActiveDirectory
  • string

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

None
  • string

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

Disk

磁盘资源。

Name Type Description
extendedLocation

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

id
  • string

资源 ID

location
  • string

资源位置

managedBy
  • string

一个相对 URI,其中包含附加了磁盘的 VM 的 ID。

managedByExtended
  • string[]

包含附加磁盘的 VM 的 ID 的相对 URI 列表。 maxShares 应设置为大于 1 的值,以便磁盘将其附加到多个 VM。

name
  • string

资源名称

properties.burstingEnabled
  • boolean

设置为 true 以启用超出磁盘预配性能目标的突发。 默认情况下,突发处于禁用状态。 不适用于超级磁盘。

properties.completionPercent
  • number

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

properties.creationData

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

properties.dataAccessAuthMode

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

properties.diskAccessId
  • string

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

properties.diskIOPSReadOnly
  • integer

所有装载共享磁盘的 VM 上将允许的 IOPS 总数作为 ReadOnly 装载。 一个操作可以在 4k 到 256k 字节之间传输。

properties.diskIOPSReadWrite
  • integer

此磁盘允许的 IOPS 数;只能为 UltraSSD 磁盘设置。 一个操作可以在 4k 到 256k 字节之间传输。

properties.diskMBpsReadOnly
  • integer

MBps) 的总吞吐量 (,所有装载共享磁盘的 VM 都允许作为 ReadOnly 装载。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法,幂为 10。

properties.diskMBpsReadWrite
  • integer

此磁盘允许的带宽;只能为 UltraSSD 磁盘设置。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法,幂为 10。

properties.diskSizeBytes
  • integer

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

properties.diskSizeGB
  • integer

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

properties.diskState

磁盘的状态。

properties.encryption

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

properties.encryptionSettingsCollection

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

properties.hyperVGeneration

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

properties.maxShares
  • integer

可以同时附加到磁盘的最大 VM 数。 大于一个值表示可以同时装载在多个 VM 上的磁盘。

properties.networkAccessPolicy

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

properties.osType

操作系统类型。

properties.propertyUpdatesInProgress

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

properties.provisioningState
  • string

磁盘预配状态。

properties.publicNetworkAccess

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

properties.purchasePlan

创建 OS 磁盘的映像的购买计划信息。 例如 - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

properties.securityProfile

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

properties.shareInfo

附加磁盘的所有 VM 的列表的详细信息。 maxShares 应设置为大于 1 的值,以便磁盘将其附加到多个 VM。

properties.supportedCapabilities

创建 OS 磁盘的映像支持的功能的列表。

properties.supportsHibernation
  • boolean

指示磁盘上的 OS 支持休眠。

properties.tier
  • string

磁盘的性能层 (,例如 P4、S10) ,如下所述: https://azure.microsoft.com/en-us/pricing/details/managed-disks/ 不适用于超级磁盘。

properties.timeCreated
  • string

创建磁盘的时间。

properties.uniqueId
  • string

标识资源的唯一 Guid。

sku

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

tags
  • object

资源标记

type
  • string

资源类型

zones
  • string[]

磁盘的逻辑区域列表。

DiskCreateOption

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

Name Type Description
Attach
  • string

磁盘将附加到 VM。

Copy
  • string

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

CopyStart
  • string

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

Empty
  • string

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

FromImage
  • string

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

Import
  • string

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

ImportSecure
  • string

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

Restore
  • string

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

Upload
  • string

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

UploadPreparedSecure
  • string

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

DiskSecurityProfile

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

Name Type Description
secureVMDiskEncryptionSetId
  • string

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

securityType

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

DiskSecurityTypes

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

Name Type Description
ConfidentialVM_DiskEncryptedWithCustomerKey
  • string

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

ConfidentialVM_DiskEncryptedWithPlatformKey
  • string

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

ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey
  • string

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

TrustedLaunch
  • string

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

DiskSku

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

Name Type Description
name

SKU 名称。

tier
  • string

SKU 层。

DiskState

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

Name Type Description
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。

DiskStorageAccountTypes

SKU 名称。

Name Type Description
Premium_LRS
  • string

高级 SSD,本地冗余存储。 最适合生产和性能敏感的工作负载。

Premium_ZRS
  • string

高级版 SSD 区域冗余存储。 最适合需要针对区域故障进行存储复原的生产工作负荷。

StandardSSD_LRS
  • string

标准 SSD,本地冗余存储。 最适合 Web 服务器、很少使用的企业应用程序和开发/测试。

StandardSSD_ZRS
  • string

标准 SSD 区域冗余存储。 最适合 Web 服务器,使用较轻的企业应用程序和开发/测试,这些应用程序和开发/测试需要针对区域故障进行存储复原。

Standard_LRS
  • string

标准 HDD,本地冗余存储。 最适合备份、非关键和不频繁的访问。

UltraSSD_LRS
  • string

超级 SSD 本地冗余存储。 最适合 IO 密集型工作负荷,例如SAP HANA、顶级数据库 (,例如SQL、Oracle) 和其他事务密集型工作负荷。

DiskUpdate

磁盘更新资源。

Name Type Description
properties.burstingEnabled
  • boolean

设置为 true 以启用超出磁盘预配性能目标的突发。 默认情况下,突发处于禁用状态。 不适用于超级磁盘。

properties.dataAccessAuthMode

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

properties.diskAccessId
  • string

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

properties.diskIOPSReadOnly
  • integer

所有装载共享磁盘的 VM 上将允许的 IOPS 总数作为 ReadOnly 装载。 一个操作可以在 4k 到 256k 字节之间传输。

properties.diskIOPSReadWrite
  • integer

此磁盘允许的 IOPS 数;只能为 UltraSSD 磁盘设置。 一个操作可以在 4k 到 256k 字节之间传输。

properties.diskMBpsReadOnly
  • integer

MBps) 的总吞吐量 (,所有装载共享磁盘的 VM 都允许作为 ReadOnly 装载。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法,幂为 10。

properties.diskMBpsReadWrite
  • integer

此磁盘允许的带宽;只能为 UltraSSD 磁盘设置。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法,幂为 10。

properties.diskSizeGB
  • integer

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

properties.encryption

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

properties.encryptionSettingsCollection

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

properties.maxShares
  • integer

可以同时附加到磁盘的最大 VM 数。 大于一个值表示可以同时装载在多个 VM 上的磁盘。

properties.networkAccessPolicy

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

properties.osType

操作系统类型。

properties.propertyUpdatesInProgress

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

properties.publicNetworkAccess

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

properties.purchasePlan

要添加到 OS 磁盘上的购买计划信息

properties.supportedCapabilities

要添加到 OS 磁盘上支持的功能列表。

properties.supportsHibernation
  • boolean

指示磁盘上的 OS 支持休眠。

properties.tier
  • string

磁盘的性能层 (,例如 P4、S10) ,如下所述: https://azure.microsoft.com/en-us/pricing/details/managed-disks/ 不适用于超级磁盘。

sku

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

tags
  • object

资源标记

Encryption

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

Name Type Description
diskEncryptionSetId
  • string

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

type

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

EncryptionSettingsCollection

磁盘或快照的加密设置

Name Type Description
enabled
  • boolean

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

encryptionSettings

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

encryptionSettingsVersion
  • string

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

EncryptionSettingsElement

一个磁盘卷的加密设置。

Name Type Description
diskEncryptionKey

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

keyEncryptionKey

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

EncryptionType

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

Name Type Description
EncryptionAtRestWithCustomerKey
  • string

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

EncryptionAtRestWithPlatformAndCustomerKeys
  • string

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

EncryptionAtRestWithPlatformKey
  • string

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

ExtendedLocation

扩展位置的复杂类型。

Name Type Description
name
  • string

扩展位置的名称。

type

扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

Name Type Description
EdgeZone
  • string

HyperVGeneration

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

Name Type Description
V1
  • string
V2
  • string

ImageDiskReference

用于创建磁盘的源映像。

Name Type Description
id
  • string

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

lun
  • integer

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

KeyVaultAndKeyReference

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

Name Type Description
keyUrl
  • string

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

sourceVault

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

KeyVaultAndSecretReference

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

Name Type Description
secretUrl
  • string

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

sourceVault

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

NetworkAccessPolicy

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

Name Type Description
AllowAll
  • string

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

AllowPrivate
  • string

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

DenyAll
  • string

无法导出磁盘。

OperatingSystemTypes

操作系统类型。

Name Type Description
Linux
  • string
Windows
  • string

PropertyUpdatesInProgress

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

Name Type Description
targetTier
  • string

如果正在进行层更改操作,则磁盘的目标性能层。

PublicNetworkAccess

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

Name Type Description
Disabled
  • string

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

Enabled
  • string

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

PurchasePlan

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

Name Type Description
name
  • string

计划 ID。

product
  • string

从市场指定映像的产品。 此值与 imageReference 元素下的 Offer 相同。

promotionCode
  • string

产品/服务促销代码。

publisher
  • string

发布者 ID。

ShareInfoElement

Name Type Description
vmUri
  • string

一个相对 URI,其中包含附加了磁盘的 VM 的 ID。

SourceVault

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

Name Type Description
id
  • string

资源 ID

SupportedCapabilities

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

Name Type Description
acceleratedNetwork
  • boolean

如此 如果从中创建 OS 磁盘的映像支持加速网络。

architecture

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