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

Restore Points - Get

获取还原点的操作。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}?api-version=2024-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}?$expand=instanceView&api-version=2024-03-01

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。

restorePointCollectionName
path True

string

还原点集合的名称。

restorePointName
path True

string

还原点的名称。

subscriptionId
path True

string

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

api-version
query True

string

客户端 API 版本。

$expand
query

RestorePointExpandOptions

要应用于操作的 expand 表达式。 “InstanceView”检索有关还原点的运行时状态的信息。

响应

名称 类型 说明
200 OK

RestorePoint

确定

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Get a restore point
Get restore point with instance view

Get a restore point

示例请求

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?$expand=instanceView&api-version=2024-03-01

示例响应

{
  "name": "rpName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
  "properties": {
    "excludeDisks": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f"
      }
    ],
    "sourceMetadata": {
      "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
      "hardwareProfile": {
        "vmSize": "Standard_B1s"
      },
      "storageProfile": {
        "osDisk": {
          "osType": "Windows",
          "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
          },
          "diskRestorePoint": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
          }
        },
        "dataDisks": [
          {
            "lun": 1,
            "name": "testingexcludedisk_DataDisk_1",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"
            },
            "diskRestorePoint": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"
            }
          }
        ],
        "diskControllerType": "NVMe"
      },
      "osProfile": {
        "computerName": "computerName",
        "adminUsername": "admin",
        "windowsConfiguration": {
          "provisionVMAgent": true,
          "enableAutomaticUpdates": true
        },
        "secrets": [],
        "allowExtensionOperations": true,
        "requireGuestProvisionSignal": true
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": true
        }
      },
      "location": "westus"
    },
    "provisioningState": "Succeeded",
    "consistencyMode": "ApplicationConsistent",
    "timeCreated": "2021-01-27T20:35:05.8401519+00:00"
  }
}

Get restore point with instance view

示例请求

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?$expand=instanceView&api-version=2024-03-01

示例响应

{
  "name": "rpName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
  "properties": {
    "excludeDisks": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f"
      }
    ],
    "sourceMetadata": {
      "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
      "hardwareProfile": {
        "vmSize": "Standard_B1s"
      },
      "storageProfile": {
        "osDisk": {
          "osType": "Windows",
          "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
          },
          "diskRestorePoint": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
          }
        },
        "dataDisks": [
          {
            "lun": 1,
            "name": "testingexcludedisk_DataDisk_1",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"
            },
            "diskRestorePoint": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"
            }
          }
        ],
        "diskControllerType": "NVMe"
      },
      "osProfile": {
        "computerName": "computerName",
        "adminUsername": "admin",
        "windowsConfiguration": {
          "provisionVMAgent": true,
          "enableAutomaticUpdates": true
        },
        "secrets": [],
        "allowExtensionOperations": true,
        "requireGuestProvisionSignal": true
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": true
        }
      },
      "location": "westus"
    },
    "provisioningState": "Succeeded",
    "consistencyMode": "ApplicationConsistent",
    "timeCreated": "2021-01-27T20:35:05.8401519+00:00",
    "instanceView": {
      "diskRestorePoints": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57",
          "replicationStatus": {
            "status": {
              "code": "ReplicationState/succeeded",
              "level": "Info",
              "displayStatus": "Succeeded"
            },
            "completionPercent": 100
          }
        },
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5",
          "replicationStatus": {
            "status": {
              "code": "ReplicationState/succeeded",
              "level": "Info",
              "displayStatus": "Succeeded"
            },
            "completionPercent": 100
          }
        }
      ],
      "statuses": [
        {
          "code": "ReplicationState/succeeded",
          "level": "Info",
          "displayStatus": "Succeeded"
        }
      ]
    }
  }
}

定义

名称 说明
AdditionalUnattendContent

指定可包含在 Windows 安装程序使用的 Unattend.xml 文件中的其他 XML 格式信息。 内容通过设置名称、组件名称和应用内容的传递来定义。

ApiEntityReference

API 实体引用。

ApiError

Api 错误。

ApiErrorBase

Api 错误基。

BootDiagnostics

启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图以诊断 VM 状态。 可以轻松查看控制台日志的输出。 Azure 还使你能够查看虚拟机监控程序中 VM 的屏幕截图。

CachingTypes

获取缓存类型。

CloudError

来自计算服务的错误响应。

ComponentNames

组件名称。 目前,唯一允许的值是 Microsoft-Windows-Shell-Setup。

ConsistencyModeTypes

RestorePoint 的 ConsistencyMode。 可以在创建还原点时在输入中指定。 目前,仅接受 CrashConsistent 作为有效输入。 有关更多详细信息,请参阅 https://aka.ms/RestorePoints

DiagnosticsProfile

指定启动诊断设置状态。 最低 API 版本:2015-06-15。

DiskControllerTypes

获取在创建还原点时捕获的 VM 的磁盘控制器类型。

DiskEncryptionSetParameters

介绍可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意: 只能为托管磁盘指定磁盘加密集资源 ID。 有关详细信息,请参阅 https://aka.ms/mdssewithcmkoverview

DiskEncryptionSettings

介绍磁盘的加密设置

DiskRestorePointAttributes

磁盘还原点详细信息。

DiskRestorePointInstanceView

磁盘还原点的实例视图。

DiskRestorePointReplicationStatus

磁盘还原点的实例视图。

EncryptionIdentity

指定 ADE 用于获取密钥保管库操作的访问令牌的托管标识。

HardwareProfile

指定虚拟机的硬件设置。

HyperVGenerationTypes

为其捕获还原点的源 VM 的 HyperV 生成。

InnerError

内部错误详细信息。

InstanceViewStatus

实例视图状态。

KeyVaultKeyReference

描述对 密钥保管库 密钥的引用

KeyVaultSecretReference

描述对密钥保管库机密的引用

LinuxConfiguration

指定虚拟机上的 Linux 操作系统设置。 有关支持的 Linux 分发版的列表,请参阅 Linux on Azure-Endorsed Distributions

LinuxPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间安排。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

LinuxPatchSettings

指定与 Linux 上的 VM 来宾修补相关的设置。

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

LinuxVMGuestPatchAutomaticByPlatformSettings

指定在 Linux 修补程序设置中选择修补模式 AutomaticByPlatform 时要应用的其他设置。

LinuxVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,其中 OrchestrationMode 为灵活。

可能的值为:

ImageDefault - 使用虚拟机的默认修补配置。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 必须为 true

ManagedDiskParameters

托管磁盘的参数。

Mode

指定启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不会在审核模式下对主机终结点的请求强制实施访问控制,而在“强制”模式下,将强制实施访问控制。 默认值为“强制模式”。

OperatingSystemType

获取操作系统类型。

OSProfile

指定虚拟机的操作系统设置。 预配 VM 后,无法更改某些设置。

PassNames

传递名称。 目前,唯一允许的值是 OobeSystem。

PatchSettings

指定与 Windows 上的 VM 来宾修补相关的设置。

ProtocolTypes

指定 WinRM 侦听器的协议。 可能的值为: http、https。

ProxyAgentSettings

指定创建虚拟机时的 ProxyAgent 设置。 最低 API 版本:2024-03-01。

RestorePoint

还原点详细信息。

RestorePointEncryption

磁盘还原点的静态加密设置。 它是一个可选属性,可以在创建还原点时在输入中指定。

RestorePointEncryptionType

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

RestorePointExpandOptions

要应用于操作的 expand 表达式。 “InstanceView”检索有关还原点的运行时状态的信息。

RestorePointInstanceView

还原点的实例视图。

RestorePointSourceMetadata

描述为其创建了还原点的虚拟机的属性。 提供的属性是创建还原点时捕获的整体虚拟机属性的子集和快照。

RestorePointSourceVMDataDisk

描述数据磁盘。

RestorePointSourceVMOSDisk

介绍操作系统磁盘。

RestorePointSourceVMStorageProfile

描述存储配置文件。

securityEncryptionTypes

指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState 以加密托管磁盘和 VMGuestState blob,VMGuestStateOnly 仅加密 VMGuestState blob,设置为 NonPersistedTPM 以不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。

SecurityProfile

指定虚拟机或虚拟机规模集的安全配置文件设置。

SecurityTypes

指定虚拟机的 SecurityType。 必须将其设置为任何指定的值才能启用 UefiSettings。 默认行为为:除非设置了此属性,否则不会启用 UefiSettings。

SettingNames

指定内容适用于的设置的名称。 可能的值为:FirstLogonCommands 和 AutoLogon。

SshConfiguration

Azure 上运行的基于 Linux 的 VM 的 SSH 配置

SshPublicKey

包含有关 SSH 证书公钥以及放置公钥的 Linux VM 上的路径的信息。

StatusLevelTypes

级别代码。

StorageAccountTypes

指定托管磁盘的存储帐户类型。 注意:UltraSSD_LRS只能与数据磁盘一起使用,它不能与 OS 磁盘一起使用。

SubResource
UefiSettings

指定创建虚拟机时使用的安全启动和 vTPM 等安全设置。 最低 API 版本:2020-12-01。

VaultCertificate

描述密钥保管库中的单个证书引用,以及证书应在 VM 上驻留的位置。

VaultSecretGroup

描述一组证书,这些证书全部位于同一密钥保管库中。

VirtualMachineSizeTypes

指定虚拟机的大小。 枚举数据类型当前已弃用,将于 2023 年 12 月 23 日删除。 获取可用大小列表的建议方法是使用以下 API: 列出可用性集中的所有可用虚拟机大小列出区域中所有可用虚拟机大小列出所有可用虚拟机大小以调整大小。 有关虚拟机大小的详细信息,请参阅 虚拟机的大小。 可用的 VM 大小取决于区域和可用性集。

VMDiskSecurityProfile

指定托管磁盘的安全配置文件设置。 注意: 只能为机密 VM 设置它。

VMSizeProperties

指定虚拟机上的 VM 大小属性设置。

WindowsConfiguration

指定虚拟机上的 Windows 操作系统设置。

WindowsPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间安排。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

WindowsVMGuestPatchAutomaticByPlatformSettings

指定在 Windows 修补程序设置中选择修补模式 AutomaticByPlatform 时要应用的其他设置。

WindowsVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,其中 OrchestrationMode 为灵活。

可能的值为:

手动 - 控制将修补程序应用到虚拟机。 为此,可以在 VM 中手动应用修补程序。 在此模式下,自动更新处于禁用状态;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false

AutomaticByOS - 操作系统会自动更新虚拟机。 属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true

WinRMConfiguration

介绍 VM 的 Windows 远程管理配置

WinRMListener

介绍 Windows 远程管理侦听器的协议和指纹

AdditionalUnattendContent

指定可包含在 Windows 安装程序使用的 Unattend.xml 文件中的其他 XML 格式信息。 内容通过设置名称、组件名称和应用内容的传递来定义。

名称 类型 说明
componentName

ComponentNames

组件名称。 目前,唯一允许的值是 Microsoft-Windows-Shell-Setup。

content

string

指定添加到指定路径和组件的 unattend.xml 文件的 XML 格式化内容。 XML 必须小于 4KB,并且必须包含要插入的设置或功能的根元素。

passName

PassNames

传递名称。 目前,唯一允许的值是 OobeSystem。

settingName

SettingNames

指定内容适用于的设置的名称。 可能的值为:FirstLogonCommands 和 AutoLogon。

ApiEntityReference

API 实体引用。

名称 类型 说明
id

string

采用 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 资源 ID。

ApiError

Api 错误。

名称 类型 说明
code

string

错误代码。

details

ApiErrorBase[]

Api 错误详细信息

innererror

InnerError

Api 内部错误

message

string

错误消息。

target

string

特定错误的目标。

ApiErrorBase

Api 错误基。

名称 类型 说明
code

string

错误代码。

message

string

错误消息。

target

string

特定错误的目标。

BootDiagnostics

启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图以诊断 VM 状态。 可以轻松查看控制台日志的输出。 Azure 还使你能够查看虚拟机监控程序中 VM 的屏幕截图。

名称 类型 说明
enabled

boolean

是否应在虚拟机上启用启动诊断。

storageUri

string

用于放置控制台输出和屏幕截图的存储帐户的 URI。 如果在启用启动诊断时未指定 storageUri,则将使用托管存储。

CachingTypes

获取缓存类型。

名称 类型 说明
None

string

ReadOnly

string

ReadWrite

string

CloudError

来自计算服务的错误响应。

名称 类型 说明
error

ApiError

Api 错误。

ComponentNames

组件名称。 目前,唯一允许的值是 Microsoft-Windows-Shell-Setup。

名称 类型 说明
Microsoft-Windows-Shell-Setup

string

ConsistencyModeTypes

RestorePoint 的 ConsistencyMode。 可以在创建还原点时在输入中指定。 目前,仅接受 CrashConsistent 作为有效输入。 有关更多详细信息,请参阅 https://aka.ms/RestorePoints

名称 类型 说明
ApplicationConsistent

string

CrashConsistent

string

FileSystemConsistent

string

DiagnosticsProfile

指定启动诊断设置状态。 最低 API 版本:2015-06-15。

名称 类型 说明
bootDiagnostics

BootDiagnostics

启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图以诊断 VM 状态。 注意:如果指定 storageUri,请确保存储帐户与 VM 位于同一区域和订阅中。 可以轻松查看控制台日志的输出。 Azure 还使你能够查看虚拟机监控程序中 VM 的屏幕截图。

DiskControllerTypes

获取在创建还原点时捕获的 VM 的磁盘控制器类型。

名称 类型 说明
NVMe

string

SCSI

string

DiskEncryptionSetParameters

介绍可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意: 只能为托管磁盘指定磁盘加密集资源 ID。 有关详细信息,请参阅 https://aka.ms/mdssewithcmkoverview

名称 类型 说明
id

string

资源 ID

DiskEncryptionSettings

介绍磁盘的加密设置

名称 类型 说明
diskEncryptionKey

KeyVaultSecretReference

指定磁盘加密密钥的位置,这是密钥保管库机密。

enabled

boolean

指定是否应在虚拟机上启用磁盘加密。

keyEncryptionKey

KeyVaultKeyReference

指定密钥加密密钥在 密钥保管库 中的位置。

DiskRestorePointAttributes

磁盘还原点详细信息。

名称 类型 说明
encryption

RestorePointEncryption

磁盘还原点的静态加密设置。 它是一个可选属性,可以在创建还原点时在输入中指定。

id

string

资源 ID

sourceDiskRestorePoint

ApiEntityReference

源磁盘还原点的资源 ID。

DiskRestorePointInstanceView

磁盘还原点的实例视图。

名称 类型 说明
id

string

磁盘还原点 ID。

replicationStatus

DiskRestorePointReplicationStatus

磁盘还原点复制状态信息。

DiskRestorePointReplicationStatus

磁盘还原点的实例视图。

名称 类型 说明
completionPercent

integer

复制完成百分比。

status

InstanceViewStatus

资源状态信息。

EncryptionIdentity

指定 ADE 用于获取密钥保管库操作的访问令牌的托管标识。

名称 类型 说明
userAssignedIdentityResourceId

string

指定与 VM 关联的用户标识之一的 ARM 资源 ID。

HardwareProfile

指定虚拟机的硬件设置。

名称 类型 说明
vmSize

VirtualMachineSizeTypes

指定虚拟机的大小。 枚举数据类型当前已弃用,将于 2023 年 12 月 23 日删除。 获取可用大小列表的建议方法是使用以下 API: 列出可用性集中的所有可用虚拟机大小列出区域中所有可用虚拟机大小列出所有可用虚拟机大小以调整大小。 有关虚拟机大小的详细信息,请参阅 虚拟机的大小。 可用的 VM 大小取决于区域和可用性集。

vmSizeProperties

VMSizeProperties

指定用于自定义虚拟机大小的属性。 最低 API 版本:2021-07-01。 此功能仍处于预览模式,VirtualMachineScaleSet 不支持此功能。 有关更多详细信息,请按照 VM 自定义 中的说明进行操作。

HyperVGenerationTypes

为其捕获还原点的源 VM 的 HyperV 生成。

名称 类型 说明
V1

string

V2

string

InnerError

内部错误详细信息。

名称 类型 说明
errordetail

string

内部错误消息或异常转储。

exceptiontype

string

异常类型。

InstanceViewStatus

实例视图状态。

名称 类型 说明
code

string

状态代码。

displayStatus

string

状态的简短可本地化标签。

level

StatusLevelTypes

级别代码。

message

string

详细状态消息,包括警报和错误消息。

time

string

状态的时间。

KeyVaultKeyReference

描述对 密钥保管库 密钥的引用

名称 类型 说明
keyUrl

string

引用 密钥保管库 中密钥加密密钥的 URL。

sourceVault

SubResource

包含密钥的密钥保管库的相对 URL。

KeyVaultSecretReference

描述对密钥保管库机密的引用

名称 类型 说明
secretUrl

string

引用密钥保管库中的机密的 URL。

sourceVault

SubResource

包含机密的密钥保管库的相对 URL。

LinuxConfiguration

指定虚拟机上的 Linux 操作系统设置。 有关支持的 Linux 分发版的列表,请参阅 Linux on Azure-Endorsed Distributions

名称 类型 说明
disablePasswordAuthentication

boolean

指定是否应禁用密码身份验证。

enableVMAgentPlatformUpdates

boolean

指示是否为 Linux 虚拟机启用 VMAgent Platform 汇报。 默认值为 false。

patchSettings

LinuxPatchSettings

[预览功能]指定与 Linux 上的 VM 来宾修补相关的设置。

provisionVMAgent

boolean

指示是否应在虚拟机上设置虚拟机代理。 如果未在请求正文中指定此属性,则默认行为是将其设置为 true。 这将确保 VM 代理安装在 VM 上,以便以后可以向 VM 添加扩展。

ssh

SshConfiguration

指定 Linux OS 的 SSH 密钥配置。

LinuxPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间安排。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

名称 类型 说明
AutomaticByPlatform

string

ImageDefault

string

LinuxPatchSettings

指定与 Linux 上的 VM 来宾修补相关的设置。

名称 类型 说明
assessmentMode

LinuxPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间安排。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

automaticByPlatformSettings

LinuxVMGuestPatchAutomaticByPlatformSettings

指定 Linux 上的 VM 来宾修补中的修补模式 AutomaticByPlatform 的其他设置。

patchMode

LinuxVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,其中 OrchestrationMode 为灵活。

可能的值为:

ImageDefault - 使用虚拟机的默认修补配置。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 必须为 true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

名称 类型 说明
Always

string

IfRequired

string

Never

string

Unknown

string

LinuxVMGuestPatchAutomaticByPlatformSettings

指定在 Linux 修补程序设置中选择修补模式 AutomaticByPlatform 时要应用的其他设置。

名称 类型 说明
bypassPlatformSafetyChecksOnUserSchedule

boolean

使客户能够计划修补,而无需意外升级

rebootSetting

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

LinuxVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,其中 OrchestrationMode 为灵活。

可能的值为:

ImageDefault - 使用虚拟机的默认修补配置。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 必须为 true

名称 类型 说明
AutomaticByPlatform

string

ImageDefault

string

ManagedDiskParameters

托管磁盘的参数。

名称 类型 说明
diskEncryptionSet

DiskEncryptionSetParameters

指定托管磁盘的客户托管磁盘加密集资源 ID。

id

string

资源 ID

securityProfile

VMDiskSecurityProfile

指定托管磁盘的安全配置文件。

storageAccountType

StorageAccountTypes

指定托管磁盘的存储帐户类型。 注意:UltraSSD_LRS只能与数据磁盘一起使用,它不能与 OS 磁盘一起使用。

Mode

指定启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不会在审核模式下对主机终结点的请求强制实施访问控制,而在“强制”模式下,将强制实施访问控制。 默认值为“强制模式”。

名称 类型 说明
Audit

string

Enforce

string

OperatingSystemType

获取操作系统类型。

名称 类型 说明
Linux

string

Windows

string

OSProfile

指定虚拟机的操作系统设置。 预配 VM 后,无法更改某些设置。

名称 类型 说明
adminPassword

string

指定管理员帐户的密码。

Windows) 最小长度 (: 8 个字符

Linux) 最小长度 (: 6 个字符

最大长度 (Windows) : 123 个字符

Linux) 最大 (长度: 72 个字符

复杂性要求: 需要满足以下 4 个条件中的 3 个
包含较低的字符
包含大写字符
具有数字
具有特殊字符 (正则表达式匹配 [\W_])

不允许的值: “abc@123”、“P@$$w 0rd”、“P@ssw0rd”、“P@ssword123”、“Pa$$word”、“pass@word1”、“Password!”、“Password1”、“Password22”、“iloveyou!”

有关重置密码的信息,请参阅 如何在 Windows VM 中重置远程桌面服务或其登录密码

有关重置根密码,请参阅使用 VMAccess 扩展管理 Azure Linux VM 上的用户、SSH 和检查或修复磁盘

adminUsername

string

指定管理员帐户的名称。

创建 VM 后,无法更新此属性。

仅限 Windows 的限制: 不能以“.”结尾

不允许的值: “administrator”、“admin”、“user”、“user1”、“test”、“user2”、“test1”、“user3”、“admin1”、“1”, “123”、“a”、“actuser”、“adm”、“admin2”、“aspnet”、“backup”、“console”、“david”、“guest”、“john”、“owner”、“root”、“server”、“support”、“support_388945a0”、“sys”、“test2”、“test3”、“user4”、“user5”。

Linux) (最小长度: 1 个字符

最大长度 (Linux) : 64 个字符

Windows) (最大长度: 20 个字符。

allowExtensionOperations

boolean

指定是否应在虚拟机上允许扩展操作。 仅当虚拟机上没有扩展时,才能将其设置为 False。

computerName

string

指定虚拟机的主机 OS 名称。 创建 VM 后,无法更新此名称。 Windows) (最大长度: 15 个字符。 Linux) 最大 (长度: 64 个字符。 有关命名约定和限制,请参阅 Azure 基础结构服务实现指南

customData

string

指定自定义数据的 Base-64 编码的字符串。 Base-64 编码的字符串将解码为一个二元数组并作为一个文件保存在虚拟机上。 该二元数组的最大长度为 65535 字节。 注意:请勿在 customData 属性中传递任何机密或密码。 创建 VM 后,无法更新此属性。 属性“customData”将传递给 VM 以保存为文件,有关详细信息,请参阅 Azure VM 上的自定义数据。 有关对 Linux VM 使用 cloud-init,请参阅 在创建期间使用 cloud-init 自定义 Linux VM

linuxConfiguration

LinuxConfiguration

指定虚拟机上的 Linux 操作系统设置。 有关支持的 Linux 分发版的列表,请参阅 Linux on Azure-Endorsed Distributions

requireGuestProvisionSignal

boolean

必须设置为 True 或省略的可选属性。

secrets

VaultSecretGroup[]

指定应安装在虚拟机上的证书集。 若要在虚拟机上安装证书,建议使用适用于 Linux 的 Azure 密钥保管库 虚拟机扩展适用于 Windows 的 Azure 密钥保管库 虚拟机扩展

windowsConfiguration

WindowsConfiguration

指定虚拟机上的 Windows 操作系统设置。

PassNames

传递名称。 目前,唯一允许的值是 OobeSystem。

名称 类型 说明
OobeSystem

string

PatchSettings

指定与 Windows 上的 VM 来宾修补相关的设置。

名称 类型 说明
assessmentMode

WindowsPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间安排。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

automaticByPlatformSettings

WindowsVMGuestPatchAutomaticByPlatformSettings

指定 Windows 上的 VM 来宾修补中的修补模式 AutomaticByPlatform 的其他设置。

enableHotpatching

boolean

使客户无需重新启动即可修补其 Azure VM。 对于 enableHotpatching,必须将“provisionVMAgent”设置为 true,“patchMode”必须设置为“AutomaticByPlatform”。

patchMode

WindowsVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,其中 OrchestrationMode 为灵活。

可能的值为:

手动 - 控制将修补程序应用到虚拟机。 为此,可以在 VM 中手动应用修补程序。 在此模式下,自动更新处于禁用状态;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false

AutomaticByOS - 操作系统会自动更新虚拟机。 属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true

ProtocolTypes

指定 WinRM 侦听器的协议。 可能的值为: http、https。

名称 类型 说明
Http

string

Https

string

ProxyAgentSettings

指定创建虚拟机时的 ProxyAgent 设置。 最低 API 版本:2024-03-01。

名称 类型 说明
enabled

boolean

指定是在虚拟机规模集还是虚拟机规模集上启用 ProxyAgent 功能。

keyIncarnationId

integer

增加此属性的值允许用户重置用于保护来宾和主机之间的信道的密钥。

mode

Mode

指定启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不会在审核模式下对主机终结点的请求强制实施访问控制,而在“强制”模式下,将强制实施访问控制。 默认值为“强制模式”。

RestorePoint

还原点详细信息。

名称 类型 说明
id

string

资源 ID

name

string

资源名称

properties.consistencyMode

ConsistencyModeTypes

RestorePoint 的 ConsistencyMode。 可以在创建还原点时在输入中指定。 目前,仅接受 CrashConsistent 作为有效输入。 有关更多详细信息,请参阅 https://aka.ms/RestorePoints

properties.excludeDisks

ApiEntityReference[]

客户希望从还原点中排除的磁盘资源 ID 的列表。 如果未指定磁盘,则将包含所有磁盘。

properties.instanceView

RestorePointInstanceView

还原点实例视图。

properties.provisioningState

string

获取还原点的预配状态。

properties.sourceMetadata

RestorePointSourceMetadata

获取在创建还原点时捕获的 VM 的详细信息。

properties.sourceRestorePoint

ApiEntityReference

需要从中创建副本的源还原点的资源 ID。

properties.timeCreated

string

获取还原点的创建时间。

type

string

资源类型

RestorePointEncryption

磁盘还原点的静态加密设置。 它是一个可选属性,可以在创建还原点时在输入中指定。

名称 类型 说明
diskEncryptionSet

DiskEncryptionSetParameters

介绍可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意: 只能为托管磁盘指定磁盘加密集资源 ID。 有关详细信息,请参阅 https://aka.ms/mdssewithcmkoverview

type

RestorePointEncryptionType

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

RestorePointEncryptionType

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

名称 类型 说明
EncryptionAtRestWithCustomerKey

string

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

EncryptionAtRestWithPlatformAndCustomerKeys

string

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

EncryptionAtRestWithPlatformKey

string

磁盘还原点使用平台管理的密钥进行静态加密。

RestorePointExpandOptions

要应用于操作的 expand 表达式。 “InstanceView”检索有关还原点的运行时状态的信息。

名称 类型 说明
instanceView

string

RestorePointInstanceView

还原点的实例视图。

名称 类型 说明
diskRestorePoints

DiskRestorePointInstanceView[]

磁盘还原点信息。

statuses

InstanceViewStatus[]

资源状态信息。

RestorePointSourceMetadata

描述为其创建了还原点的虚拟机的属性。 提供的属性是创建还原点时捕获的整体虚拟机属性的子集和快照。

名称 类型 说明
diagnosticsProfile

DiagnosticsProfile

获取诊断配置文件。

hardwareProfile

HardwareProfile

获取硬件配置文件。

hyperVGeneration

HyperVGenerationTypes

为其捕获还原点的源 VM 的 HyperV 生成。

licenseType

string

获取许可证类型,该类型用于自带许可证方案。

location

string

从中创建还原点的 VM 的位置。

osProfile

OSProfile

获取 OS 配置文件。

securityProfile

SecurityProfile

获取安全配置文件。

storageProfile

RestorePointSourceVMStorageProfile

获取存储配置文件。

userData

string

与捕获还原点的源 VM 关联的 UserData,这是一个 base-64 编码值。

vmId

string

获取虚拟机唯一 ID。

RestorePointSourceVMDataDisk

描述数据磁盘。

名称 类型 说明
caching

CachingTypes

获取缓存类型。

diskRestorePoint

DiskRestorePointAttributes

包含磁盘还原点属性。

diskSizeGB

integer

获取空白数据磁盘的初始磁盘大小(以 GB 为单位),以及现有 OS 和数据磁盘的新所需大小。

lun

integer

获取逻辑单元号。

managedDisk

ManagedDiskParameters

包含托管磁盘详细信息。

name

string

获取磁盘名称。

writeAcceleratorEnabled

boolean

如果磁盘已启用写入加速器,则显示 true。

RestorePointSourceVMOSDisk

介绍操作系统磁盘。

名称 类型 说明
caching

CachingTypes

获取缓存类型。

diskRestorePoint

DiskRestorePointAttributes

包含磁盘还原点属性。

diskSizeGB

integer

获取磁盘大小(以 GB 为单位)。

encryptionSettings

DiskEncryptionSettings

获取磁盘加密设置。

managedDisk

ManagedDiskParameters

获取托管磁盘详细信息

name

string

获取磁盘名称。

osType

OperatingSystemType

获取操作系统类型。

writeAcceleratorEnabled

boolean

如果磁盘已启用写入加速器,则显示 true。

RestorePointSourceVMStorageProfile

描述存储配置文件。

名称 类型 说明
dataDisks

RestorePointSourceVMDataDisk[]

获取创建还原点时捕获的 VM 的数据磁盘。

diskControllerType

DiskControllerTypes

获取在创建还原点时捕获的 VM 的磁盘控制器类型。

osDisk

RestorePointSourceVMOSDisk

获取在创建还原点时捕获的 VM 的 OS 磁盘。

securityEncryptionTypes

指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState 以加密托管磁盘和 VMGuestState blob,VMGuestStateOnly 仅加密 VMGuestState blob,设置为 NonPersistedTPM 以不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。

名称 类型 说明
DiskWithVMGuestState

string

NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

指定虚拟机或虚拟机规模集的安全配置文件设置。

名称 类型 说明
encryptionAtHost

boolean

用户可以在请求中使用此属性来启用或禁用虚拟机或虚拟机规模集的主机加密。 这将为所有磁盘启用加密,包括主机本身的资源/临时磁盘。 默认行为为:除非资源的此属性设置为 true,否则将禁用主机上的加密。

encryptionIdentity

EncryptionIdentity

指定 ADE 用于获取密钥保管库操作的访问令牌的托管标识。

proxyAgentSettings

ProxyAgentSettings

指定创建虚拟机时的 ProxyAgent 设置。 最低 API 版本:2024-03-01。

securityType

SecurityTypes

指定虚拟机的 SecurityType。 必须将其设置为任何指定的值才能启用 UefiSettings。 默认行为为:除非设置了此属性,否则不会启用 UefiSettings。

uefiSettings

UefiSettings

指定创建虚拟机时使用的安全启动和 vTPM 等安全设置。 最低 API 版本:2020-12-01。

SecurityTypes

指定虚拟机的 SecurityType。 必须将其设置为任何指定的值才能启用 UefiSettings。 默认行为为:除非设置了此属性,否则不会启用 UefiSettings。

名称 类型 说明
ConfidentialVM

string

TrustedLaunch

string

SettingNames

指定内容适用于的设置的名称。 可能的值为:FirstLogonCommands 和 AutoLogon。

名称 类型 说明
AutoLogon

string

FirstLogonCommands

string

SshConfiguration

Azure 上运行的基于 Linux 的 VM 的 SSH 配置

名称 类型 说明
publicKeys

SshPublicKey[]

用于对基于 Linux 的 VM 进行身份验证的 SSH 公钥列表。

SshPublicKey

包含有关 SSH 证书公钥以及放置公钥的 Linux VM 上的路径的信息。

名称 类型 说明
keyData

string

用于通过 ssh 向 VM 进行身份验证的 SSH 公钥证书。 密钥需要至少为 2048 位且采用 ssh-rsa 格式。 有关创建 SSH 密钥,请参阅 [在 Linux 和 Mac 上为 Azure 中的 Linux VM 创建 SSH 密钥]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

path

string

指定所创建的 VM 上存储 ssh 公钥的完整路径。 如果该文件已存在,则指定的密钥将追加到该文件上。 示例:/home/user/.ssh/authorized_keys

StatusLevelTypes

级别代码。

名称 类型 说明
Error

string

Info

string

Warning

string

StorageAccountTypes

指定托管磁盘的存储帐户类型。 注意:UltraSSD_LRS只能与数据磁盘一起使用,它不能与 OS 磁盘一起使用。

名称 类型 说明
PremiumV2_LRS

string

Premium_LRS

string

Premium_ZRS

string

StandardSSD_LRS

string

StandardSSD_ZRS

string

Standard_LRS

string

UltraSSD_LRS

string

SubResource

名称 类型 说明
id

string

资源 ID

UefiSettings

指定创建虚拟机时使用的安全启动和 vTPM 等安全设置。 最低 API 版本:2020-12-01。

名称 类型 说明
secureBootEnabled

boolean

指定是否应在虚拟机上启用安全启动。 最低 API 版本:2020-12-01。

vTpmEnabled

boolean

指定是否应在虚拟机上启用 vTPM。 最低 API 版本:2020-12-01。

VaultCertificate

描述密钥保管库中的单个证书引用,以及证书应在 VM 上驻留的位置。

名称 类型 说明
certificateStore

string

对于 Windows VM,指定应向其添加证书的虚拟机上的证书存储。 指定的证书存储隐式位于 LocalMachine 帐户中。 对于 Linux VM,证书文件位于 /var/lib/waagent 目录下,X509 证书文件的文件名 <为 UppercaseThumbprint.crt>, <私钥的文件名为 UppercaseThumbprint.prv>。 这两个文件都采用 .pem 格式。

certificateUrl

string

这是已作为机密上传到密钥保管库的证书的 URL。 若要向密钥保管库添加机密,请参阅将密钥或机密添加到密钥保管库。 在这种情况下,证书必须是以下 JSON 对象的 Base64 编码,该对象以 UTF-8 编码:

{
“data”:“”,
“dataType”:“pfx”,
“password”:“”
}
若要在虚拟机上安装证书,建议使用适用于 Linux 的 Azure 密钥保管库 虚拟机扩展适用于 Windows 的 Azure 密钥保管库 虚拟机扩展

VaultSecretGroup

描述一组证书,这些证书全部位于同一密钥保管库中。

名称 类型 说明
sourceVault

SubResource

包含 VaultCertificates 中所有证书的密钥保管库的相对 URL。

vaultCertificates

VaultCertificate[]

SourceVault 中包含证书的密钥保管库引用列表。

VirtualMachineSizeTypes

指定虚拟机的大小。 枚举数据类型当前已弃用,将于 2023 年 12 月 23 日删除。 获取可用大小列表的建议方法是使用以下 API: 列出可用性集中的所有可用虚拟机大小列出区域中所有可用虚拟机大小列出所有可用虚拟机大小以调整大小。 有关虚拟机大小的详细信息,请参阅 虚拟机的大小。 可用的 VM 大小取决于区域和可用性集。

名称 类型 说明
Basic_A0

string

Basic_A1

string

Basic_A2

string

Basic_A3

string

Basic_A4

string

Standard_A0

string

Standard_A1

string

Standard_A10

string

Standard_A11

string

Standard_A1_v2

string

Standard_A2

string

Standard_A2_v2

string

Standard_A2m_v2

string

Standard_A3

string

Standard_A4

string

Standard_A4_v2

string

Standard_A4m_v2

string

Standard_A5

string

Standard_A6

string

Standard_A7

string

Standard_A8

string

Standard_A8_v2

string

Standard_A8m_v2

string

Standard_A9

string

Standard_B1ms

string

Standard_B1s

string

Standard_B2ms

string

Standard_B2s

string

Standard_B4ms

string

Standard_B8ms

string

Standard_D1

string

Standard_D11

string

Standard_D11_v2

string

Standard_D12

string

Standard_D12_v2

string

Standard_D13

string

Standard_D13_v2

string

Standard_D14

string

Standard_D14_v2

string

Standard_D15_v2

string

Standard_D16_v3

string

Standard_D16s_v3

string

Standard_D1_v2

string

Standard_D2

string

Standard_D2_v2

string

Standard_D2_v3

string

Standard_D2s_v3

string

Standard_D3

string

Standard_D32_v3

string

Standard_D32s_v3

string

Standard_D3_v2

string

Standard_D4

string

Standard_D4_v2

string

Standard_D4_v3

string

Standard_D4s_v3

string

Standard_D5_v2

string

Standard_D64_v3

string

Standard_D64s_v3

string

Standard_D8_v3

string

Standard_D8s_v3

string

Standard_DS1

string

Standard_DS11

string

Standard_DS11_v2

string

Standard_DS12

string

Standard_DS12_v2

string

Standard_DS13

string

Standard_DS13-2_v2

string

Standard_DS13-4_v2

string

Standard_DS13_v2

string

Standard_DS14

string

Standard_DS14-4_v2

string

Standard_DS14-8_v2

string

Standard_DS14_v2

string

Standard_DS15_v2

string

Standard_DS1_v2

string

Standard_DS2

string

Standard_DS2_v2

string

Standard_DS3

string

Standard_DS3_v2

string

Standard_DS4

string

Standard_DS4_v2

string

Standard_DS5_v2

string

Standard_E16_v3

string

Standard_E16s_v3

string

Standard_E2_v3

string

Standard_E2s_v3

string

Standard_E32-16_v3

string

Standard_E32-8s_v3

string

Standard_E32_v3

string

Standard_E32s_v3

string

Standard_E4_v3

string

Standard_E4s_v3

string

Standard_E64-16s_v3

string

Standard_E64-32s_v3

string

Standard_E64_v3

string

Standard_E64s_v3

string

Standard_E8_v3

string

Standard_E8s_v3

string

Standard_F1

string

Standard_F16

string

Standard_F16s

string

Standard_F16s_v2

string

Standard_F1s

string

Standard_F2

string

Standard_F2s

string

Standard_F2s_v2

string

Standard_F32s_v2

string

Standard_F4

string

Standard_F4s

string

Standard_F4s_v2

string

Standard_F64s_v2

string

Standard_F72s_v2

string

Standard_F8

string

Standard_F8s

string

Standard_F8s_v2

string

Standard_G1

string

Standard_G2

string

Standard_G3

string

Standard_G4

string

Standard_G5

string

Standard_GS1

string

Standard_GS2

string

Standard_GS3

string

Standard_GS4

string

Standard_GS4-4

string

Standard_GS4-8

string

Standard_GS5

string

Standard_GS5-16

string

Standard_GS5-8

string

Standard_H16

string

Standard_H16m

string

Standard_H16mr

string

Standard_H16r

string

Standard_H8

string

Standard_H8m

string

Standard_L16s

string

Standard_L32s

string

Standard_L4s

string

Standard_L8s

string

Standard_M128-32ms

string

Standard_M128-64ms

string

Standard_M128ms

string

Standard_M128s

string

Standard_M64-16ms

string

Standard_M64-32ms

string

Standard_M64ms

string

Standard_M64s

string

Standard_NC12

string

Standard_NC12s_v2

string

Standard_NC12s_v3

string

Standard_NC24

string

Standard_NC24r

string

Standard_NC24rs_v2

string

Standard_NC24rs_v3

string

Standard_NC24s_v2

string

Standard_NC24s_v3

string

Standard_NC6

string

Standard_NC6s_v2

string

Standard_NC6s_v3

string

Standard_ND12s

string

Standard_ND24rs

string

Standard_ND24s

string

Standard_ND6s

string

Standard_NV12

string

Standard_NV24

string

Standard_NV6

string

VMDiskSecurityProfile

指定托管磁盘的安全配置文件设置。 注意: 只能为机密 VM 设置它。

名称 类型 说明
diskEncryptionSet

DiskEncryptionSetParameters

指定用于客户托管密钥加密的机密 VM OS 磁盘和 VMGuest Blob 的托管磁盘的客户托管磁盘加密集资源 ID。

securityEncryptionType

securityEncryptionTypes

指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState 以加密托管磁盘和 VMGuestState blob,VMGuestStateOnly 仅加密 VMGuestState blob,设置为 NonPersistedTPM 以不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。

VMSizeProperties

指定虚拟机上的 VM 大小属性设置。

名称 类型 说明
vCPUsAvailable

integer

指定可用于 VM 的 vCPU 数。 如果未在请求正文中指定此属性,则默认行为是将其设置为“ 列出区域中所有可用虚拟机大小”的 API 响应中公开的可用于该 VM 大小的 vCPU 值。

vCPUsPerCore

integer

指定 vCPU 与物理核心的比率。 如果未在请求正文中指定此属性,则默认行为设置为“ 列出区域中所有可用虚拟机大小”的 API 响应中公开的 VM 大小的 vCPUsPerCore 值。 将此属性设置为 1 还意味着禁用超线程。

WindowsConfiguration

指定虚拟机上的 Windows 操作系统设置。

名称 类型 说明
additionalUnattendContent

AdditionalUnattendContent[]

指定可包含在 Windows 安装程序使用的 Unattend.xml 文件中的其他 Base-64 编码 XML 格式信息。

enableAutomaticUpdates

boolean

指示是否为 Windows 虚拟机启用自动汇报。 默认值为 true。 对于虚拟机规模集,可以更新此属性,更新将在 OS 重新预配时生效。

enableVMAgentPlatformUpdates

boolean

指示是否为 Windows 虚拟机启用 VMAgent Platform 汇报。 默认值为 false。

patchSettings

PatchSettings

[预览功能]指定与 Windows 上的 VM 来宾修补相关的设置。

provisionVMAgent

boolean

指示是否应在虚拟机上设置虚拟机代理。 如果未在请求正文中指定此属性,则默认将其设置为 true。 这将确保 VM 代理安装在 VM 上,以便以后可以向 VM 添加扩展。

timeZone

string

指定虚拟机的时区。 例如“太平洋标准时间”。 可以从 TimeZoneInfo.GetSystemTimeZones 返回的时区 TimeZoneInfo.Id 值。

winRM

WinRMConfiguration

指定 Windows 远程管理侦听器。 这将启用远程 Windows PowerShell。

WindowsPatchAssessmentMode

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为:

ImageDefault - 控制虚拟机上修补程序评估的时间安排。

AutomaticByPlatform - 平台将触发定期修补程序评估。 属性 provisionVMAgent 必须为 true。

名称 类型 说明
AutomaticByPlatform

string

ImageDefault

string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

名称 类型 说明
Always

string

IfRequired

string

Never

string

Unknown

string

WindowsVMGuestPatchAutomaticByPlatformSettings

指定在 Windows 修补程序设置中选择修补模式 AutomaticByPlatform 时要应用的其他设置。

名称 类型 说明
bypassPlatformSafetyChecksOnUserSchedule

boolean

使客户能够计划修补,而无需意外升级

rebootSetting

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

WindowsVMGuestPatchMode

指定将 VM 来宾修补到 IaaS 虚拟机或与虚拟机规模集关联的虚拟机的模式,其中 OrchestrationMode 为灵活。

可能的值为:

手动 - 控制将修补程序应用到虚拟机。 为此,可以在 VM 中手动应用修补程序。 在此模式下,自动更新处于禁用状态;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false

AutomaticByOS - 操作系统会自动更新虚拟机。 属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。

AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true

名称 类型 说明
AutomaticByOS

string

AutomaticByPlatform

string

Manual

string

WinRMConfiguration

介绍 VM 的 Windows 远程管理配置

名称 类型 说明
listeners

WinRMListener[]

Windows 远程管理侦听器的列表

WinRMListener

介绍 Windows 远程管理侦听器的协议和指纹

名称 类型 说明
certificateUrl

string

这是已作为机密上传到密钥保管库的证书的 URL。 若要向密钥保管库添加机密,请参阅将密钥或机密添加到密钥保管库。 在这种情况下,证书必须是以下 JSON 对象的 Base64 编码,该对象以 UTF-8 编码:

{
“data”:“”,
“dataType”:“pfx”,
“password”:“”
}
若要在虚拟机上安装证书,建议使用适用于 Linux 的 Azure 密钥保管库 虚拟机扩展适用于 Windows 的 Azure 密钥保管库 虚拟机扩展

protocol

ProtocolTypes

指定 WinRM 侦听器的协议。 可能的值为: http、https。