forked from pnp/cli-microsoft365
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/pnp/cli-microsoft365 into e…
…ventreceiverlist
- Loading branch information
Showing
39 changed files
with
2,412 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/docs/cmd/aad/approleassignment/approleassignment-remove.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# planner task reference add | ||
|
||
Adds a new reference to a Planner task. | ||
|
||
## Usage | ||
|
||
```sh | ||
m365 planner task reference add [options] | ||
``` | ||
|
||
## Options | ||
|
||
`-i, --taskId <taskId>` | ||
: ID of the task. | ||
|
||
`-u, --url <url>` | ||
: URL location of the reference. | ||
|
||
`--alias [alias]` | ||
: A name alias to describe the reference. | ||
|
||
`--type [type]` | ||
: Used to describe the type of the reference. Types include: `PowerPoint`, `Word`, `Excel`, `Other`. | ||
|
||
--8<-- "docs/cmd/_global.md" | ||
|
||
## Examples | ||
|
||
Add a new reference with the url _https://www.microsoft.com_ to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_ | ||
|
||
```sh | ||
m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" | ||
``` | ||
|
||
Add a new reference with the url _https://www.microsoft.com_ and with the alias _Parker_ to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_ | ||
|
||
```sh | ||
m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --alias "Parker" | ||
``` | ||
|
||
Add a new reference with the url _https://www.microsoft.com_ and with the type Excel to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_ | ||
|
||
```sh | ||
m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --type "Excel" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# planner task reference list | ||
|
||
Retrieve the references associated to a Planner task. | ||
|
||
## Usage | ||
|
||
```sh | ||
m365 planner task reference list [options] | ||
``` | ||
|
||
## Options | ||
|
||
`-i, --taskId <taskId>` | ||
: ID of the task to retrieve references from | ||
|
||
--8<-- "docs/cmd/_global.md" | ||
|
||
## Examples | ||
|
||
Retrieve the references of the specified planner task | ||
|
||
```sh | ||
m365 planner task reference list --taskId uBk5fK_MHkeyuPYlCo4OFpcAM | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# pp gateway list | ||
|
||
Returns a list of gateways for which the user is an admin | ||
|
||
## Usage | ||
|
||
```sh | ||
m365 pp gateway list [options] | ||
``` | ||
|
||
## Options | ||
|
||
--8<-- "docs/cmd/_global.md" | ||
|
||
## Examples | ||
|
||
List gateways for which the user is an admin | ||
|
||
```sh | ||
m365 pp gateway list | ||
``` |
21 changes: 21 additions & 0 deletions
21
docs/docs/cmd/search/externalconnection/externalconnection-list.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# search externalconnection list | ||
|
||
Lists external connections defined in Microsoft Search | ||
|
||
## Usage | ||
|
||
```sh | ||
m365 search externalconnection list [options] | ||
``` | ||
|
||
## Options | ||
|
||
--8<-- "docs/cmd/_global.md" | ||
|
||
## Examples | ||
|
||
List external connections defined in Microsoft Search | ||
|
||
```sh | ||
m365 search externalconnection list | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# spo eventreceiver get | ||
|
||
Retrieves specific event receiver for the specified web, site or list by event receiver name or id. | ||
|
||
## Usage | ||
|
||
```sh | ||
m365 spo eventreceiver get [options] | ||
``` | ||
|
||
## Options | ||
|
||
`-u, --webUrl <webUrl>` | ||
: The URL of the web for which to retrieve the event receivers. | ||
|
||
`--listTitle [listTitle]` | ||
: The title of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. | ||
Specify either `listTitle`, `listId` or `listUrl`. | ||
|
||
`--listId [listId]` | ||
: The id of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. | ||
Specify either `listTitle`, `listId` or `listUrl`. | ||
|
||
`--listUrl [listUrl]` | ||
: The url of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. | ||
Specify either `listTitle`, `listId` or `listUrl`. | ||
|
||
`-n, --name [name]` | ||
The name of the event receiver to retrieve. Specify either `name` or `id` but not both. | ||
|
||
`-i, --id [id]` | ||
The id of the event receiver to retrieve. Specify either `name` or `id` but not both. | ||
|
||
`-s, --scope [scope]` | ||
: The scope of which to retrieve the Event Receivers. | ||
Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties. | ||
|
||
--8<-- "docs/cmd/_global.md" | ||
|
||
## Examples | ||
|
||
Retrieve event receivers in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_. | ||
|
||
```sh | ||
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver' | ||
``` | ||
|
||
Retrieve event receivers in site _<https://contoso.sharepoint.com/sites/contoso-sales>_ with id _c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec_. | ||
|
||
```sh | ||
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec | ||
``` | ||
|
||
Retrieve event receivers for list with title _Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_. | ||
|
||
```sh | ||
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver' | ||
``` | ||
|
||
Retrieve event receivers for list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with id _c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec_. | ||
|
||
```sh | ||
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec | ||
``` | ||
|
||
Retrieve event receivers for list with url _/sites/contoso-sales/lists/Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_. | ||
|
||
```sh | ||
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver' | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# spo list view add | ||
|
||
Adds a new view to a SharePoint list | ||
|
||
## Usage | ||
|
||
```sh | ||
m365 spo list view add [options] | ||
``` | ||
|
||
## Options | ||
|
||
`-u, --webUrl <webUrl>` | ||
: URL of the site where the list is located. | ||
|
||
`--listId [listId]` | ||
: ID of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple. | ||
|
||
`--listTitle [listTitle]` | ||
: Title of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple. | ||
|
||
`--listUrl [listUrl]` | ||
: Relative URL of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple. | ||
|
||
`--title <title>` | ||
: Title of the view to be created for the list. | ||
|
||
`--fields <fields>` | ||
: Comma-separated list of **case-sensitive** internal names of the fields to add to the view. | ||
|
||
`--personal` | ||
: View will be created as personal view, if specified. | ||
|
||
`--default` | ||
: View will be set as default view, if specified. | ||
|
||
`--paged` | ||
: View supports paging, if specified (recommended to use this). | ||
|
||
`--rowLimit [rowLimit]` | ||
: Sets the number of items to display for the view. Default value is 30. | ||
|
||
--8<-- "docs/cmd/_global.md" | ||
|
||
## Remarks | ||
|
||
We recommend using the `paged` option. When specified, the view supports displaying more items page by page (default behavior). When not specified, the `rowLimit` is absolute, and there is no link to see more items. | ||
|
||
## Examples | ||
|
||
Add a view called _All events_ to a list with specific title. | ||
|
||
```sh | ||
spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "My List" --title "All events" --fields "FieldName1,FieldName2,Created,Author,Modified,Editor" --paged | ||
``` | ||
|
||
Add a view as default view with title _All events_ to a list with a specific URL. | ||
|
||
```sh | ||
spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl "/Lists/MyList" --title "All events" --fields "FieldName1,Created" --paged --default | ||
``` | ||
|
||
Add a personal view called _All events_ to a list with a specific ID. | ||
|
||
```sh | ||
spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listId 00000000-0000-0000-0000-000000000000 --title "All events" --fields "FieldName1,Created" --paged --personal | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# spo userprofile set | ||
# spo userprofile get | ||
|
||
Get SharePoint user profile properties for the specified user | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.