cli-microsoft365 icon indicating copy to clipboard operation
cli-microsoft365 copied to clipboard

New command: m365 graph changelog list

Open appieschot opened this issue 5 years ago • 10 comments

Usage

m365 graph changelog list [options]

Description

Gets an overview of specific API-level changes in Microsoft Graph v1.0 and beta

Options

Option Description
-v, --versions [versions] Comma-separated list of Versions to show changes for. Beta, v1.0. Default v1.0
-c, --changeType [changeType] Comma-separated list of change types to show changes for. Addition, Change, Deletion. When no changeType is selected all changes are returned.
-s, --services [services] Comma-separated list of services to show changes for. Users,Groups,Applications,Calendar,Change notifications,Cloud communications,Compliance,Cross-device experiences,Customer Booking,Devices and apps,Education,Files,Financials,Identity and access,Mail,Notes,Notifications,People and workplace intelligence,Personal contacts,Reports,Search,Security,Sites and lists,Taxonomy,Teamwork,To do tasks,Workbooks and charts. When no service is selected all changes are returned.
--startDate [startDate] The startdate used to query for changes. Supported date format is YYYY-MM-DD. When no date is specified all changes are returned.
--endDate [endDate] The enddate used to query for changes. Supported date format is YYYY-MM-DD. When no date is specified all changes are returned.
Option Description
-o, --option <option> option
-o, --output [output] Output type. json,text. Default text
--verbose Runs command with verbose logging
--debug Runs command with debug logging

Additional Information

  • See https://developer.microsoft.com/en-us/graph/changelog/ for changes (use RSS to get data).
  • The V1.0 endpoint is marked as 'prd' in the dataset

appieschot avatar Jan 11 '21 19:01 appieschot

@pnp/cli-for-microsoft-365-maintainers did I mis anything?

appieschot avatar Jan 11 '21 19:01 appieschot

Looks good to me, I do have one comment though, are we to assume that if we choose a service such as Identity and access that includes all of the sub services, such as Identity and sign-in, Governance and so on?

It may be beneficial to include the sub services as options as valid choices to help narrow down the response further.

garrytrinder avatar Jan 14 '21 21:01 garrytrinder

Very nice! Also, let's add remarks about the default behavior for the changeType, service and date options. I'd assume that if no value is specified, you get all available data.

waldekmastykarz avatar Jan 15 '21 09:01 waldekmastykarz

Also, I'd suggest removing -d from startDate because it's ambiguous between the start and end date.

waldekmastykarz avatar Jan 15 '21 09:01 waldekmastykarz

@garrytrinder agree on the option to use the subservices, however they seem to be not reflected in the RSS response . The response always returns <title>Reports</title> even though the filter is Microsoft usage reports (see: Rss source). So that might end up being confusing; you are using a subfilter but the response will not return that as a header. It looks like there is logic in the page itself to do that and its not coming from the response.

appieschot avatar Jan 15 '21 12:01 appieschot

@appieschot does that mean that we'd need to retrieve the parent category and then apply filtering ourselves? Sounds like something we could do assuming it makes sense. We could also start with just the top categories and add second level later if there is any interest in it.

waldekmastykarz avatar Jan 15 '21 14:01 waldekmastykarz

@waldekmastykarz the filter works as it is passed in the URL, so we could add the filter option. The only results is that if you filter by Microsoft usage reports the response would say results for Reports unless we implement custom logic to override that (something I rather not do).

appieschot avatar Jan 15 '21 14:01 appieschot

I don't we will show the title anywhere, rather just the results themselves, right?

waldekmastykarz avatar Jan 15 '21 16:01 waldekmastykarz

I can start working on this one 😄

Jwaegebaert avatar Jul 05 '22 18:07 Jwaegebaert

Awesome @Jwaegebaert! We appreciate your help 👏

waldekmastykarz avatar Jul 06 '22 09:07 waldekmastykarz