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

Machine Extensions - Update

用于创建或更新扩展的操作。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}?api-version=2021-05-20

URI 参数

Name In Required Type Description
extensionName
path True
  • string

计算机扩展的名称。

machineName
path True
  • string

应创建或更新扩展的计算机的名称。

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

请求正文

Name Type Description
properties

介绍计算机扩展更新属性。

tags
  • object

资源标记

响应

Name Type Description
200 OK

OK

202 Accepted

已接受

Other Status Codes

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

安全性

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 Machine Extension

Sample Request

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine/extensions/CustomScriptExtension?api-version=2021-05-20

{
  "properties": {
    "publisher": "Microsoft.Compute",
    "typeHandlerVersion": "1.10",
    "type": "CustomScriptExtension",
    "settings": {
      "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -lt 100 }\""
    }
  }
}

Sample Response

{
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension",
  "name": "CustomScriptExtension",
  "type": "Microsoft.HybridCompute/machines/extensions",
  "location": "eastus2euap",
  "properties": {
    "publisher": "Microsoft.Compute",
    "type": "string",
    "typeHandlerVersion": "1.10.3",
    "autoUpgradeMinorVersion": false,
    "settings": "@{commandToExecute=powershell.exe -c \"Get-Process | Where-Object { $_.CPU -lt 100 }\"}",
    "protectedSettings": {},
    "provisioningState": "Succeeded",
    "instanceView": {
      "name": "CustomScriptExtension",
      "type": "CustomScriptExtension",
      "typeHandlerVersion": "1.10.3",
      "status": {
        "code": "success",
        "level": "Information",
        "message": "Finished executing command, StdOut: , StdErr:",
        "time": "2020-01-08T20:42:10.999Z"
      }
    }
  }
}

定义

createdByType

创建资源的标识的类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

MachineExtension

描述计算机扩展。

MachineExtensionInstanceView

描述计算机扩展实例视图。

MachineExtensionProperties

描述计算机扩展的属性。

MachineExtensionUpdate

描述计算机扩展更新。

MachineExtensionUpdateProperties

描述计算机扩展的属性。

Status

实例视图状态。

StatusLevelTypes

级别代码。

systemData

与创建和上次修改资源相关的元数据。

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

MachineExtension

描述计算机扩展。

Name Type Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

资源所在的地理位置

name
  • string

资源的名称

properties

描述计算机扩展属性。

systemData

与此资源相关的系统元数据。

tags
  • object

资源标记。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

MachineExtensionInstanceView

描述计算机扩展实例视图。

Name Type Description
name
  • string

计算机扩展名称。

status

实例视图状态。

type
  • string

指定扩展的类型;例如“CustomScriptExtension”。

typeHandlerVersion
  • string

指定脚本处理程序的版本。

MachineExtensionProperties

描述计算机扩展的属性。

Name Type Description
autoUpgradeMinorVersion
  • boolean

指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。

forceUpdateTag
  • string

即使扩展配置未更改,扩展处理程序也应强制更新。

instanceView

计算机扩展实例视图。

protectedSettings
  • object

该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。

provisioningState
  • string

仅出现在响应中的预配状态。

publisher
  • string

扩展处理程序发布者的名称。

settings
  • object

扩展的 Json 格式公共设置。

type
  • string

指定扩展的类型;例如“CustomScriptExtension”。

typeHandlerVersion
  • string

指定脚本处理程序的版本。

MachineExtensionUpdate

描述计算机扩展更新。

Name Type Description
properties

介绍计算机扩展更新属性。

tags
  • object

资源标记

MachineExtensionUpdateProperties

描述计算机扩展的属性。

Name Type Description
autoUpgradeMinorVersion
  • boolean

指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。

forceUpdateTag
  • string

即使扩展配置未更改,扩展处理程序也应强制更新。

protectedSettings
  • object

该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。

publisher
  • string

扩展处理程序发布者的名称。

settings
  • object

扩展的 Json 格式公共设置。

type
  • string

指定扩展的类型;例如“CustomScriptExtension”。

typeHandlerVersion
  • string

指定脚本处理程序的版本。

Status

实例视图状态。

Name Type Description
code
  • string

状态代码。

displayStatus
  • string

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

level

级别代码。

message
  • string

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

time
  • string

状态的时间。

StatusLevelTypes

级别代码。

Name Type Description
Error
  • string
Info
  • string
Warning
  • string

systemData

与创建和上次修改资源相关的元数据。

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。