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

Machine Extensions - Update

参考

Service:: Hybrid Compute

API Version:: 2022-12-27

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

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

URI 参数

名称	在	必需	类型	说明
extensionName	path	True	string	计算机扩展的名称。
machineName	path	True	string	应在其中创建或更新扩展的计算机的名称。 Regex pattern: `^[a-zA-Z0-9-_\.]{1,54}$`
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	类型	说明
properties.autoUpgradeMinorVersion	boolean	指示扩展是否应使用较新的次要版本（如果在部署时可用）。但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。
properties.enableAutomaticUpgrade	boolean	指示如果有较新的可用版本，平台是否应自动升级扩展。
properties.forceUpdateTag	string	如何在扩展配置未更改的情况下强制更新扩展处理程序。
properties.protectedSettings		该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。
properties.publisher	string	扩展处理程序发布者的名称。
properties.settings		扩展的 Json 格式的公共设置。
properties.type	string	指定扩展的类型;例如“CustomScriptExtension”。
properties.typeHandlerVersion	string	指定脚本处理程序的版本。
tags	object	资源标记

响应

名称	类型	说明
200 OK	MachineExtension	确定
202 Accepted		已接受 Headers Location: string Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

名称

类型

说明

200 OK

MachineExtension

确定

202 Accepted

已接受

Headers

Location: string
Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Create or Update a Machine Extension

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

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HybridCompute;
using Azure.ResourceManager.HybridCompute.Models;

// Generated from example definition: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2022-12-27/examples/UpdateExtension.json
// this example is just showing the usage of "MachineExtensions_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this HybridComputeMachineExtensionResource created on azure
// for more information of creating HybridComputeMachineExtensionResource, please refer to the document of HybridComputeMachineExtensionResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "myResourceGroup";
string machineName = "myMachine";
string extensionName = "CustomScriptExtension";
ResourceIdentifier hybridComputeMachineExtensionResourceId = HybridComputeMachineExtensionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, machineName, extensionName);
HybridComputeMachineExtensionResource hybridComputeMachineExtension = client.GetHybridComputeMachineExtensionResource(hybridComputeMachineExtensionResourceId);

// invoke the operation
HybridComputeMachineExtensionPatch patch = new HybridComputeMachineExtensionPatch()
{
    Publisher = "Microsoft.Compute",
    MachineExtensionUpdatePropertiesType = "CustomScriptExtension",
    TypeHandlerVersion = "1.10",
    EnableAutomaticUpgrade = true,
    Settings =
    {
    ["commandToExecute"] = BinaryData.FromString("\"powershell.exe -c \"Get-Process | Where-Object { $_.CPU -lt 100 }\"\""),
    },
};
ArmOperation<HybridComputeMachineExtensionResource> lro = await hybridComputeMachineExtension.UpdateAsync(WaitUntil.Completed, patch);
HybridComputeMachineExtensionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
HybridComputeMachineExtensionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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",
    "enableAutomaticUpgrade": true,
    "autoUpgradeMinorVersion": false,
    "settings": {
      "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\""
    },
    "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"
      }
    }
  }
}

Status code:: 202

Location: {callbackUrl}
Retry-After: 200
Azure-AsyncOperation: {callbackUri}

定义

名称	说明
createdByType	创建资源的标识类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
MachineExtension	描述计算机扩展。
MachineExtensionInstanceView	介绍计算机扩展实例视图。
MachineExtensionProperties	描述计算机扩展的属性。
MachineExtensionUpdate	描述计算机扩展更新。
Status	实例视图状态。
StatusLevelTypes	级别代码。
systemData	与资源的创建和上次修改相关的元数据。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

MachineExtension

描述计算机扩展。

名称	类型	说明
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	资源所在的地理位置
name	string	资源的名称
properties	MachineExtensionProperties	介绍计算机扩展属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

MachineExtensionInstanceView

介绍计算机扩展实例视图。

名称	类型	说明
name	string	计算机扩展名称。
status	Status	实例视图状态。
type	string	指定扩展的类型;例如“CustomScriptExtension”。
typeHandlerVersion	string	指定脚本处理程序的版本。

MachineExtensionProperties

描述计算机扩展的属性。

名称	类型	说明
autoUpgradeMinorVersion	boolean	指示扩展是否应使用较新的次要版本（如果在部署时可用）。但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。
enableAutomaticUpgrade	boolean	指示如果有较新的可用版本，平台是否应自动升级扩展。
forceUpdateTag	string	如何在扩展配置未更改的情况下强制更新扩展处理程序。
instanceView	MachineExtensionInstanceView	计算机扩展实例视图。
protectedSettings		该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。
provisioningState	string	预配状态，仅显示在响应中。
publisher	string	扩展处理程序发布者的名称。
settings		扩展的 Json 格式的公共设置。
type	string	指定扩展的类型;例如“CustomScriptExtension”。
typeHandlerVersion	string	指定脚本处理程序的版本。

MachineExtensionUpdate

描述计算机扩展更新。

名称	类型	说明
properties.autoUpgradeMinorVersion	boolean	指示扩展是否应使用较新的次要版本（如果在部署时可用）。但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。
properties.enableAutomaticUpgrade	boolean	指示如果有较新的可用版本，平台是否应自动升级扩展。
properties.forceUpdateTag	string	如何在扩展配置未更改的情况下强制更新扩展处理程序。
properties.protectedSettings		该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。
properties.publisher	string	扩展处理程序发布者的名称。
properties.settings		扩展的 Json 格式的公共设置。
properties.type	string	指定扩展的类型;例如“CustomScriptExtension”。
properties.typeHandlerVersion	string	指定脚本处理程序的版本。
tags	object	资源标记

Status

实例视图状态。

名称	类型	说明
code	string	状态代码。
displayStatus	string	状态的简短可本地化标签。
level	StatusLevelTypes	级别代码。
message	string	详细状态消息，包括警报和错误消息。
time	string	状态的时间。

StatusLevelTypes

级别代码。

名称	类型	说明
Error	string
Info	string
Warning	string

systemData

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

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

Machine Extensions - Update

URI 参数

请求正文

响应

安全性

azure_auth

Scopes

示例

Create or Update a Machine Extension

Sample Request

Sample Response

定义

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

MachineExtension

MachineExtensionInstanceView

MachineExtensionProperties

MachineExtensionUpdate

Status

StatusLevelTypes

systemData

其他资源