reportRoot: getTeamsTeamCounts
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta
de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Obtenga el número de equipos de un tipo determinado en una instancia de Microsoft Teams.
Esta API está disponible en las siguientes implementaciones nacionales de nube.
Servicio global | Gobierno de EE. UU. L4 | Us Government L5 (DOD) | China operada por 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ✅ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
Tipo de permiso | Permisos con privilegios mínimos | Permisos con privilegios más altos |
---|---|---|
Delegado (cuenta profesional o educativa) | Reports.Read.All | No disponible. |
Delegado (cuenta personal de Microsoft) | No admitida. | No admitida. |
Aplicación | Reports.Read.All | No disponible. |
Nota: Para que los permisos delegados permitan a las aplicaciones leer informes de uso del servicio en nombre de un usuario, el administrador de inquilinos debe haber asignado al usuario el rol de administrador limitado de Identificador de Microsoft Entra adecuado. Para obtener más información, consulte Autorización para que las API lean los informes de uso de Microsoft 365.
Solicitud HTTP
GET /reports/getTeamsTeamCounts(period='{period_value}')
Parámetros de función
En la dirección URL de la solicitud, proporcione los parámetros siguientes con un valor válido.
Parámetro | Tipo | Descripción |
---|---|---|
period | cadena | Especifica la duración de tiempo durante la que se agrega el informe. Los valores admitidos para {period_value} son: D7 , D30 , D90 y D180 . Estos valores siguen el formato Dn, donde n representa el número de días durante los que se agrega el informe. Obligatorio. |
Nota: Debe establecer el período o la fecha en la dirección URL de la solicitud.
Parámetros de consulta opcionales
Este método admite el $format
parámetro de consulta OData para personalizar la respuesta. El tipo de salida predeterminado es text/csv
. Sin embargo, si desea especificar el tipo de salida, puede usar el parámetro de consulta OData $format
para establecer la salida predeterminada en text/csv
o application/json
.
Encabezados de solicitud
Nombre | Descripción |
---|---|
Authorization | {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización. |
Cuerpo de la solicitud
No proporcione un cuerpo de solicitud para este método.
Respuesta
CSV
Si se ejecuta correctamente, este método devuelve una 302 Found
respuesta que redirige a una dirección URL de descarga autenticada previamente para el informe. La URL se encuentra en el encabezado Location
de la respuesta.
Las direcciones URL de descarga autenticadas previamente solo son válidas durante un breve período (unos minutos) y no requieren un Authorization
encabezado.
El archivo CSV tiene los siguientes encabezados de columna:
- Fecha de actualización del informe
- Fecha del informe
- Equipos públicos
- Equipos públicos activos
- Equipos privados
- Equipos privados activos
JSON
Si se ejecuta correctamente, este método devuelve un 200 OK
código de respuesta y un objeto JSON en el cuerpo de la respuesta.
Ejemplos
Ejemplo 1: salida CSV
Este es un ejemplo que genera CSV.
Solicitud
En el ejemplo siguiente se muestra la solicitud.
GET https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(period='D7')?$format=text/csv
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe
Siga el redireccionamiento 302 y el archivo CSV que descarga tiene el siguiente esquema.
HTTP/1.1 200 OK
Content-Type: application/octet-stream
Report Refresh Date,Report Date,Public Teams,Active Public Teams,Private Teams,Active Private Teams,
Ejemplo 2: Salida JSON
Este es un ejemplo que devuelve JSON.
Solicitud
En el ejemplo siguiente se muestra la solicitud.
GET https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(period='D7')?$format=application/json
Respuesta
En el ejemplo siguiente se muestra la respuesta.
Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 641
{
"@odata.context": "https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(period='D7')?$format=application/json&$skiptoken=D07uj",
"value": [
{
"reportRefreshDate": "2021-09-01",
"reportPeriod":7,
"teamsTeamUsageByDate": [
{
"reportDate": "2022-08-01",
"publicTeams": 26,
"privateTeams": 17,
"activePublicTeams": 20,
"activePrivateTeams": 12
}
]
}
]
}