Guest Agents - Create

Riferimento

Servizio:: Azure Arc enabled SCVMM

Versione API:: 2024-06-01

Implementa il metodo GuestAgent PUT.
Creare o aggiornare GuestAgent.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceUri	path	True	string	Identificatore completo di Azure Resource Manager della risorsa.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.credentials	GuestCredential	Nome utente/Credenziali password per il provisioning dell'agente guest.
properties.httpProxyConfig	HttpProxyConfiguration	Configurazione del proxy HTTP per la macchina virtuale.
properties.privateLinkScopeResourceId	string	ID risorsa dell'ambito del collegamento privato a cui questo computer viene assegnato, se presente.
properties.provisioningAction	ProvisioningAction	Ottiene o imposta l'azione di provisioning dell'agente guest.

Risposte

Nome	Tipo	Descrizione
200 OK	GuestAgent	Operazione di aggiornamento della risorsa 'GuestAgent' completata
201 Created	GuestAgent	Operazione di creazione della risorsa 'GuestAgent' completata Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Nome

Tipo

Descrizione

200 OK

GuestAgent

Operazione di aggiornamento della risorsa 'GuestAgent' completata

201 Created

GuestAgent

Operazione di creazione della risorsa 'GuestAgent' completata

Intestazioni

Retry-After: integer

Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

GuestAgents_Create_MaximumSet

GuestAgents_Create_MinimumSet

GuestAgents_Create_MaximumSet

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Codice di stato:: 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

Esempio di richiesta

HTTP

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

{}

Risposta di esempio

Codice di stato:: 200

{}

Codice di stato:: 201

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

{}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
GuestAgent	Definisce l'agente Guest.
GuestCredential	Nome utente/Credenziali password per la connessione al guest.
HttpProxyConfiguration	Configurazione del proxy HTTP per la macchina virtuale.
ProvisioningAction	Azione di provisioning dell'agente guest.
ProvisioningState	Stato di provisioning della risorsa.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

GuestAgent

Definisce l'agente Guest.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties.credentials	GuestCredential	Nome utente/Credenziali password per il provisioning dell'agente guest.
properties.customResourceName	string	Ottiene il nome della risorsa corrispondente in Kubernetes.
properties.httpProxyConfig	HttpProxyConfiguration	Configurazione del proxy HTTP per la macchina virtuale.
properties.privateLinkScopeResourceId	string	ID risorsa dell'ambito del collegamento privato a cui questo computer viene assegnato, se presente.
properties.provisioningAction	ProvisioningAction	Ottiene o imposta l'azione di provisioning dell'agente guest.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa.
properties.status	string	Ottiene lo stato dell'agente guest.
properties.uuid	string	Ottiene un identificatore univoco per questa risorsa.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

GuestCredential

Nome utente/Credenziali password per la connessione al guest.

Nome	Tipo	Descrizione
password	string	Ottiene o imposta la password per la connessione con il guest.
username	string	Ottiene o imposta il nome utente da connettere al guest.

HttpProxyConfiguration

Configurazione del proxy HTTP per la macchina virtuale.

Nome	Tipo	Descrizione
httpsProxy	string	Ottiene o imposta l'URL httpsProxy.

ProvisioningAction

Azione di provisioning dell'agente guest.

Nome	Tipo	Descrizione
install	string	Installare l'agente guest.
repair	string	Ripristinare l'agente guest.
uninstall	string	Disinstallare l'agente guest.

ProvisioningState

Stato di provisioning della risorsa.

Nome	Tipo	Descrizione
Accepted	string	La risorsa è stata accettata.
Canceled	string	La creazione della risorsa è stata annullata.
Created	string	La risorsa è stata creata.
Deleting	string	La risorsa viene eliminata.
Failed	string	Creazione della risorsa non riuscita.
Provisioning	string	La risorsa è il provisioning.
Succeeded	string	La risorsa è stata creata.
Updating	string	La risorsa viene aggiornata.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Condividi tramite

Guest Agents - Create

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

GuestAgents_Create_MaximumSet

Esempio di richiesta

Risposta di esempio

GuestAgents_Create_MinimumSet

Esempio di richiesta

Risposta di esempio

Definizioni

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuestAgent

GuestCredential

HttpProxyConfiguration

ProvisioningAction

ProvisioningState

systemData

Risorse aggiuntive