Skip to content

Commit

Permalink
Moves global options in docs to a separate file. Closes pnp#1852 and p…
Browse files Browse the repository at this point in the history
  • Loading branch information
waldekmastykarz authored and arjunumenon committed Dec 4, 2020
1 parent 9136945 commit 6ac8511
Show file tree
Hide file tree
Showing 410 changed files with 444 additions and 5,657 deletions.
14 changes: 14 additions & 0 deletions docs/docs/cmd/_global.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
`-h, --help`
: output usage information

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/approleassignment/approleassignment-add.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ m365 aad approleassignment add [options]

## Options

`-h, --help`
: output usage information

`--appId [appId]`
: Application appId also known as clientId of the App Registration to which the configured scopes (app roles) should be applied

Expand All @@ -28,17 +25,7 @@ m365 aad approleassignment add [options]
`-s, --scope <scope>`
: Permissions known also as scopes and roles to grant the application with. If multiple permissions have to be granted, they have to be comma separated ex. `Sites.Read.All,Sites.ReadWrite.all`

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Remarks

Expand Down
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/approleassignment/approleassignment-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ m365 aad approleassignment list [options]

## Options

`-h, --help`
: output usage information

`-i, --appId [appId]`
: Application (client) Id of the App Registration for which the configured app roles should be retrieved

Expand All @@ -22,17 +19,7 @@ m365 aad approleassignment list [options]
`--objectId [objectId]`
: ObjectId of the application for which the configured app roles should be retrieved

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Remarks

Expand Down
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/approleassignment/approleassignment-remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ m365 aad approleassignment remove [options]

## Options

`-h, --help`
: output usage information

`--appId [appId]`
: Application appId also known as clientId of the App Registration for which the configured scopes (app roles) should be deleted

Expand All @@ -31,17 +28,7 @@ m365 aad approleassignment remove [options]
`--confirm`
: Don't prompt for confirming removing the all role assignment

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Remarks

Expand Down
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/groupsetting/groupsetting-add.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,10 @@ m365 aad groupsetting add [options]

## Options

`-h, --help`
: output usage information

`-i, --templateId <templateId>`
: The ID of the group setting template to use to create the group setting

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Remarks

Expand Down
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/groupsetting/groupsetting-get.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,10 @@ m365 aad groupsetting get [options]

## Options

`-h, --help`
: output usage information

`-i, --id <id>`
: The ID of the group setting to retrieve

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Examples

Expand Down
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/groupsetting/groupsetting-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,7 @@ m365 aad groupsetting list [options]

## Options

`-h, --help`
: output usage information

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Examples

Expand Down
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/groupsetting/groupsetting-remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,13 @@ m365 aad groupsetting remove [options]

## Options

`-h, --help`
: output usage information

`-i, --id <id>`
: The ID of the group setting to remove

`--confirm`
: Don't prompt for confirming removing the group setting

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Remarks

Expand Down
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/groupsetting/groupsetting-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,10 @@ m365 aad groupsetting set [options]

## Options

`-h, --help`
: output usage information

`-i, --id <id>`
: The ID of the group setting to update

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Remarks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,13 @@ m365 aad groupsettingtemplate get [options]

## Options

`-h, --help`
: output usage information

`-i, --id [id]`
: The ID of the settings template to retrieve. Specify the `id` or `displayName` but not both

`-n, --displayName [displayName]`
: The display name of the settings template to retrieve. Specify the `id` or `displayName` but not both

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,7 @@ m365 aad groupsettingtemplate list [options]

## Options

`-h, --help`
: output usage information

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Examples

Expand Down
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/o365group/o365group-add.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ m365 aad o365group add [options]

## Options

`-h, --help`
: output usage information

`-n, --displayName <displayName>`
: Display name for the Microsoft 365 Group

Expand All @@ -34,17 +31,7 @@ m365 aad o365group add [options]
`-l, --logoPath [logoPath]`
: Local path to the image file to use as group logo

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Remarks

Expand Down
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/o365group/o365group-get.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,13 @@ m365 aad o365group get [options]

## Options

`-h, --help`
: output usage information

`-i, --id <id>`
: The ID of the Microsoft 365 Group to retrieve information for

`--includeSiteUrl`
: Set to retrieve the site URL for the group

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Examples

Expand Down
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/o365group/o365group-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ m365 aad o365group list [options]

## Options

`-h, --help`
: output usage information

`-d, --displayName [displayName]`
: Retrieve only groups with displayName starting with the specified value

Expand All @@ -28,17 +25,7 @@ m365 aad o365group list [options]
`--orphaned`
: Set to only retrieve groups without owners

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Remarks

Expand Down
15 changes: 1 addition & 14 deletions docs/docs/cmd/aad/o365group/o365group-remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,13 @@ m365 aad o365group remove [options]

## Options

`-h, --help`
: output usage information

`-i, --id <id>`
: The ID of the Microsoft 365 Group to remove

`--confirm`
: Don't prompt for confirming removing the group

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples

`-o, --output [output]`
: Output type. `json,text`. Default `text`

`--verbose`
: Runs command with verbose logging

`--debug`
: Runs command with debug logging
--8<-- "docs/cmd/_global.md"

## Remarks

Expand Down

0 comments on commit 6ac8511

Please sign in to comment.