Trabalhar com a API de comunicações de serviço no Microsoft Graph
A API de comunicações de serviço fornece postagens do centro de mensagens e integridade do serviço pertencentes aos serviços de nuvem da Microsoft inscritos pelo locatário. Você pode obter dados de integridade atuais e históricos de um serviço microsoft (por exemplo, o serviço Exchange Online está inativo). Você pode marcar a integridade do serviço para determinar se um problema está controlado e uma resolução está em andamento antes de chamar suporte ou passar tempo solucionando problemas. As postagens do centro de mensagens permitem acompanhar as alterações futuras, incluindo novos recursos, atualizações e outros anúncios importantes (por exemplo, Exchange Online está recebendo um novo recurso).
Authorization
O Microsoft Graph permite que os aplicativos obtenham acesso autorizado à integridade e alterem as comunicações sobre um serviço de nuvem da Microsoft inscrito por um locatário. Com as permissões delegadas ou de aplicativo apropriadas, seu aplicativo pode acessar os dados de comunicações em nome de um usuário conectado ou sem qualquer usuário conectado no locatário. Os tipos delegados e de aplicativo dessas permissões são concedidos apenas por um administrador.
Para obter mais informações sobre tokens de acesso, registro de aplicativo e permissões delegadas e de aplicativo, confira Noções básicas de autenticação e autorização.
Acessar a API de comunicações do serviço em nome do usuário conectado
Permissões delegadas são necessárias para acessar a API de comunicações de serviço em nome de um usuário conectado. Aplicativos de tela voltados para o cliente, como o Centro de administração do Microsoft 365 (acessível apenas para funções de administrador), podem chamar a API de comunicações de serviço para obter os dados de anúncios de serviço e integridade do serviço para o locatário do usuário conectado, em nome do usuário conectado. Os usuários podem descobrir se seus servis inscritos são saudáveis ou têm problemas. Eles também podem aprender sobre quaisquer problemas de serviço atuais que afetam seus locatários.
Controle de acesso baseado em função para acesso à delegação
A API de comunicações de serviço também aplica o RBAC (controle de acesso baseado em função) para identificar se o usuário conectado que está em nome exigiu Microsoft Entra função. O usuário conectado do qual está em nome deve ter pelo menos uma das funções de administrador.
Para obter mais informações sobre as funções de administrador Microsoft Entra, confira:
- Sobre as funções de administrador no centro de administração do Microsoft 365
- Microsoft Entra funções internas
- Funções no Microsoft 365, incluindo Microsoft Entra ID, funções específicas de serviço e entre serviços
Acessar a API de comunicações do serviço sem usuário
As permissões de aplicativo são necessárias para acessar a API de comunicações de serviço sem um usuário conectado. Aplicativos executados como serviços de back-end, como serviços de monitoramento ou alerta, podem chamar a API de comunicações de serviço com sua própria identidade e não em nome de um usuário. Esses serviços de back-end podem criar pipelines personalizados de monitoramento/alerta e chamar a API de comunicações de serviço para obter dados de anúncios de serviço e integridade do serviço.
Casos de uso comuns e permissões necessárias
| Casos de uso | Solicitações de API | Permissões obrigatórias | Tipos de permissão com suporte |
|---|---|---|---|
| Listar visões gerais de integridade para locatário | Lista healthOverviews | ServiceHealth.Read.All | Delegado e aplicativo |
| Obter informações específicas de integridade do serviço para locatário | Obter serviceHealth | ServiceHealth.Read.All | Delegado e aplicativo |
| Listar todos os problemas de serviço para locatário | Problemas de lista | ServiceHealth.Read.All | Delegado e aplicativo |
| Obter um problema de serviço específico para o locatário | Obter problema | ServiceHealth.Read.All | Delegado e aplicativo |
| Obter um relatório de revisão pós-incidente para locatário | Obter relatório de incidente | ServiceHealth.Read.All | Delegado e aplicativo |
| Listar todas as mensagens de serviço para locatário | Listar mensagens | ServiceMessage.Read.All | Delegado e aplicativo |
| Obter uma mensagem de serviço específica para o locatário | Obter mensagem | ServiceMessage.Read.All | Delegado e aplicativo |
| Atualizar status de mensagem de serviço para usuário conectado | Para obter uma lista de operações de status, consulte serviceUpdateMessage. | ServiceMessageViewpoint.Write | Delegated |
Disponibilidade de nuvem nacional do Microsoft Graph
A API de comunicações de serviço está disponível nas nuvens nacionais do Microsoft Graph. Você pode obter dados de integridade e comunicações de serviço para seus locatários de nuvens nacionais.
| Nuvens nacionais | URL da API (parcial) |
|---|---|
| Serviço global do Microsoft Graph | https://graph.microsoft.com/v1.0/admin/serviceAnnouncement/| |
| Microsoft Graph para O Governo dos EUA L4 (GccHigh) | https://graph.microsoft.us/v1.0/admin/serviceAnnouncement/ |
| Microsoft Graph for US Government L5 (DoD) | https://dod-graph.microsoft.us/v1.0/admin/serviceAnnouncement/ |
| Microsoft Graph China operado pela 21Vianet | https://microsoftgraph.chinacloudapi.cn/v1.0/admin/serviceAnnouncement/ |
Para obter detalhes sobre a disponibilidade nacional de nuvem, consulte Nuvens nacionais do Microsoft Graph.
Limites de comunicações de serviço
Para garantir o desempenho do serviço, a API de comunicações de serviço tem limites de limitação para as solicitações por locatário por aplicativo. Para obter detalhes sobre os limites, consulte limitação de limites para o serviço de comunicações de serviço.
Próximas etapas
A API de comunicações de serviço pode abrir novas maneiras de você se envolver com usuários. Para obter mais informações, confira o seguinte: