Obtención de datos de audiencia

Artículo
07/08/2024

Use el siguiente método en las API de hardware de Microsoft para obtener las audiencias aplicables a su organización. Las audiencias permiten restringir una publicación a las máquinas con una configuración determinada. Por ejemplo, una implementación de prueba solo se puede entregar a los clientes con una clave del Registro determinada instalada.

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

Para poder utilizar estos métodos, el producto y el envío deben existir ya en su cuenta del Centro de desarrollo. Para crear o administrar envíos para productos, consulte los métodos en Administrar envíos de productos.

Descripción	Método	URI
Obtenga una lista de audiencias aplicables a su organización.	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/audiences`

Requisitos previos

Si aún no lo ha hecho, complete todos los requisitos previos para las API de hardware de Microsoft antes de intentar usar cualquiera de estos métodos.

Recursos de datos

Los métodos de las API de hardware de Microsoft para obtener datos de etiquetas de envío usan los siguientes recursos de datos JSON.

Recurso de audiencia

Este recurso representa una audiencia que es aplicable a su organización.

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

Este recurso tiene los siguientes valores

Valor	Tipo	Descripción
id	string	Identificador de la audiencia. Este es el valor que se recibirá o enviará en la etiqueta de envío.
nombre	string	Nombre descriptivo de la audiencia
descripción	string	Descripción del público
audienceName	string	Nombre de la audiencia

Solicitar

Este método tiene la sintaxis siguiente.

Método	URI de solicitud
GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/audience`

Encabezado de solicitud

Encabezado	Tipo	Descripción
Autorización	string	Necesario. Token de acceso de Id. de Microsoft Entra en el formulario Token> de portador<.
aceptar	string	Opcional. Especifica el tipo de contenido. El valor permitido es "application/json"

Parámetros de solicitud

No proporcione parámetros de solicitud para este método.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Ejemplos de solicitud

En el ejemplo siguiente se muestra cómo recuperar información sobre las audiencias aplicables a su organización.

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

Respuesta

En el ejemplo siguiente se muestra el cuerpo de respuesta JSON devuelto por una solicitud correcta para todas las audiencias aplicables a la organización. Los detalles sobre los valores del cuerpo de la respuesta aparecen en la tabla siguiente al ejemplo.

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