Listar assinaturas

Artigo
06/22/2024

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 uma lista de subscrições de webhook.

O conteúdo da resposta depende do contexto no qual o aplicativo está chamando; para obter detalhes, consulte os cenários na seção Permissões.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global	US Government L4	US Government L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	✅

Permissões

Dependendo do recurso e do tipo de permissão (delegado ou aplicativo) solicitado, a permissão especificada na tabela a seguir é a menos privilegiada necessária para fazer chamadas a esta API. Para saber mais, incluindo tomar cuidado antes de escolher as permissões mais privilegiadas, pesquise as seguintes permissões em Permissões.

Observação

Alguns recursos suportam notificações de alteração em vários cenários, cada um dos quais pode exigir permissões diferentes. Nesses casos, utilize o caminho do recurso para diferenciar os cenários.

Recurso com suporte	Delegada (conta corporativa ou de estudante)	Delegada (conta pessoal da Microsoft)	Application
approvalItems	Sem suporte.	Sem suporte.	ApprovalSolution.ReadWrite.All
callRecord	Sem suporte.	Sem suporte.	CallRecords.Read.All
callRecording `communications/onlineMeetings/getAllRecordings` Todas as gravações ficam disponíveis no inquilino.	Sem suporte.	Sem suporte.	OnlineMeetingRecording.Read.All
callRecording `communications/onlineMeetings/{onlineMeetingId}/recordings` Qualquer gravação fica disponível para uma reunião específica.	OnlineMeetingRecording.Read.All	Sem suporte.	OnlineMeetingRecording.Read.All
callRecording `users/{userId}/onlineMeetings/getAllRecordings` Uma gravação de chamada que fica disponível numa reunião organizada por um utilizador específico.	OnlineMeetingRecording.Read.All	Sem suporte.	OnlineMeetingRecording.Read.All
callRecording `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings` Uma gravação de chamada que fica disponível numa reunião onde está instalada uma determinada aplicação do Teams.	Sem suporte.	Sem suporte.	OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read.Chat
callTranscript `communications/onlineMeetings/getAllTranscripts` Qualquer transcrição fica disponível no inquilino.	Sem suporte.	Sem suporte.	OnlineMeetingTranscript.Read.All
callTranscript `communications/onlineMeetings/{onlineMeetingId}/transcripts` Qualquer transcrição fica disponível para uma reunião específica.	OnlineMeetingTranscript.Read.All	Sem suporte.	OnlineMeetingTranscript.Read.All
callTranscript `users/{userId}/onlineMeetings/getAllTranscripts` Uma transcrição de chamadas que fica disponível numa reunião organizada por um utilizador específico.	OnlineMeetingTranscript.Read.All	Sem suporte.	OnlineMeetingTranscript.Read.All
callTranscript `appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts` Uma transcrição de chamadas que fica disponível numa reunião onde está instalada uma determinada aplicação do Teams.	Sem suporte.	Sem suporte.	OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read.Chat
canal `/teams/getAllChannels` Todos os canais numa organização.	Sem suporte.	Sem suporte.	Channel.ReadBasic.All, ChannelSettings.Read.All
canal `/teams/{id}/channels` Todos os canais de uma determinada equipa numa organização.	Channel.ReadBasic.All, ChannelSettings.Read.All, Subscription.Read.All	Sem suporte.	Channel.ReadBasic.All, ChannelSettings.Read.All
chat `/chats` Todas as conversas numa organização.	Sem suporte.	Sem suporte.	Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat `/chats/{id}` Uma conversa específica.	Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All	Sem suporte.	ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, Chat.Manage.Chat, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat `/appCatalogs/teamsApps/{id}/installedToChats` Todas as conversas numa organização onde está instalada uma determinada aplicação do Teams.	Sem suporte.	Sem suporte.	Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
chat `/users/{id}/chats` Todas as conversas das quais um determinado utilizador faz parte.	Chat.ReadBasic, Chat.Read, Chat.ReadWrite	Sem suporte.	Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chatMessage `/teams/{id}/channels/{id}/messages` Todas as mensagens e respostas num canal específico.	ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All, Subscription.Read.All	Sem suporte.	ChannelMessage.Read.Group, ChannelMessage.Read.All
chatMessage `/teams/getAllMessages` Todas as mensagens de canal na organização.	Sem suporte.	Sem suporte.	ChannelMessage.Read.All
chatMessage `/chats/{id}/messages` Todas as mensagens numa conversa.	Chat.Read, Chat.ReadWrite, Subscription.Read.All	Sem suporte.	Chat.Read.All
chatMessage `/chats/getAllMessages` Todas as mensagens de chat numa organização.	Sem suporte.	Sem suporte.	Chat.Read.All
chatMessage `/users/{id}/chats/getAllMessages` Mensagens de chat para todas as conversas de que um determinado utilizador faz parte.	Chat.Read, Chat.ReadWrite, Subscription.Read.All	Sem suporte.	Chat.Read.All, Chat.ReadWrite.All
chatMessage `/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages` Mensagens de chat para todas as conversas numa organização onde está instalada uma determinada aplicação do Teams.	Sem suporte.	Sem suporte.	Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
contato	Contacts.Read, Subscription.Read.All	Contacts.Read, Subscription.Read.All	Contacts.Read
conversationMember `/chats/getAllMembers` Membros de todas as conversas numa organização.	Sem suporte.	Sem suporte.	ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember `/chats/{id}/members` Membros de uma conversa específica.	ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All	Sem suporte.	ChatMember.Read.Chat, Chat.Manage.Chat, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember `appCatalogs/teamsApps/{id}/installedToChats/getAllMembers` Chat members for all chats in an organization where a particular Teams app is installed.	Sem suporte.	Sem suporte.	ChatMember.Read.WhereInstalled, ChatMember.ReadWrite.WhereInstalled, Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
conversationMember `/teams/getAllMembers` Membros de todas as equipas numa organização.	Sem suporte.	Sem suporte.	TeamMember.Read.All, TeamMember.ReadWrite.All
conversationMember `/teams/{id}/members` Membros de uma determinada equipa.	TeamMember.Read.All, Subscription.Read.All	Sem suporte.	TeamMember.Read.All
conversationMember `/teams/{id}/channels/getAllMembers` Membros em todos os canais privados de uma determinada equipa.	Sem suporte.	Sem suporte.	ChannelMember.Read.All
conversationMember `/teams/getAllChannels/getAllMembers`	Sem suporte.	Sem suporte.	ChannelMember.Read.All
driveItem OneDrive pessoal do utilizador.	Sem suporte.	Files.ReadWrite, Subscription.Read.All	Sem suporte.
driveItem OneDrive para trabalho ou escola.	Files.ReadWrite.All, Subscription.Read.All	Sem suporte.	Files.ReadWrite.All
evento	Calendars.Read, Subscription.Read.All	Calendars.Read, Subscription.Read.All	Calendars.Read
grupo	Group.Read.All, Subscription.Read.All	Sem suporte.	Group.Read.All
conversa em grupo	Group.Read.All, Subscription.Read.All	Sem suporte.	Sem suporte.
list	Sites.ReadWrite.All, Subscription.Read.All	Sem suporte.	Sites.ReadWrite.All
message	Mail.ReadBasic, Mail.Read, Subscription.Read.All	Mail.ReadBasic, Mail.Read, Subscription.Read.All	Mail.Read
offerShiftRequest `/teams/{id}/schedule/offerShiftRequests` Alterações a qualquer pedido de turno de oferta numa equipa.	Schedule.Read.All, Schedule.ReadWrite.All	Sem suporte.	Schedule.Read.All, Schedule.ReadWrite.All
reunião online	Sem suporte.	Sem suporte.	OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All
openShiftChangeRequest `/teams/{id}/schedule/openShiftChangeRequests` Alterações a qualquer pedido de turno aberto numa equipa.	Schedule.Read.All, Schedule.ReadWrite.All	Sem suporte.	Schedule.Read.All, Schedule.ReadWrite.All
presence	Presence.Read.All, Subscription.Read.All	Sem suporte.	Sem suporte.
impressora	Sem suporte.	Sem suporte.	Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition	Sem suporte.	Sem suporte.	PrintTaskDefinition.ReadWrite.All
alerta de segurança	SecurityEvents.ReadWrite.All, Subscription.Read.All	Sem suporte.	SecurityEvents.ReadWrite.All
shift `/teams/{id}/schedule/shifts` Alterações a qualquer mudança numa equipa.	Schedule.Read.All, Schedule.ReadWrite.All	Sem suporte.	Schedule.Read.All, Schedule.ReadWrite.All
swapShiftsChangeRequest `/teams/{id}/schedule/swapShiftsChangeRequests` Alterações a qualquer pedido de turno de troca numa equipa.	Schedule.Read.All, Schedule.ReadWrite.All	Sem suporte.	Schedule.Read.All, Schedule.ReadWrite.All
team `/teams` Todas as equipas numa organização.	Sem suporte.	Sem suporte.	Team.ReadBasic.All, TeamSettings.Read.All
team `/teams/{id}` Uma equipa específica.	Team.ReadBasic.All, TeamSettings.Read.All, Subscription.Read.All	Sem suporte.	Team.ReadBasic.All, TeamSettings.Read.All
timeOffRequest `/teams/{id}/schedule/timeOffRequests` Alterações a qualquer pedido de folga numa equipa.	Schedule.Read.All, Schedule.ReadWrite.All	Sem suporte.	Schedule.Read.All, Schedule.ReadWrite.All
todoTask	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	Sem suporte.
user	User.Read.All, Subscription.Read.All	User.Read.All	User.Read.All
baseTask (preterido)	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	Sem suporte.

Observação

As seguintes permissões utilizam o consentimento específico do recurso:

OnlineMeetingRecording.Read.Chat
OnlineMeetingTranscript.Read.Chat
ChatSettings.Read.Chat
ChatSettings.ReadWrite.Chat
Chat.Manage.Chat
ChannelMessage.Read.Group
ChatMember.Read.Chat

Os resultados da resposta são baseados no contexto do aplicativo de chamada. As seções a seguir descrevem os cenários comuns.

Cenários Básicos

Normalmente, uma aplicação quer obter as subscrições que criou originalmente para o utilizador com sessão iniciada ou todos os utilizadores no diretório (contas escolares/profissionais). Estes cenários não requerem permissões especiais para além das que a aplicação utilizou originalmente para criar as respetivas subscrições.

Contexto do aplicativo de chamada	A resposta contém
O aplicativo está chamando em nome do usuário conectado (permissão delegada). -e- O aplicativo tem a permissão original necessária para criar a assinatura. Nota: Este cenário aplica-se tanto a contas Microsoft pessoais como a contas escolares/profissionais.	Subscrições criadas pela aplicação apenas para o utilizador com sessão iniciada.
O aplicativo está chamando em nome de si mesmo (permissão de aplicativo). -e- O aplicativo tem a permissão original necessária para criar a assinatura. Nota: este cenário aplica-se apenas a contas escolares/profissionais.	Subscrições criadas pela aplicação para si ou para qualquer utilizador no diretório.

Cenários avançados

Em alguns casos, um aplicativo deseja recuperar assinaturas criadas por outros aplicativos. Por exemplo, um usuário deseja ver todas as assinaturas criadas por qualquer aplicativo em seu nome. Em alternativa, um Administrador Global que pretenda ver todas as subscrições de todas as aplicações no respetivo diretório. Para esses cenários, é necessária uma permissão delegada Subscription.Read.All.

Contexto do aplicativo de chamada	A resposta contém
O aplicativo está chamando em nome do usuário conectado (permissão delegada). O usuário é um não administrador. -e- O aplicativo tem a permissão Subscription.Read.All Nota: este cenário aplica-se tanto a contas Microsoft pessoais como a contas escolares/profissionais.	Assinaturas criadas por qualquer aplicativo apenas para o usuário conectado.
O aplicativo está chamando em nome do usuário conectado (permissão delegada). O utilizador é um Administrador Global. -e- O aplicativo tem a permissão Subscription.Read.All Nota: este cenário aplica-se apenas a contas escolares/profissionais.	Assinaturas criadas por qualquer aplicativo para qualquer usuário no diretório.

Solicitação HTTP

GET /subscriptions

Parâmetros de consulta opcionais

Este método não suporta os parâmetros de consulta OData para ajudar a personalizar a resposta.

Cabeçalhos de solicitação

Nome	Tipo	Descrição
Autorização	string	{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

Se bem sucedido, este método retorna um código de resposta 200 OK e uma lista de objetos de assinatura no corpo da resposta.

Exemplo

Solicitação

GET https://graph.microsoft.com/beta/subscriptions


// 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
var result = await graphClient.Subscriptions.GetAsync();

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



mgc-beta subscriptions list

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



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

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
subscriptions, err := graphClient.Subscriptions().Get(context.Background(), nil)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SubscriptionCollectionResponse result = graphClient.subscriptions().get();

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

let subscriptions = await client.api('/subscriptions')
	.version('beta')
	.get();

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


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


$result = $graphServiceClient->subscriptions()->get()->wait();

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


Import-Module Microsoft.Graph.Beta.ChangeNotifications

Get-MgBetaSubscription

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


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

result = await graph_client.subscriptions.get()

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta.

Observação: a resposta mostrada aqui pode ser reduzida para legibilidade.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#subscriptions",
  "value": [
    {
      "id": "0fc0d6db-0073-42e5-a186-853da75fb308",
      "resource": "Users",
      "applicationId": "24d3b144-21ae-4080-943f-7067b395b913",
      "changeType": "updated,deleted",
      "clientState": null,
      "notificationUrl": "https://webhookappexample.azurewebsites.net/api/notifications",
      "lifecycleNotificationUrl":"https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
      "expirationDateTime": "2018-03-12T05:00:00Z",
      "creatorId": "8ee44408-0679-472c-bc2a-692812af3437",
      "latestSupportedTlsVersion": "v1_2",
      "encryptionCertificate": "",
      "encryptionCertificateId": "",
      "includeResourceData": false,
      "notificationContentType": "application/json"
    }
  ]
}

Observação: o valor da propriedade clientState não é retornado para fins de segurança.

Quando uma solicitação retorna várias páginas de dados, a resposta inclui uma propriedade @odata.nextLink para ajudá-lo a gerenciar os resultados. Para saber mais, consulte Paginação de dados do Microsoft Graph em seu aplicativo.

Compartilhar via

Listar assinaturas

Permissões

Cenários Básicos

Cenários avançados

Solicitação HTTP

Parâmetros de consulta opcionais

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplo

Solicitação

Resposta

Comentários

Recursos adicionais