Abrufen von Daten zur Zielgruppe

Artikel
07/08/2024

Verwenden Sie die folgende Methode in Microsoft-Hardware-APIs , um die für Ihre Organisation anwendbaren Zielgruppen abzurufen. Benutzergruppen ermöglichen es Ihnen, eine Publikation auf Computer mit einer bestimmten Konfiguration einzuschränken. Beispielsweise kann eine Testbereitstellung nur an Clients übermittelt werden, bei der ein bestimmter Registrierungsschlüssel installiert ist.

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

Bevor Sie diese Methoden verwenden können, müssen das Produkt und die Übermittlung bereits in Ihrem Dev Center-Konto vorhanden sein. Um Produktübermittlungen zu erstellen oder zu verwalten, lesen Sie die Methoden in Produktübermittlungen verwalten.

Beschreibung	Method	URI
Rufen Sie eine Liste der Zielgruppen ab, die für Ihre Organisation gelten.	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/audiences`

Voraussetzungen

Falls noch nicht geschehen, führen Sie alle Voraussetzungen für die Microsoft-Hardware-APIs aus, bevor Sie versuchen, eine dieser Methoden zu verwenden.

Datenressourcen

Die Methoden der Microsoft-Hardware-APIs zum Abrufen von Versandetikettendaten verwenden die folgenden JSON-Datenressourcen.

Benutzergruppenressource

Diese Ressource stellt eine Zielgruppe dar, die für Ihre Organisation gilt.

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

Diese Ressource hat die folgenden Werte:

Wert	Typ	Beschreibung
id	Zeichenfolge	Die ID der Zielgruppe. Dies ist der Wert, der im Versandetikett empfangen oder gesendet wird.
name	Zeichenfolge	Anzeigename der Zielgruppe
Beschreibung	string	Beschreibung der Zielgruppe
audienceName	Zeichenfolge	Name der Zielgruppe

Anfordern

Diese Methode weist die folgende Syntax auf.

Methode	Anforderungs-URI
GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/audience`

Anforderungsheader

Header	Typ	Beschreibung
Autorisierung	Zeichenfolge	Erforderlich. Das Microsoft Entra ID-Zugriffstoken im Formular bearer-Token><.
Akzeptieren	Zeichenfolge	Optional. Gibt den Inhaltstyp an. Zulässiger Wert ist "application/json"

Anforderungsparameter

Stellen Sie keine Anforderungsparameter für diese Methode bereit.

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Beispiele für Anforderungen

Das folgende Beispiel veranschaulicht, wie Informationen zu Zielgruppen abgerufen werden, die für Ihre Organisation gelten.

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

Antwort

Das folgende Beispiel veranschaulicht den JSON-Antworttext, der von einer erfolgreichen Anforderung für alle Zielgruppen zurückgegeben wird, die für Ihre Organisation gelten. Details zu den Werten im Antworttext werden in der Tabelle nach dem Beispiel angezeigt.

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