Obtenir des données d’audience
Utilisez la méthode suivante dans les API matérielles Microsoft pour obtenir les audiences applicables à votre organisation. Les audiences vous permettent de restreindre une publication aux machines avec une configuration particulière. Par exemple, un déploiement de test peut être remis uniquement aux clients avec une clé de Registre particulière installée.
https://manage.devcenter.microsoft.com/v2.0/my/hardware/audiences
Avant de pouvoir utiliser ces méthodes, le produit et la soumission doivent déjà exister dans votre compte Dev Center. Pour créer ou gérer des soumissions de produits, consultez les méthodes de la section Gérer les soumissions de produits.
Description | Method | URI |
---|---|---|
Obtenez la liste des audiences applicables à votre organisation. | GET | https://manage.devcenter.microsoft.com/v2.0/my/hardware/audiences |
Prérequis
Si vous ne l’avez pas déjà fait, remplissez toutes les conditions préalables pour les API matérielles Microsoft avant d’essayer d’utiliser l’une de ces méthodes.
Ressources de données
Les méthodes d’API matérielles Microsoft pour obtenir des données d’étiquette d’expédition utilisent les ressources de données JSON suivantes.
Ressource d’audience
Cette ressource représente un public applicable à votre organisation.
{
"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"
}
Cette ressource a les valeurs suivantes
Valeur | Type | Description |
---|---|---|
id | string | ID du public. Il s’agit de la valeur qui sera reçue ou envoyée dans l’étiquette d’expédition. |
name | chaîne | Nom convivial du public |
description | string | Description du public |
audienceName | string | Nom de l’audience |
Requête
Cette méthode a la syntaxe suivante.
Méthode | URI de demande |
---|---|
GET | https://manage.devcenter.microsoft.com/v2.0/my/hardware/audience |
En-tête de requête
En-tête | Type | Description |
---|---|---|
Autorisation | string | Obligatoire. Jeton d’accès d’ID Microsoft Entra dans le jeton> porteur <de formulaire. |
accepter | string | facultatif. Spécifie le type de contenu. La valeur autorisée est « application/json » |
Paramètres de la demande
Ne fournissez pas de paramètres de requête pour cette méthode.
Corps de la demande
Ne fournissez pas de corps de requête pour cette méthode.
Exemples de requête
L’exemple suivant montre comment récupérer des informations sur les audiences applicables à votre organisation.
GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/audience HTTP/1.1
Authorization: Bearer <your access token>
Response
L’exemple suivant illustre le corps de réponse JSON retourné par une requête réussie pour tous les publics applicables à votre organisation. Les détails sur les valeurs dans le corps de la réponse apparaissent dans le tableau suivant l’exemple.
{
"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"
}
]
}
Cette ressource a les valeurs suivantes
Valeur | Type | Description |
---|---|---|
valeur | tableau | Tableau d’objets qui contiennent des informations sur chaque audience. Pour plus d’informations sur les données de chaque objet, consultez la ressource d’audience. |
liens | tableau | Tableau d’objets avec des liens utiles sur l’entité conteneur. Pour plus d’informations, consultez l’objet Link. |