Machines - Create Or Update

參考

Service:: Hybrid Compute

API Version:: 2022-12-27

建立或更新混合式計算機的作業。請注意，某些屬性只能在機器建立期間設定。

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

URI 參數

名稱	位於	必要	類型	Description
machineName	path	True	string	混合式計算機的名稱。 Regex pattern: `^[a-zA-Z0-9-_\.]{1,54}$`
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源所在的地理位置
identity		Identity	資源的身分識別。
properties.agentUpgrade		AgentUpgrade	計算機 w.r.t 代理程序升級的資訊
properties.clientPublicKey		string	用戶端在初始資源上線期間所提供的公鑰
properties.cloudMetadata		CloudMetadata	雲端環境的元數據 (Azure/GCP/AWS/OCI...) 。
properties.extensions		MachineExtensionInstanceView[]	機器延伸模組資訊 (已被取代的欄位)
properties.locationData		locationData	與資源地理位置相關的元數據。
properties.mssqlDiscovered		string	指定電腦上是否探索到任何 MS SQL 實例。
properties.osProfile		OSProfile	指定混合式電腦的作業系統設定。
properties.osType		string	操作系統類型 (windows/linux) 。
properties.parentClusterResourceId		string	父叢集的資源標識碼 (Azure HCI) 指派給此電腦，如果有的話。
properties.privateLinkScopeResourceId		string	如果有任何，則會指派此計算機之私人連結範圍的資源標識符。
properties.serviceStatuses		ServiceStatuses	回報回 ARM 的相依服務狀態。
properties.vmId		string	指定混合式計算機的唯一標識碼。
tags		object	資源標籤。

回應

名稱	類型	Description
200 OK	Machine	確定
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Create or Update a Machine

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

{
  "location": "eastus2euap",
  "properties": {
    "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
    "locationData": {
      "name": "Redmond"
    },
    "clientPublicKey": "string",
    "parentClusterResourceId": "{AzureStackHCIResourceId}",
    "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

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;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2022-12-27/examples/Machines_CreateOrUpdate.json
// this example is just showing the usage of "Machines_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this HybridComputeMachineResource
HybridComputeMachineCollection collection = resourceGroupResource.GetHybridComputeMachines();

// invoke the operation
string machineName = "myMachine";
HybridComputeMachineData data = new HybridComputeMachineData(new AzureLocation("eastus2euap"))
{
    Identity = new ManagedServiceIdentity("SystemAssigned"),
    LocationData = new LocationData("Redmond"),
    VmId = Guid.Parse("b7a098cc-b0b8-46e8-a205-62f301a62a8f"),
    ClientPublicKey = "string",
    PrivateLinkScopeResourceId = new ResourceIdentifier("/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName"),
    ParentClusterResourceId = new ResourceIdentifier("{AzureStackHCIResourceId}"),
};
ArmOperation<HybridComputeMachineResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, machineName, data);
HybridComputeMachineResource 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
HybridComputeMachineData 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",
  "name": "myMachine",
  "location": "eastus2euap",
  "tags": null,
  "identity": {
    "type": "SystemAssigned",
    "principalId": "string",
    "tenantId": "string"
  },
  "type": "Microsoft.HybridCompute/machines",
  "properties": {
    "provisioningState": "Succeeded",
    "agentVersion": null,
    "status": null,
    "lastStatusChange": null,
    "errorDetails": null,
    "displayName": null,
    "machineFqdn": null,
    "vmUuid": null,
    "osSku": null,
    "domainName": null,
    "adFqdn": null,
    "dnsFqdn": null,
    "osVersion": null,
    "osType": null,
    "osProfile": {
      "computerName": null,
      "windowsConfiguration": {
        "patchSettings": {
          "assessmentMode": null,
          "patchMode": null
        }
      },
      "linuxConfiguration": {
        "patchSettings": {
          "assessmentMode": null,
          "patchMode": null
        }
      }
    },
    "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
    "locationData": {
      "name": "Redmond",
      "city": "redmond",
      "district": null,
      "countryOrRegion": "usa"
    },
    "clientPublicKey": "string",
    "parentClusterResourceId": "{AzureStackHCIResourceId}",
    "mssqlDiscovered": "false",
    "detectedProperties": {
      "cloudprovider": "N/A",
      "manufacturer": "Microsoft Corporation",
      "model": "Virtual Machine"
    },
    "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName"
  }
}

定義

名稱	Description
agent configuration mode	要使用的組態模式名稱。模式是 Microsoft 維護的安全性控制件、延伸模組允許清單和來賓設定預先定義的設定。
AgentConfiguration	用戶可以透過 azcmagent config 命令或在本機透過 ARM 設定的可設定屬性。
AgentUpgrade	w.r.t 代理程序升級資訊。
AssessmentModeTypes	指定評量模式。
CloudMetadata	雲端環境的元數據 (Azure/GCP/AWS/OCI...) 。
ConfigurationExtension	描述可識別延伸模組的屬性。
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
Identity	資源的身分識別。
LastAttemptStatusEnum	指定代理程序升級的狀態。
LinuxConfiguration	指定更新管理的 Linux 組態。
locationData	與資源地理位置相關的元數據。
Machine	描述混合式機器。
MachineExtension	描述機器擴充功能。
MachineExtensionInstanceView	描述計算機延伸模組實例檢視。
MachineExtensionProperties	描述機器擴充功能的屬性。
OSProfile	指定混合式電腦的作業系統設定。
PatchModeTypes	指定修補模式。
ResourceIdentityType	識別類型。
ServiceStatus	描述服務的狀態和行為。
ServiceStatuses	報告相依服務的狀態和行為。
Status	實例檢視狀態。
StatusLevelTypes	層級程序代碼。
StatusTypes	混合式計算機代理程序的狀態。
systemData	與建立和上次修改資源相關的元數據。
WindowsConfiguration	指定更新管理的 Windows 組態。

agent configuration mode

要使用的組態模式名稱。模式是 Microsoft 維護的安全性控制件、延伸模組允許清單和來賓設定預先定義的設定。

名稱	類型	Description
full	string
monitor	string

AgentConfiguration

用戶可以透過 azcmagent config 命令或在本機透過 ARM 設定的可設定屬性。

名稱	類型	Description
configMode	agent configuration mode	要使用的組態模式名稱。模式是由 Microsoft 維護的安全性控制件、延伸模組允許清單和來賓設定預先定義的組態。
extensionsAllowList	ConfigurationExtension[]	允許安裝或更新的延伸模組陣列。
extensionsBlockList	ConfigurationExtension[]	無法安裝或更新封鎖 (擴充功能陣列)
extensionsEnabled	string	指定延伸模組服務已啟用或停用。
guestConfigurationEnabled	string	指定客體設定服務已啟用或停用。
incomingConnectionsPorts	string[]	指定代理程式能夠接聽的埠清單。
proxyBypass	string[]	不應使用指定 Proxy 伺服器的服務名稱清單。
proxyUrl	string	指定要使用的 Proxy URL。

AgentUpgrade

w.r.t 代理程序升級資訊。

名稱	類型	Description
correlationId	string	每個升級從 RSM 傳入的相互關聯標識碼。
desiredVersion	string	指定計算機的版本資訊 w.r.t AgentUpgrade。
enableAutomaticUpgrade	boolean	指定 RSM 是否應該嘗試升級這部電腦
lastAttemptMessage	string	上次升級嘗試失敗的訊息。如果有的話。
lastAttemptStatus	LastAttemptStatusEnum	指定代理程序升級的狀態。
lastAttemptTimestamp	string	上次升級嘗試的時間戳

AssessmentModeTypes

指定評量模式。

名稱	類型	Description
AutomaticByPlatform	string
ImageDefault	string

CloudMetadata

雲端環境的元數據 (Azure/GCP/AWS/OCI...) 。

名稱	類型	Description
provider	string	指定 Azure/AWS/GCP...) (雲端提供者。

ConfigurationExtension

描述可識別延伸模組的屬性。

名稱	類型	Description
publisher	string	擴充功能的發行者。
type	string	延伸模組的類型。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

Identity

資源的身分識別。

名稱	類型	Description
principalId	string	資源識別的主要標識碼。
tenantId	string	資源的租用戶標識碼。
type	ResourceIdentityType	識別類型。

LastAttemptStatusEnum

指定代理程序升級的狀態。

名稱	類型	Description
Failed	string
Success	string

LinuxConfiguration

指定更新管理的 Linux 組態。

名稱	類型	Description
patchSettings.assessmentMode	AssessmentModeTypes	指定評量模式。
patchSettings.patchMode	PatchModeTypes	指定修補模式。

locationData

與資源地理位置相關的元數據。

名稱	類型	Description
city	string	資源所在的城市或位置。
countryOrRegion	string	資源所在的國家或地區
district	string	資源所在的區域、州或省。
name	string	地理或實體位置的正式名稱。

Machine

描述混合式機器。

名稱	類型	Description
id	string	資源的完整資源識別碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	資源的身分識別。
location	string	資源所在的地理位置
name	string	資源的名稱
properties.adFqdn	string	指定AD完整顯示名稱。
properties.agentConfiguration	AgentConfiguration	用戶可以透過 azcmagent config 命令或在本機透過 ARM 設定的可設定屬性。
properties.agentUpgrade	AgentUpgrade	計算機 w.r.t 代理程序升級的資訊
properties.agentVersion	string	混合式電腦代理程式完整版本。
properties.clientPublicKey	string	用戶端提供在初始資源上線期間使用的公鑰
properties.cloudMetadata	CloudMetadata	雲端環境的元數據 (Azure/GCP/AWS/OCI...) 。
properties.detectedProperties	object	從電腦偵測到屬性。
properties.displayName	string	指定混合式計算機顯示名稱。
properties.dnsFqdn	string	指定 DNS 完整顯示名稱。
properties.domainName	string	指定 Windows 功能變數名稱。
properties.errorDetails	ErrorDetail[]	錯誤狀態的詳細數據。
properties.extensions	MachineExtensionInstanceView[]	機器擴充功能資訊 (已被取代的欄位)
properties.lastStatusChange	string	上次狀態變更的時間。
properties.locationData	locationData	與資源地理位置相關的元數據。
properties.machineFqdn	string	指定混合式機器 FQDN。
properties.mssqlDiscovered	string	指定電腦上是否探索到任何 MS SQL 實例。
properties.osName	string	在混合式計算機上執行的作業系統。
properties.osProfile	OSProfile	指定混合式電腦的作業系統設定。
properties.osSku	string	指定作業系統產品 SKU。
properties.osType	string	操作系統 (windows/linux) 的類型。
properties.osVersion	string	在混合式計算機上執行的作業系統版本。
properties.parentClusterResourceId	string	(Azure HCI) 指派給此機器的資源識別碼，如果有的話。
properties.privateLinkScopeResourceId	string	如果有任何專案，則會將這部計算機指派給的私人連結範圍資源標識碼。
properties.provisioningState	string	布建狀態，只會出現在回應中。
properties.serviceStatuses	ServiceStatuses	回報回 ARM 的相依服務狀態。
properties.status	StatusTypes	混合式計算機代理程序的狀態。
properties.vmId	string	指定混合式計算機的唯一標識碼。
properties.vmUuid	string	指定 Arc 機器的唯一 SMBIOS 識別碼
resources	MachineExtension[]	與電腦建立關聯的擴充功能清單
systemData	systemData	Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
tags	object	資源標籤。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

MachineExtension

描述機器擴充功能。

名稱	類型	Description
id	string	資源的完整資源識別碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	資源所在的地理位置
name	string	資源的名稱
properties	MachineExtensionProperties	描述計算機擴充功能屬性。
systemData	systemData	Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
tags	object	資源標籤。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

MachineExtensionInstanceView

描述計算機延伸模組實例檢視。

名稱	類型	Description
name	string	計算機擴充功能名稱。
status	Status	實例檢視狀態。
type	string	指定延伸模組的類型;例如“CustomScriptExtension”。
typeHandlerVersion	string	指定文稿處理程式的版本。

MachineExtensionProperties

描述機器擴充功能的屬性。

名稱	類型	Description
autoUpgradeMinorVersion	boolean	指出擴充功能是否應該在部署時間使用較新的次要版本。不過，部署之後，除非重新部署延伸模組，否則延伸模組將不會升級次要版本，即使此屬性設定為 true 亦然。
enableAutomaticUpgrade	boolean	指出如果有較新版本可用，平臺是否應該自動升級延伸模組。
forceUpdateTag	string	延伸模組處理程式應該如何強制更新，即使延伸模組組態尚未變更也一樣。
instanceView	MachineExtensionInstanceView	計算機延伸模組實例檢視。
protectedSettings		此延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。
provisioningState	string	布建狀態，只會出現在回應中。
publisher	string	擴充處理程序發行者的名稱。
settings		擴充功能的 Json 格式化公用設定。
type	string	指定延伸模組的類型;範例為「CustomScriptExtension」。。
typeHandlerVersion	string	指定文稿處理程式的版本。

OSProfile

指定混合式電腦的作業系統設定。

名稱	類型	Description
computerName	string	指定混合式電腦的主機OS名稱。
linuxConfiguration	LinuxConfiguration	指定更新管理的 Linux 組態。
windowsConfiguration	WindowsConfiguration	指定更新管理的 Windows 組態。

PatchModeTypes

指定修補模式。

名稱	類型	Description
AutomaticByOS	string
AutomaticByPlatform	string
ImageDefault	string
Manual	string

ResourceIdentityType

識別類型。

名稱	類型	Description
SystemAssigned	string

ServiceStatus

描述服務的狀態和行為。

名稱	類型	Description
startupType	string	啟用 Arc 的電腦啟動時服務的行為。
status	string	服務的目前狀態。

ServiceStatuses

報告相依服務的狀態和行為。

名稱	類型	Description
extensionService	ServiceStatus	已啟用Arc之電腦上的擴充功能服務狀態。
guestConfigurationService	ServiceStatus	已啟用 Arc 的機器上客體設定服務的狀態。

Status

實例檢視狀態。

名稱	類型	Description
code	string	狀態碼。
displayStatus	string	狀態的簡短可當地語系化標籤。
level	StatusLevelTypes	層級程序代碼。
message	string	詳細的狀態消息，包括警示和錯誤訊息。
time	string	狀態的時間。

StatusLevelTypes

層級程序代碼。

名稱	類型	Description
Error	string
Info	string
Warning	string

StatusTypes

混合式計算機代理程序的狀態。

名稱	類型	Description
Connected	string
Disconnected	string
Error	string

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

WindowsConfiguration

指定更新管理的 Windows 組態。

名稱	類型	Description
patchSettings.assessmentMode	AssessmentModeTypes	指定評量模式。
patchSettings.patchMode	PatchModeTypes	指定修補模式。