Updates - Get Operations

Usługa:

Device Update

Wersja interfejsu API:

2020-09-01

Pobierz listę wszystkich operacji aktualizacji importu. Ukończone operacje są przechowywane przez 7 dni przed automatycznym usunięciem. Operacje usuwania nie są zwracane przez tę wersję interfejsu API.

GET https://{accountEndpoint}/deviceupdate/{instanceId}/v2/updates/operations

Z parametrami opcjonalnymi:

GET https://{accountEndpoint}/deviceupdate/{instanceId}/v2/updates/operations?$filter={$filter}&$top={$top}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountEndpoint	path	True	string	Punkt końcowy konta.
instanceId	path	True	string	Identyfikator wystąpienia konta.
$filter	query		string	Ogranicza zestaw zwracanych operacji. Obsługiwany jest tylko jeden konkretny filtr: "status eq 'NotStarted' lub status eq 'Running'"
$top	query		integer (int32)	Określa nieujemną liczbę całkowitą n, która ogranicza liczbę elementów zwracanych z kolekcji. Usługa zwraca liczbę dostępnych elementów do, ale nie większą niż określona wartość n.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PageableListOfOperations	Szczegóły operacji.
429 Too Many Requests		Zbyt wiele żądań; Istnieje limit szybkości dla liczby operacji, które można wykonać w danym okresie.

Zabezpieczenia

azure_auth_implicit

Przepływ niejawny OAuth2 usługi Azure Active Directory

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

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

azure_auth_code

Przepływ kodu dostępu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

azure_auth_application

Przepływ aplikacji OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: application
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Zakresy

Nazwa	Opis
.default	zakres poświadczeń klienta

azure_auth_password

Przepływ haseł protokołu OAuth2 w usłudze Azure Active Directory

Typ: oauth2
Flow: password
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Updates_GetOperations

Przykładowe żądanie

HTTP

GET https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/updates/operations

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
      "status": "Succeeded",
      "resourceLocation": "/v2/updates/providers/microsoft/names/adu/versions/1.0.0.0",
      "traceId": "2b881ef9deaf5d45b0a716ca5b4145ec",
      "createdDateTime": "2020-04-22T21:00:53.2548897+00:00",
      "lastActionDateTime": "2020-04-22T21:01:43.9401420+00:00",
      "etag": "\"a0f7b6f2-3f6c-4eb6-8a59-2f5411c23888\""
    }
  ]
}

Kod stanu:

429

Definicje

Nazwa	Opis
Error	Szczegóły błędu.
InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
Operation	Metadane operacji.
OperationStatus	Stan operacji.
PageableListOfOperations	Lista operacji z obsługą stronicowania serwera.
UpdateId	Aktualizowanie identyfikatora.

Error

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu zdefiniowany przez serwer.
details	Error[]	Tablica błędów, które doprowadziły do zgłoszonego błędu.
innererror	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
occurredDateTime	string (date-time)	Data i godzina w formacie UTC, kiedy wystąpił błąd.
target	string	Element docelowy błędu.

InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż podany przez błąd zawierający.
errorDetail	string	Wewnętrzny komunikat o błędzie lub wyjątku.
innerError	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.

Operation

Objekt

Metadane operacji.

Nazwa	Typ	Opis
createdDateTime	string (date-time)	Data i godzina w formacie UTC utworzenia operacji.
error	Error	Napotkano błąd operacji, jeśli istnieje.
etag	string	Operacja ETag.
lastActionDateTime	string (date-time)	Data i godzina w formacie UTC, kiedy stan operacji został ostatnio zaktualizowany.
operationId	string	Identyfikator operacji.
resourceLocation	string	Lokalizacja zaimportowanej aktualizacji, gdy operacja zakończy się pomyślnie.
status	OperationStatus	Stan operacji.
traceId	string	Tożsamość korelacji operacji, która może być używana przez pomoc techniczną firmy Microsoft do rozwiązywania problemów.
updateId	UpdateId	Tożsamość importowanej lub usuniętej aktualizacji. W przypadku importu ta właściwość zostanie wypełniona tylko po pomyślnym przetworzeniu manifestu importu.

OperationStatus

Wyliczanie

Stan operacji.

Wartość	Opis
Failed	Operacja w tle zakończyła się niepowodzeniem.
NotStarted	Operacja w tle została utworzona, ale nie została jeszcze uruchomiona.
Running	Operacja w tle jest obecnie uruchomiona.
Succeeded	Operacja w tle zakończyła się powodzeniem.
Undefined	Stan niezdefiniowanej operacji.

PageableListOfOperations

Objekt

Lista operacji z obsługą stronicowania serwera.

Nazwa	Typ	Opis
nextLink	string	Link do następnej strony elementów.
value	Operation[]	Kolekcja elementów z możliwością stronicowania.

UpdateId

Objekt

Aktualizowanie identyfikatora.

Nazwa	Typ	Opis
name	string	Zaktualizuj nazwę.
provider	string	Dostawca aktualizacji.
version	string	Zaktualizuj wersję.