Excluir assinatura

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.

Exclua uma assinatura.

Para obter a lista de recursos que suportam a subscrição de notificações de alteração, consulte a tabela na secçã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	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	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	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	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	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	Contacts.Read	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	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	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 de um usuário)	Sem suporte.	Files.ReadWrite	Sem suporte.
driveItem (OneDrive para trabalho ou escola)	Files.ReadWrite.All	Sem suporte.	Files.ReadWrite.All
evento	Calendars.Read	Calendars.Read	Calendars.Read
grupo	Group.Read.All	Sem suporte.	Group.Read.All
conversa em grupo	Group.Read.All	Sem suporte.	Sem suporte.
list	Sites.ReadWrite.All	Sem suporte.	Sites.ReadWrite.All
message	Mail.ReadBasic, Mail.Read	Mail.ReadBasic, Mail.Read	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	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	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	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	Tasks.ReadWrite	Sem suporte.
user	User.Read.All	User.Read.All	User.Read.All
virtualEventWebinar	VirtualEvent.Read	Sem suporte.	VirtualEvent.Read.All
baseTask (preterido)	Tasks.ReadWrite	Tasks.ReadWrite	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

chatMessage

chatMessage assinaturas podem ser especificadas para incluir dados de recurso. Se especificado para incluir dados de recurso (includeResourceData definido como true), encryption é necessária. A criação de assinatura falhará se um encryptionCertificate não for especificado para tais assinaturas.

Tem de utilizar o cabeçalho do Prefer: include-unknown-enum-members pedido para obter os seguintes valores no chatMessagemessageTypeenum evoluível: systemEventMessage para /teams/{id}/channels/{id}/messages e /chats/{id}/messages recurso.

Observação

/teams/getAllMessages, /chats/getAllMessages, /me/chats/getAllMessages, /users/{id}/chats/getAllMessagese /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages são APIs com tráfego limitado; podem aplicar-se modelos de pagamento e requisitos de licenciamento . /teams/getAllMessages e /chats/getAllMessages suportam modelos model=A de pagamento e model=B , /me/chats/getAllMessages, /users/{id}/chats/getAllMessagese /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages suportam apenas model=B. Se não especificar um modelo de pagamento na consulta, será utilizado o modo de avaliação predefinido.

Observação

Para adicionar ou alterar um modelo de pagamento para um recurso subscrito de uma notificação de alteração, tem de criar uma nova subscrição de notificação de alteração com o novo modelo de pagamento; atualizar uma notificação de alteração existente não funciona.

conversationMember

conversationMember subscriptions can be specified to include resource data. Se especificado para incluir dados de recurso (includeResourceData definido como true), encryption é necessária. A criação de assinatura falhará se um encryptionCertificate não for especificado.

Observação

/teams/getAllMembers, /chats/getAllMemberse /appCatalogs/teamsApps/{id}/installedToChats/getAllMembers são APIs com tráfego limitado; podem aplicar-se modelos de pagamento e requisitos de licenciamento . /teams/getAllMembers e /chats/getAllMembers suportam modelos model=A de pagamento e model=B . /appCatalogs/teamsApps/{id}/installedToChats/getAllMembers suporta apenas model=B. Se não especificar um modelo de pagamento na consulta, será utilizado o modo de avaliação predefinido.

Observação

equipa, canal e chat

as subscrições de equipa, canal e chat podem ser especificadas para incluir dados de recursos. Se especificado para incluir dados de recurso (includeResourceData definido como true), encryption é necessária. A criação de assinatura falhará se um encryptionCertificate não for especificado.

Pode utilizar o parâmetro de cadeia de consulta notifyOnUserSpecificProperties quando subscrever alterações num chat específico ou ao nível do utilizador. Quando define o parâmetro de cadeia de consulta notifyOnUserSpecificProperties como durante a true criação da subscrição, são enviados dois tipos de payloads para o subscritor. Um tipo contém propriedades específicas do utilizador e o outro é enviado sem eles. Para obter mais informações, consulte Obter notificações de alteração para conversas com o Microsoft Graph.

Observação

/appCatalogs/teamsApps/{id}/installedToChats tem requisitos de licenciamento e pagamento, especificamente suportando apenas model=B. Se nenhum modelo for especificado, o modo de avaliação será usado.

Observação

Exemplo de solicitação

Especifique o parâmetro de consulta model na propriedade recurso no corpo da solicitação.

POST https://graph.microsoft.com/v1.0/subscriptions
Content-type: application/json

{
   "changeType": "created",
   "notificationUrl": "https://webhook.azurewebsites.net/api/send/myNotifyClient",
   "resource": "chats/getAllMessages?model=A",
   "expirationDateTime":"2016-11-20T18:23:45.9356913Z",
   "clientState": "secretClientValue",
   "latestSupportedTlsVersion": "v1_2"
}

driveItem

Aplicam-se mais limitações às subscrições em itens do OneDrive. As limitações se aplicam para criação e gerenciamento de assinaturas (receber, atualizar e excluir assinaturas).

No OneDrive pessoal, você pode se inscrever em qualquer pasta raiz ou qualquer subpasta da unidade. No OneDrive para trabalho ou escola, pode subscrever apenas a pasta raiz. As notificações de alteração são enviadas para os tipos pedidos de alterações na pasta subscrita ou em qualquer ficheiro, pasta ou outras instâncias driveItem na respetiva hierarquia. Não pode subscrever instâncias drive ou driveItem que não sejam pastas, como ficheiros individuais.

contato, evento e mensagem

Pode subscrever alterações nos recursos de contactos, eventos ou mensagens do Outlook e, opcionalmente, especificar no payload do pedido POST se pretende incluir dados de recursos encriptados em notificações.

Criar e gerenciar (obter, atualizar e excluir) uma assinatura requer um escopo de leitura para o recurso. Por exemplo, para receber notificações de alteração nas mensagens, seu aplicativo precisa da permissão Mail.Read. As notificações de alteração do Outlook dão suporte a escopos de permissão de aplicativo e delegados. Observe as seguintes limitações:

A permissão delegada dá suporte a inscrição de itens em pastas apenas na caixa de correio do usuário conectado. Por exemplo, não pode utilizar a permissão delegada Calendários.Ler para subscrever eventos na caixa de correio de outro utilizador.
Se inscrever para alterar as notificações de contatos, eventos no Outlook ou mensagens em pastascompartilhadas ou delegadas:
- Usar a permissão de aplicativos correspondentes para inscrever as alterações dos itens em uma pasta ou uma caixa de correio de qualquer usuários no locatário.
- Não utilize as permissões de partilha do Outlook (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared e os seus homólogos de leitura/escrita), uma vez que não suportam a subscrição para alterar notificações de itens em pastas partilhadas ou delegadas.

onlineMeetings, presença

onlineMeetings e subscrições de presença requerem encriptação para notificações com dados de recursos. A criação da subscrição falhará se encryptionCertificate e encryptionCertificateId não forem especificados se os dados de recursos forem desejados nas notificações. Para obter detalhes sobre subscrições de reuniões online, consulte Obter notificações de alteração para reuniões online.

virtualEventWebinar

As subscrições em eventos virtuais suportam apenas notificações básicas e estão limitadas a algumas entidades de um evento virtual. Para obter mais informações sobre os tipos de subscrição suportados, veja Obter notificações de alteração para atualizações de eventos virtuais do Microsoft Teams.

Solicitação HTTP

DELETE /subscriptions/{subscription-id}

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 tiver êxito, este método retornará um código de resposta 204 No Content.

Para detalhes sobre como os erros são retornados, confira Respostas de erro.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

DELETE https://graph.microsoft.com/beta/subscriptions/7f105c7d-2dc5-4530-97cd-4e7ae6534c07


// 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.Subscriptions["{subscription-id}"].DeleteAsync();

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 delete --subscription-id {subscription-id}

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
graphClient.Subscriptions().BySubscriptionId("subscription-id").Delete(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);

graphClient.subscriptions().bySubscriptionId("{subscription-id}").delete();

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);

await client.api('/subscriptions/7f105c7d-2dc5-4530-97cd-4e7ae6534c07')
	.version('beta')
	.delete();

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);


$graphServiceClient->subscriptions()->bySubscriptionId('subscription-id')->delete()->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

Remove-MgBetaSubscription -SubscriptionId $subscriptionId

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

await graph_client.subscriptions.by_subscription_id('subscription-id').delete()

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.

HTTP/1.1 204 No Content

Compartilhar via

Excluir assinatura

Permissões

chatMessage

conversationMember

equipa, canal e chat

Exemplo de solicitação

driveItem

contato, evento e mensagem

onlineMeetings, presença

virtualEventWebinar

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplo

Solicitação

Resposta

Comentários

Recursos adicionais