Guest Agents - Create

參考

服務:: Azure Arc enabled SCVMM

API 版本:: 2024-06-01

實作 GuestAgent PUT 方法。
建立或更新 GuestAgent。

PUT https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2024-06-01

URI 參數

名稱	位於	必要	類型	Description
resourceUri	path	True	string	資源的完整 Azure Resource Manager 標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
properties.credentials	GuestCredential	用來布建客體代理程式的用戶名稱/密碼認證。
properties.httpProxyConfig	HttpProxyConfiguration	VM 的 HTTP Proxy 設定。
properties.privateLinkScopeResourceId	string	此計算機指派給私人連結範圍的資源標識符，如果有的話。
properties.provisioningAction	ProvisioningAction	取得或設定客體代理程式布建動作。

回應

名稱	類型	Description
200 OK	GuestAgent	資源『GuestAgent』更新作業成功
201 Created	GuestAgent	資源『GuestAgent』建立作業成功標題 Retry-After: integer
Other Status Codes	ErrorResponse	未預期的錯誤回應。

名稱

類型

Description

200 OK

GuestAgent

資源『GuestAgent』更新作業成功

201 Created

GuestAgent

資源『GuestAgent』建立作業成功

標題

Retry-After: integer

Other Status Codes

ErrorResponse

未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

範例

GuestAgents_Create_MaximumSet

GuestAgents_Create_MinimumSet

GuestAgents_Create_MaximumSet

範例要求

HTTP

PUT https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2024-06-01

{
  "properties": {
    "credentials": {
      "username": "jqxuwirrcpfv",
      "password": "gkvbnmuahumuoibvscoxzfdqwvfuf"
    },
    "httpProxyConfig": {
      "httpsProxy": "uoyzyticmohohomlkwct"
    },
    "provisioningAction": "install"
  }
}

範例回覆

狀態碼:: 200

{
  "properties": {
    "uuid": "hbsgztyakewtgbuxbesezncnzu",
    "credentials": {
      "username": "jqxuwirrcpfv"
    },
    "httpProxyConfig": {
      "httpsProxy": "uoyzyticmohohomlkwct"
    },
    "provisioningAction": "install",
    "status": "jpoukrzfenzrmjdahimkl",
    "customResourceName": "mhqymxkapuvsugd",
    "provisioningState": "Succeeded",
    "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName"
  },
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default",
  "name": "rwecpthzyt",
  "type": "dkcgcbtlwtsedxzhvtu",
  "systemData": {
    "createdBy": "p",
    "createdByType": "User",
    "createdAt": "2024-01-29T22:28:00.094Z",
    "lastModifiedBy": "goxcwpyyqlxndquly",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-29T22:28:00.095Z"
  }
}

狀態碼:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "properties": {
    "uuid": "hbsgztyakewtgbuxbesezncnzu",
    "credentials": {
      "username": "jqxuwirrcpfv"
    },
    "httpProxyConfig": {
      "httpsProxy": "uoyzyticmohohomlkwct"
    },
    "provisioningAction": "install",
    "status": "jpoukrzfenzrmjdahimkl",
    "customResourceName": "mhqymxkapuvsugd",
    "provisioningState": "Succeeded",
    "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName"
  },
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default",
  "name": "rwecpthzyt",
  "type": "dkcgcbtlwtsedxzhvtu",
  "systemData": {
    "createdBy": "p",
    "createdByType": "User",
    "createdAt": "2024-01-29T22:28:00.094Z",
    "lastModifiedBy": "goxcwpyyqlxndquly",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-29T22:28:00.095Z"
  }
}

GuestAgents_Create_MinimumSet

範例要求

HTTP

PUT https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2024-06-01

{}

範例回覆

狀態碼:: 200

{}

狀態碼:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GuestAgent	定義 GuestAgent。
GuestCredential	用來連線至來賓的用戶名稱/密碼認證。
HttpProxyConfiguration	VM 的 HTTP Proxy 設定。
ProvisioningAction	客體代理程式布建動作。
ProvisioningState	資源的布建狀態。
systemData	與建立和上次修改資源相關的元數據。

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 物件。

GuestAgent

定義 GuestAgent。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.credentials	GuestCredential	用來布建客體代理程式的用戶名稱/密碼認證。
properties.customResourceName	string	取得 Kubernetes 中對應資源的名稱。
properties.httpProxyConfig	HttpProxyConfiguration	VM 的 HTTP Proxy 設定。
properties.privateLinkScopeResourceId	string	此計算機指派給私人連結範圍的資源標識符，如果有的話。
properties.provisioningAction	ProvisioningAction	取得或設定客體代理程式布建動作。
properties.provisioningState	ProvisioningState	資源布建狀態。
properties.status	string	取得客體代理程序狀態。
properties.uuid	string	取得此資源的唯一標識碼。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

GuestCredential

用來連線至來賓的用戶名稱/密碼認證。

名稱	類型	Description
password	string	取得或設定要與來賓連線的密碼。
username	string	取得或設定要與來賓連線的用戶名稱。

HttpProxyConfiguration

VM 的 HTTP Proxy 設定。

名稱	類型	Description
httpsProxy	string	取得或設定 HTTPsProxy URL。

ProvisioningAction

客體代理程式布建動作。

名稱	類型	Description
install	string	安裝客體代理程式。
repair	string	修復客體代理程式。
uninstall	string	卸載客體代理程式。

ProvisioningState

資源的布建狀態。

名稱	類型	Description
Accepted	string	已接受資源。
Canceled	string	已取消資源建立。
Created	string	資源已建立。
Deleting	string	正在刪除資源。
Failed	string	資源建立失敗。
Provisioning	string	資源正在布建。
Succeeded	string	已建立資源。
Updating	string	資源正在更新。

systemData

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

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

共用方式為

Guest Agents - Create

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

GuestAgents_Create_MaximumSet

範例要求

範例回覆

GuestAgents_Create_MinimumSet

範例要求

範例回覆

定義

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuestAgent

GuestCredential

HttpProxyConfiguration

ProvisioningAction

ProvisioningState

systemData

其他資源