reportRoot: getMailboxUsageDetail

Namespace: microsoft.graph

Obtenha dados sobre o uso da caixa de correio.

Observação: para saber mais sobre diferentes visualizações e nomes de relatórios, confira Relatórios do Microsoft 365 - Uso da caixa de correio.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

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.

Observação: 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 Microsoft Entra limitada apropriada. Para saber mais, confira Autorização para APIs lerem os relatórios de uso do Microsoft 365.

Solicitação HTTP

GET /reports/getMailboxUsageDetail(period='{period_value}')

Parâmetros de função

Na URL da solicitação, forneça um valor válido ao seguinte parâmetro.

Cabeçalhos de solicitação

Resposta

Se for bem-sucedido, este método retorna uma resposta 302 Found que redireciona para uma URL de download pré-autenticada para o relatório. Essa URL pode ser encontrada no cabeçalho Location na resposta.

As URLs de download previamente autenticadas são válidas apenas por um curto período de tempo (alguns minutos) e não exigem um cabeçalho Authorization.

O arquivo CSV possui os seguintes cabeçalhos para colunas.

• Data de atualização do relatório
• Nome UPN
• Nome de exibição
• Excluído
• Data de exclusão
• Data de criação
• Data da última atividade
• Contagem de itens
• Armazenamento utilizado (bytes)
• Cota de aviso de problema (bytes)
• Cota de proibição de envio (bytes)
• Cota de envio/recebimento (bytes)
• Contagem de itens excluídos
• Tamanho de itens excluídos (bytes)
• Cota de Item Excluída (bytes)
• Tem que Arquivar
• Período de Relatório

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/reports/getMailboxUsageDetail(period='D7')

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Reports.GetMailboxUsageDetailWithPeriod("{period}").GetAsync();

mgc reports get-mailbox-usage-detail-with-period get --period {period-id}

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
period := "{period}"
graphClient.Reports().GetMailboxUsageDetailWithPeriod(&period).Get(context.Background(), nil)

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.reports().getMailboxUsageDetailWithPeriod("{period}").get();

const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/reports/getMailboxUsageDetail(period='D7')')
	.get();

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->reports()->getMailboxUsageDetailWithPeriod('{period}', )->get()->wait();

Import-Module Microsoft.Graph.Reports

Get-MgReportMailboxUsageDetail -Period $periodId 

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.reports.get_mailbox_usage_detail_with_period("{period}").get()

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 baixado terá o seguinte esquema.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Created Date,Last Activity Date,Item Count,Storage Used (Byte),Issue Warning Quota (Byte),Prohibit Send Quota (Byte),Prohibit Send/Receive Quota (Byte),Deleted Item Count,Deleted Item Size (Byte),Report Period