reportRoot: getTeamsTeamCounts
Namespace: microsoft.graph
Importante
As APIs na versão /beta
no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Obtenha o número de equipes de um tipo específico em uma instância do Microsoft Teams.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ✅ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Tipo de permissão | Permissões menos privilegiadas | Permissões privilegiadas mais altas |
---|---|---|
Delegada (conta corporativa ou de estudante) | Reports.Read.All | Indisponível. |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Aplicativo | Reports.Read.All | Indisponível. |
Nota: Para que as permissões delegadas permitam que os aplicativos leiam relatórios de uso do serviço em nome de um usuário, o administrador do locatário deve ter atribuído ao usuário a função de administrador adequada Microsoft Entra ID limitada. Para obter mais informações, confira Autorização para APIs lerem relatórios de uso do Microsoft 365.
Solicitação HTTP
GET /reports/getTeamsTeamCounts(period='{period_value}')
Parâmetros de função
Na URL de solicitação, forneça os seguintes parâmetros com um valor válido.
Parâmetro | Tipo | Descrição |
---|---|---|
ponto | cadeia de caracteres | Especifica o período de tempo durante o qual o relatório é agregado. Os valores com suporte para {period_value} são: D7 , D30 , , D90 e D180 . Esses valores seguem o formato Dn, em que n representa o número de dias sobre os quais o relatório é agregado. Obrigatório. |
Nota: Você precisa definir o período ou a data na URL de solicitação.
Parâmetros de consulta opcionais
Esse método dá suporte ao $format
parâmetro de consulta OData para personalizar a resposta. O tipo de saída padrão é text/csv
. No entanto, se você quiser especificar o tipo de saída, poderá usar o parâmetro de consulta OData $format
para definir a saída padrão como text/csv
ou application/json
.
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
CSV
Se for bem-sucedido, esse método retornará uma 302 Found
resposta que redireciona para uma URL de download pré-autenticada para o relatório. Essa URL pode ser encontrada no cabeçalho Location
na resposta.
URLs de download pré-autenticadas são válidas apenas por um curto período (alguns minutos) e não exigem um Authorization
cabeçalho.
O arquivo CSV possui os seguintes cabeçalhos para colunas:
- Data de atualização do relatório
- Data do relatório
- Equipes Públicas
- Equipes Públicas Ativas
- Equipes Privadas
- Equipes Privadas Ativas
JSON
Se for bem-sucedido, esse método retornará um 200 OK
código de resposta e um objeto JSON no corpo da resposta.
Exemplos
Exemplo 1: saída CSV
Aqui está um exemplo que gera CSV.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(period='D7')?$format=text/csv
Resposta
O exemplo a seguir mostra a resposta.
HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe
Siga o redirecionamento 302 e o arquivo CSV que baixa o esquema a seguir.
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,
Exemplo 2: saída JSON
Aqui está um exemplo que retorna JSON.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(period='D7')?$format=application/json
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
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
}
]
}
]
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de