Guest Agents - Create

Dienst:: Azure Arc enabled SCVMM

API-Version:: 2025-03-13

Implementiert die GuestAgent PUT-Methode.
Erstellen oder Aktualisieren von GuestAgent.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceUri	path	True	string	Der vollqualifizierte Azure Resource Manager-Bezeichner der Ressource.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.credentials	GuestCredential	Benutzername/Kennwortanmeldeinformationen zum Bereitstellen des Gast-Agents.
properties.httpProxyConfig	HttpProxyConfiguration	HTTP-Proxykonfiguration für den virtuellen Computer.
properties.privateLinkScopeResourceId	string (arm-id)	Die Ressourcen-ID des privaten Verknüpfungsbereichs, dem dieser Computer zugewiesen ist, falls vorhanden.
properties.provisioningAction	ProvisioningAction	Ruft die Bereitstellungsaktion des Gast-Agents ab oder legt sie fest.

Antworten

Name	Typ	Beschreibung
200 OK	GuestAgent	Der Aktualisierungsvorgang der Ressource "GuestAgent" war erfolgreich.
201 Created	GuestAgent	Der Erstellungsvorgang der Ressource "GuestAgent" war erfolgreich. Header Retry-After: integer
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

GuestAgent

Der Aktualisierungsvorgang der Ressource "GuestAgent" war erfolgreich.

201 Created

GuestAgent

Der Erstellungsvorgang der Ressource "GuestAgent" war erfolgreich.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

GuestAgents_Create_MaximumSet

GuestAgents_Create_MinimumSet

GuestAgents_Create_MaximumSet

Beispielanforderung

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"
  }
}

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Statuscode:: 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

Beispielanforderung

HTTP

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

{}

Beispiel für eine Antwort

Statuscode:: 200

{}

Statuscode:: 201

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

{}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GuestAgent	Definiert den GuestAgent.
GuestCredential	Benutzername/Kennwortanmeldeinformationen zum Herstellen einer Verbindung mit Gast.
HttpProxyConfiguration	HTTP-Proxykonfiguration für den virtuellen Computer.
ProvisioningAction	Gast-Agent-Bereitstellungsaktion.
ProvisioningState	Der Bereitstellungsstatus der Ressource.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GuestAgent

Objekt

Definiert den GuestAgent.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.credentials	GuestCredential	Benutzername/Kennwortanmeldeinformationen zum Bereitstellen des Gast-Agents.
properties.customResourceName	string	Ruft den Namen der entsprechenden Ressource in Kubernetes ab.
properties.httpProxyConfig	HttpProxyConfiguration	HTTP-Proxykonfiguration für den virtuellen Computer.
properties.privateLinkScopeResourceId	string (arm-id)	Die Ressourcen-ID des privaten Verknüpfungsbereichs, dem dieser Computer zugewiesen ist, falls vorhanden.
properties.provisioningAction	ProvisioningAction	Ruft die Bereitstellungsaktion des Gast-Agents ab oder legt sie fest.
properties.provisioningState	ProvisioningState	Bereitstellungsstatus der Ressource.
properties.status	string	Ruft den Status des Gast-Agents ab.
properties.uuid	string	Ruft einen eindeutigen Bezeichner für diese Ressource ab.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

GuestCredential

Objekt

Benutzername/Kennwortanmeldeinformationen zum Herstellen einer Verbindung mit Gast.

Name	Typ	Beschreibung
password	string (password)	Ruft das Kennwort ab, um eine Verbindung mit dem Gast herzustellen, oder legt es fest.
username	string	Ruft den Benutzernamen ab, der mit dem Gast verbunden werden soll, oder legt diesen fest.

HttpProxyConfiguration

Objekt

HTTP-Proxykonfiguration für den virtuellen Computer.

Name	Typ	Beschreibung
httpsProxy	string	Dient zum Abrufen oder Festlegen der httpsProxy-URL.

ProvisioningAction

Enumeration

Gast-Agent-Bereitstellungsaktion.

Wert	Beschreibung
install	Installieren Sie den Gast-Agent.
uninstall	Deinstallieren Sie den Gast-Agent.
repair	Reparieren sie den Gast-Agent.

ProvisioningState

Enumeration

Der Bereitstellungsstatus der Ressource.

Wert	Beschreibung
Succeeded	Ressource wurde erstellt.
Failed	Fehler bei der Ressourcenerstellung.
Canceled	Die Ressourcenerstellung wurde abgebrochen.
Provisioning	Die Ressource wird bereitgestellt.
Updating	Die Ressource wird aktualisiert.
Deleting	Die Ressource wird gelöscht.
Accepted	Die Ressource wurde akzeptiert.
Created	Die Ressource wurde erstellt.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Guest Agents - Create

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

GuestAgents_Create_MaximumSet

Beispielanforderung

Beispiel für eine Antwort

GuestAgents_Create_MinimumSet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuestAgent

GuestCredential

HttpProxyConfiguration

ProvisioningAction

ProvisioningState

systemData