@pnp/cli-microsoft365 6.3.0-beta.c3dc921 → 6.3.0-beta.cefe20e
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.js +8 -0
- package/dist/Auth.js +0 -18
- package/dist/Command.js +12 -1
- package/dist/appInsights.js +2 -1
- package/dist/cli/Cli.js +74 -3
- package/dist/m365/aad/commands/group/group-list.js +2 -1
- package/dist/m365/aad/commands/license/license-list.js +41 -0
- package/dist/m365/aad/commands/user/user-add.js +223 -0
- package/dist/m365/aad/commands/user/user-license-add.js +88 -0
- package/dist/m365/aad/commands/user/user-license-list.js +99 -0
- package/dist/m365/aad/commands/user/user-license-remove.js +114 -0
- package/dist/m365/aad/commands/user/user-recyclebinitem-clear.js +103 -0
- package/dist/m365/aad/commands/user/user-recyclebinitem-list.js +41 -0
- package/dist/m365/aad/commands/user/user-recyclebinitem-remove.js +92 -0
- package/dist/m365/aad/commands/user/user-recyclebinitem-restore.js +77 -0
- package/dist/m365/aad/commands/user/user-remove.js +107 -0
- package/dist/m365/aad/commands.js +10 -0
- package/dist/m365/base/O365MgmtCommand.js +10 -0
- package/dist/m365/context/commands/option/option-list.js +54 -0
- package/dist/m365/context/commands.js +1 -0
- package/dist/m365/file/commands/convert/convert-pdf.js +7 -6
- package/dist/m365/flow/commands/environment/FlowEnvironmentDetails.js +3 -0
- package/dist/m365/flow/commands/environment/environment-get.js +26 -11
- package/dist/m365/flow/commands/run/run-list.js +55 -3
- package/dist/m365/graph/commands/changelog/changelog-list.js +3 -2
- package/dist/m365/onenote/commands/notebook/notebook-list.js +50 -53
- package/dist/m365/onenote/commands/page/page-list.js +2 -16
- package/dist/m365/outlook/commands/mail/mail-send.js +3 -2
- package/dist/m365/outlook/commands/message/message-get.js +4 -3
- package/dist/m365/pa/commands/environment/environment-get.js +13 -5
- package/dist/m365/planner/commands/plan/plan-add.js +20 -6
- package/dist/m365/planner/commands/plan/plan-get.js +40 -26
- package/dist/m365/planner/commands/plan/plan-list.js +24 -14
- package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
- package/dist/m365/planner/commands/plan/plan-set.js +21 -10
- package/dist/m365/planner/commands/roster/roster-add.js +47 -0
- package/dist/m365/planner/commands/roster/roster-get.js +61 -0
- package/dist/m365/planner/commands/roster/roster-member-add.js +113 -0
- package/dist/m365/planner/commands/roster/roster-member-list.js +54 -0
- package/dist/m365/planner/commands/roster/roster-member-remove.js +140 -0
- package/dist/m365/planner/commands/roster/roster-remove.js +88 -0
- package/dist/m365/planner/commands/task/task-add.js +3 -0
- package/dist/m365/planner/commands/task/task-checklistitem-add.js +2 -1
- package/dist/m365/planner/commands/task/task-checklistitem-list.js +2 -1
- package/dist/m365/planner/commands.js +6 -0
- package/dist/m365/pp/commands/environment/environment-get.js +18 -9
- package/dist/m365/pp/commands/solution/solution-get.js +2 -1
- package/dist/m365/pp/commands/solution/solution-list.js +2 -1
- package/dist/m365/purview/commands/auditlog/auditlog-list.js +205 -0
- package/dist/m365/purview/commands/retentionevent/retentionevent-get.js +75 -0
- package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +46 -0
- package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +97 -0
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-add.js +77 -0
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +75 -0
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +43 -0
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-remove.js +97 -0
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-set.js +90 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +5 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +5 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-list.js +5 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-remove.js +5 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +11 -1
- package/dist/m365/purview/commands.js +9 -0
- package/dist/m365/spfx/commands/project/WebApiPermissionRequests.js +3 -0
- package/dist/m365/spfx/commands/project/project-permissions-grant.js +81 -0
- package/dist/m365/spfx/commands.js +3 -2
- package/dist/m365/spo/commands/app/app-add.js +2 -1
- package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-add.js +95 -0
- package/dist/m365/spo/commands/customaction/customaction-get.js +17 -66
- package/dist/m365/spo/commands/customaction/customaction-list.js +2 -36
- package/dist/m365/spo/commands/customaction/customaction-remove.js +11 -18
- package/dist/m365/spo/commands/file/GraphFileDetails.js +0 -1
- package/dist/m365/spo/commands/file/file-move.js +0 -2
- package/dist/m365/spo/commands/file/file-sharinginfo-get.js +2 -1
- package/dist/m365/spo/commands/file/file-sharinglink-add.js +2 -22
- package/dist/m365/spo/commands/file/file-sharinglink-clear.js +137 -0
- package/dist/m365/spo/commands/file/file-sharinglink-get.js +2 -25
- package/dist/m365/spo/commands/file/file-sharinglink-list.js +9 -29
- package/dist/m365/spo/commands/file/file-sharinglink-remove.js +2 -25
- package/dist/m365/spo/commands/file/file-sharinglink-set.js +104 -0
- package/dist/m365/spo/commands/folder/folder-copy.js +0 -2
- package/dist/m365/spo/commands/folder/folder-move.js +0 -2
- package/dist/m365/spo/commands/group/group-list.js +2 -1
- package/dist/m365/spo/commands/hubsite/hubsite-get.js +1 -1
- package/dist/m365/spo/commands/listitem/listitem-add.js +2 -1
- package/dist/m365/spo/commands/listitem/listitem-list.js +2 -1
- package/dist/m365/spo/commands/navigation/navigation-node-add.js +17 -3
- package/dist/m365/spo/commands/navigation/navigation-node-get.js +73 -0
- package/dist/m365/spo/commands/navigation/navigation-node-list.js +4 -7
- package/dist/m365/spo/commands/navigation/navigation-node-set.js +118 -0
- package/dist/m365/spo/commands/page/page-column-get.js +2 -1
- package/dist/m365/spo/commands/page/page-column-list.js +2 -1
- package/dist/m365/spo/commands/page/page-section-get.js +2 -1
- package/dist/m365/spo/commands/page/page-section-list.js +2 -1
- package/dist/m365/spo/commands/site/site-add.js +0 -3
- package/dist/m365/spo/commands/site/site-apppermission-add.js +2 -14
- package/dist/m365/spo/commands/site/site-apppermission-get.js +2 -14
- package/dist/m365/spo/commands/site/site-apppermission-list.js +2 -14
- package/dist/m365/spo/commands/site/site-apppermission-remove.js +2 -14
- package/dist/m365/spo/commands/site/site-apppermission-set.js +2 -14
- package/dist/m365/spo/commands/site/site-remove.js +0 -3
- package/dist/m365/spo/commands/site/site-set.js +0 -2
- package/dist/m365/spo/commands/sitedesign/sitedesign-add.js +6 -0
- package/dist/m365/spo/commands/spo-search.js +2 -1
- package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-add.js +179 -0
- package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-remove.js +0 -1
- package/dist/m365/spo/commands/term/term-list.js +2 -1
- package/dist/m365/spo/commands/userprofile/userprofile-get.js +2 -2
- package/dist/m365/spo/commands/web/web-set.js +11 -4
- package/dist/m365/spo/commands.js +6 -0
- package/dist/m365/teams/commands/chat/chat-list.js +4 -4
- package/dist/m365/teams/commands/meeting/meeting-attendancereport-list.js +5 -5
- package/dist/m365/teams/commands/meeting/meeting-get.js +5 -5
- package/dist/m365/teams/commands/meeting/meeting-list.js +5 -4
- package/dist/m365/teams/commands/team/team-add.js +3 -8
- package/dist/m365/teams/commands/team/team-app-list.js +1 -1
- package/dist/m365/teams/commands/user/user-app-list.js +2 -1
- package/dist/m365/todo/commands/task/task-get.js +2 -1
- package/dist/m365/todo/commands/task/task-list.js +2 -1
- package/dist/m365/yammer/commands/yammer-search.js +2 -1
- package/dist/utils/aadUser.js +38 -0
- package/dist/utils/accessToken.js +1 -1
- package/dist/utils/planner.js +16 -5
- package/dist/utils/session.js +18 -0
- package/dist/utils/spo.js +119 -12
- package/docs/docs/cmd/aad/app/app-list.md +3 -0
- package/docs/docs/cmd/aad/license/license-list.md +87 -0
- package/docs/docs/cmd/aad/user/user-add.md +168 -0
- package/docs/docs/cmd/aad/user/user-license-add.md +108 -0
- package/docs/docs/cmd/aad/user/user-license-list.md +98 -0
- package/docs/docs/cmd/aad/user/user-license-remove.md +43 -0
- package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md +42 -0
- package/docs/docs/cmd/aad/user/user-recyclebinitem-list.md +82 -0
- package/docs/docs/cmd/aad/user/user-recyclebinitem-remove.md +45 -0
- package/docs/docs/cmd/aad/user/user-recyclebinitem-restore.md +99 -0
- package/docs/docs/cmd/aad/user/user-remove.md +51 -0
- package/docs/docs/cmd/aad/user/user-set.md +2 -2
- package/docs/docs/cmd/context/option/option-list.md +63 -0
- package/docs/docs/cmd/flow/environment/environment-get.md +31 -3
- package/docs/docs/cmd/flow/run/run-list.md +21 -0
- package/docs/docs/cmd/login.md +26 -0
- package/docs/docs/cmd/logout.md +4 -0
- package/docs/docs/cmd/pa/app/app-get.md +24 -0
- package/docs/docs/cmd/pa/app/app-list.md +21 -0
- package/docs/docs/cmd/pa/connector/connector-list.md +17 -0
- package/docs/docs/cmd/pa/environment/environment-get.md +26 -2
- package/docs/docs/cmd/pa/environment/environment-list.md +19 -0
- package/docs/docs/cmd/planner/plan/plan-add.md +17 -6
- package/docs/docs/cmd/planner/plan/plan-get.md +21 -7
- package/docs/docs/cmd/planner/plan/plan-list.md +16 -2
- package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
- package/docs/docs/cmd/planner/plan/plan-set.md +10 -4
- package/docs/docs/cmd/planner/roster/roster-add.md +60 -0
- package/docs/docs/cmd/planner/roster/roster-get.md +73 -0
- package/docs/docs/cmd/planner/roster/roster-member-add.md +87 -0
- package/docs/docs/cmd/planner/roster/roster-member-list.md +76 -0
- package/docs/docs/cmd/planner/roster/roster-member-remove.md +51 -0
- package/docs/docs/cmd/planner/roster/roster-remove.md +48 -0
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +43 -0
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +43 -0
- package/docs/docs/cmd/pp/card/card-clone.md +12 -0
- package/docs/docs/cmd/pp/card/card-get.md +49 -0
- package/docs/docs/cmd/pp/card/card-list.md +49 -0
- package/docs/docs/cmd/pp/chatbot/chatbot-get.md +55 -0
- package/docs/docs/cmd/pp/chatbot/chatbot-list.md +36 -0
- package/docs/docs/cmd/pp/dataverse/dataverse-table-get.md +30 -0
- package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +30 -0
- package/docs/docs/cmd/pp/dataverse/dataverse-table-row-list.md +30 -0
- package/docs/docs/cmd/pp/environment/environment-get.md +19 -0
- package/docs/docs/cmd/pp/environment/environment-list.md +19 -0
- package/docs/docs/cmd/pp/gateway/gateway-get.md +19 -0
- package/docs/docs/cmd/pp/gateway/gateway-list.md +19 -0
- package/docs/docs/cmd/pp/managementapp/managementapp-add.md +12 -0
- package/docs/docs/cmd/pp/managementapp/managementapp-list.md +12 -0
- package/docs/docs/cmd/pp/solution/solution-get.md +14 -0
- package/docs/docs/cmd/pp/solution/solution-list.md +14 -0
- package/docs/docs/cmd/pp/solution/solution-publisher-get.md +20 -1
- package/docs/docs/cmd/pp/solution/solution-publisher-list.md +18 -0
- package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +21 -0
- package/docs/docs/cmd/purview/auditlog/auditlog-list.md +123 -0
- package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +132 -0
- package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +107 -0
- package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +45 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +106 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +103 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +97 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +43 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +43 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +3 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +3 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +3 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +3 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +3 -0
- package/docs/docs/cmd/request.md +74 -0
- package/docs/docs/cmd/spfx/project/project-permissions-grant.md +65 -0
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +56 -0
- package/docs/docs/cmd/spo/file/file-sharinglink-clear.md +46 -0
- package/docs/docs/cmd/spo/file/file-sharinglink-list.md +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-set.md +104 -0
- package/docs/docs/cmd/spo/homesite/homesite-get.md +20 -1
- package/docs/docs/cmd/spo/homesite/homesite-remove.md +8 -2
- package/docs/docs/cmd/spo/homesite/homesite-set.md +8 -2
- package/docs/docs/cmd/spo/hubsite/hubsite-connect.md +9 -9
- package/docs/docs/cmd/spo/hubsite/hubsite-data-get.md +34 -5
- package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md +6 -6
- package/docs/docs/cmd/spo/hubsite/hubsite-get.md +36 -19
- package/docs/docs/cmd/spo/hubsite/hubsite-list.md +59 -1
- package/docs/docs/cmd/spo/hubsite/hubsite-register.md +30 -1
- package/docs/docs/cmd/spo/hubsite/hubsite-rights-grant.md +6 -6
- package/docs/docs/cmd/spo/hubsite/hubsite-rights-revoke.md +4 -4
- package/docs/docs/cmd/spo/hubsite/hubsite-set.md +40 -15
- package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +4 -4
- package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +7 -1
- package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +9 -3
- package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +8 -2
- package/docs/docs/cmd/spo/list/list-add.md +123 -57
- package/docs/docs/cmd/spo/list/list-contenttype-add.md +50 -5
- package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +4 -4
- package/docs/docs/cmd/spo/list/list-contenttype-list.md +49 -4
- package/docs/docs/cmd/spo/list/list-contenttype-remove.md +6 -6
- package/docs/docs/cmd/spo/list/list-get.md +70 -4
- package/docs/docs/cmd/spo/list/list-list.md +70 -2
- package/docs/docs/cmd/spo/list/list-remove.md +6 -6
- package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +2 -2
- package/docs/docs/cmd/spo/list/list-retentionlabel-get.md +36 -3
- package/docs/docs/cmd/spo/list/list-retentionlabel-remove.md +3 -3
- package/docs/docs/cmd/spo/list/list-roleassignment-add.md +6 -6
- package/docs/docs/cmd/spo/list/list-roleassignment-remove.md +3 -3
- package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +9 -9
- package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +7 -7
- package/docs/docs/cmd/spo/list/list-set.md +61 -61
- package/docs/docs/cmd/spo/list/list-sitescript-get.md +35 -3
- package/docs/docs/cmd/spo/list/list-view-add.md +66 -5
- package/docs/docs/cmd/spo/list/list-view-field-add.md +10 -10
- package/docs/docs/cmd/spo/list/list-view-get.md +61 -0
- package/docs/docs/cmd/spo/list/list-view-list.md +61 -0
- package/docs/docs/cmd/spo/list/list-view-set.md +1 -1
- package/docs/docs/cmd/spo/list/list-webhook-add.md +19 -0
- package/docs/docs/cmd/spo/list/list-webhook-get.md +19 -0
- package/docs/docs/cmd/spo/list/list-webhook-list.md +19 -0
- package/docs/docs/cmd/spo/listitem/listitem-add.md +29 -0
- package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +19 -4
- package/docs/docs/cmd/spo/listitem/listitem-get.md +57 -0
- package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +8 -2
- package/docs/docs/cmd/spo/listitem/listitem-list.md +28 -0
- package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +15 -0
- package/docs/docs/cmd/spo/listitem/listitem-set.md +30 -0
- package/docs/docs/cmd/spo/navigation/navigation-node-add.md +40 -3
- package/docs/docs/cmd/spo/navigation/navigation-node-get.md +91 -0
- package/docs/docs/cmd/spo/navigation/navigation-node-list.md +30 -0
- package/docs/docs/cmd/spo/navigation/navigation-node-remove.md +1 -1
- package/docs/docs/cmd/spo/navigation/navigation-node-set.md +59 -0
- package/docs/docs/cmd/spo/sitedesign/sitedesign-add.md +3 -0
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +59 -0
- package/docs/docs/cmd/spo/web/web-set.md +9 -0
- package/docs/docs/cmd/status.md +46 -0
- package/docs/docs/cmd/version.md +26 -0
- package/npm-shrinkwrap.json +912 -876
- package/package.json +13 -12
|
@@ -122,3 +122,20 @@ m365 pa connector list --environmentName Default-d87a7535-dd31-4437-bfe1-95340ac
|
|
|
122
122
|
name,displayName
|
|
123
123
|
shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012,My connector
|
|
124
124
|
```
|
|
125
|
+
|
|
126
|
+
=== "Markdown"
|
|
127
|
+
|
|
128
|
+
```md
|
|
129
|
+
# pa connector list --environmentName "Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6"
|
|
130
|
+
|
|
131
|
+
Date: 9/1/2023
|
|
132
|
+
|
|
133
|
+
## My connector (/providers/Microsoft.PowerApps/apis/shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012)
|
|
134
|
+
|
|
135
|
+
Property | Value
|
|
136
|
+
---------|-------
|
|
137
|
+
name | shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012
|
|
138
|
+
id | /providers/Microsoft.PowerApps/apis/shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012
|
|
139
|
+
type | Microsoft.PowerApps/apis
|
|
140
|
+
properties | {"displayName":"My connector","iconUri":"https://az787822.vo.msecnd.net/defaulticons/api-dedicated.png","iconBrandColor":"#007ee5","contact":{},"license":{},"apiEnvironment":"Shared","isCustomApi":true,"connectionParameters":{},"runtimeUrls":["https://europe-002.azure-apim.net/apim/my-20connector-5f0027f520b23e81c1-5f9888a90360086012"],"primaryRuntimeUrl":"https://europe-002.azure-apim.net/apim/my-20connector-5f0027f520b23e81c1-5f9888a90360086012","metadata":{"source":"powerapps-user-defined","brandColor":"#007ee5","contact":{},"license":{},"publisherUrl":null,"serviceUrl":null,"documentationUrl":null,"environmentName":"Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6","xrmConnectorId":null,"almMode":"Environment","createdBy":"{\"id\":\"03043611-d01e-4e58-9fbe-1a18ecb861d8\",\"displayName\":\"MOD Administrator\",\"email\":\"admin@contoso.OnMicrosoft.com\",\"type\":\"User\",\"tenantId\":\"0d645e38-ec52-4a4f-ac58-65f2ac4015f6\",\"userPrincipalName\":\"admin@contoso.onmicrosoft.com\"}","modifiedBy":"{\"id\":\"03043611-d01e-4e58-9fbe-1a18ecb861d8\",\"displayName\":\"MOD Administrator\",\"email\":\"admin@contoso.OnMicrosoft.com\",\"type\":\"User\",\"tenantId\":\"0d645e38-ec52-4a4f-ac58-65f2ac4015f6\",\"userPrincipalName\":\"admin@contoso.onmicrosoft.com\"}","allowSharing":false},"capabilities":[],"description":"","apiDefinitions":{"originalSwaggerUrl":"https://paeu2weu8.blob.core.windows.net/api-swagger-files/my-20connector-5f0027f520b23e81c1-5f9888a90360086012.json_original?sv=2018-03-28&sr=b&sig=cOkjAecgpr6sSznMpDqiZitUOpVvVDJRCOZfe3VmReU%3D&se=2019-12-05T19%3A53%3A49Z&sp=r","modifiedSwaggerUrl":"https://paeu2weu8.blob.core.windows.net/api-swagger-files/my-20connector-5f0027f520b23e81c1-5f9888a90360086012.json?sv=2018-03-28&sr=b&sig=rkpKHP8K%2F2yNBIUQcVN%2B0ZPjnP9sECrM%2FfoZMG%2BJZX0%3D&se=2019-12-05T19%3A53%3A49Z&sp=r"},"createdBy":{"id":"03043611-d01e-4e58-9fbe-1a18ecb861d8","displayName":"MOD Administrator","email":"admin@contoso.OnMicrosoft.com","type":"User","tenantId":"0d645e38-ec52-4a4f-ac58-65f2ac4015f6","userPrincipalName":"admin@contoso.onmicrosoft.com"},"modifiedBy":{"id":"03043611-d01e-4e58-9fbe-1a18ecb861d8","displayName":"MOD Administrator","email":"admin@contoso.OnMicrosoft.com","type":"User","tenantId":"0d645e38-ec52-4a4f-ac58-65f2ac4015f6","userPrincipalName":"admin@contoso.onmicrosoft.com"},"createdTime":"2019-12-05T18:45:03.4615313Z","changedTime":"2019-12-05T18:45:03.4615313Z","environment":{"id":"/providers/Microsoft.PowerApps/environments/Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6","name":"Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6"},"tier":"Standard","publisher":"MOD Administrator","almMode":"Environment"}
|
|
141
|
+
```
|
|
@@ -10,8 +10,8 @@ m365 pa environment get [options]
|
|
|
10
10
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
|
-
`-n, --name
|
|
14
|
-
: The name of the environment
|
|
13
|
+
`-n, --name [name]`
|
|
14
|
+
: The name of the environment. When not specified, the default environment is retrieved.
|
|
15
15
|
|
|
16
16
|
--8<-- "docs/cmd/_global.md"
|
|
17
17
|
|
|
@@ -24,6 +24,12 @@ If the environment with the name you specified doesn't exist, you will get the `
|
|
|
24
24
|
|
|
25
25
|
## Examples
|
|
26
26
|
|
|
27
|
+
Get information about the default Power Apps environment
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
m365 pa environment get
|
|
31
|
+
```
|
|
32
|
+
|
|
27
33
|
Get information about the Power Apps environment named _Default-d87a7535-dd31-4437-bfe1-95340acd55c5_
|
|
28
34
|
|
|
29
35
|
```sh
|
|
@@ -141,4 +147,22 @@ m365 pa environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
|
|
|
141
147
|
name,id,location,displayName,provisioningState,environmentSku,azureRegionHint,isDefault
|
|
142
148
|
Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e,/providers/Microsoft.PowerApps/environments/Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e,europe,environmentName (default),Succeeded,Default,westeurope,1
|
|
143
149
|
```
|
|
150
|
+
|
|
151
|
+
=== "Markdown"
|
|
144
152
|
|
|
153
|
+
```md
|
|
154
|
+
# pa environment get --name "Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d"
|
|
155
|
+
|
|
156
|
+
Date: 9/1/2023
|
|
157
|
+
|
|
158
|
+
## environmentName (default) (org6633050c) (/providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d)
|
|
159
|
+
|
|
160
|
+
Property | Value
|
|
161
|
+
---------|-------
|
|
162
|
+
id | /providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
|
|
163
|
+
name | Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
|
|
164
|
+
location | europe
|
|
165
|
+
type | Microsoft.PowerApps/environments
|
|
166
|
+
properties | {"azureRegionHint":"westeurope","displayName":"contoso (default) (org6633049a)","createdTime":"2020-03-12T13:39:17.9876946Z","createdBy":{"id":"SYSTEM","displayName":"SYSTEM","type":"NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","environmentType":"Production","isDefault":true,"runtimeEndpoints":{"microsoft.BusinessAppPlatform":"https://europe.api.bap.microsoft.com","microsoft.CommonDataModel":"https://europe.api.cds.microsoft.com","microsoft.PowerApps":"https://europe.api.powerapps.com","microsoft.PowerAppsAdvisor":"https://europe.api.advisor.powerapps.com","microsoft.PowerVirtualAgents":"https://powervamg.eu-il109.gateway.prod.island.powerapps.com","microsoft.ApiManagement":"https://management.EUROPE.azure-apihub.net","microsoft.Flow":"https://emea.api.flow.microsoft.com"},"linkedEnvironmentMetadata":{"type":"Dynamics365Instance","resourceId":"5041ef46-5a1c-4a0f-a185-6bb49b5c6686","friendlyName":"contoso (default)","uniqueName":"unq5041ef465a1c4a0fa1856bb49b5c6","domainName":"org6633049a","version":"9.2.22101.00168","instanceUrl":"https://org6633049a.crm4.dynamics.com/","instanceApiUrl":"https://org6633049a.api.crm4.dynamics.com","baseLanguage":1033,"instanceState":"Ready","createdTime":"2021-10-08T09:50:41.283Z","modifiedTime":"2022-10-29T14:04:14.0720726Z","hostNameSuffix":"crm4.dynamics.com","bapSolutionId":"00000001-0000-0000-0001-00000000009b","creationTemplates":["D365_CDS"],"webApiVersion":"v9.0","platformSku":"Standard"},"retentionPeriod":"P7D","lifecycleAuthority":"Environment","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"updateCadence":{"id":"Frequent"},"connectedGroups":[],"protectionStatus":{"keyManagedBy":"Microsoft"},"trialScenarioType":"None","cluster":{"category":"Prod","number":"109","uriSuffix":"eu-il109.gateway.prod.island","geoShortName":"EU","environment":"Prod"},"governanceConfiguration":{"protectionLevel":"Basic"}}
|
|
167
|
+
displayName | contoso (default) (org6633049a)
|
|
168
|
+
```
|
|
@@ -133,3 +133,22 @@ m365 pa environment list
|
|
|
133
133
|
name,displayName
|
|
134
134
|
Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e,environmentName (default) (org6633050c)
|
|
135
135
|
```
|
|
136
|
+
|
|
137
|
+
=== "Markdown"
|
|
138
|
+
|
|
139
|
+
```md
|
|
140
|
+
# pa environment list
|
|
141
|
+
|
|
142
|
+
Date: 9/1/2023
|
|
143
|
+
|
|
144
|
+
## environmentName (default) (org6633050c) (/providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d)
|
|
145
|
+
|
|
146
|
+
Property | Value
|
|
147
|
+
---------|-------
|
|
148
|
+
id | /providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
|
|
149
|
+
name | Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
|
|
150
|
+
location | europe
|
|
151
|
+
type | Microsoft.PowerApps/environments
|
|
152
|
+
properties | {"azureRegionHint":"westeurope","displayName":"contoso (default) (org6633049a)","createdTime":"2020-03-12T13:39:17.9876946Z","createdBy":{"id":"SYSTEM","displayName":"SYSTEM","type":"NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","environmentType":"Production","isDefault":true,"runtimeEndpoints":{"microsoft.BusinessAppPlatform":"https://europe.api.bap.microsoft.com","microsoft.CommonDataModel":"https://europe.api.cds.microsoft.com","microsoft.PowerApps":"https://europe.api.powerapps.com","microsoft.PowerAppsAdvisor":"https://europe.api.advisor.powerapps.com","microsoft.PowerVirtualAgents":"https://powervamg.eu-il109.gateway.prod.island.powerapps.com","microsoft.ApiManagement":"https://management.EUROPE.azure-apihub.net","microsoft.Flow":"https://emea.api.flow.microsoft.com"},"linkedEnvironmentMetadata":{"type":"Dynamics365Instance","resourceId":"5041ef46-5a1c-4a0f-a185-6bb49b5c6686","friendlyName":"contoso (default)","uniqueName":"unq5041ef465a1c4a0fa1856bb49b5c6","domainName":"org6633049a","version":"9.2.22101.00168","instanceUrl":"https://org6633049a.crm4.dynamics.com/","instanceApiUrl":"https://org6633049a.api.crm4.dynamics.com","baseLanguage":1033,"instanceState":"Ready","createdTime":"2021-10-08T09:50:41.283Z","modifiedTime":"2022-10-29T14:04:14.0720726Z","hostNameSuffix":"crm4.dynamics.com","bapSolutionId":"00000001-0000-0000-0001-00000000009b","creationTemplates":["D365_CDS"],"webApiVersion":"v9.0","platformSku":"Standard"},"retentionPeriod":"P7D","lifecycleAuthority":"Environment","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"updateCadence":{"id":"Frequent"},"connectedGroups":[],"protectionStatus":{"keyManagedBy":"Microsoft"},"trialScenarioType":"None","cluster":{"category":"Prod","number":"109","uriSuffix":"eu-il109.gateway.prod.island","geoShortName":"EU","environment":"Prod"},"governanceConfiguration":{"protectionLevel":"Basic"}}
|
|
153
|
+
displayName | contoso (default) (org6633049a)
|
|
154
|
+
```
|
|
@@ -14,10 +14,13 @@ m365 planner plan add [options]
|
|
|
14
14
|
: Title of the plan to add.
|
|
15
15
|
|
|
16
16
|
`--ownerGroupId [ownerGroupId]`
|
|
17
|
-
: ID of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId
|
|
17
|
+
: ID of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
|
|
18
18
|
|
|
19
19
|
`--ownerGroupName [ownerGroupName]`
|
|
20
|
-
: Name of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId
|
|
20
|
+
: Name of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
|
|
21
|
+
|
|
22
|
+
`--rosterId [rosterId]`
|
|
23
|
+
: ID of the Planner Roster. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
|
|
21
24
|
|
|
22
25
|
`--shareWithUserIds [shareWithUserIds]`
|
|
23
26
|
: The comma-separated IDs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
|
|
@@ -29,23 +32,31 @@ m365 planner plan add [options]
|
|
|
29
32
|
|
|
30
33
|
## Remarks
|
|
31
34
|
|
|
32
|
-
Related to the options `--shareWithUserIds` and `--shareWithUserNames`. If you are leveraging Microsoft 365 groups, use the `aad o365group user` commands to manage group membership to share the [group's](https://pnp.github.io/cli-microsoft365/cmd/aad/o365group/o365group-user-add/) plan. You can also add existing members of the group to this collection though it is not required for them to access the plan owned by the group.
|
|
35
|
+
- Related to the options `--shareWithUserIds` and `--shareWithUserNames`. If you are leveraging Microsoft 365 groups, use the `aad o365group user` commands to manage group membership to share the [group's](https://pnp.github.io/cli-microsoft365/cmd/aad/o365group/o365group-user-add/) plan. You can also add existing members of the group to this collection though it is not required for them to access the plan owned by the group.
|
|
36
|
+
|
|
37
|
+
- Hint: Unlike for groups, a Planner Roster can contain only 1 plan.
|
|
33
38
|
|
|
34
39
|
## Examples
|
|
35
40
|
|
|
36
|
-
Adds a Microsoft Planner plan with
|
|
41
|
+
Adds a Microsoft Planner plan with a Group by id
|
|
37
42
|
|
|
38
43
|
```sh
|
|
39
44
|
m365 planner plan add --title 'My Planner Plan' --ownerGroupId '233e43d0-dc6a-482e-9b4e-0de7a7bce9b4'
|
|
40
45
|
```
|
|
41
46
|
|
|
42
|
-
Adds a Microsoft Planner plan with
|
|
47
|
+
Adds a Microsoft Planner plan with with a Group by name
|
|
43
48
|
|
|
44
49
|
```sh
|
|
45
50
|
m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group'
|
|
46
51
|
```
|
|
47
52
|
|
|
48
|
-
Adds a Microsoft Planner plan with
|
|
53
|
+
Adds a Microsoft Planner plan with a Roster by id
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
m365 planner plan add --title 'My Planner Plan' --rosterId 'tYqYlNd6eECmsNhN_fcq85cAGAnd'
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Adds a Microsoft Planner plan with with a Group by name and share it with the given users
|
|
49
60
|
|
|
50
61
|
```sh
|
|
51
62
|
m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
|
|
@@ -11,39 +11,53 @@ m365 planner plan get [options]
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
13
|
`-i, --id [id]`
|
|
14
|
-
: ID of the plan. Specify either `id` or `
|
|
14
|
+
: ID of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
|
|
15
15
|
|
|
16
16
|
`-t, --title [title]`
|
|
17
|
-
: Title of the plan. Specify either `id` or `
|
|
17
|
+
: Title of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
|
|
18
|
+
|
|
19
|
+
`--rosterId [rosterId]`
|
|
20
|
+
: ID of the Planner Roster. Specify either `id`, `title` or `rosterId` but not multiple.
|
|
18
21
|
|
|
19
22
|
`--ownerGroupId [ownerGroupId]`
|
|
20
|
-
: ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title
|
|
23
|
+
: ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
|
|
21
24
|
|
|
22
25
|
`--ownerGroupName [ownerGroupName]`
|
|
23
|
-
: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title
|
|
26
|
+
: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
|
|
24
27
|
|
|
25
28
|
--8<-- "docs/cmd/_global.md"
|
|
26
29
|
|
|
30
|
+
## Remarks
|
|
31
|
+
|
|
32
|
+
!!! attention
|
|
33
|
+
When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
34
|
+
|
|
27
35
|
## Examples
|
|
28
36
|
|
|
29
|
-
Returns the Microsoft Planner plan
|
|
37
|
+
Returns the Microsoft Planner plan by id
|
|
30
38
|
|
|
31
39
|
```sh
|
|
32
40
|
m365 planner plan get --id "gndWOTSK60GfPQfiDDj43JgACDCb"
|
|
33
41
|
```
|
|
34
42
|
|
|
35
|
-
Returns the Microsoft Planner plan
|
|
43
|
+
Returns the Microsoft Planner plan by title and owner group id
|
|
36
44
|
|
|
37
45
|
```sh
|
|
38
46
|
m365 planner plan get --title "MyPlan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
|
|
39
47
|
```
|
|
40
48
|
|
|
41
|
-
Returns the Microsoft Planner plan
|
|
49
|
+
Returns the Microsoft Planner plan by title and owner group name
|
|
42
50
|
|
|
43
51
|
```sh
|
|
44
52
|
m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
|
|
45
53
|
```
|
|
46
54
|
|
|
55
|
+
Returns the Microsoft Planner plan by roster id
|
|
56
|
+
|
|
57
|
+
```sh
|
|
58
|
+
m365 planner plan get --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
|
|
59
|
+
```
|
|
60
|
+
|
|
47
61
|
## Response
|
|
48
62
|
|
|
49
63
|
=== "JSON"
|
|
@@ -11,13 +11,21 @@ m365 planner plan list [options]
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
13
|
`--ownerGroupId [ownerGroupId]`
|
|
14
|
-
: ID of the Group that owns the plan. Specify either `ownerGroupId
|
|
14
|
+
: ID of the Group that owns the plan. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
|
|
15
15
|
|
|
16
16
|
`--ownerGroupName [ownerGroupName]`
|
|
17
|
-
: Name of the Group that owns the plan. Specify either `ownerGroupId
|
|
17
|
+
: Name of the Group that owns the plan. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
|
|
18
|
+
|
|
19
|
+
`--rosterId [rosterId]`
|
|
20
|
+
: ID of the Planner Roster. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
|
|
18
21
|
|
|
19
22
|
--8<-- "docs/cmd/_global.md"
|
|
20
23
|
|
|
24
|
+
## Remarks
|
|
25
|
+
|
|
26
|
+
!!! attention
|
|
27
|
+
When using rosterId, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
28
|
+
|
|
21
29
|
## Examples
|
|
22
30
|
|
|
23
31
|
Returns a list of Microsoft Planner plans for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
|
|
@@ -32,6 +40,12 @@ Returns a list of Microsoft Planner plans for Group _My Planner Group_
|
|
|
32
40
|
m365 planner plan list --ownerGroupName "My Planner Group"
|
|
33
41
|
```
|
|
34
42
|
|
|
43
|
+
Returns a list of Microsoft Planner plans for Roster _FeMZFDoK8k2oWmuGE-XFHZcAEwtn_
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
m365 planner plan list --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
|
|
47
|
+
```
|
|
48
|
+
|
|
35
49
|
## Response
|
|
36
50
|
|
|
37
51
|
=== "JSON"
|
|
@@ -27,6 +27,10 @@ m365 planner plan remove [options]
|
|
|
27
27
|
|
|
28
28
|
--8<-- "docs/cmd/_global.md"
|
|
29
29
|
|
|
30
|
+
## Remarks
|
|
31
|
+
|
|
32
|
+
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.md).
|
|
33
|
+
|
|
30
34
|
## Examples
|
|
31
35
|
|
|
32
36
|
Removes the Microsoft Planner plan by ID
|
|
@@ -11,16 +11,19 @@ m365 planner plan set [options]
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
13
|
`-i, --id [id]`
|
|
14
|
-
: ID of the plan. Specify either `id` or `
|
|
14
|
+
: ID of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
|
|
15
15
|
|
|
16
16
|
`-t, --title [title]`
|
|
17
|
-
: Title of the plan. Specify either `id` or `
|
|
17
|
+
: Title of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
|
|
18
|
+
|
|
19
|
+
`--rosterId [rosterId]`
|
|
20
|
+
: ID of the Planner Roster. Specify either `id`, `title` or `rosterId` but not multiple.
|
|
18
21
|
|
|
19
22
|
`--ownerGroupId [ownerGroupId]`
|
|
20
|
-
: ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title
|
|
23
|
+
: ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
|
|
21
24
|
|
|
22
25
|
`--ownerGroupName [ownerGroupName]`
|
|
23
|
-
: Name of the Group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title
|
|
26
|
+
: Name of the Group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
|
|
24
27
|
|
|
25
28
|
`--newTitle [newTitle]`
|
|
26
29
|
: New title of the plan.
|
|
@@ -40,6 +43,9 @@ This command allows using unknown options.
|
|
|
40
43
|
`--category1 [category1]`
|
|
41
44
|
: New label for a category. Define the category key within your option to update the related label. Category 1 to 25 are available. E.g., `--category4`, `--category12`.
|
|
42
45
|
|
|
46
|
+
!!! attention
|
|
47
|
+
When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
48
|
+
|
|
43
49
|
## Examples
|
|
44
50
|
|
|
45
51
|
Updates a Microsoft Planner plan title to New Title
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# planner roster add
|
|
2
|
+
|
|
3
|
+
Creates a new Microsoft Planner Roster
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner roster add [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
--8<-- "docs/cmd/_global.md"
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
!!! attention
|
|
18
|
+
The Roster will be automatically deleted when it doesn't contain a plan 24 hours after its creation. Membership information will be completely erased within 30 days of this deletion.
|
|
19
|
+
|
|
20
|
+
!!! attention
|
|
21
|
+
This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
22
|
+
|
|
23
|
+
!!! important
|
|
24
|
+
To be able to create a new Roster, the Planner Roster creation tenant setting should be enabled. Use the [planner tenant settings list](../tenant/tenant-settings-list.md) command to check if this setting is enabled for your tenant.
|
|
25
|
+
|
|
26
|
+
## Examples
|
|
27
|
+
|
|
28
|
+
Creates a new Microsoft Planner Roster
|
|
29
|
+
|
|
30
|
+
```sh
|
|
31
|
+
m365 planner roster add
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Response
|
|
35
|
+
|
|
36
|
+
=== "JSON"
|
|
37
|
+
|
|
38
|
+
```json
|
|
39
|
+
{
|
|
40
|
+
"id": "e6fmvM_yi0OJgvmepE5uj5cAE6qX",
|
|
41
|
+
"assignedSensitivityLabel": null
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
=== "Text"
|
|
46
|
+
|
|
47
|
+
```text
|
|
48
|
+
assignedSensitivityLabel: null
|
|
49
|
+
id : e6fmvM_yi0OJgvmepE5uj5cAE6qX
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
=== "CSV"
|
|
53
|
+
|
|
54
|
+
```csv
|
|
55
|
+
id,assignedSensitivityLabel
|
|
56
|
+
e6fmvM_yi0OJgvmepE5uj5cAE6qX,
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Additional information
|
|
60
|
+
Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# planner roster get
|
|
2
|
+
|
|
3
|
+
Gets information about the specific Microsoft Planner Roster.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner roster get [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`--id <id>`
|
|
14
|
+
: ID of the Planner Roster.
|
|
15
|
+
|
|
16
|
+
--8<-- "docs/cmd/_global.md"
|
|
17
|
+
|
|
18
|
+
## Remarks
|
|
19
|
+
|
|
20
|
+
!!! attention
|
|
21
|
+
This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
22
|
+
|
|
23
|
+
## Examples
|
|
24
|
+
|
|
25
|
+
Gets information about a specific Planner Roster.
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
m365 planner roster get --id tYqYlNd6eECmsNhN_fcq85cAGAnd
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Response
|
|
32
|
+
|
|
33
|
+
=== "JSON"
|
|
34
|
+
|
|
35
|
+
```json
|
|
36
|
+
{
|
|
37
|
+
"id": "tYqYlNd6eECmsNhN_fcq85cAGAnd",
|
|
38
|
+
"assignedSensitivityLabel": null
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
=== "Text"
|
|
43
|
+
|
|
44
|
+
```text
|
|
45
|
+
assignedSensitivityLabel: null
|
|
46
|
+
id : tYqYlNd6eECmsNhN_fcq85cAGAnd
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
=== "CSV"
|
|
50
|
+
|
|
51
|
+
```csv
|
|
52
|
+
id,assignedSensitivityLabel
|
|
53
|
+
tYqYlNd6eECmsNhN_fcq85cAGAnd,
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
=== "Markdown"
|
|
57
|
+
|
|
58
|
+
```md
|
|
59
|
+
# planner roster get --id "tYqYlNd6eECmsNhN_fcq85cAGAnd"
|
|
60
|
+
|
|
61
|
+
Date: 1/30/2023
|
|
62
|
+
|
|
63
|
+
## undefined (tYqYlNd6eECmsNhN_fcq85cAGAnd)
|
|
64
|
+
|
|
65
|
+
Property | Value
|
|
66
|
+
---------|-------
|
|
67
|
+
id | tYqYlNd6eECmsNhN_fcq85cAGAnd
|
|
68
|
+
assignedSensitivityLabel | null
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Additional information
|
|
72
|
+
|
|
73
|
+
Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# planner roster member add
|
|
2
|
+
|
|
3
|
+
Adds a user to a Microsoft Planner Roster
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner roster member add [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`--rosterId <rosterId>`
|
|
14
|
+
: ID of the Planner Roster.
|
|
15
|
+
|
|
16
|
+
`--userId [userId]`
|
|
17
|
+
: User's Azure AD ID. Specify either `userId`, `userName` but not both.
|
|
18
|
+
|
|
19
|
+
`--userName [userName]`
|
|
20
|
+
: User's UPN (user principal name, e.g. johndoe@example.com). Specify either `userId`, `userName` but not both.
|
|
21
|
+
|
|
22
|
+
--8<-- "docs/cmd/_global.md"
|
|
23
|
+
|
|
24
|
+
## Remarks
|
|
25
|
+
|
|
26
|
+
!!! attention
|
|
27
|
+
This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
28
|
+
|
|
29
|
+
## Examples
|
|
30
|
+
|
|
31
|
+
Adds a specific user by user name as member of the Planner Roster
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
m365 planner roster member add --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Adds a specific user by ID as member of the Planner Roster
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
m365 planner roster member add --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Response
|
|
44
|
+
|
|
45
|
+
=== "JSON"
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"id": "b3a1be03-54a5-43d2-b4fb-6562fe9bec0b",
|
|
50
|
+
"userId": "2056d2f6-3257-4253-8cfc-b73393e414e5",
|
|
51
|
+
"tenantId": "5b7b813c-2339-48cd-8c51-bd4fcb269420",
|
|
52
|
+
"roles": []
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
=== "Text"
|
|
57
|
+
|
|
58
|
+
```text
|
|
59
|
+
id : b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
|
|
60
|
+
roles : []
|
|
61
|
+
tenantId: 5b7b813c-2339-48cd-8c51-bd4fcb269420
|
|
62
|
+
userId : 2056d2f6-3257-4253-8cfc-b73393e414e5
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
=== "CSV"
|
|
66
|
+
|
|
67
|
+
```csv
|
|
68
|
+
id,userId,tenantId,roles
|
|
69
|
+
b3a1be03-54a5-43d2-b4fb-6562fe9bec0b,2056d2f6-3257-4253-8cfc-b73393e414e5,5b7b813c-2339-48cd-8c51-bd4fcb269420,[]
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
=== "Markdown"
|
|
73
|
+
|
|
74
|
+
```md
|
|
75
|
+
# planner roster member add --rosterId "tYqYlNd6eECmsNhN_fcq85cAGAnd" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"
|
|
76
|
+
|
|
77
|
+
Date: 6/2/2023
|
|
78
|
+
|
|
79
|
+
## b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
|
|
80
|
+
|
|
81
|
+
Property | Value
|
|
82
|
+
---------|-------
|
|
83
|
+
id | b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
|
|
84
|
+
userId | 2056d2f6-3257-4253-8cfc-b73393e414e5
|
|
85
|
+
tenantId | 5b7b813c-2339-48cd-8c51-bd4fcb269420
|
|
86
|
+
roles | []
|
|
87
|
+
```
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# planner roster member list
|
|
2
|
+
|
|
3
|
+
Lists members of the specified Microsoft Planner Roster
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner roster member list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`--rosterId <rosterId>`
|
|
14
|
+
: ID of the Planner Roster.
|
|
15
|
+
|
|
16
|
+
--8<-- "docs/cmd/_global.md"
|
|
17
|
+
|
|
18
|
+
## Remarks
|
|
19
|
+
|
|
20
|
+
!!! attention
|
|
21
|
+
This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
22
|
+
|
|
23
|
+
## Examples
|
|
24
|
+
|
|
25
|
+
Lists members of the specified Microsoft Planner Roster
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
m365 planner roster member list --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Response
|
|
32
|
+
|
|
33
|
+
=== "JSON"
|
|
34
|
+
|
|
35
|
+
```json
|
|
36
|
+
[
|
|
37
|
+
{
|
|
38
|
+
"id": "b3a1be03-54a5-43d2-b4fb-6562fe9bec0b",
|
|
39
|
+
"userId": "2056d2f6-3257-4253-8cfc-b73393e414e5",
|
|
40
|
+
"tenantId": "5b7b813c-2339-48cd-8c51-bd4fcb269420",
|
|
41
|
+
"roles": []
|
|
42
|
+
}
|
|
43
|
+
]
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
=== "Text"
|
|
47
|
+
|
|
48
|
+
```text
|
|
49
|
+
id userId tenantId roles
|
|
50
|
+
------------------------------------ ------------------------------------ ------------------------------------ ------------------------------------
|
|
51
|
+
b3a1be03-54a5-43d2-b4fb-6562fe9bec0b 2056d2f6-3257-4253-8cfc-b73393e414e5 5b7b813c-2339-48cd-8c51-bd4fcb269420 []
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
=== "CSV"
|
|
55
|
+
|
|
56
|
+
```csv
|
|
57
|
+
id,userId,tenantId,roles
|
|
58
|
+
b3a1be03-54a5-43d2-b4fb-6562fe9bec0b,2056d2f6-3257-4253-8cfc-b73393e414e5,5b7b813c-2339-48cd-8c51-bd4fcb269420,[]
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
=== "Markdown"
|
|
62
|
+
|
|
63
|
+
```md
|
|
64
|
+
# planner roster member list --rosterId "RuY-PSpdw02drevnYDTCJpgAEfoI"
|
|
65
|
+
|
|
66
|
+
Date: 5/2/2023
|
|
67
|
+
|
|
68
|
+
## b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
|
|
69
|
+
|
|
70
|
+
Property | Value
|
|
71
|
+
---------|-------
|
|
72
|
+
id | b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
|
|
73
|
+
userId | 2056d2f6-3257-4253-8cfc-b73393e414e5
|
|
74
|
+
tenantId | 5b7b813c-2339-48cd-8c51-bd4fcb269420
|
|
75
|
+
roles | []
|
|
76
|
+
```
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# planner roster member remove
|
|
2
|
+
|
|
3
|
+
Removes a member from a Microsoft Planner Roster
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner roster member remove [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`--rosterId <rosterId>`
|
|
14
|
+
: ID of the Planner Roster.
|
|
15
|
+
|
|
16
|
+
`--userId [userId]`
|
|
17
|
+
: User's Azure AD ID. Specify either `userId` or `userName` but not both.
|
|
18
|
+
|
|
19
|
+
`--userName [userName]`
|
|
20
|
+
: User's UPN (user principal name, e.g. johndoe@example.com). Specify either `userId` or `userName` but not both.
|
|
21
|
+
|
|
22
|
+
`--confirm`
|
|
23
|
+
: Don't prompt for confirmation.
|
|
24
|
+
|
|
25
|
+
--8<-- "docs/cmd/_global.md"
|
|
26
|
+
|
|
27
|
+
## Remarks
|
|
28
|
+
|
|
29
|
+
!!! attention
|
|
30
|
+
This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
31
|
+
|
|
32
|
+
!!! attention
|
|
33
|
+
The Planner Roster will be deleted when it doesn't have any users remaining in the membership list because the last user removed themselves. Roster, its plan and all contained tasks will be deleted within 30 days of this operation. We will show an extra prompt when this happens. This prompt is also suppressed when specifying `--confirm`.
|
|
34
|
+
|
|
35
|
+
## Examples
|
|
36
|
+
|
|
37
|
+
Remove a Roster member by its Azure AD ID
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId 126878e5-d8f9-4db2-951d-d25486488d38
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Remove a Roster member by its UPN
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Response
|
|
50
|
+
|
|
51
|
+
The command won't return a response on success.
|