servicePrincipal: delta

Obtenha entidades de serviço recém-criadas, atualizadas ou excluídas sem precisar executar uma leitura completa de toda a coleção de recursos.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) Directory.Read.All, Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte.
Aplicativo Application.ReadWrite.All, Directory.Read.All

Solicitação HTTP

Para começar a controlar as alterações, você faz uma solicitação, incluindo a função delta no recurso servicePrincipal.

GET /servicePrincipals/delta

Parâmetros de consulta

Controlar alterações incorre em uma rodada 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 recursos, indicando a conclusão dessa rodada de controle 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 @odata.nextLink URL da chamada de função delta anterior , indicando que há mais alterações a serem controladas na mesma coleção de recursos.

Parâmetros de consulta opcionais

Este método dá suporte a Parâmetros de consulta do 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 com suporte $filter é para controlar alterações para recursos específicos, por sua ID: $filter=id+eq+{value} ou $filter=id+eq+{value1}+or+id+eq+{value2}. O número de IDs que você pode especificar é limitado pelo comprimento máximo da URL.

Cabeçalhos de solicitação

Nome Descrição
Autorização <Token> de portador

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 200 OK de resposta e um objeto de coleção servicePrincipal no corpo da resposta. A resposta também inclui uma URL nextLink ou uma URL deltaLink.

  • Se uma URL @odata.nextLink é retornada, existem páginas de dado adicionais a serem recuperadas na sessão. O aplicativo continua fazendo solicitações usando a URL @odata.nextLink até uma URL @odata.deltaLink ser incluída na resposta.

  • Se uma URL @odata.deltaLink é retornada, não há mais nenhum dado sobre o estado do recurso a ser retornado. Persista e use @odata.deltaLink a URL para saber mais sobre as alterações no recurso no futuro.

Confira:

Exemplo

Solicitação

GET https://graph.microsoft.com/v1.0/servicePrincipals/delta

Resposta

Observação: o objeto de resposta exibido aqui pode ser encurtado para legibilidade.

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#servicePrincipals",
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/servicePrincipals/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
  "value": [
     {
      "accountEnabled": true,
      "addIns": [
        {
          "id": "id-value",
          "type": "type-value",
          "properties": [
            {
              "key": "key-value",
              "value": "value-value"
            }
          ]
        }
      ],
      "appDisplayName": "appDisplayName-value",
      "appId": "appId-value",
      "appOwnerOrganizationId": "appOwnerOrganizationId-value",
      "appRoleAssignmentRequired": true
    }
  ]
}