Guest Agents - Get

Service:

Azure Arc enabled SCVMM

Version d'API:

2024-06-01

Obtient GuestAgent.
Implémente la méthode GUESTAgent GET.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceUri	path	True	string	Identificateur Azure Resource Manager complet de la ressource.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	GuestAgent	L’opération Azure s’est terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

GuestAgents_Get_MaximumSet

GuestAgents_Get_MinimumSet

GuestAgents_Get_MaximumSet

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

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

GuestAgents_Get_MinimumSet

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

{}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GuestAgent	Définit GuestAgent.
GuestCredential	Nom d’utilisateur /Informations d’identification du mot de passe pour se connecter à l’invité.
HttpProxyConfiguration	Configuration du proxy HTTP pour la machine virtuelle.
ProvisioningAction	Action d’approvisionnement de l’agent invité.
ProvisioningState	État d’approvisionnement de la ressource.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

GuestAgent

Définit GuestAgent.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.credentials	GuestCredential	Nom d’utilisateur /Informations d’identification du mot de passe pour approvisionner l’agent invité.
properties.customResourceName	string	Obtient le nom de la ressource correspondante dans Kubernetes.
properties.httpProxyConfig	HttpProxyConfiguration	Configuration du proxy HTTP pour la machine virtuelle.
properties.privateLinkScopeResourceId	string	L’ID de ressource de l’étendue de liaison privée à laquelle cette machine est affectée, le cas échéant.
properties.provisioningAction	ProvisioningAction	Obtient ou définit l’action d’approvisionnement de l’agent invité.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource.
properties.status	string	Obtient l’état de l’agent invité.
properties.uuid	string	Obtient un identificateur unique pour cette ressource.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

GuestCredential

Nom d’utilisateur /Informations d’identification du mot de passe pour se connecter à l’invité.

Nom	Type	Description
password	string	Obtient ou définit le mot de passe à connecter à l’invité.
username	string	Obtient ou définit le nom d’utilisateur à connecter avec l’invité.

HttpProxyConfiguration

Configuration du proxy HTTP pour la machine virtuelle.

Nom	Type	Description
httpsProxy	string	Obtient ou définit l’URL httpsProxy.

ProvisioningAction

Action d’approvisionnement de l’agent invité.

Nom	Type	Description
install	string	Installez l’agent invité.
repair	string	Réparer l’agent invité.
uninstall	string	Désinstallez l’agent invité.

ProvisioningState

État d’approvisionnement de la ressource.

Nom	Type	Description
Accepted	string	La ressource a été acceptée.
Canceled	string	La création de ressources a été annulée.
Created	string	La ressource a été créée.
Deleting	string	La ressource est en cours de suppression.
Failed	string	Échec de la création de ressources.
Provisioning	string	La ressource est en cours d’approvisionnement.
Succeeded	string	La ressource a été créée.
Updating	string	La ressource est mise à jour.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.