Guest Agents - Create

Odwołanie

Usługa:: Azure Arc enabled SCVMM

Wersja interfejsu API:: 2024-06-01

Implementuje metodę GUESTAgent PUT.
Utwórz lub zaktualizuj agenta gościa.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceUri	path	True	string	W pełni kwalifikowany identyfikator zasobu usługi Azure Resource Manager.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
properties.credentials	GuestCredential	Poświadczenia nazwy użytkownika/hasła do aprowizowania agenta gościa.
properties.httpProxyConfig	HttpProxyConfiguration	Konfiguracja serwera proxy HTTP dla maszyny wirtualnej.
properties.privateLinkScopeResourceId	string	Identyfikator zasobu zakresu łącza prywatnego, do którego przypisano tę maszynę, jeśli istnieje.
properties.provisioningAction	ProvisioningAction	Pobiera lub ustawia akcję aprowizacji agenta gościa.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GuestAgent	Operacja aktualizacji zasobu "GuestAgent" zakończyła się pomyślnie
201 Created	GuestAgent	Operacja tworzenia zasobu "GuestAgent" powiodła się Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Nazwa

Typ

Opis

200 OK

GuestAgent

Operacja aktualizacji zasobu "GuestAgent" zakończyła się pomyślnie

201 Created

GuestAgent

Operacja tworzenia zasobu "GuestAgent" powiodła się

Nagłówki

Retry-After: integer

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

GuestAgents_Create_MaximumSet

GuestAgents_Create_MinimumSet

GuestAgents_Create_MaximumSet

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 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

Przykładowe żądanie

HTTP

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

{}

Przykładowa odpowiedź

Kod stanu:: 200

{}

Kod stanu:: 201

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

{}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GuestAgent	Definiuje agenta GuestAgent.
GuestCredential	Poświadczenia nazwy użytkownika/hasła w celu nawiązania połączenia z gościem.
HttpProxyConfiguration	Konfiguracja serwera proxy HTTP dla maszyny wirtualnej.
ProvisioningAction	Akcja aprowizacji agenta gościa.
ProvisioningState	Stan aprowizacji zasobu.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

GuestAgent

Definiuje agenta GuestAgent.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.credentials	GuestCredential	Poświadczenia nazwy użytkownika/hasła do aprowizowania agenta gościa.
properties.customResourceName	string	Pobiera nazwę odpowiedniego zasobu na platformie Kubernetes.
properties.httpProxyConfig	HttpProxyConfiguration	Konfiguracja serwera proxy HTTP dla maszyny wirtualnej.
properties.privateLinkScopeResourceId	string	Identyfikator zasobu zakresu łącza prywatnego, do którego przypisano tę maszynę, jeśli istnieje.
properties.provisioningAction	ProvisioningAction	Pobiera lub ustawia akcję aprowizacji agenta gościa.
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu.
properties.status	string	Pobiera stan agenta gościa.
properties.uuid	string	Pobiera unikatowy identyfikator tego zasobu.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

GuestCredential

Poświadczenia nazwy użytkownika/hasła w celu nawiązania połączenia z gościem.

Nazwa	Typ	Opis
password	string	Pobiera lub ustawia hasło, aby nawiązać połączenie z gościem.
username	string	Pobiera lub ustawia nazwę użytkownika w celu nawiązania połączenia z gościem.

HttpProxyConfiguration

Konfiguracja serwera proxy HTTP dla maszyny wirtualnej.

Nazwa	Typ	Opis
httpsProxy	string	Pobiera lub ustawia adres URL httpsProxy.

ProvisioningAction

Akcja aprowizacji agenta gościa.

Nazwa	Typ	Opis
install	string	Zainstaluj agenta gościa.
repair	string	Napraw agenta gościa.
uninstall	string	Odinstaluj agenta gościa.

ProvisioningState

Stan aprowizacji zasobu.

Nazwa	Typ	Opis
Accepted	string	Zasób został zaakceptowany.
Canceled	string	Tworzenie zasobów zostało anulowane.
Created	string	Zasób został utworzony.
Deleting	string	Zasób jest usuwany.
Failed	string	Tworzenie zasobu nie powiodło się.
Provisioning	string	Zasób aprowizacji.
Succeeded	string	Zasób został utworzony.
Updating	string	Zasób jest aktualizowany.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Guest Agents - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

GuestAgents_Create_MaximumSet

Przykładowe żądanie

Przykładowa odpowiedź

GuestAgents_Create_MinimumSet

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuestAgent

GuestCredential

HttpProxyConfiguration

ProvisioningAction

ProvisioningState

systemData

Dodatkowe zasoby