Guest Agents - Create

Tjänst:: Azure Arc enabled SCVMM

API-version:: 2025-03-13

Implementerar Metoden GuestAgent PUT.
Skapa eller uppdatera GuestAgent.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceUri	path	True	string	Resursens fullständigt kvalificerade Azure Resource Manager-identifierare.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties.credentials	GuestCredential	Autentiseringsuppgifter för användarnamn/lösenord för att etablera gästagenten.
properties.httpProxyConfig	HttpProxyConfiguration	HTTP-proxykonfiguration för den virtuella datorn.
properties.privateLinkScopeResourceId	string (arm-id)	Resurs-ID:t för det privata länkomfång som den här datorn tilldelas till, om det finns några.
properties.provisioningAction	ProvisioningAction	Hämtar eller anger etableringsåtgärden för gästagenten.

Svar

Name	Typ	Description
200 OK	GuestAgent	Resursens uppdateringsåtgärd "GuestAgent" har slutförts
201 Created	GuestAgent	Resursen "GuestAgent" har skapats Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Name

Typ

Description

200 OK

GuestAgent

Resursens uppdateringsåtgärd "GuestAgent" har slutförts

201 Created

GuestAgent

Resursen "GuestAgent" har skapats

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

GuestAgents_Create_MaximumSet

GuestAgents_Create_MinimumSet

GuestAgents_Create_MaximumSet

Exempelbegäran

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

Exempelsvar

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

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

Exempelbegäran

HTTP

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

{}

Exempelsvar

Statuskod:: 200

{}

Statuskod:: 201

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

{}

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
GuestAgent	Definierar GuestAgent.
GuestCredential	Autentiseringsuppgifter för användarnamn/lösenord för att ansluta till gäst.
HttpProxyConfiguration	HTTP-proxykonfiguration för den virtuella datorn.
ProvisioningAction	Etableringsåtgärd för gästagent.
ProvisioningState	Resursens etableringstillstånd.
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

GuestAgent

Objekt

Definierar GuestAgent.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.credentials	GuestCredential	Autentiseringsuppgifter för användarnamn/lösenord för att etablera gästagenten.
properties.customResourceName	string	Hämtar namnet på motsvarande resurs i Kubernetes.
properties.httpProxyConfig	HttpProxyConfiguration	HTTP-proxykonfiguration för den virtuella datorn.
properties.privateLinkScopeResourceId	string (arm-id)	Resurs-ID:t för det privata länkomfång som den här datorn tilldelas till, om det finns några.
properties.provisioningAction	ProvisioningAction	Hämtar eller anger etableringsåtgärden för gästagenten.
properties.provisioningState	ProvisioningState	Etableringstillstånd för resursen.
properties.status	string	Hämtar gästagentens status.
properties.uuid	string	Hämtar en unik identifierare för den här resursen.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

GuestCredential

Objekt

Autentiseringsuppgifter för användarnamn/lösenord för att ansluta till gäst.

Name	Typ	Description
password	string (password)	Hämtar eller anger lösenordet för att ansluta till gästen.
username	string	Hämtar eller anger användarnamn för att ansluta till gästen.

HttpProxyConfiguration

Objekt

HTTP-proxykonfiguration för den virtuella datorn.

Name	Typ	Description
httpsProxy	string	Hämtar eller anger httpsProxy-url.

ProvisioningAction

Uppräkning

Etableringsåtgärd för gästagent.

Värde	Description
install	Installera gästagenten.
uninstall	Avinstallera gästagenten.
repair	Reparera gästagenten.

ProvisioningState

Uppräkning

Resursens etableringstillstånd.

Värde	Description
Succeeded	Resursen har skapats.
Failed	Det gick inte att skapa resurser.
Canceled	Resursskapandet avbröts.
Provisioning	Resursen etableras.
Updating	Resursen uppdateras.
Deleting	Resursen tas bort.
Accepted	Resursen har godkänts.
Created	Resursen skapades.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Dela via

Guest Agents - Create

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

GuestAgents_Create_MaximumSet

Exempelbegäran

Exempelsvar

GuestAgents_Create_MinimumSet

Exempelbegäran

Exempelsvar

Definitioner

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuestAgent

GuestCredential

HttpProxyConfiguration

ProvisioningAction

ProvisioningState

systemData