你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Restore Point Collections - Get
用于获取还原点集合的操作。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}?api-version=2024-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}?$expand=restorePoints&api-version=2024-07-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
资源组的名称。 |
restore
|
path | True |
string |
还原点集合的名称。 |
subscription
|
path | True |
string |
唯一标识 azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
$expand
|
query |
要应用于操作的展开表达式。 如果 expand=restorePoints,服务器将返回 restorePointCollection 中的所有包含还原点。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
还行 |
|
Other Status Codes |
描述操作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Get a restore point collection, including the restore points contained in the restore point collection
示例请求
示例响应
{
"name": "rpcName",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName",
"type": "Microsoft.Compute/restorePointCollections",
"location": "westus",
"tags": {
"myTag1": "tagValue1"
},
"properties": {
"source": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
"location": "eastus"
},
"restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
"provisioningState": "Succeeded",
"restorePoints": [
{
"name": "restorePointName",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName",
"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/restorePointName/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/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"
},
"diskRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/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 a restore point collection (but not the restore points contained in the restore point collection)
示例请求
示例响应
{
"name": "myRpc",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
"type": "Microsoft.Compute/restorePointCollections",
"location": "westus",
"tags": {
"myTag1": "tagValue1"
},
"properties": {
"source": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
"location": "eastus"
},
"restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
"provisioningState": "Succeeded"
}
}
定义
名称 | 说明 |
---|---|
Additional |
指定 Windows 安装程序使用的 Unattend.xml 文件中可以包含的其他 XML 格式化信息。 内容通过设置名称、组件名称和应用内容的传递来定义。 |
Api |
API 实体引用。 |
Api |
Api 错误。 |
Api |
Api 错误基数。 |
Boot |
启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图来诊断 VM 状态。 可以轻松查看控制台日志的输出。 通过 Azure,还可以从虚拟机监控程序查看 VM 的屏幕截图。 |
Caching |
获取缓存类型。 |
Cloud |
来自计算服务的错误响应。 |
Component |
组件名称。 目前,唯一允许的值是Microsoft-Windows-Shell-Setup。 |
Consistency |
RestorePoint 的 ConsistencyMode。 可以在创建还原点时在输入中指定。 目前,仅接受 CrashConsistent 作为有效输入。 有关详细信息,请参阅 https://aka.ms/RestorePoints。 |
Diagnostics |
指定启动诊断设置状态。 最低 API 版本:2015-06-15。 |
Disk |
获取在创建还原点时捕获的 VM 的磁盘控制器类型。 |
Disk |
描述可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意: 只能为托管磁盘指定磁盘加密集资源 ID。 有关详细信息,请参阅 https://aka.ms/mdssewithcmkoverview。 |
Disk |
描述磁盘的加密设置 |
Disk |
磁盘还原点详细信息。 |
Disk |
磁盘还原点的实例视图。 |
Disk |
磁盘还原点的实例视图。 |
Encryption |
指定 ADE 用于获取 keyvault 操作的访问令牌的托管标识。 |
Hardware |
指定虚拟机的硬件设置。 |
Hyper |
捕获还原点的源 VM 的 HyperVGeneration。 |
Inner |
内部错误详细信息。 |
Instance |
实例视图状态。 |
Key |
描述对 Key Vault 密钥的引用 |
Key |
描述对 Key Vault 机密的引用 |
Linux |
指定虚拟机上的 Linux 操作系统设置。 有关受支持的 Linux 分发版的列表,请参阅 Azure-Endorsed 分发版上的 Linux。 |
Linux |
指定 IaaS 虚拟机的 VM 来宾修补评估模式。 |
Linux |
指定与 Linux 上的 VM 来宾修补相关的设置。 |
Linux |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 |
Linux |
指定在 Linux 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。 |
Linux |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 |
Managed |
托管磁盘的参数。 |
Mode |
指定在启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不强制对审核模式下主机终结点的请求实施访问控制,而在“强制”模式下,将强制实施访问控制。 默认值为“强制”模式。 |
Operating |
获取操作系统类型。 |
OSProfile |
指定虚拟机的操作系统设置。 预配 VM 后,无法更改某些设置。 |
Pass |
传递名称。 目前,唯一允许的值是 OobeSystem。 |
Patch |
指定与 Windows 上的 VM 来宾修补相关的设置。 |
Protocol |
指定 WinRM 侦听器的协议。 可能的值为:http、https。 |
Proxy |
在创建虚拟机时指定 ProxyAgent 设置。 最低 API 版本:2023-09-01。 |
Restore |
还原点详细信息。 |
Restore |
创建或更新还原点集合参数。 |
Restore |
要应用于操作的展开表达式。 如果 expand=restorePoints,服务器将返回 restorePointCollection 中的所有包含还原点。 |
Restore |
从中创建此还原点集合的源资源的属性。 |
Restore |
磁盘还原点的静态加密设置。 它是一个可选属性,可在创建还原点时在输入中指定。 |
Restore |
用于加密磁盘还原点数据的密钥类型。 |
Restore |
还原点的实例视图。 |
Restore |
描述为其创建还原点的虚拟机的属性。 提供的属性是还原点创建时捕获的总体虚拟机属性的子集和快照。 |
Restore |
描述数据磁盘。 |
Restore |
描述操作系统磁盘。 |
Restore |
描述存储配置文件。 |
security |
指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState,用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob,并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。 |
Security |
指定虚拟机或虚拟机规模集的安全配置文件设置。 |
Security |
指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 UefiSettings。 默认行为为:除非设置了此属性,否则不会启用 UefiSettings。 |
Setting |
指定内容应用到的设置的名称。 可能的值包括:FirstLogonCommands 和 AutoLogon。 |
Ssh |
Azure 上运行的基于 Linux 的 VM 的 SSH 配置 |
Ssh |
包含有关 SSH 证书公钥的信息以及放置公钥的 Linux VM 上的路径。 |
Status |
级别代码。 |
Storage |
指定托管磁盘的存储帐户类型。 注意:UltraSSD_LRS只能与数据磁盘一起使用,它不能与 OS 磁盘一起使用。 |
Sub |
|
Uefi |
指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。 最低 api 版本:2020-12-01。 |
Vault |
介绍 Key Vault 中的单个证书引用,以及证书应驻留在 VM 上的位置。 |
Vault |
描述一组证书,这些证书都位于同一 Key Vault 中。 |
Virtual |
指定虚拟机的大小。 枚举数据类型当前已弃用,将于 2023 年 12 月 23 日删除。 获取可用大小列表的建议方法是使用以下 API:列出可用性集中的所有可用虚拟机大小,列出区域中所有可用的虚拟机大小,列出所有可用的虚拟机大小以调整大小。 有关虚拟机大小的详细信息,请参阅虚拟机 |
VMDisk |
指定托管磁盘的安全配置文件设置。 注意: 只能为机密 VM 设置它。 |
VMSize |
指定虚拟机上的 VM 大小属性设置。 |
Windows |
指定虚拟机上的 Windows 操作系统设置。 |
Windows |
指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。 |
Windows |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 |
Windows |
指定在 Windows 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。 |
Windows |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 |
Win |
介绍 VM 的 Windows 远程管理配置 |
Win |
介绍 Windows 远程管理侦听器的协议和指纹 |
AdditionalUnattendContent
指定 Windows 安装程序使用的 Unattend.xml 文件中可以包含的其他 XML 格式化信息。 内容通过设置名称、组件名称和应用内容的传递来定义。
名称 | 类型 | 说明 |
---|---|---|
componentName |
组件名称。 目前,唯一允许的值是Microsoft-Windows-Shell-Setup。 |
|
content |
string |
指定为指定路径和组件添加到 unattend.xml 文件的 XML 格式化内容。 XML 必须小于 4KB,并且必须包含要插入的设置或功能的根元素。 |
passName |
传递名称。 目前,唯一允许的值是 OobeSystem。 |
|
settingName |
指定内容应用到的设置的名称。 可能的值包括:FirstLogonCommands 和 AutoLogon。 |
ApiEntityReference
API 实体引用。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 形式的 ARM 资源 ID |
ApiError
Api 错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
details |
API 错误详细信息 |
|
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 |
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 |
启动诊断是一项调试功能,可用于查看控制台输出和屏幕截图来诊断 VM 状态。 注意:如果指定 storageUri,请确保存储帐户与 VM 位于同一区域和订阅中。 可以轻松查看控制台日志的输出。 通过 Azure,还可以从虚拟机监控程序查看 VM 的屏幕截图。 |
DiskControllerTypes
获取在创建还原点时捕获的 VM 的磁盘控制器类型。
名称 | 类型 | 说明 |
---|---|---|
NVMe |
string |
|
SCSI |
string |
DiskEncryptionSetParameters
描述可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意: 只能为托管磁盘指定磁盘加密集资源 ID。 有关详细信息,请参阅 https://aka.ms/mdssewithcmkoverview。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID |
DiskEncryptionSettings
描述磁盘的加密设置
名称 | 类型 | 说明 |
---|---|---|
diskEncryptionKey |
指定磁盘加密密钥的位置,该密钥是 Key Vault 机密。 |
|
enabled |
boolean |
指定是否应在虚拟机上启用磁盘加密。 |
keyEncryptionKey |
指定 Key Vault 中密钥加密密钥的位置。 |
DiskRestorePointAttributes
磁盘还原点详细信息。
名称 | 类型 | 说明 |
---|---|---|
encryption |
磁盘还原点的静态加密设置。 它是一个可选属性,可在创建还原点时在输入中指定。 |
|
id |
string |
资源 ID |
sourceDiskRestorePoint |
源磁盘还原点的资源 ID。 |
DiskRestorePointInstanceView
磁盘还原点的实例视图。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
磁盘还原点 ID。 |
replicationStatus |
磁盘还原点复制状态信息。 |
DiskRestorePointReplicationStatus
磁盘还原点的实例视图。
名称 | 类型 | 说明 |
---|---|---|
completionPercent |
integer |
复制完成百分比。 |
status |
资源状态信息。 |
EncryptionIdentity
指定 ADE 用于获取 keyvault 操作的访问令牌的托管标识。
名称 | 类型 | 说明 |
---|---|---|
userAssignedIdentityResourceId |
string |
指定与 VM 关联的用户标识之一的 ARM 资源 ID。 |
HardwareProfile
指定虚拟机的硬件设置。
名称 | 类型 | 说明 |
---|---|---|
vmSize |
指定虚拟机的大小。 枚举数据类型当前已弃用,将于 2023 年 12 月 23 日删除。 获取可用大小列表的建议方法是使用以下 API:列出可用性集中的所有可用虚拟机大小,列出区域中所有可用的虚拟机大小,列出所有可用的虚拟机大小以调整大小。 有关虚拟机大小的详细信息,请参阅虚拟机 |
|
vmSizeProperties |
指定用于自定义虚拟机大小的属性。 最低 API 版本:2021-07-01。 此功能仍处于预览模式,VirtualMachineScaleSet 不支持此功能。 有关详细信息,请按照 VM 自定义 中的说明进行操作。 |
HyperVGenerationTypes
捕获还原点的源 VM 的 HyperVGeneration。
名称 | 类型 | 说明 |
---|---|---|
V1 |
string |
|
V2 |
string |
InnerError
内部错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
errordetail |
string |
内部错误消息或异常转储。 |
exceptiontype |
string |
异常类型。 |
InstanceViewStatus
实例视图状态。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
状态代码。 |
displayStatus |
string |
状态的简短可本地化标签。 |
level |
级别代码。 |
|
message |
string |
详细状态消息,包括警报和错误消息。 |
time |
string |
状态的时间。 |
KeyVaultKeyReference
描述对 Key Vault 密钥的引用
名称 | 类型 | 说明 |
---|---|---|
keyUrl |
string |
引用 Key Vault 中的密钥加密密钥的 URL。 |
sourceVault |
包含密钥的 Key Vault 的相对 URL。 |
KeyVaultSecretReference
描述对 Key Vault 机密的引用
名称 | 类型 | 说明 |
---|---|---|
secretUrl |
string |
引用 Key Vault 中的机密的 URL。 |
sourceVault |
包含机密的 Key Vault 的相对 URL。 |
LinuxConfiguration
指定虚拟机上的 Linux 操作系统设置。 有关受支持的 Linux 分发版的列表,请参阅 Azure-Endorsed 分发版上的 Linux。
名称 | 类型 | 说明 |
---|---|---|
disablePasswordAuthentication |
boolean |
指定是否应禁用密码身份验证。 |
enableVMAgentPlatformUpdates |
boolean |
指示是否为 Linux 虚拟机启用了 VMAgent 平台更新。 默认值为 false。 |
patchSettings |
[预览功能]指定与 Linux 上的 VM 来宾修补相关的设置。 |
|
provisionVMAgent |
boolean |
指示是否应在虚拟机上预配虚拟机代理。 如果未在请求正文中指定此属性,则默认行为是将其设置为 true。 这将确保 VM 代理安装在 VM 上,以便以后可以向 VM 添加扩展。 |
ssh |
指定 Linux OS 的 ssh 密钥配置。 |
LinuxPatchAssessmentMode
指定 IaaS 虚拟机的 VM 来宾修补评估模式。
可能的值包括:
ImageDefault - 控制虚拟机上的修补程序评估的时间。
AutomaticByPlatform - 平台将触发定期修补评估。 属性 provisionVMAgent 必须为 true。
名称 | 类型 | 说明 |
---|---|---|
AutomaticByPlatform |
string |
|
ImageDefault |
string |
LinuxPatchSettings
指定与 Linux 上的 VM 来宾修补相关的设置。
名称 | 类型 | 说明 |
---|---|---|
assessmentMode |
指定 IaaS 虚拟机的 VM 来宾修补评估模式。 |
|
automaticByPlatformSettings |
指定 Linux 上的 VM 来宾修补中修补程序模式 AutomaticByPlatform 的其他设置。 |
|
patchMode |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 |
LinuxVMGuestPatchAutomaticByPlatformRebootSetting
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。
名称 | 类型 | 说明 |
---|---|---|
Always |
string |
|
IfRequired |
string |
|
Never |
string |
|
Unknown |
string |
LinuxVMGuestPatchAutomaticByPlatformSettings
指定在 Linux 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。
名称 | 类型 | 说明 |
---|---|---|
bypassPlatformSafetyChecksOnUserSchedule |
boolean |
使客户能够在不意外升级的情况下计划修补 |
rebootSetting |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 |
LinuxVMGuestPatchMode
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。
可能的值包括:
ImageDefault - 使用虚拟机的默认修补配置。
AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 必须为 true
名称 | 类型 | 说明 |
---|---|---|
AutomaticByPlatform |
string |
|
ImageDefault |
string |
ManagedDiskParameters
托管磁盘的参数。
名称 | 类型 | 说明 |
---|---|---|
diskEncryptionSet |
指定托管磁盘的客户托管磁盘加密集资源 ID。 |
|
id |
string |
资源 ID |
securityProfile |
指定托管磁盘的安全配置文件。 |
|
storageAccountType |
指定托管磁盘的存储帐户类型。 注意:UltraSSD_LRS只能与数据磁盘一起使用,它不能与 OS 磁盘一起使用。 |
Mode
指定在启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不强制对审核模式下主机终结点的请求实施访问控制,而在“强制”模式下,将强制实施访问控制。 默认值为“强制”模式。
名称 | 类型 | 说明 |
---|---|---|
Audit |
string |
|
Enforce |
string |
OperatingSystemType
获取操作系统类型。
名称 | 类型 | 说明 |
---|---|---|
Linux |
string |
|
Windows |
string |
OSProfile
指定虚拟机的操作系统设置。 预配 VM 后,无法更改某些设置。
名称 | 类型 | 说明 |
---|---|---|
adminPassword |
string |
指定管理员帐户的密码。 |
adminUsername |
string |
指定管理员帐户的名称。 |
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 上的自定义数据。 有关将 cloud-init 用于 Linux VM,请参阅 使用 cloud-init 在创建期间自定义 Linux VM。 |
linuxConfiguration |
指定虚拟机上的 Linux 操作系统设置。 有关受支持的 Linux 分发版的列表,请参阅 Azure-Endorsed 分发版上的 Linux。 |
|
requireGuestProvisionSignal |
boolean |
必须设置为 True 或省略的可选属性。 |
secrets |
指定应安装在虚拟机上的证书集。 若要在虚拟机上安装证书,建议使用适用于 Linux 的 |
|
windowsConfiguration |
指定虚拟机上的 Windows 操作系统设置。 |
PassNames
传递名称。 目前,唯一允许的值是 OobeSystem。
名称 | 类型 | 说明 |
---|---|---|
OobeSystem |
string |
PatchSettings
指定与 Windows 上的 VM 来宾修补相关的设置。
名称 | 类型 | 说明 |
---|---|---|
assessmentMode |
指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。 |
|
automaticByPlatformSettings |
指定 Windows 上的 VM 来宾修补中修补程序模式 AutomaticByPlatform 的其他设置。 |
|
enableHotpatching |
boolean |
使客户无需重新启动即可修补其 Azure VM。 对于 enableHotpatching,必须将“provisionVMAgent”设置为 true,并且“patchMode”必须设置为“AutomaticByPlatform”。 |
patchMode |
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。 |
ProtocolTypes
指定 WinRM 侦听器的协议。 可能的值为:http、https。
名称 | 类型 | 说明 |
---|---|---|
Http |
string |
|
Https |
string |
ProxyAgentSettings
在创建虚拟机时指定 ProxyAgent 设置。 最低 API 版本:2023-09-01。
名称 | 类型 | 说明 |
---|---|---|
enabled |
boolean |
指定是否应在虚拟机或虚拟机规模集上启用 ProxyAgent 功能。 |
keyIncarnationId |
integer |
增加此属性的值允许用户重置用于保护来宾和主机之间的通信通道的密钥。 |
mode |
指定在启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视,但不强制对审核模式下主机终结点的请求实施访问控制,而在“强制”模式下,将强制实施访问控制。 默认值为“强制”模式。 |
RestorePoint
还原点详细信息。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID |
name |
string |
资源名称 |
properties.consistencyMode |
RestorePoint 的 ConsistencyMode。 可以在创建还原点时在输入中指定。 目前,仅接受 CrashConsistent 作为有效输入。 有关详细信息,请参阅 https://aka.ms/RestorePoints。 |
|
properties.excludeDisks |
客户希望从还原点中排除的磁盘资源 ID 列表。 如果未指定任何磁盘,将包括所有磁盘。 |
|
properties.instanceView |
还原点实例视图。 |
|
properties.provisioningState |
string |
获取还原点的预配状态。 |
properties.sourceMetadata |
获取还原点创建时捕获的 VM 的详细信息。 |
|
properties.sourceRestorePoint |
需要从中创建副本的源还原点的资源 ID。 |
|
properties.timeCreated |
string |
获取还原点的创建时间。 |
type |
string |
资源类型 |
RestorePointCollection
创建或更新还原点集合参数。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID |
location |
string |
资源位置 |
name |
string |
资源名称 |
properties.provisioningState |
string |
还原点集合的预配状态。 |
properties.restorePointCollectionId |
string |
还原点集合的唯一 ID。 |
properties.restorePoints |
包含在此还原点集合下创建的所有还原点的列表。 |
|
properties.source |
从中创建此还原点集合的源资源的属性。 |
|
tags |
object |
资源标记 |
type |
string |
资源类型 |
RestorePointCollectionExpandOptions
要应用于操作的展开表达式。 如果 expand=restorePoints,服务器将返回 restorePointCollection 中的所有包含还原点。
名称 | 类型 | 说明 |
---|---|---|
restorePoints |
string |
RestorePointCollectionSourceProperties
从中创建此还原点集合的源资源的属性。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
用于创建此还原点集合的源资源的资源 ID |
location |
string |
用于创建此还原点集合的源资源的位置。 |
RestorePointEncryption
磁盘还原点的静态加密设置。 它是一个可选属性,可在创建还原点时在输入中指定。
名称 | 类型 | 说明 |
---|---|---|
diskEncryptionSet |
描述可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意: 只能为托管磁盘指定磁盘加密集资源 ID。 有关详细信息,请参阅 https://aka.ms/mdssewithcmkoverview。 |
|
type |
用于加密磁盘还原点数据的密钥类型。 |
RestorePointEncryptionType
用于加密磁盘还原点数据的密钥类型。
名称 | 类型 | 说明 |
---|---|---|
EncryptionAtRestWithCustomerKey |
string |
磁盘还原点使用客户管理的密钥进行静态加密,客户可以更改和吊销。 |
EncryptionAtRestWithPlatformAndCustomerKeys |
string |
磁盘还原点使用 2 层加密进行静态加密。 其中一个密钥是客户管理的,另一个密钥是平台管理的。 |
EncryptionAtRestWithPlatformKey |
string |
磁盘还原点使用平台托管密钥进行静态加密。 |
RestorePointInstanceView
还原点的实例视图。
名称 | 类型 | 说明 |
---|---|---|
diskRestorePoints |
磁盘还原点信息。 |
|
statuses |
资源状态信息。 |
RestorePointSourceMetadata
描述为其创建还原点的虚拟机的属性。 提供的属性是还原点创建时捕获的总体虚拟机属性的子集和快照。
名称 | 类型 | 说明 |
---|---|---|
diagnosticsProfile |
获取诊断配置文件。 |
|
hardwareProfile |
获取硬件配置文件。 |
|
hyperVGeneration |
捕获还原点的源 VM 的 HyperVGeneration。 |
|
licenseType |
string |
获取用于自带许可证方案的许可证类型。 |
location |
string |
从中创建还原点的 VM 的位置。 |
osProfile |
获取 OS 配置文件。 |
|
securityProfile |
获取安全配置文件。 |
|
storageProfile |
获取存储配置文件。 |
|
userData |
string |
与捕获还原点的源 VM 关联的 UserData,这是一个 base-64 编码值。 |
vmId |
string |
获取虚拟机的唯一 ID。 |
RestorePointSourceVMDataDisk
描述数据磁盘。
名称 | 类型 | 说明 |
---|---|---|
caching |
获取缓存类型。 |
|
diskRestorePoint |
包含磁盘还原点属性。 |
|
diskSizeGB |
integer |
获取空白数据磁盘的初始磁盘大小(以 GB 为单位)以及现有 OS 和数据磁盘的新所需大小。 |
lun |
integer |
获取逻辑单元号。 |
managedDisk |
包含托管磁盘详细信息。 |
|
name |
string |
获取磁盘名称。 |
writeAcceleratorEnabled |
boolean |
如果磁盘已启用写入加速器,则显示 true。 |
RestorePointSourceVMOSDisk
描述操作系统磁盘。
名称 | 类型 | 说明 |
---|---|---|
caching |
获取缓存类型。 |
|
diskRestorePoint |
包含磁盘还原点属性。 |
|
diskSizeGB |
integer |
获取磁盘大小(以 GB 为单位)。 |
encryptionSettings |
获取磁盘加密设置。 |
|
managedDisk |
获取托管磁盘详细信息 |
|
name |
string |
获取磁盘名称。 |
osType |
获取操作系统类型。 |
|
writeAcceleratorEnabled |
boolean |
如果磁盘已启用写入加速器,则显示 true。 |
RestorePointSourceVMStorageProfile
描述存储配置文件。
名称 | 类型 | 说明 |
---|---|---|
dataDisks |
获取在创建还原点时捕获的 VM 的数据磁盘。 |
|
diskControllerType |
获取在创建还原点时捕获的 VM 的磁盘控制器类型。 |
|
osDisk |
获取在创建还原点时捕获的 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 |
指定 ADE 用于获取 keyvault 操作的访问令牌的托管标识。 |
|
proxyAgentSettings |
在创建虚拟机时指定 ProxyAgent 设置。 最低 API 版本:2023-09-01。 |
|
securityType |
指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 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 |
用于通过基于 Linux 的 VM 进行身份验证的 SSH 公钥列表。 |
SshPublicKey
包含有关 SSH 证书公钥的信息以及放置公钥的 Linux VM 上的路径。
名称 | 类型 | 说明 |
---|---|---|
keyData |
string |
用于通过 ssh 向 VM 进行身份验证的 SSH 公钥证书。 密钥必须至少为 2048 位且采用 ssh-rsa 格式。 有关创建 ssh 密钥,请参阅 [在 Azure 中的 Linux 和 Mac 上为 Linux VM 创建 SSH 密钥]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). |
path |
string |
指定存储 ssh 公钥的已创建 VM 上的完整路径。 如果文件已存在,则指定的键将追加到该文件中。 示例:/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
介绍 Key Vault 中的单个证书引用,以及证书应驻留在 VM 上的位置。
名称 | 类型 | 说明 |
---|---|---|
certificateStore |
string |
对于 Windows VM,指定应向其添加证书的虚拟机上的证书存储。 指定的证书存储隐式位于 LocalMachine 帐户中。 对于 Linux VM,证书文件位于 /var/lib/waagent 目录下,文件名为 X509 证书文件 <大写Thumbprint>.crt,<用于私钥的 uppercaseThumbprint>.prv。 这两个文件都是 .pem 格式的。 |
certificateUrl |
string |
这是已作为机密上传到 Key Vault 的证书的 URL。 若要将机密添加到 Key Vault,请参阅 向密钥保管库添加密钥或机密。 在这种情况下,证书必须是以下 JSON 对象的 Base64 编码,该对象在 UTF-8 中编码: |
VaultSecretGroup
描述一组证书,这些证书都位于同一 Key Vault 中。
名称 | 类型 | 说明 |
---|---|---|
sourceVault |
Key Vault 的相对 URL,其中包含 VaultCertificates 中的所有证书。 |
|
vaultCertificates |
SourceVault 中包含证书的密钥保管库引用列表。 |
VirtualMachineSizeTypes
指定虚拟机的大小。 枚举数据类型当前已弃用,将于 2023 年 12 月 23 日删除。 获取可用大小列表的建议方法是使用以下 API:列出可用性集中的所有可用虚拟机大小,列出区域中所有可用的虚拟机大小,列出所有可用的虚拟机大小以调整大小。 有关虚拟机大小的详细信息,请参阅虚拟机
名称 | 类型 | 说明 |
---|---|---|
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 |
指定用于客户托管密钥加密的 ConfidentialVM OS 磁盘和 VMGuest Blob 的托管磁盘的客户托管磁盘加密集资源 ID。 |
|
securityEncryptionType |
指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState,用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob,并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。 注意: 只能为机密 VM 设置它。 |
VMSizeProperties
指定虚拟机上的 VM 大小属性设置。
名称 | 类型 | 说明 |
---|---|---|
vCPUsAvailable |
integer |
指定可用于 VM 的 vCPU 数。 如果未在请求正文中指定此属性,则默认行为是将其设置为 api 响应中公开的 vCPU 的值,列出区域中所有可用的虚拟机大小。 |
vCPUsPerCore |
integer |
指定 vCPU 与物理核心比率。 如果未在请求正文中指定此属性,则默认行为设置为 api 响应中公开的 vm 大小的 vCPUUsPerCore 值,列出区域中的所有可用虚拟机大小。 将此属性设置为 1 也意味着禁用了超线程处理。 |
WindowsConfiguration
指定虚拟机上的 Windows 操作系统设置。
名称 | 类型 | 说明 |
---|---|---|
additionalUnattendContent |
指定其他 base-64 编码的 XML 格式信息,这些信息可以包含在 Windows 安装程序使用的 Unattend.xml 文件中。 |
|
enableAutomaticUpdates |
boolean |
指示是否为 Windows 虚拟机启用自动更新。 默认值为 true。 对于虚拟机规模集,可以更新此属性,更新将对 OS 重新预配生效。 |
enableVMAgentPlatformUpdates |
boolean |
指示是否为 Windows 虚拟机启用了 VMAgent 平台更新。 |
patchSettings |
[预览功能]指定与 Windows 上的 VM 来宾修补相关的设置。 |
|
provisionVMAgent |
boolean |
指示是否应在虚拟机上预配虚拟机代理。 如果未在请求正文中指定此属性,则默认情况下此属性设置为 true。 这将确保 VM 代理安装在 VM 上,以便以后可以向 VM 添加扩展。 |
timeZone |
string |
指定虚拟机的时区。 例如“太平洋标准时间”。 可能的值可以从 TimeZoneInfo.GetSystemTimeZones返回的时区 TimeZoneInfo.Id 值。 |
winRM |
指定 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 |
指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。 |
WindowsVMGuestPatchMode
指定 VM 来宾修补到 IaaS 虚拟机的模式,或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。
可能的值包括:
手动 - 可以控制将修补程序应用到虚拟机。 为此,请在 VM 中手动应用修补程序。 在此模式下,自动更新处于禁用状态;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false
AutomaticByOS - 虚拟机将由 OS 自动更新。 属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。
AutomaticByPlatform - 虚拟机将由平台自动更新。 属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true
名称 | 类型 | 说明 |
---|---|---|
AutomaticByOS |
string |
|
AutomaticByPlatform |
string |
|
Manual |
string |
WinRMConfiguration
介绍 VM 的 Windows 远程管理配置
名称 | 类型 | 说明 |
---|---|---|
listeners |
Windows 远程管理侦听器列表 |
WinRMListener
介绍 Windows 远程管理侦听器的协议和指纹
名称 | 类型 | 说明 |
---|---|---|
certificateUrl |
string |
这是已作为机密上传到 Key Vault 的证书的 URL。 若要将机密添加到 Key Vault,请参阅 向密钥保管库添加密钥或机密。 在这种情况下,证书必须是以下 JSON 对象的 Base64 编码,该对象在 UTF-8 中编码: |
protocol |
指定 WinRM 侦听器的协议。 可能的值为:http、https。 |