Udostępnij przez


Pobieranie danych odbiorców

Użyj następującej metody w interfejsów API sprzętowych Microsoftu, aby uzyskać odbiorców stosownych do twojej organizacji. Odbiorcy umożliwiają ograniczenie publikacji do maszyn z określoną konfiguracją. Na przykład wdrożenie testowe można dostarczyć tylko do klientów z zainstalowanym określonym kluczem rejestru.

https://manage.devcenter.microsoft.com/v2.0/my/hardware/audiences

Aby można było użyć tych metod, produkt i zgłoszenie muszą już istnieć na koncie Centrum Dev. Aby utworzyć zgłoszenia produktów lub zarządzać nimi, zapoznaj się z metodami w sekcji Zarządzanie zgłoszeniami produktów.

Opis Metoda URI
Pobierz listę odbiorców mających zastosowanie do twojej organizacji. GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/audiences

Wymagania wstępne

Jeśli jeszcze tego nie zrobiono, przed podjęciem próby użycia dowolnej z tych metod wykonaj wszystkie wymagania wstępne dla interfejsów API sprzętu firmy Microsoft.

Zasoby danych

Metody interfejsów API sprzętu firmy Microsoft do pobierania danych etykiet wysyłkowych używają następujących zasobów danych JSON.

Zasób odbiorców

Ten zasób reprezentuje odbiorców, którzy mają zastosowanie do Twojej organizacji.

{
  "id": "9f4f44d8-bfec-48c6-a02c-2d9ea220f6e2",
  "name": "My Custom Audience",
  "description": "Matches machines that have the following registry key: HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\FOO-BAR",
  "audienceName": "Sample_Audience_Key"
}

Ten zasób ma następujące wartości

Wartość Typ Opis
id sznurek Identyfikator odbiorców. Jest to wartość, która zostanie odebrana lub wysłana w etykiecie wysyłkowej.
nazwa sznurek Przyjazna nazwa odbiorców
opis sznurek Opis odbiorców
nazwaOdbiorcy sznurek Nazwa odbiorców

Żądanie

Ta metoda ma następującą składnię.

Metoda Żądanie URI
GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/audience

Nagłówek żądania

Nagłówek Typ Opis
Autoryzacja sznurek To jest wymagane. Token dostępu Microsoft Entra ID w formie typu Bearer<tokenu>.
akceptować sznurek Opcjonalny. Określa typ zawartości. Dozwolona wartość to "application/json"

Parametry żądania

Nie należy podawać parametrów żądania dla tej metody.

Ciało żądania

Nie należy podawać treści żądania dla tej metody.

Prośba o przykłady

W poniższym przykładzie pokazano, jak pobrać informacje o odbiorcach mających zastosowanie do organizacji.

GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/audience HTTP/1.1
Authorization: Bearer <your access token>

Odpowiedź

W poniższym przykładzie pokazano treść odpowiedzi JSON zwróconą przez pomyślne żądanie dla wszystkich odbiorców mających zastosowanie do organizacji. Szczegółowe informacje o wartościach w treści odpowiedzi są wyświetlane w tabeli poniżej przykładu.

{
  "value": [
    {
      "id": "9f4f44d8-bfec-48c6-a02c-2d9ea220f6e2",
      "name": "Test Registry Key",
      "description": "Matches machines that have the following registry key: HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\Test Drivers - use at own risk",
      "audienceName": "Test_Registry_Key"
    },
    {
      "id": "10415bba-3572-421b-a3de-d0d347bace5f",
      "name": "Test Audience 2",
      "description": "Additional Audience",
      "audienceName": "Test_Audeince_2"
    }
  ],
  "links": [
    {
      "href": "https://manage.devcenter..microsoft.com/api/v1/hardware/audiences",
      "rel": "self",
      "method": "GET"
    }
  ]
}

Ten zasób ma następujące wartości

Wartość Typ Opis
wartość układ Zbiór obiektów, które zawierają informacje o każdej grupie docelowej. Aby uzyskać więcej informacji na temat danych w każdym obiekcie, zapoznaj się z zasobem odbiorców.
Odsyłacze układ Tablica obiektów z przydatnymi linkami dotyczącymi jednostki zawierającej. Aby uzyskać więcej informacji, zobacz obiekt linku.

Zobacz też

  • przykłady interfejsu API pulpitu nawigacyjnego sprzętu (GitHub)