microsoftgraph / microsoftgraph/msgraph-sdk-powershell

Additional Delta documentation

Aperta
#2,223 2 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Request: Documentation
Lingua principale
C#
Stelle
898
Fork
230
Merge medio
2g 5h
PR unite (30g)
31

Descrizione

Is your feature request related to a problem? Please describe.
I have many questions around the use of the delta cmdlets - such as Get-MgUserDelta. Being unaware of how this works properly, or the pitfalls surround the use of this means I am hesitant to use these cmdlets. For example, the Get-MgUserDelta page is very light on detail.

Describe the solution you'd like
Supplementary documentation against the cmdlets (whether via get-help, or website) providing further detail on how to use them, what to look out for, and how the SDK handles certain situations. i.e. Supply a specific PowerShell SDK lens to the use of these endpoints. Further detail in the next section.

Describe alternatives you've considered
While providing a link back to the Graph API documentation (E.g. Incremental changes for Users) is a good start, it lacks some of the context as to how the PowerShell SDK will handle these. For example:

  • What happens when the token expires 7 days after creation? Does the cmdlet throw an error, or will it automatically re-run a full synchronisation and cache the new token?
  • The same question to if an HTTP 410 is returned. Currently, the only way for me to get an answer to these questions is to just run a test over 7 days to ascertain the answers myself.
  • Will the SDK simply ignore properties which are stored outside the main data store (This should return 501, but what happens if it's combined with 3 other attributes, e.g. Get-MgUserDelta -Property UserPrincipalName,AccountEnabled,Skills)

It's important for scripting to know how to handle these, so that either a try/catch can be established to catch any token related errors, and prepare any script for a full synchronisation of data, rather than just the delta, as backend systems may respond adversely to an unplanned 10,000 user dump, when it is used to receiving 20.

Additional context
As a side note, it is noted that the Graph API does not currently support the parameter lastmodifieddatetime. While outside the scope of this forum, use of this parameter may have alleviated the requirement to use the delta cmdlets, but not the need for additional documentation

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla documentazione di Get-MgUserDelta e dalle pagine collegate di Microsoft Graph sulle query delta. Determina e documenta il comportamento di PowerShell SDK in caso di token delta scaduti, risposte HTTP 410 e proprietà non supportate o miste, incluso ciò che gli utenti devono gestire autonomamente. Il lavoro è completato quando la documentazione del cmdlet spiega questi casi con indicazioni pratiche per lo scripting.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
powershell
Ambito
api, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.