tipo de recurso de assinatura

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 de versão.

Cuidado

Os aplicativos existentes que usam esse recurso com baseTask ou baseTaskList devem ser atualizados, pois o conjunto de APIs de tarefas pendentes criado com base nesses recursos foi preterido a partir de 31 de maio de 2022. Esse conjunto de API deixará de retornar dados em 31 de agosto de 2022. Use o conjunto de API criado em todoTask.

Uma assinatura que permite a um aplicativo cliente receber notificações sobre alterações de dados no Microsoft Graph. Atualmente, as assinaturas estão habilitadas para os recursos a seguir.

Nota As assinaturas marcadas com um asterisco (*) têm suporte apenas no ponto /beta de extremidade.

• Um alert da API de Segurança do Microsoft Graph.
• Uma baseTask (preterida) de um usuário no Microsoft To Do.*
• Uma callRecord produzida após uma chamada ou uma reunião no Microsoft Teams.
• Um canal no Microsoft Teams.
• Um chat no Microsoft Teams.
• Um chatMessage enviado por meio de equipes ou canais no Microsoft Teams.
• Uma [conversation][] em um grupo do Microsoft 365.
• Um membro da conversa em uma equipe, canal ou chat no Microsoft Teams.
• Conteúdo da hierarquia de uma pasta raiz driveItem no OneDrive for Business ou de uma pasta raiz ou uma subpasta driveItem no OneDrive pessoal do usuário.
• Um [grupo][] no Azure Active Directory.
• Uma list em um site do SharePoint.
• Uma message, event ou [contact][] no Outlook.
• Uma reunião online no Microsoft Teams.*
• A [presença][] de um usuário no Microsoft Teams.*
• Uma equipe no Microsoft Teams.
• Uma impressora (quando um trabalho de impressão da impressora chegar ao estado JobFetchable – pronto para ser buscado para impressão) e uma printTaskDefinition na Impressão Universal. Para obter mais informações, consulte Assinar para alterar as notificações de APIs de impressão na nuvem.
• Um todoTask de um usuário no Microsoft To Do.
• Um [usuário][] no Azure Active Directory.

Para obter os valores de caminho de recurso possíveis para cada recurso com suporte, consulte Usar a API do Microsoft Graph para obter notificações de alteração. Para saber como usar notificações de ciclo de vida, consulte Reduzir assinaturas ausentes e alterar notificações.

Métodos

Método	Tipo de retorno	Descrição
Criar assinatura	assinatura	Assina um aplicativo de escuta para receber notificações sobre alterações nos dados do Microsoft Graph.
Atualizar assinatura	subscription	Renove uma assinatura atualizando seu tempo de expiração.
Listar de assinaturas	assinatura	Lista assinaturas ativas.
Obter assinatura	subscription	Ler propriedades e relações do objeto de assinatura.
Excluir assinatura	Nenhuma	Excluir um objeto de assinatura.

Propriedades

Propriedade	Tipo	Descrição	Recursos com Suporte
ApplicationId	Cadeia de caracteres	Opcional. Identificador do aplicativo usado para criar a assinatura. Somente leitura.	Todos
changeType	Cadeia de caracteres	Necessário. Indica o tipo de alteração no recurso inscrito que gerará uma alteração de notificação. Os valores com suporte são: created, updated, deleted. Vários valores podem ser combinados usando uma lista separada por vírgula. Observação: As notificações de alteração de lista e item raiz da unidade dão suporte apenas updated changeType. Usuário e grupo notificações de alteração dão suporte updated e deleted changeType.	Todos
clientState	String	Opcional. Especifica o valor da propriedade clientState enviado pelo serviço em cada notificação de alteração. O tamanho máximo é de 255 caracteres. O cliente pode verificar se a notificação de alteração veio do serviço comparando o valor da propriedade clientState enviada com a assinatura com o valor da propriedade clientState recebida com cada notificação de alteração.	Todos
creatorId	String	Opcional. Identificador de usuário ou entidade de serviço que criou a assinatura. Se o aplicativo usou permissões delegadas para criar a assinatura, esse campo conterá a ID do usuário conectado do qual o aplicativo chamou em nome. Se o aplicativo usou permissões de aplicativo, esse campo contém a ID da entidade de serviço correspondente ao aplicativo. Somente leitura.	Todos
encryptionCertificate	Cadeia de caracteres	Opcional. Uma representação codificada em Base64 de um certificado com uma chave pública usada para criptografar os dados dos recursos nas notificações de alteração. Opcional, mas necessário quando includeResourceData for true.	Todos
encryptionCertificateId	String	Opcional. Um identificador personalizado fornecido pelo aplicativo para ajudar a identificar o certificado necessário para descriptografar os dados do recurso. Obrigatório quando includeResourceData é true.	Todos
expirationDateTime	DateTimeOffset	Obrigatório. Especifique a data e a hora em que a assinatura do Webhook expira. O forário está em UTC e pode ser um período de tempo desde a criação da assinatura que varia de acordo com o recurso assinado. Para obter o período máximo de assinaturas com suporte, consulte a tabela abaixo.	Todos
id	Cadeia de caracteres	Opcional. Identificador exclusivo da assinatura. Somente leitura.	Todos
includeResourceData	Booleano	Opcional. Quando definido como true, alterar as notificações inclui dados de recurso (como o conteúdo de uma mensagem de bate-papo).	Todos
latestSupportedTlsVersion	Cadeia de caracteres	Opcional. Especifique a versão mais recente do Protocolo TLS que o ponto de extremidade de notificação, especificado por notificationUrl, oferece suporte. Os valores possíveis são: v1_0, v1_1, v1_2, v1_3. Quanto aos assinantes cujo ponto de extremidade de notificação oferece suporte a uma versão inferior à versão recomendada no momento (TLS 1.2), especificar essa propriedade por um conjunto de linhas do tempo permite que eles usem temporariamente sua versão preterida do TLS antes de concluir a atualização para o TLS 1.2. Para esses assinantes, não definir essa propriedade de acordo com a linha do tempo resultaria em erro nas operações de assinatura. Para os assinantes cujo ponto de extremidade já tem suporte ao TLS 1.2, a configuração dessa propriedade é opcional. Nesses casos, o Microsoft Graph padroniza a propriedade como v1_2.	Todos
lifecycleNotificationUrl	String	Opcional. A URL do ponto de extremidade que recebe notificações do ciclo de vida, incluindo notificações de subscriptionRemoved e missed. Esta URL deve fazer uso do protocolo HTTPS.	Todos
notificationContentType	String	Opcional. O tipo de conteúdo desejado para notificações de alteração do Microsoft Graph para tipos de recursos com suporte. O tipo de conteúdo padrão é application/json.	Todos
notificationQueryOptions	String	Opcional. Opções de consulta OData para especificar o valor do recurso de direcionamento. Os clientes recebem notificações quando o recurso atinge o estado correspondente às opções de consulta fornecidas aqui. Com essa nova propriedade na carga de criação da assinatura juntamente com todas as propriedades existentes, os Webhooks entregarão notificações sempre que um recurso atingir o estado desejado mencionado na propriedade notificationQueryOptions . Por exemplo, quando o trabalho de impressão é concluído ou quando um valor de propriedade de recurso de trabalho de impressão isFetchable torna-se true etc.	Serviço de Impressão Universal
notificationUrl	Cadeia de caracteres	Obrigatório. A URL do ponto de extremidade que recebe as notificações de alteração. Esta URL deve fazer uso do protocolo HTTPS.	Todos
notificationUrlAppId	String	Opcional. A ID do aplicativo que o serviço de assinatura pode usar para gerar o token de validação. Isso permite que o cliente valide a autenticidade da notificação recebida.	Todos
recurso	Cadeia de caracteres	Obrigatório. Especifica o recurso que será monitorado para detectar alterações. Não incluir a URL base (https://graph.microsoft.com/beta/). Consulte os possíveis valores do caminho do recurso de cada recurso suportado.	Todos

Tamanho máximo da assinatura por tipo de recurso

Resource	Tempo de expiração máximo
Alerta de segurança	43200 minutos (em 30 dias )
Teams callRecord	4230 minutos (em 3 dias)
Canal do Teams	60 minutos (1 hora)
Chat do Teams	60 minutos (1 hora)
Teams chatMessage	60 minutos (1 hora)
conversationMember do Teams	60 minutos (1 hora)
onlineMeeting do Teams	4320 minutos (3 dias)
Equipe do Teams	60 minutos (1 hora)
Conversa em grupo	4230 minutos (em 3 dias)
OneDrive driveItem	42.300 minutos (menos de 30 dias)
Lista do Microsoft Office SharePoint Online	42.300 minutos (menos de 30 dias)
Outlook mensagem, evento, contato	4230 minutos (em 3 dias)
usuário, grupo, outros recursos de diretório	41760 minutos (menos de 29 dias)
onlineMeeting	4230 minutos (em 3 dias)
presence	60 minutos (1 hora)
Imprimir printer	4230 minutos (em 3 dias)
Imprimir printTaskDefinition	4230 minutos (em 3 dias)
todoTask	4230 minutos (em 3 dias)
baseTask (preterido)	4230 minutos (em 3 dias)

Observação: Os aplicativos existentes e os novos aplicativos não devem ultrapassar o valor suportado. No futuro, as solicitações para criar ou renovar uma assinatura além do valor máximo falharão.

Relações

Nenhum

Representação JSON

Veja a seguir uma representação JSON do recurso.

{
  "@odata.type": "#microsoft.graph.subscription",
  "id": "String (identifier)",
  "resource": "String",
  "changeType": "String",
  "clientState": "String",
  "notificationUrl": "String",
  "expirationDateTime": "String (timestamp)",
  "applicationId": "String",
  "creatorId": "String",
  "includeResourceData": "Boolean",
  "lifecycleNotificationUrl": "String",
  "encryptionCertificate": "String",
  "encryptionCertificateId": "String",
  "latestSupportedTlsVersion": "String",
  "notificationQueryOptions": "String",
  "notificationContentType": "String",
  "notificationUrlAppId": "String"
}