Listar assinaturas

Namespace: microsoft.graph

Recupere as propriedades e os relacionamentos das assinaturas do webhook, com base no ID do aplicativo, no usuário e na função do usuário com um locatário.

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.

Permissões

Esta API suporta os seguintes escopos de permissão; para saber mais, incluindo como escolher permissões, confira Permissões.

Recurso com suporte	Delegada (conta corporativa ou de estudante)	Delegada (conta pessoal da Microsoft)	Application
callRecord (/communications/callRecords)	Incompatível	Incompatível	CallRecords.Read.All
canal (/teams/getAllChannels – todos os canais em uma organização)	Incompatível	Sem suporte	Channel.ReadBasic.All, ChannelSettings.Read.All
canal (/teams/{id}/channels)	Channel.ReadBasic.All, ChannelSettings.Read.All, Subscription.Read.All	Sem suporte	Channel.ReadBasic.All, ChannelSettings.Read.All
chat chat (/conversa – todos os chats em uma organização)	Incompatível	Incompatível	Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat (/chats/{id})	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
chatMessage (/teams/{id}/channels/{id}/messages)	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)	Chat.Read, Chat.ReadWrite, Subscription.Read.All	Sem suporte	Chat.Read.All
chatMessage (/teams/getAllMessages -- todas as mensagens de chat na organização)	Sem suporte	Sem suporte	Chat.Read.All
chatMessage (/users/{id}/chats/getAllMessages -- mensagens de chat para todos os chats dos quais um usuário específico faz parte)	Chat.Read, Chat.ReadWrite	Sem suporte	Chat.Read.All, Chat.ReadWrite.All
contato	Contacts.Read, Subscription.Read.All	Contacts.Read, Subscription.Read.All	Contacts.Read
conversationMember (/teams/{id}/channels/getAllMembers)	Incompatível	Incompatível	ChannelMember.Read.All
conversationMember (/chats/getAllMembers)	Incompatível	Sem suporte	ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember (/chats/{id}/members)	ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All	Incompatível	ChatMember.Read.Chat , Chat.Manage.Chat, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember (/teams/{id}/members)	TeamMember.Read.All, Subscription.Read.All	Incompatível	TeamMember.Read.All
driveItem (OneDrive pessoal de um usuário)	Sem suporte	Files.ReadWrite, Subscription.Read.All	Sem suporte
driveItem (OneDrive for Business)	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	Incompatível	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
presence	Presence.Read.All, Subscription.Read.All	Sem suporte	Incompatível
printer	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
equipe (/teams – todas as equipes em uma organização)	Sem suporte	Incompatível	Team.ReadBasic.All, TeamSettings.Read.All
equipe (/teams/{id})	Team.ReadBasic.All, TeamSettings.Read.All, Subscription.Read.All	Incompatível	Team.ReadBasic.All, TeamSettings.Read.All
todoTask	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	Incompatível
user	User.Read.All, Subscription.Read.All	User.Read.All	User.Read.All

Observação: Permissões marcadas com * usam consentimento específico de recurso.

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

Comumente, um aplicativo deseja recuperar assinaturas originalmente criadas para o usuário atualmente conectado ou para todos os usuários no diretório (contas corporativas/de estudante). Esses cenários não exigem permissões especiais além daquelas usadas originalmente pelo aplicativo para criar suas assinaturas.

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: Isso se aplica a contas pessoais da Microsoft e contas de trabalho/escola.	Assinaturas criadas por este aplicativo apenas para o usuário conectado.
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. Observação: Isso se aplica somente a contas de trabalho/escola.	Assinaturas criadas por este aplicativo para si ou para qualquer usuário 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. Ou, um administrador pode querer ver todas as assinaturas de todos os aplicativos em seu 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: Isso se aplica a contas pessoais da Microsoft e contas de trabalho/escola.	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 usuário é um administrador. -e- O aplicativo tem a permissão Subscription.Read.All Nota: Isso se aplica apenas a contas de trabalho/escola.	Assinaturas criadas por qualquer aplicativo para qualquer usuário no diretório.

Solicitação HTTP

GET /subscriptions

Parâmetros de consulta opcionais

Esse método não dá suporte aos parâmetros de consulta OData ajudar a personalizar a resposta.

Cabeçalhos de solicitação

Nome	Tipo	Descrição
Autorização	string	{token} de portador. Obrigatório.

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

HTTP

GET https://graph.microsoft.com/v1.0/subscriptions

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var subscriptions = await graphClient.Subscriptions
    .Request()
    .GetAsync();

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

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

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

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

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/subscriptions"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        NSError *jsonError = nil;
        MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
        MSGraphSubscription *subscription = [[MSGraphSubscription alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];

}];

[meDataTask execute];

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

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

SubscriptionCollectionPage subscriptions = graphClient.subscriptions()
    .buildRequest()
    .get();

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

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

result, err := graphClient.Subscriptions().Get()

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

PowerShell

Import-Module Microsoft.Graph.ChangeNotifications

Get-MgSubscription

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

Resposta

Este é um exemplo de 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/v1.0/$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.