Guest Agents - Create

Service:: Azure Arc enabled SCVMM

API-versie:: 2025-03-13

Implementeert de PUT-methode GuestAgent.
GuestAgent maken of bijwerken.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceUri	path	True	string	De volledig gekwalificeerde Azure Resource Manager-id van de resource.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
properties.credentials	GuestCredential	Gebruikersnaam/wachtwoordreferenties voor het inrichten van de gastagent.
properties.httpProxyConfig	HttpProxyConfiguration	HTTP-proxyconfiguratie voor de VIRTUELE machine.
properties.privateLinkScopeResourceId	string (arm-id)	De resource-id van het private link-bereik waaraan deze machine, indien van toepassing, is toegewezen.
properties.provisioningAction	ProvisioningAction	Hiermee haalt u de inrichtingsactie voor de gastagent op of stelt u deze in.

Antwoorden

Name	Type	Description
200 OK	GuestAgent	De updatebewerking 'GuestAgent' van de resource is voltooid
201 Created	GuestAgent	De bewerking voor het maken van de resource 'GuestAgent' is voltooid Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Name

Type

Description

200 OK

GuestAgent

De updatebewerking 'GuestAgent' van de resource is voltooid

201 Created

GuestAgent

De bewerking voor het maken van de resource 'GuestAgent' is voltooid

Kopteksten

Retry-After: integer

Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

GuestAgents_Create_MaximumSet

GuestAgents_Create_MinimumSet

GuestAgents_Create_MaximumSet

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

HTTP

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

{}

Voorbeeldrespons

Statuscode:: 200

{}

Statuscode:: 201

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

{}

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GuestAgent	Definieert de GuestAgent.
GuestCredential	Gebruikersnaam/wachtwoordreferenties om verbinding te maken met gast.
HttpProxyConfiguration	HTTP-proxyconfiguratie voor de VIRTUELE machine.
ProvisioningAction	Inrichtingsactie voor gastagenten.
ProvisioningState	De inrichtingsstatus van de resource.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GuestAgent

Object

Definieert de GuestAgent.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.credentials	GuestCredential	Gebruikersnaam/wachtwoordreferenties voor het inrichten van de gastagent.
properties.customResourceName	string	Hiermee haalt u de naam op van de bijbehorende resource in Kubernetes.
properties.httpProxyConfig	HttpProxyConfiguration	HTTP-proxyconfiguratie voor de VIRTUELE machine.
properties.privateLinkScopeResourceId	string (arm-id)	De resource-id van het private link-bereik waaraan deze machine, indien van toepassing, is toegewezen.
properties.provisioningAction	ProvisioningAction	Hiermee haalt u de inrichtingsactie voor de gastagent op of stelt u deze in.
properties.provisioningState	ProvisioningState	Inrichtingsstatus van de resource.
properties.status	string	Hiermee haalt u de status van de gastagent op.
properties.uuid	string	Hiermee haalt u een unieke id voor deze resource op.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

GuestCredential

Object

Gebruikersnaam/wachtwoordreferenties om verbinding te maken met gast.

Name	Type	Description
password	string (password)	Hiermee haalt u het wachtwoord op of stelt u het in om verbinding te maken met de gast.
username	string	Hiermee haalt u de gebruikersnaam op of stelt u deze in om verbinding te maken met de gast.

HttpProxyConfiguration

Object

HTTP-proxyconfiguratie voor de VIRTUELE machine.

Name	Type	Description
httpsProxy	string	Hiermee haalt u httpsProxy-URL op of stelt u deze in.

ProvisioningAction

Inventarisatie

Inrichtingsactie voor gastagenten.

Waarde	Description
install	Installeer de gastagent.
uninstall	Verwijder de gastagent.
repair	Gastagent herstellen.

ProvisioningState

Inventarisatie

De inrichtingsstatus van de resource.

Waarde	Description
Succeeded	De resource is gemaakt.
Failed	Het maken van resources is mislukt.
Canceled	Het maken van resources is geannuleerd.
Provisioning	De resource wordt ingericht.
Updating	De resource wordt bijgewerkt.
Deleting	De resource wordt verwijderd.
Accepted	De resource is geaccepteerd.
Created	De resource is gemaakt.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Delen via

Guest Agents - Create

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

GuestAgents_Create_MaximumSet

Voorbeeldaanvraag

Voorbeeldrespons

GuestAgents_Create_MinimumSet

Voorbeeldaanvraag

Voorbeeldrespons

Definities

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuestAgent

GuestCredential

HttpProxyConfiguration

ProvisioningAction

ProvisioningState

systemData