user: delta
Namespace: microsoft.graph
Veja os usuários recentemente criados, atualizados ou excluídos sem ter que executar uma leitura completa da coleção de usuários inteira. Confira controle de alterações para obter detalhes.
Observação
As alterações na propriedade licenseAssignmentStates não são rastreadas no momento.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Tipo de permissão | Permissões menos privilegiadas | Permissões privilegiadas mais altas |
---|---|---|
Delegado (conta corporativa ou de estudante) | User.Read.All | Directory.Read.All, Directory.ReadWrite.All, User.ReadWrite.All |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Aplicativo | User.Read.All | Directory.Read.All, Directory.ReadWrite.All, User.ReadWrite.All |
Solicitação HTTP
Para começar a acompanhar as alterações, você faz uma solicitação incluindo a função delta no recurso de usuários.
GET /users/delta
Parâmetros de consulta
O controle de alterações em usuários corresponde a uma série de uma ou mais chamadas de função delta. Se você usar qualquer parâmetro de consulta (diferente de $deltatoken
e $skiptoken
), especifique-o na primeira solicitação delta. O Microsoft Graph codifica automaticamente todos os parâmetros especificados na parte do token da URL @odata.nextLink
ou @odata.deltaLink
fornecida na resposta.
Você só precisa especificar uma vez os parâmetros de consulta desejados antecipadamente.
Em solicitações subsequentes, copie e aplique a URL @odata.nextLink
ou @odata.deltaLink
da resposta anterior, já que essa URL inclui os parâmetros codificados desejados.
Parâmetro de consulta | Tipo | Descrição |
---|---|---|
$deltatoken | string | Um token de estado retornado na @odata.deltaLink URL da chamada de função delta anterior para a mesma coleção de usuários, indicando a conclusão dessa rodada de rastreamento de alterações. Salve e aplique toda a URL @odata.deltaLink , incluindo esse token na primeira solicitação da próxima série de controle de alterações desse conjunto. |
$skiptoken | string | Um token de estado retornado na URL @odata.nextLink da chamada de função delta anterior indicando que não há mais alterações a serem controladas na mesma coleção de usuários. |
Parâmetros de consulta OData
Este método fornece suporte opcional a Parâmetros de Consulta OData para ajudar a personalizar a resposta.
- Você pode usar um parâmetro de consulta
$select
como em qualquer solicitação GET para especificar somente as propriedades necessárias para obter melhor desempenho. A propriedade id sempre será retornada. - Há suporte limitado para
$filter
:- A única expressão
$filter
suportada é para controlar alterações em um objeto específico:$filter=id+eq+{value}
. É possível filtrar vários objetos. Por exemplo,https://graph.microsoft.com/v1.0/users/delta/?$filter= id eq '477e9fc6-5de7-4406-bb2a-7e5c83c9ffff' or id eq '004d6a07-fe70-4b92-add5-e6e37b8affff'
. Há um limite de 50 objetos filtrados.
- A única expressão
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Content-Type | application/json |
Preferir | return=minimal Especificar esse cabeçalho com uma solicitação que usa @odata.deltaLink retorna somente as propriedades do objeto que foram alteradas desde a última vez. Opcional. |
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 o código de resposta 200 OK
e o objeto da coleção user no corpo da resposta. A resposta também inclui uma URL @odata.nextLink
ou @odata.deltaLink
.
Se uma URL
@odata.nextLink
for retornada:- Existem páginas de dados adicionais a recuperar na sessão. O aplicativo continua fazendo solicitações usando a
@odata.nextLink
URL até que uma@odata.deltaLink
URL seja incluída na resposta. - A resposta inclui o mesmo conjunto de propriedades como na solicitação de consulta delta inicial. Assim você pode capturar o estado atual de todos os objetos ao iniciar o ciclo de delta.
- Existem páginas de dados adicionais a recuperar na sessão. O aplicativo continua fazendo solicitações usando a
Se uma URL
@odata.deltaLink
for retornada:- Isso indica que não há mais dados sobre o estado existente do recurso a ser retornado. Salve e use a URL
@odata.deltaLink
para saber mais sobre alterações ao recurso na próxima fase. - Você pode especificar o cabeçalho
Prefer:return=minimal
para incluir somente os valores de resposta das propriedades que foram alteradas desde a hora em que o@odata.deltaLink
foi emitido.
- Isso indica que não há mais dados sobre o estado existente do recurso a ser retornado. Salve e use a URL
Padrão: retornar as mesmas propriedades de uma solicitação delta inicial
Por padrão, as solicitações usando @odata.deltaLink
ou @odata.nextLink
retornam as mesmas propriedades selecionadas na consulta delta inicial das seguintes maneiras:
- Se a propriedade foi alterada, o novo valor será incluído na resposta. Isso inclui propriedades definidas com valor nulo.
- Se a propriedade não tiver sido alterada, o valor antigo será incluído na resposta.
- Se a propriedade nunca foi definida anteriormente, de nenhuma forma será incluída na resposta.
Observação: com esse comportamento, ao verificar a resposta, não será possível dizer se uma propriedade foi alterada ou não. Além disso, as respostas delta tendem a ser grandes porque contêm todos os valores de propriedade - conforme mostrado no Exemplo 2.
Alternativa: retornar somente as propriedades alteradas
Adicionar o cabeçalho prefer:return=minimal
opcional na solicitação resulta no comportamento a seguir:
- Se a propriedade foi alterada, o novo valor será incluído na resposta. Isso inclui propriedades definidas com valor nulo.
- Se a propriedade não tiver sido alterada, a propriedade não será incluída na resposta. (Diferente do comportamento padrão.)
Observação: é possível adicionar o cabeçalho a uma solicitação
@odata.deltaLink
a qualquer momento no ciclo de delta. O cabeçalho afeta apenas o conjunto de propriedades incluídas na resposta e ele não afeta como a consulta delta é executada. Veja o Exemplo 3.
Exemplos
Exemplo 1: Propriedades padrão
Solicitação
O exemplo a seguir mostra uma solicitação. Não há parâmetro $select
, portanto, um conjunto padrão de propriedades é rastreado e retornado.
GET https://graph.microsoft.com/v1.0/users/delta
Resposta
Aqui está um exemplo da resposta ao usar @odata.deltaLink
obtido da inicialização da consulta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users",
"@odata.nextLink":"https://graph.microsoft.com/v1.0/users/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"businessPhones": [
"+1 425 555 0109"
],
"displayName": "Adele Vance",
"givenName": "Adele",
"jobTitle": "Retail Manager",
"mail": "AdeleV@contoso.com",
"mobilePhone": "+1 425 555 0109",
"officeLocation": "18/2111",
"preferredLanguage": "en-US",
"surname": "Vance",
"userPrincipalName": "AdeleV@contoso.com",
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd"
}
]
}
Exemplo 2: Escolher três propriedades
Solicitação
O próximo exemplo mostra uma solicitação inicial selecionando três propriedades para controle de alterações com comportamento de resposta padrão.
GET https://graph.microsoft.com/v1.0/users/delta?$select=displayName,jobTitle,mobilePhone
Resposta
Aqui está um exemplo da resposta ao usar @odata.deltaLink
obtido da inicialização da consulta. Todas as três propriedades estão incluídas na resposta e não se sabe quais foram alteradas desde que a @odata.deltaLink
foi obtida.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users",
"@odata.nextLink":"https://graph.microsoft.com/v1.0/users/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"displayName": "Adele Vance",
"jobTitle": "Retail Manager",
"mobilePhone": "+1 425 555 0109"
}
]
}
Exemplo 3: Comportamento de resposta mínimo alternativo
Solicitação
O exemplo a seguir mostra uma solicitação inicial selecionando três propriedades para controle de alterações com o comportamento de resposta mínima alternativa.
GET https://graph.microsoft.com/v1.0/users/delta?$select=displayName,jobTitle,mobilePhone
Prefer: return=minimal
Resposta
Aqui está um exemplo da resposta ao usar @odata.deltaLink
obtido da inicialização da consulta. A mobilePhone
propriedade não está incluída, o que significa que ela não foi alterada desde a última consulta delta; displayName
e jobTitle
está incluída, o que significa que seus valores foram alterados.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users",
"@odata.nextLink":"https://graph.microsoft.com/v1.0/users/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"displayName": "Vance Adele",
"jobTitle": "Product Marketing Manager"
}
]
}
Conteúdo relacionado
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de