Guest Agents - Create

Layanan:: Azure Arc enabled SCVMM

Versi API:: 2025-03-13

Menerapkan metode GUESTAgent PUT.
Buat atau Perbarui GuestAgent.

PUT https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2025-03-13

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceUri	path	True	string	Pengidentifikasi Azure Resource manager sumber daya yang sepenuhnya memenuhi syarat.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.credentials	GuestCredential	Kredensial Nama Pengguna/Kata Sandi untuk menyediakan agen tamu.
properties.httpProxyConfig	HttpProxyConfiguration	Konfigurasi Proksi HTTP untuk VM.
properties.privateLinkScopeResourceId	string (arm-id)	Id sumber daya dari cakupan tautan privat tempat komputer ini ditetapkan, jika ada.
properties.provisioningAction	ProvisioningAction	Mendapatkan atau mengatur tindakan provisi agen tamu.

Respons

Nama	Jenis	Deskripsi
200 OK	GuestAgent	Operasi pembaruan Sumber Daya 'GuestAgent' berhasil
201 Created	GuestAgent	Operasi pembuatan Sumber Daya 'GuestAgent' berhasil Header Retry-After: integer
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Nama

Jenis

Deskripsi

200 OK

GuestAgent

Operasi pembaruan Sumber Daya 'GuestAgent' berhasil

201 Created

GuestAgent

Operasi pembuatan Sumber Daya 'GuestAgent' berhasil

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

GuestAgents_Create_MaximumSet

GuestAgents_Create_MinimumSet

GuestAgents_Create_MaximumSet

Permintaan sampel

HTTP

PUT https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2025-03-13

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

Respon sampel

Kode status:: 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"
  }
}

Kode status:: 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

Permintaan sampel

HTTP

PUT https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2025-03-13

{}

Respon sampel

Kode status:: 200

{}

Kode status:: 201

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

{}

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
GuestAgent	Menentukan GuestAgent.
GuestCredential	Kredensial Nama Pengguna/Kata Sandi untuk tersambung ke tamu.
HttpProxyConfiguration	Konfigurasi Proksi HTTP untuk VM.
ProvisioningAction	Tindakan provisi agen tamu.
ProvisioningState	Status provisi sumber daya.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

GuestAgent

Objek

Menentukan GuestAgent.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties.credentials	GuestCredential	Kredensial Nama Pengguna/Kata Sandi untuk menyediakan agen tamu.
properties.customResourceName	string	Mendapatkan nama sumber daya yang sesuai di Kubernetes.
properties.httpProxyConfig	HttpProxyConfiguration	Konfigurasi Proksi HTTP untuk VM.
properties.privateLinkScopeResourceId	string (arm-id)	Id sumber daya dari cakupan tautan privat tempat komputer ini ditetapkan, jika ada.
properties.provisioningAction	ProvisioningAction	Mendapatkan atau mengatur tindakan provisi agen tamu.
properties.provisioningState	ProvisioningState	Status provisi sumber daya.
properties.status	string	Mendapatkan status agen tamu.
properties.uuid	string	Mendapatkan pengidentifikasi unik untuk sumber daya ini.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

GuestCredential

Objek

Kredensial Nama Pengguna/Kata Sandi untuk tersambung ke tamu.

Nama	Jenis	Deskripsi
password	string (password)	Mendapatkan atau mengatur kata sandi untuk terhubung dengan tamu.
username	string	Mendapatkan atau mengatur nama pengguna untuk terhubung dengan tamu.

HttpProxyConfiguration

Objek

Konfigurasi Proksi HTTP untuk VM.

Nama	Jenis	Deskripsi
httpsProxy	string	Mendapatkan atau mengatur url httpsProxy.

ProvisioningAction

Enumeration

Tindakan provisi agen tamu.

Nilai	Deskripsi
install	Pasang agen tamu.
uninstall	Hapus instalan agen tamu.
repair	Perbaiki agen tamu.

ProvisioningState

Enumeration

Status provisi sumber daya.

Nilai	Deskripsi
Succeeded	Sumber daya telah dibuat.
Failed	Pembuatan sumber daya gagal.
Canceled	Pembuatan sumber daya dibatalkan.
Provisioning	Sumber daya sedang diprovisikan.
Updating	Sumber daya sedang diperbarui.
Deleting	Sumber daya sedang dihapus.
Accepted	Sumber daya telah diterima.
Created	Sumber daya dibuat.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

Bagikan melalui

Guest Agents - Create

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

GuestAgents_Create_MaximumSet

Permintaan sampel

Respon sampel

GuestAgents_Create_MinimumSet

Permintaan sampel

Respon sampel

Definisi

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuestAgent

GuestCredential

HttpProxyConfiguration

ProvisioningAction

ProvisioningState

systemData