Guest Agent - Create

Dienst:

Azure Stack HCI

API-Version:

2024-01-01

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

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceUri	path	True	string	Der vollqualifizierte Azure Resource Manager-Bezeichner der hybriden Computerressource, die erweitert werden soll.
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.provisioningAction	ProvisioningAction	Die Gast-Agent-Bereitstellungsaktion.

Antworten

Name	Typ	Beschreibung
200 OK	GuestAgent	Aktualisiert
201 Created	GuestAgent	Erstellt
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

CreateGuestAgent

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default?api-version=2024-01-01

{
  "properties": {
    "provisioningAction": "install",
    "credentials": {
      "username": "tempuser",
      "password": "<password>"
    }
  }
}

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default",
  "name": "default",
  "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents",
  "properties": {
    "provisioningAction": "install",
    "status": "connected",
    "provisioningState": "Succeeded"
  }
}

Statuscode:

201

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default",
  "name": "default",
  "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents",
  "properties": {
    "provisioningAction": "install",
    "status": "connected",
    "provisioningState": "Created"
  }
}

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.
ProvisioningAction	Definiert die verschiedenen Arten von Vorgängen für den Gast-Agent.
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	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /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.provisioningAction	ProvisioningAction	Die Gast-Agent-Bereitstellungsaktion.
properties.provisioningState	string	Der Bereitstellungsstatus.
properties.status	string	Der Status des Gast-Agents.
systemData	systemData	Die Systemdaten.
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	Das Kennwort, das mit dem Gast verbunden werden soll.
username	string	Der Benutzername, der mit dem Gast verbunden werden soll.

ProvisioningAction

Enumeration

Definiert die verschiedenen Arten von Vorgängen für den Gast-Agent.

Wert	Beschreibung
install
uninstall
repair

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.