Skip to content

Adds minimal permissions to docs pages #6728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Adds minimal permissions to docs pages #6728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion .eslintrc.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ module.exports = {
]
}
],
"@typescript-eslint/explicit-function-return-type": ["error", { "allowExpressions": true }],
"@typescript-eslint/explicit-function-return-type": ["error", { "allowExpressions": true }, ],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this is an accidental change?

Suggested change
"@typescript-eslint/explicit-function-return-type": ["error", { "allowExpressions": true }, ],
"@typescript-eslint/explicit-function-return-type": ["error", { "allowExpressions": true }],

"mocha/no-identical-title": "error",
"@typescript-eslint/no-floating-promises": "error"
},
Expand All @@ -271,6 +271,14 @@ module.exports = {
"rules": {
"camelcase": "off"
}
},
{
"files": [
"*.mjs"
],
"rules": {
"@typescript-eslint/explicit-function-return-type": "off"
}
}
]
};
2 changes: 1 addition & 1 deletion docs/docs/cmd/_global.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
```md definition-list
`-h, --help [help]`
: Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are `options`, `examples`, `remarks`, `response`, `full`. Default is `options`.
: Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are `options`, `examples`, `remarks`, `permissions`, `response`, `full`. Default is `options`.

`--query [query]`
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples.
Expand Down
19 changes: 19 additions & 0 deletions docs/docs/cmd/planner/bucket/bucket-add.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,25 @@ When using `rosterId`, the command is based on an API that is currently in previ

:::

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|---------------------------------------|
| Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|-------------------------------------------|
| Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |

</TabItem>
</Tabs>

## Examples

Adds a Microsoft Planner bucket for a plan based on its ID with an order hint
Expand Down
19 changes: 19 additions & 0 deletions docs/docs/cmd/planner/bucket/bucket-get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,25 @@ When using `rosterId`, the command is based on an API that is currently in previ

:::

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|----------------------------------|
| Microsoft Graph | Tasks.Read, GroupMember.Read.All |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|--------------------------------------|
| Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |

</TabItem>
</Tabs>

## Examples

Gets the specified Microsoft Planner bucket
Expand Down
19 changes: 19 additions & 0 deletions docs/docs/cmd/planner/bucket/bucket-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,25 @@ When using `rosterId`, the command is based on an API that is currently in previ

:::

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|----------------------------------|
| Microsoft Graph | Tasks.Read, GroupMember.Read.All |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|--------------------------------------|
| Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |

</TabItem>
</Tabs>

## Examples

Lists the Microsoft Planner buckets based on its plan ID
Expand Down
21 changes: 21 additions & 0 deletions docs/docs/cmd/planner/bucket/bucket-remove.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# planner bucket remove

Expand Down Expand Up @@ -48,6 +50,25 @@ When using `rosterId`, the command is based on an API that is currently in previ

:::

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|---------------------------------------|
| Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|-------------------------------------------|
| Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |

</TabItem>
</Tabs>

## Examples

Removes the Microsoft Planner bucket by ID
Expand Down
21 changes: 21 additions & 0 deletions docs/docs/cmd/planner/bucket/bucket-set.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# planner bucket set

Expand Down Expand Up @@ -51,6 +53,25 @@ When using `rosterId`, the command is based on an API that is currently in previ

:::

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|---------------------------------------|
| Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|-------------------------------------------|
| Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |

</TabItem>
</Tabs>

## Examples

Updates the Microsoft Planner bucket by its ID
Expand Down
19 changes: 19 additions & 0 deletions docs/docs/cmd/planner/plan/plan-add.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,25 @@ m365 planner plan add [options]

- Hint: Unlike for groups, a Planner Roster can contain only 1 plan.

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|---------------------------------------|
| Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|-------------------------------------------|
| Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |

</TabItem>
</Tabs>

## Examples

Adds a Microsoft Planner plan with a Group by id.
Expand Down
19 changes: 19 additions & 0 deletions docs/docs/cmd/planner/plan/plan-get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,25 @@ When using `rosterId`, the command is based on an API that is currently in previ

:::

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|----------------------------------|
| Microsoft Graph | Tasks.Read, GroupMember.Read.All |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|--------------------------------------|
| Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |

</TabItem>
</Tabs>

## Examples

Returns the Microsoft Planner plan by id.
Expand Down
19 changes: 19 additions & 0 deletions docs/docs/cmd/planner/plan/plan-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,25 @@ When using rosterId, the command is based on an API that is currently in preview

:::

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|----------------------------------|
| Microsoft Graph | Tasks.Read, GroupMember.Read.All |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|--------------------------------------|
| Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |

</TabItem>
</Tabs>

## Examples

Returns a list of Microsoft Planner plans for the specified Group by id.
Expand Down
21 changes: 21 additions & 0 deletions docs/docs/cmd/planner/plan/plan-remove.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# planner plan remove

Expand Down Expand Up @@ -35,6 +37,25 @@ m365 planner plan remove [options]

If you wish to delete a Planner plan contained within a Planner Roster, you'll have to remove the roster using [planner roster remove](../roster/roster-remove.mdx).

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|---------------------------------------|
| Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|-------------------------------------------|
| Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |

</TabItem>
</Tabs>

## Examples

Removes the Microsoft Planner plan by ID
Expand Down
19 changes: 19 additions & 0 deletions docs/docs/cmd/planner/plan/plan-set.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,25 @@ When using `rosterId`, the command is based on an API that is currently in previ

:::

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|---------------------------------------|
| Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|-------------------------------------------|
| Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |

</TabItem>
</Tabs>

## Examples

Updates a Microsoft Planner plan title.
Expand Down
19 changes: 19 additions & 0 deletions docs/docs/cmd/planner/roster/roster-add.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,25 @@ To be able to create a new Roster, the Planner Roster creation tenant setting sh

:::

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|-----------------|
| Microsoft Graph | Tasks.ReadWrite |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|---------------------|
| Microsoft Graph | Tasks.ReadWrite.All |

</TabItem>
</Tabs>

## Examples

Creates a new Microsoft Planner Roster
Expand Down
19 changes: 19 additions & 0 deletions docs/docs/cmd/planner/roster/roster-get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,25 @@ This command is based on an API that is currently in preview and is subject to c

:::

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|-------------|
| Microsoft Graph | Tasks.Read |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|----------------|
| Microsoft Graph | Tasks.Read.All |

</TabItem>
</Tabs>

## Examples

Gets information about a specific Planner Roster.
Expand Down
19 changes: 19 additions & 0 deletions docs/docs/cmd/planner/roster/roster-member-add.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,25 @@ This command is based on an API that is currently in preview and is subject to c

:::

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|-----------------|
| Microsoft Graph | Tasks.ReadWrite |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|---------------------|
| Microsoft Graph | Tasks.ReadWrite.All |

</TabItem>
</Tabs>

## Examples

Adds a specific user by user name as member of the Planner Roster.
Expand Down
Loading