directoryRole: DeltadirectoryRole: delta

Wichtig

APIs unter der /beta Version in Microsoft Graph können Änderungen unterworfen werden.APIs under the /beta version in Microsoft Graph are subject to change. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt.Use of these APIs in production applications is not supported.

Abrufen neu erstellter, aktualisierter oder gelöschter Verzeichnis Rollen, ohne dass ein vollständiger Lesevorgang der gesamten Ressourcensammlung durchgeführt werden muss.Get newly created, updated, or deleted directory roles without having to perform a full read of the entire resource collection. Weitere Informationen finden Sie unter Verwenden der Delta-Abfrage .See Using Delta Query for details.

BerechtigungenPermissions

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

BerechtigungstypPermission type Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)Permissions (from least to most privileged)
Delegiert (Geschäfts-, Schul- oder Unikonto)Delegated (work or school account) RoleManagement. Read. Directory, Directory. Read. all, RoleManagement. ReadWrite. Directory, Directory. ReadWrite. all, Directory. AccessAsUser. allRoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All, Directory.AccessAsUser.All
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account) Nicht unterstütztNot supported.
AnwendungApplication RoleManagement. Read. Directory, Directory. Read. all, RoleManagement. ReadWrite. Directory, Directory. ReadWrite. allRoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All

HTTP-AnforderungHTTP request

Um mit dem Nachverfolgen von Änderungen zu beginnen, stellen Sie eine Anforderung einschließlich der Delta-Funktion für die directoryRole-Ressource.To begin tracking changes, you make a request including the delta function on the directoryRole resource.


GET /directoryRoles/delta

AbfrageparameterQuery parameters

Nachverfolgen von Änderungen wird eine Runde von einem oder mehreren Delta Funktionsaufrufen verursacht.Tracking changes incurs a round of one or more delta function calls. Wenn Sie Abfrageparameter (außer $deltatoken und $skiptoken) verwenden, müssen Sie sie in der ursprünglichen Delta-Anforderung angeben.If you use any query parameter (other than $deltatoken and $skiptoken), you must specify it in the initial delta request. Microsoft Graph codiert automatisch alle angegebenen Parameter in den Tokenteil der in der Antwort enthaltenen nextLink- oder deltaLink-URL.Microsoft Graph automatically encodes any specified parameters into the token portion of the nextLink or deltaLink URL provided in the response. Sie müssen alle gewünschten Abfrageparameter nur einmal im Vorfeld angeben.You only need to specify any desired query parameters once upfront. In nachfolgenden Anforderungen können Sie die nextLink- oder deltaLink-URL aus der vorherigen Antwort kopieren und anwenden, da diese URL bereits die codierten gewünschten Parameter enthält.In subsequent requests, copy and apply the nextLink or deltaLink URL from the previous response, as that URL already includes the encoded, desired parameters.

AbfrageparameterQuery parameter TypType BeschreibungDescription
$deltatoken$deltatoken stringstring Ein Status Token , das in deltaLink der URL des vorhergehenden Delta -Funktionsaufrufs für dieselbe Ressourcensammlung zurückgegeben wird und den Abschluss dieser Runde der Änderungsnachverfolgung angibt.A state token returned in the deltaLink URL of the previous delta function call for the same resource collection, indicating the completion of that round of change tracking. Speichern Sie die gesamte deltaLink URL einschließlich dieses Tokens in der ersten Anforderung der nächsten Runde der Änderungsnachverfolgung für diese Auflistung, und wenden Sie Sie an.Save and apply the entire deltaLink URL including this token in the first request of the next round of change tracking for that collection.
$skiptoken$skiptoken stringstring Ein Status Token , das in nextLink der URL des vorherigen Delta -Funktionsaufrufs zurückgegeben wird und angibt, dass weitere Änderungen in derselben Ressourcensammlung nachverfolgt werden sollen.A state token returned in the nextLink URL of the previous delta function call, indicating there are further changes to be tracked in the same resource collection.

Optionale AbfrageparameterOptional query parameters

Diese Methode unterstützt OData-Abfrageparameter zur Anpassung der Antwort.This method supports OData Query Parameters to help customize the response.

  • Sie können wie bei jeder GET-Anforderung den Abfrageparameter $select verwenden, um zwecks Leistungsoptimierung nur die benötigten Eigenschaften anzugeben. Die Eigenschaft id wird immer zurückgegeben.You can use a $select query parameter as in any GET request to specify only the properties your need for best performance. The id property is always returned.

  • Es besteht eingeschränkte Unterstützung für $filter:There is limited support for $filter:

    • Der einzige unter $filter stützte Ausdruck ist zum Nachverfolgen von Änderungen für bestimmte Ressourcen mit $filter=id+eq+{value} der $filter=id+eq+{value1}+or+id+eq+{value2}ID: oder.The only supported $filter expression is for tracking changes for specific resources, by their id: $filter=id+eq+{value} or $filter=id+eq+{value1}+or+id+eq+{value2}. Die Anzahl der IDs, die Sie angeben können, ist durch die maximale URL-Länge limitiert.The number of ids you can specify is limited by the maximum URL length.

AnforderungsheaderRequest headers

NameName BeschreibungDescription
AuthorizationAuthorization Bearer <token>Bearer <token>
Content-TypeContent-Type application/jsonapplication/json

AnforderungstextRequest body

Geben Sie für diese Methode keinen Anforderungstext an.Do not supply a request body for this method.

AntwortResponse

Wenn die Methode erfolgreich verläuft 200 OK , werden der Antwortcode und das directoryRole -Auflistungsobjekt im Antworttext zurückgegeben.If successful, this method returns 200 OK response code and directoryRole collection object in the response body. Die Antwort enthält auch eine nextLink-URL oder eine deltaLink-URL.The response also includes a nextLink URL or a deltaLink URL.

  • Wenn eine nextLink-URL zurückgegeben wird, gibt es zusätzliche Seiten mit Daten, die in der Sitzung abgerufen werden müssen.If a nextLink URL is returned, there are additional pages of data to be retrieved in the session. Die Anwendung nimmt weiterhin Anforderungen über die nextLink-URL vor, bis eine deltaLink-URL in der Antwort zurückgegeben wird.The application continues making requests using the nextLink URL until a deltaLink URL is included in the response.

  • Wenn eine deltaLink-URL zurückgegeben wird, gibt es keine weiteren Daten über den derzeitigen Status der zurückzugebenden Ressource.If a deltaLink URL is returned, there is no more data about the existing state of the resource to be returned. Speichern Sie und verwenden deltaLink Sie die URL, um Informationen zu Änderungen an der Ressource in der Zukunft zu erhalten.Persist and use the deltaLink URL to learn about changes to the resource in the future.

Siehe:See:

BeispielExample

AnforderungRequest
GET https://graph.microsoft.com/beta/directoryRoles/delta
AntwortResponse

Hinweis: Das hier gezeigte Antwortobjekt ist möglicherweise aus Platzgründen abgeschnitten. Von einem tatsächlichen Aufruf werden alle Eigenschaften zurückgegeben.Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#directoryRoles",
  "@odata.nextLink":"https://graph.microsoft.com/beta/directoryRoles/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
  "value": [
      {
      "description": "description-value",
      "displayName": "displayName-value",
      "roleTemplateId": "roleTemplateId-value",
      "id": "id-value"
    }
  ]
}