@pnp/cli-microsoft365 7.1.0-beta.aca68bd → 7.1.0-beta.ba486fa
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/.devcontainer/Dockerfile +0 -1
- package/.eslintrc.cjs +1 -0
- package/Dockerfile +0 -1
- package/dist/Auth.js +2 -2
- package/dist/Command.js +18 -28
- package/dist/appInsights.js +5 -9
- package/dist/cli/Cli.js +9 -4
- package/dist/m365/aad/commands/group/group-user-list.js +146 -0
- package/dist/m365/aad/commands/m365group/m365group-remove.js +109 -15
- package/dist/m365/aad/commands.js +1 -0
- package/dist/m365/cli/commands/cli-doctor.js +11 -6
- package/dist/m365/commands/setup.js +6 -1
- package/dist/m365/spo/commands/app/app-deploy.js +1 -1
- package/dist/m365/spo/commands/app/app-get.js +1 -1
- package/dist/m365/spo/commands/app/app-teamspackage-download.js +1 -1
- package/dist/m365/spo/commands/apppage/apppage-add.js +1 -1
- package/dist/m365/spo/commands/feature/feature-disable.js +8 -6
- package/dist/m365/spo/commands/feature/feature-enable.js +6 -5
- package/dist/m365/spo/commands/page/Page.js +1 -1
- package/dist/m365/spo/commands/page/page-add.js +1 -1
- package/dist/m365/spo/commands/page/page-get.js +1 -1
- package/dist/m365/spo/commands/page/page-header-set.js +1 -1
- package/dist/m365/spo/commands/page/page-remove.js +1 -1
- package/dist/m365/spo/commands/page/page-set.js +2 -2
- package/dist/m365/spo/commands/page/page-text-add.js +1 -1
- package/dist/m365/spo/commands/sitedesign/sitedesign-get.js +15 -14
- package/dist/m365/spo/commands/sitedesign/sitedesign-remove.js +22 -22
- package/dist/m365/spo/commands/user/user-get.js +7 -1
- package/dist/m365/todo/commands/task/task-list.js +8 -10
- package/dist/m365/todo/commands/task/task-remove.js +36 -36
- package/dist/m365/todo/commands/task/task-set.js +11 -13
- package/dist/m365/yammer/commands/group/group-user-remove.js +22 -23
- package/dist/telemetry.js +30 -14
- package/dist/telemetryRunner.js +26 -0
- package/dist/utils/odata.js +20 -19
- package/dist/utils/prompt.js +16 -0
- package/docs/docs/cmd/aad/group/group-user-list.mdx +135 -0
- package/docs/docs/cmd/aad/license/license-list.mdx +21 -16
- package/docs/docs/cmd/aad/m365group/m365group-add.mdx +1 -1
- package/docs/docs/cmd/aad/m365group/m365group-remove.mdx +11 -1
- package/docs/docs/cmd/aad/user/user-add.mdx +2 -4
- package/docs/docs/cmd/aad/user/user-license-add.mdx +2 -4
- package/docs/docs/cmd/aad/user/user-license-list.mdx +3 -5
- package/docs/docs/cmd/aad/user/user-recyclebinitem-list.mdx +1 -3
- package/docs/docs/cmd/aad/user/user-recyclebinitem-restore.mdx +1 -3
- package/docs/docs/cmd/flow/environment/environment-get.mdx +3 -4
- package/docs/docs/cmd/flow/environment/environment-list.mdx +3 -4
- package/docs/docs/cmd/flow/owner/owner-list.mdx +2 -3
- package/docs/docs/cmd/flow/run/run-list.mdx +6 -8
- package/docs/docs/cmd/graph/schemaextension/schemaextension-list.mdx +2 -3
- package/docs/docs/cmd/onenote/page/page-list.mdx +6 -9
- package/docs/docs/cmd/outlook/message/message-get.mdx +5 -15
- package/docs/docs/cmd/outlook/message/message-list.mdx +5 -14
- package/docs/docs/cmd/outlook/room/room-list.mdx +3 -6
- package/docs/docs/cmd/outlook/roomlist/roomlist-list.mdx +1 -3
- package/docs/docs/cmd/pa/app/app-get.mdx +4 -7
- package/docs/docs/cmd/pa/app/app-list.mdx +4 -7
- package/docs/docs/cmd/pa/connector/connector-list.mdx +2 -4
- package/docs/docs/cmd/pa/environment/environment-get.mdx +2 -4
- package/docs/docs/cmd/pa/environment/environment-list.mdx +1 -3
- package/docs/docs/cmd/planner/plan/plan-add.mdx +4 -11
- package/docs/docs/cmd/planner/plan/plan-get.mdx +4 -9
- package/docs/docs/cmd/planner/plan/plan-list.mdx +3 -6
- package/docs/docs/cmd/planner/plan/plan-set.mdx +3 -9
- package/docs/docs/cmd/planner/roster/roster-member-add.mdx +2 -4
- package/docs/docs/cmd/planner/roster/roster-member-get.mdx +2 -4
- package/docs/docs/cmd/planner/roster/roster-member-list.mdx +1 -3
- package/docs/docs/cmd/planner/task/task-add.mdx +4 -14
- package/docs/docs/cmd/planner/task/task-checklistitem-add.mdx +2 -4
- package/docs/docs/cmd/planner/task/task-checklistitem-list.mdx +1 -3
- package/docs/docs/cmd/planner/task/task-get.mdx +0 -7
- package/docs/docs/cmd/planner/task/task-list.mdx +1 -5
- package/docs/docs/cmd/planner/task/task-reference-add.mdx +0 -2
- package/docs/docs/cmd/planner/task/task-reference-list.mdx +0 -2
- package/docs/docs/cmd/planner/task/task-set.mdx +4 -13
- package/docs/docs/cmd/planner/tenant/tenant-settings-list.mdx +1 -3
- package/docs/docs/cmd/planner/tenant/tenant-settings-set.mdx +3 -5
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.mdx +6 -8
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.mdx +4 -7
- package/docs/docs/cmd/pp/card/card-get.mdx +4 -8
- package/docs/docs/cmd/pp/card/card-list.mdx +0 -4
- package/docs/docs/cmd/pp/chatbot/chatbot-get.mdx +4 -6
- package/docs/docs/cmd/pp/dataverse/dataverse-table-get.mdx +3 -14
- package/docs/docs/cmd/pp/dataverse/dataverse-table-list.mdx +3 -14
- package/docs/docs/cmd/pp/environment/environment-get.mdx +3 -5
- package/docs/docs/cmd/pp/environment/environment-list.mdx +2 -4
- package/docs/docs/cmd/pp/gateway/gateway-get.mdx +0 -3
- package/docs/docs/cmd/pp/gateway/gateway-list.mdx +1 -4
- package/docs/docs/cmd/purview/auditlog/auditlog-list.mdx +4 -0
- package/docs/docs/cmd/purview/retentionevent/retentionevent-add.mdx +3 -8
- package/docs/docs/cmd/purview/retentionevent/retentionevent-get.mdx +1 -3
- package/docs/docs/cmd/purview/retentionevent/retentionevent-list.mdx +1 -5
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.mdx +0 -2
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.mdx +1 -3
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.mdx +1 -3
- package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.mdx +3 -6
- package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.mdx +3 -5
- package/docs/docs/cmd/purview/threatassessment/threatassessment-get.mdx +4 -8
- package/docs/docs/cmd/spo/app/app-add.mdx +94 -7
- package/docs/docs/cmd/spo/app/app-deploy.mdx +11 -7
- package/docs/docs/cmd/spo/app/app-get.mdx +117 -8
- package/docs/docs/cmd/spo/app/app-install.mdx +9 -5
- package/docs/docs/cmd/spo/app/app-instance-list.mdx +85 -2
- package/docs/docs/cmd/spo/app/app-list.mdx +95 -3
- package/docs/docs/cmd/spo/app/app-remove.mdx +11 -7
- package/docs/docs/cmd/spo/app/app-retract.mdx +9 -5
- package/docs/docs/cmd/spo/app/app-teamspackage-download.mdx +12 -8
- package/docs/docs/cmd/spo/app/app-uninstall.mdx +11 -7
- package/docs/docs/cmd/spo/app/app-upgrade.mdx +9 -5
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.mdx +4 -2
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +9 -7
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +6 -6
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.mdx +12 -6
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-set.mdx +4 -2
- package/docs/docs/cmd/spo/apppage/apppage-add.mdx +54 -5
- package/docs/docs/cmd/spo/apppage/apppage-set.mdx +8 -4
- package/docs/docs/cmd/spo/cdn/cdn-get.mdx +36 -1
- package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx +7 -3
- package/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx +48 -3
- package/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx +8 -4
- package/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx +53 -3
- package/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx +7 -3
- package/docs/docs/cmd/spo/cdn/cdn-set.mdx +7 -3
- package/docs/docs/cmd/spo/commandset/commandset-add.mdx +6 -6
- package/docs/docs/cmd/spo/commandset/commandset-get.mdx +3 -5
- package/docs/docs/cmd/spo/commandset/commandset-list.mdx +6 -5
- package/docs/docs/cmd/spo/commandset/commandset-remove.mdx +7 -3
- package/docs/docs/cmd/spo/commandset/commandset-set.mdx +6 -4
- package/docs/docs/cmd/spo/contenttype/contenttype-add.mdx +148 -9
- package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx +19 -15
- package/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx +12 -8
- package/docs/docs/cmd/spo/contenttype/contenttype-get.mdx +147 -8
- package/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +115 -4
- package/docs/docs/cmd/spo/contenttype/contenttype-remove.mdx +8 -4
- package/docs/docs/cmd/spo/contenttype/contenttype-set.mdx +8 -4
- package/docs/docs/cmd/spo/contenttypehub/contenttypehub-get.mdx +44 -0
- package/docs/docs/cmd/spo/customaction/customaction-add.mdx +12 -8
- package/docs/docs/cmd/spo/customaction/customaction-clear.mdx +10 -7
- package/docs/docs/cmd/spo/customaction/customaction-get.mdx +11 -15
- package/docs/docs/cmd/spo/customaction/customaction-list.mdx +87 -5
- package/docs/docs/cmd/spo/customaction/customaction-remove.mdx +17 -13
- package/docs/docs/cmd/spo/customaction/customaction-set.mdx +27 -23
- package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx +29 -14
- package/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx +66 -5
- package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.mdx +4 -0
- package/docs/docs/cmd/spo/externaluser/externaluser-list.mdx +78 -7
- package/docs/docs/cmd/spo/feature/feature-disable.mdx +10 -6
- package/docs/docs/cmd/spo/feature/feature-enable.mdx +9 -5
- package/docs/docs/cmd/spo/feature/feature-list.mdx +52 -0
- package/docs/docs/cmd/spo/field/field-add.mdx +177 -11
- package/docs/docs/cmd/spo/field/field-get.mdx +175 -9
- package/docs/docs/cmd/spo/field/field-list.mdx +135 -8
- package/docs/docs/cmd/spo/field/field-remove.mdx +16 -12
- package/docs/docs/cmd/spo/field/field-set.mdx +15 -11
- package/docs/docs/cmd/spo/file/file-add.mdx +31 -27
- package/docs/docs/cmd/spo/file/file-checkin.mdx +13 -9
- package/docs/docs/cmd/spo/file/file-checkout.mdx +9 -5
- package/docs/docs/cmd/spo/file/file-copy.mdx +5 -5
- package/docs/docs/cmd/spo/file/file-get.mdx +89 -18
- package/docs/docs/cmd/spo/file/file-list.mdx +5 -5
- package/docs/docs/cmd/spo/file/file-move.mdx +5 -5
- package/docs/docs/cmd/spo/file/file-remove.mdx +13 -9
- package/docs/docs/cmd/spo/file/file-rename.mdx +63 -5
- package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +3 -3
- package/docs/docs/cmd/spo/file/file-retentionlabel-remove.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +4 -0
- package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +7 -3
- package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +9 -5
- package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +10 -6
- package/docs/docs/cmd/spo/file/file-sharinginfo-get.mdx +133 -5
- package/docs/docs/cmd/spo/file/file-sharinglink-add.mdx +21 -3
- package/docs/docs/cmd/spo/file/file-sharinglink-clear.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-sharinglink-get.mdx +18 -0
- package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx +20 -3
- package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx +2 -7
- package/docs/docs/cmd/spo/file/file-version-clear.mdx +7 -7
- package/docs/docs/cmd/spo/file/file-version-get.mdx +28 -6
- package/docs/docs/cmd/spo/file/file-version-list.mdx +28 -6
- package/docs/docs/cmd/spo/file/file-version-remove.mdx +8 -8
- package/docs/docs/cmd/spo/file/file-version-restore.mdx +8 -8
- package/docs/docs/cmd/spo/folder/folder-add.mdx +3 -3
- package/docs/docs/cmd/spo/folder/folder-copy.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-get.mdx +257 -3
- package/docs/docs/cmd/spo/folder/folder-list.mdx +3 -4
- package/docs/docs/cmd/spo/folder/folder-move.mdx +5 -5
- package/docs/docs/cmd/spo/folder/folder-remove.mdx +6 -2
- package/docs/docs/cmd/spo/folder/folder-rename.mdx +2 -2
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +3 -3
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.mdx +2 -2
- package/docs/docs/cmd/spo/folder/folder-roleassignment-add.mdx +13 -8
- package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.mdx +8 -4
- package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.mdx +4 -0
- package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.mdx +5 -1
- package/docs/docs/cmd/spo/group/group-add.mdx +78 -0
- package/docs/docs/cmd/spo/group/group-get.mdx +81 -3
- package/docs/docs/cmd/spo/group/group-list.mdx +74 -3
- package/docs/docs/cmd/spo/group/group-member-add.mdx +13 -21
- package/docs/docs/cmd/spo/group/group-member-list.mdx +80 -5
- package/docs/docs/cmd/spo/group/group-member-remove.mdx +4 -4
- package/docs/docs/cmd/spo/group/group-remove.mdx +10 -6
- package/docs/docs/cmd/spo/group/group-set.mdx +9 -5
- package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.mdx +36 -1
- package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx +6 -2
- package/docs/docs/cmd/spo/hubsite/hubsite-data-get.mdx +0 -2
- package/docs/docs/cmd/spo/list/list-add.mdx +0 -3
- package/docs/docs/cmd/spo/list/list-contenttype-add.mdx +0 -2
- package/docs/docs/cmd/spo/list/list-contenttype-list.mdx +0 -2
- package/docs/docs/cmd/spo/list/list-get.mdx +1 -4
- package/docs/docs/cmd/spo/list/list-list.mdx +0 -4
- package/docs/docs/cmd/spo/list/list-view-add.mdx +0 -3
- package/docs/docs/cmd/spo/list/list-view-get.mdx +9 -12
- package/docs/docs/cmd/spo/list/list-view-list.mdx +4 -7
- package/docs/docs/cmd/spo/listitem/listitem-attachment-list.mdx +8 -11
- package/docs/docs/cmd/spo/listitem/listitem-get.mdx +0 -2
- package/docs/docs/cmd/spo/navigation/navigation-node-add.mdx +4 -6
- package/docs/docs/cmd/spo/navigation/navigation-node-get.mdx +0 -2
- package/docs/docs/cmd/spo/navigation/navigation-node-list.mdx +4 -6
- package/docs/docs/cmd/spo/page/page-copy.mdx +4 -8
- package/docs/docs/cmd/spo/page/page-get.mdx +2 -5
- package/docs/docs/cmd/spo/page/page-list.mdx +1 -5
- package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx +4 -4
- package/docs/docs/cmd/spo/sitescript/sitescript-set.mdx +6 -7
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.mdx +3 -1
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +5 -3
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +4 -2
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-remove.mdx +5 -1
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-set.mdx +2 -0
- package/docs/docs/cmd/spo/tenant/tenant-commandset-add.mdx +2 -1
- package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +5 -2
- package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +4 -1
- package/docs/docs/cmd/spo/tenant/tenant-commandset-remove.mdx +5 -1
- package/docs/docs/cmd/spo/tenant/tenant-commandset-set.mdx +3 -1
- package/docs/docs/cmd/spo/user/user-get.mdx +6 -0
- package/docs/docs/cmd/teams/channel/channel-member-list.mdx +3 -5
- package/docs/docs/cmd/teams/channel/channel-member-set.mdx +0 -2
- package/docs/docs/cmd/teams/chat/chat-get.mdx +2 -4
- package/docs/docs/cmd/teams/chat/chat-list.mdx +1 -3
- package/docs/docs/cmd/teams/chat/chat-member-list.mdx +2 -4
- package/docs/docs/cmd/teams/message/message-get.mdx +0 -7
- package/docs/docs/cmd/teams/message/message-list.mdx +0 -6
- package/docs/docs/cmd/teams/message/message-reply-list.mdx +0 -6
- package/docs/docs/cmd/teams/tab/tab-add.mdx +10 -12
- package/docs/docs/cmd/teams/tab/tab-get.mdx +8 -10
- package/docs/docs/cmd/teams/tab/tab-list.mdx +4 -7
- package/docs/docs/cmd/teams/team/team-add.mdx +0 -7
- package/docs/docs/cmd/teams/team/team-get.mdx +0 -6
- package/docs/docs/cmd/tenant/security/security-alerts-list.mdx +1 -1
- package/docs/docs/cmd/todo/task/task-add.mdx +9 -13
- package/docs/docs/cmd/todo/task/task-set.mdx +10 -14
- package/eslint-rules/lib/index.js +2 -1
- package/eslint-rules/lib/rules/no-by-server-relative-url-usage.js +55 -0
- package/npm-shrinkwrap.json +86 -82
- package/package.json +52 -31
|
@@ -32,13 +32,13 @@ Register CLI for Microsoft 365 or Azure AD application as a management applicati
|
|
|
32
32
|
|
|
33
33
|
## Examples
|
|
34
34
|
|
|
35
|
-
List Microsoft Power Platform environments
|
|
35
|
+
List Microsoft Power Platform environments.
|
|
36
36
|
|
|
37
37
|
```sh
|
|
38
38
|
m365 pp environment list
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
List all Microsoft Power Platform environments
|
|
41
|
+
List all Microsoft Power Platform environments.
|
|
42
42
|
|
|
43
43
|
```sh
|
|
44
44
|
m365 pp environment list --asAdmin
|
|
@@ -375,10 +375,8 @@ m365 pp environment list --asAdmin
|
|
|
375
375
|
type | Microsoft.BusinessAppPlatform/environments
|
|
376
376
|
location | europe
|
|
377
377
|
name | Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
|
|
378
|
-
properties | {"tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","azureRegion":"northeurope","displayName":"contoso (default)","createdTime":"2020-03-12T13:39:17.9876946Z","createdBy":{"id":"SYSTEM","displayName":"SYSTEM","type":"NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","isDefault":true,"clientUris":{"admin":"https://admin.powerplatform.microsoft.com/environments/environment/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/hub","maker":"https://make.powerapps.com/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/home"},"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"},"databaseType":"CommonDataService","linkedEnvironmentMetadata":{"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","backgroundOperationsState":"Enabled","scaleGroup":"EURCRMLIVESG644","platformSku":"Standard"},"trialScenarioType":"None","retentionPeriod":"P7D","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"updateCadence":{"id":"Frequent"},"retentionDetails":{"retentionPeriod":"P7D","backupsAvailableFromDateTime":"2022-10-23T23:27:16.8059564Z"},"protectionStatus":{"keyManagedBy":"Microsoft"},"cluster":{"category":"Prod","number":"109","uriSuffix":"eu-il109.gateway.prod.island","geoShortName":"EU","environment":"Prod"},"connectedGroups":[],"lifecycleOperationsEnforcement":{"allowedOperations":[{"type":{"id":"Backup"}},{"type":{"id":"Edit"}},{"type":{"id":"Enable"}},{"type":{"id":"Disable"}},{"type":{"id":"EnableGovernanceConfiguration"}}],"disallowedOperations":[{"type":{"id":"Provision"},"reason":{"message":"Provision cannot be performed because there is no linked CDS instance or the CDS instance version is not supported."}},{"type":{"id":"Unlock"},"reason":{"message":"Unlock cannot be performed because there is no linked CDS instance or the CDS instance version is not supported."}},{"type":{"id":"Convert"},"reason":{"message":"Convert cannot be performed on environment of type Default."}},{"type":{"id":"Copy"},"reason":{"message":"Copy cannot be performed on environment of type Default."}},{"type":{"id":"Delete"},"reason":{"message":"Delete cannot be performed on environment of type Default."}},{"type":{"id":"Promote"},"reason":{"message":"Promote cannot be performed on environment of type Default."}},{"type":{"id":"Recover"},"reason":{"message":"Recover cannot be performed on environment of type Default."}},{"type":{"id":"Reset"},"reason":{"message":"Reset cannot be performed on environment of type Default."}},{"type":{"id":"Restore"},"reason":{"message":"Restore cannot be performed on environment of type Default."}},{"type":{"id":"UpdateProtectionStatus"},"reason":{"message":"UpdateProtectionStatus cannot be performed on environment of type Default."}},{"type":{"id":"NewCustomerManagedKey"},"reason":{"message":"NewCustomerManagedKey cannot be performed on environment of type Default."}},{"type":{"id":"RotateCustomerManagedKey"},"reason":{"message":"RotateCustomerManagedKey cannot be performed on environment of type Default."}},{"type":{"id":"RevertToMicrosoftKey"},"reason":{"message":"RevertToMicrosoftKey cannot be performed on environment of type Default."}},{"type":{"id":"NewNetworkInjection"},"reason":{"message":"NewNetworkInjection cannot be performed on environment of type Default."}},{"type":{"id":"SwapNetworkInjection"},"reason":{"message":"SwapNetworkInjection cannot be performed on environment of type Default."}},{"type":{"id":"RevertNetworkInjection"},"reason":{"message":"RevertNetworkInjection cannot be performed on environment of type Default."}},{"type":{"id":"NewIdentity"},"reason":{"message":"NewIdentity cannot be performed on environment of type Default."}},{"type":{"id":"SwapIdentity"},"reason":{"message":"SwapIdentity cannot be performed on environment of type Default."}},{"type":{"id":"RevertIdentity"},"reason":{"message":"RevertIdentity cannot be performed on environment of type Default."}},{"type":{"id":"DisableGovernanceConfiguration"},"reason":{"message":"DisableGovernanceConfiguration cannot be performed on Power Platform environment because of the governance configuration."}},{"type":{"id":"UpdateGovernanceConfiguration"},"reason":{"message":"UpdateGovernanceConfiguration cannot be performed on Power Platform environment because of the governance configuration." }}]},"governanceConfiguration":{"protectionLevel":"Basic"}}
|
|
379
378
|
displayName | contoso (default)
|
|
380
379
|
```
|
|
381
380
|
|
|
382
381
|
</TabItem>
|
|
383
382
|
</Tabs>
|
|
384
|
-
|
|
@@ -80,10 +80,7 @@ m365 pp gateway get --id 1f69e798-5852-4fdd-ab01-33bb14b6e934
|
|
|
80
80
|
gatewayId | 0
|
|
81
81
|
name | Contoso Gateway
|
|
82
82
|
type | Resource
|
|
83
|
-
publicKey | {"exponent":"AQAB","modulus":"okJBN8MJyaVkjfkN75B6OgP7RYiC3KFMFaky9KqqudqiTOcZPRXlsG+emrbnnBpFzw7ywe4gWtUGnPCqy01RKeDZrFA3QfkVPJpH28OWfrmgkMQNsI4Op2uxwEyjnJAyfYxIsHlpevOZoDKpWJgV+sH6MRf/+LK4hN3vNJuWKKpf90rNwjipnYMumHyKVkd4Vssc9Ftsu4Samu0/TkXzUkyje5DxMF2ZK1Nt2TgItBcpKi4wLCP4bPDYYaa9vfOmBlji7U+gwuE5bjnmjazFljQ5sOP0VdA0fRoId3+nI7n1rSgRq265jNHX84HZbm2D/Pk8C0dElTmYEswGPDWEJQ=="}
|
|
84
|
-
gatewayAnnotation | {\"gatewayContactInformation\":[\"admin@contoso.onmicrosoft.com\"],\"gatewayVersion\":\"3000.122.8\",\"gatewayWitnessString\":\"{\\\"EncryptedResult\\\":\\\"UyfEqNSy0e9S4D0m9oacPyYhgiXLWusCiKepoLudnTEe68iw9qEaV6qNqTbSKlVUwUkD9KjbnbV0O3vU97Q/KTJXpw9/1SiyhpO+JN1rcaL51mPjyQo0WwMHMo2PU3rdEyxsLjkJxJZHTh4+XGB/lQ==\\\",\\\"IV\\\":\\\"QxCYjHEl8Ab9i78ZBYpnDw==\\\",\\\"Signature\\\":\\\"upVXK3DvWdj5scw8iUDDilzQz1ovuNgeuXRpmf0N828=\\\"}\",\"gatewayMachine\":\"SPFxDevelop\",\"gatewaySalt\":\"rA1M34AdgdCbOYQMvo/izA==\",\"gatewayWitnessStringLegacy\":null,\"gatewaySaltLegacy\":null,\"gatewayDepartment\":null,\"gatewayVirtualNetworkSubnetId\":null}
|
|
85
83
|
```
|
|
86
84
|
|
|
87
85
|
</TabItem>
|
|
88
86
|
</Tabs>
|
|
89
|
-
|
|
@@ -18,7 +18,7 @@ m365 pp gateway list [options]
|
|
|
18
18
|
|
|
19
19
|
## Examples
|
|
20
20
|
|
|
21
|
-
List gateways for which the user is an admin
|
|
21
|
+
List gateways for which the user is an admin.
|
|
22
22
|
|
|
23
23
|
```sh
|
|
24
24
|
m365 pp gateway list
|
|
@@ -78,10 +78,7 @@ m365 pp gateway list
|
|
|
78
78
|
gatewayId | 0
|
|
79
79
|
name | Contoso Gateway
|
|
80
80
|
type | Resource
|
|
81
|
-
publicKey | {"exponent":"AQAB","modulus":"okJBN8MJyaVkjfkN75B6OgP7RYiC3KFMFaky9KqqudqiTOcZPRXlsG+emrbnnBpFzw7ywe4gWtUGnPCqy01RKeDZrFA3QfkVPJpH28OWfrmgkMQNsI4Op2uxwEyjnJAyfYxIsHlpevOZoDKpWJgV+sH6MRf/+LK4hN3vNJuWKKpf90rNwjipnYMumHyKVkd4Vssc9Ftsu4Samu0/TkXzUkyje5DxMF2ZK1Nt2TgItBcpKi4wLCP4bPDYYaa9vfOmBlji7U+gwuE5bjnmjazFljQ5sOP0VdA0fRoId3+nI7n1rSgRq265jNHX84HZbm2D/Pk8C0dElTmYEswGPDWEJQ=="}
|
|
82
|
-
gatewayAnnotation | {\"gatewayContactInformation\":[\"admin@contoso.onmicrosoft.com\"],\"gatewayVersion\":\"3000.122.8\",\"gatewayWitnessString\":\"{\\\"EncryptedResult\\\":\\\"UyfEqNSy0e9S4D0m9oacPyYhgiXLWusCiKepoLudnTEe68iw9qEaV6qNqTbSKlVUwUkD9KjbnbV0O3vU97Q/KTJXpw9/1SiyhpO+JN1rcaL51mPjyQo0WwMHMo2PU3rdEyxsLjkJxJZHTh4+XGB/lQ==\\\",\\\"IV\\\":\\\"QxCYjHEl8Ab9i78ZBYpnDw==\\\",\\\"Signature\\\":\\\"upVXK3DvWdj5scw8iUDDilzQz1ovuNgeuXRpmf0N828=\\\"}\",\"gatewayMachine\":\"SPFxDevelop\",\"gatewaySalt\":\"rA1M34AdgdCbOYQMvo/izA==\",\"gatewayWitnessStringLegacy\":null,\"gatewaySaltLegacy\":null,\"gatewayDepartment\":null,\"gatewayVirtualNetworkSubnetId\":null}
|
|
83
81
|
```
|
|
84
82
|
|
|
85
83
|
</TabItem>
|
|
86
84
|
</Tabs>
|
|
87
|
-
|
|
@@ -143,3 +143,7 @@ m365 purview auditlog list --contentType SharePoint --startTime "2023-01-01T00:0
|
|
|
143
143
|
</TabItem>
|
|
144
144
|
</Tabs>
|
|
145
145
|
|
|
146
|
+
## More information
|
|
147
|
+
|
|
148
|
+
- Explanation of all available audit log activities/operations: https://learn.microsoft.com/en-us/purview/audit-log-activities
|
|
149
|
+
- Explanation of all available audit log properties: https://learn.microsoft.com/en-us/purview/audit-log-detailed-properties
|
|
@@ -16,7 +16,7 @@ m365 purview retentionevent add [options]
|
|
|
16
16
|
|
|
17
17
|
```md definition-list
|
|
18
18
|
`-n, --displayName <displayName>`
|
|
19
|
-
: The display name of the event
|
|
19
|
+
: The display name of the event.
|
|
20
20
|
|
|
21
21
|
`-e, --eventTypeName [eventTypeName]`
|
|
22
22
|
: Name of the event type associated with the event. Specify either `eventTypeId` or `eventTypeName` but not both.
|
|
@@ -25,7 +25,7 @@ m365 purview retentionevent add [options]
|
|
|
25
25
|
: Id of the event type associated with the event. Specify either `eventTypeId` or `eventTypeName` but not both.
|
|
26
26
|
|
|
27
27
|
`-d, --description [description]`
|
|
28
|
-
: A description for the event
|
|
28
|
+
: A description for the event.
|
|
29
29
|
|
|
30
30
|
`--triggerDateTime [triggerDateTime]`
|
|
31
31
|
: Optional time when the event should be triggered.
|
|
@@ -49,7 +49,7 @@ This command is based on an API that is currently in preview and is subject to c
|
|
|
49
49
|
|
|
50
50
|
## Examples
|
|
51
51
|
|
|
52
|
-
Create a retention event to start retention at the end of 2022 for all employee documents that have been labeled and have the Asset ID _EmployeeNr1234_
|
|
52
|
+
Create a retention event to start retention at the end of 2022 for all employee documents that have been labeled and have the Asset ID _EmployeeNr1234_.
|
|
53
53
|
|
|
54
54
|
```sh
|
|
55
55
|
m365 purview retentionevent add --displayName 'Employee information expiration' --description 'Employee documents expired due to offboarding' --eventTypeName 'CustomRetentionTime' --triggerDateTime '2022-12-31' --assetIds 'ComplianceAssetId:EmployeeNr1234'
|
|
@@ -144,11 +144,6 @@ m365 purview retentionevent add --displayName 'Employee information expiration'
|
|
|
144
144
|
createdDateTime | 2023-02-20T18:53:05Z
|
|
145
145
|
lastModifiedDateTime | 2023-02-20T18:53:05Z
|
|
146
146
|
id | 9f5c1a04-8f7a-4bff-e400-08db1373b324
|
|
147
|
-
eventQueries | [{"queryType":"files","query":"filesQuery,filesQuery1"},{"queryType":"messages","query":"messagesQuery,messagesQuery1"}]
|
|
148
|
-
eventStatus | {"error":null,"status":"pending"}
|
|
149
|
-
eventPropagationResults | []
|
|
150
|
-
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
151
|
-
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
152
147
|
```
|
|
153
148
|
|
|
154
149
|
</TabItem>
|
|
@@ -23,7 +23,7 @@ m365 purview retentionevent get [options]
|
|
|
23
23
|
|
|
24
24
|
## Examples
|
|
25
25
|
|
|
26
|
-
Get a retention event by id
|
|
26
|
+
Get a retention event by id.
|
|
27
27
|
|
|
28
28
|
```sh
|
|
29
29
|
m365 purview retentionevent get --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
@@ -130,8 +130,6 @@ This command is based on an API that is currently in preview and is subject to c
|
|
|
130
130
|
createdDateTime | 2023-02-01T09:17:40Z
|
|
131
131
|
lastModifiedDateTime | 2023-02-01T09:17:40Z
|
|
132
132
|
id | c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
133
|
-
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
134
|
-
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
135
133
|
```
|
|
136
134
|
|
|
137
135
|
</TabItem>
|
|
@@ -18,7 +18,7 @@ m365 purview retentionevent list [options]
|
|
|
18
18
|
|
|
19
19
|
## Examples
|
|
20
20
|
|
|
21
|
-
Get a list of retention events
|
|
21
|
+
Get a list of retention events.
|
|
22
22
|
|
|
23
23
|
```sh
|
|
24
24
|
m365 purview retentionevent list
|
|
@@ -103,10 +103,6 @@ This command is based on a Microsoft Graph API that is currently in preview and
|
|
|
103
103
|
createdDateTime | 2023-02-03T13:51:40Z
|
|
104
104
|
lastModifiedDateTime | 2023-02-03T13:51:40Z
|
|
105
105
|
id | 7248cfa8-c03a-4ec1-49a4-08db05edc686
|
|
106
|
-
eventQueries | []
|
|
107
|
-
eventPropagationResults | []
|
|
108
|
-
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
109
|
-
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
110
106
|
```
|
|
111
107
|
|
|
112
108
|
</TabItem>
|
|
@@ -107,8 +107,6 @@ m365 purview retentioneventtype add --displayName 'Contract Expiry' --descriptio
|
|
|
107
107
|
createdDateTime | 2023-01-31T20:55:35Z
|
|
108
108
|
lastModifiedDateTime | 2023-01-31T20:55:35Z
|
|
109
109
|
id | ca0e1f8d-4e42-4a81-be85-022502d70c4e
|
|
110
|
-
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
111
|
-
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
112
110
|
```
|
|
113
111
|
|
|
114
112
|
</TabItem>
|
|
@@ -31,7 +31,7 @@ This command is based on an API that is currently in preview and is subject to c
|
|
|
31
31
|
|
|
32
32
|
## Examples
|
|
33
33
|
|
|
34
|
-
Get a retention event type by id
|
|
34
|
+
Get a retention event type by id.
|
|
35
35
|
|
|
36
36
|
```sh
|
|
37
37
|
m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
@@ -102,8 +102,6 @@ m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
|
102
102
|
createdDateTime | 2023-01-29T09:30:42Z
|
|
103
103
|
lastModifiedDateTime | 2023-01-29T09:30:42Z
|
|
104
104
|
id | c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
105
|
-
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
106
|
-
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
107
105
|
```
|
|
108
106
|
|
|
109
107
|
</TabItem>
|
|
@@ -26,7 +26,7 @@ This command is based on a Microsoft Graph API that is currently in preview and
|
|
|
26
26
|
|
|
27
27
|
## Examples
|
|
28
28
|
|
|
29
|
-
Get a list of retention event types
|
|
29
|
+
Get a list of retention event types.
|
|
30
30
|
|
|
31
31
|
```sh
|
|
32
32
|
m365 purview retentioneventtype list
|
|
@@ -96,8 +96,6 @@ m365 purview retentioneventtype list
|
|
|
96
96
|
createdDateTime | 2023-02-02T15:47:54Z
|
|
97
97
|
lastModifiedDateTime | 2023-02-02T15:47:54Z
|
|
98
98
|
id | 81fa91bd-66cd-4c6c-b0cb-71f37210dc74
|
|
99
|
-
createdBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
|
|
100
|
-
lastModifiedBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
|
|
101
99
|
```
|
|
102
100
|
|
|
103
101
|
</TabItem>
|
|
@@ -41,22 +41,21 @@ When operating in app-only mode, you have the option to use either the `userName
|
|
|
41
41
|
|
|
42
42
|
:::
|
|
43
43
|
|
|
44
|
-
|
|
45
44
|
## Examples
|
|
46
45
|
|
|
47
|
-
Get a sensitivity label
|
|
46
|
+
Get a sensitivity label.
|
|
48
47
|
|
|
49
48
|
```sh
|
|
50
49
|
m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e
|
|
51
50
|
```
|
|
52
51
|
|
|
53
|
-
Get a sensitivity label that a specific user has access to by its Id
|
|
52
|
+
Get a sensitivity label that a specific user has access to by its Id.
|
|
54
53
|
|
|
55
54
|
```sh
|
|
56
55
|
m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e --userId 59f80e08-24b1-41f8-8586-16765fd830d3
|
|
57
56
|
```
|
|
58
57
|
|
|
59
|
-
Get a sensitivity label that a specific user has access to by its UPN
|
|
58
|
+
Get a sensitivity label that a specific user has access to by its UPN.
|
|
60
59
|
|
|
61
60
|
```sh
|
|
62
61
|
m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e --userName john.doe@contoso.com
|
|
@@ -129,10 +128,8 @@ m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e --us
|
|
|
129
128
|
tooltip | Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.
|
|
130
129
|
isActive | true
|
|
131
130
|
isAppliable | true
|
|
132
|
-
contentFormats | ["file","email"]
|
|
133
131
|
hasProtection | false
|
|
134
132
|
```
|
|
135
133
|
|
|
136
134
|
</TabItem>
|
|
137
135
|
</Tabs>
|
|
138
|
-
|
|
@@ -40,19 +40,19 @@ When operating in app-only mode, you have the option to use either the `userName
|
|
|
40
40
|
|
|
41
41
|
## Examples
|
|
42
42
|
|
|
43
|
-
Get a list of sensitivity labels
|
|
43
|
+
Get a list of sensitivity labels.
|
|
44
44
|
|
|
45
45
|
```sh
|
|
46
46
|
m365 purview sensitivitylabel list
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
Get a list of sensitivity labels that a specific user has access to by its Id
|
|
49
|
+
Get a list of sensitivity labels that a specific user has access to by its Id.
|
|
50
50
|
|
|
51
51
|
```sh
|
|
52
52
|
m365 purview sensitivitylabel list --userId 59f80e08-24b1-41f8-8586-16765fd830d3
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
Get a list of sensitivity labels that a specific user has access to by its UPN
|
|
55
|
+
Get a list of sensitivity labels that a specific user has access to by its UPN.
|
|
56
56
|
|
|
57
57
|
```sh
|
|
58
58
|
m365 purview sensitivitylabel list --userName john.doe@contoso.com
|
|
@@ -121,11 +121,9 @@ m365 purview sensitivitylabel list --userName john.doe@contoso.com
|
|
|
121
121
|
tooltip | Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.
|
|
122
122
|
isActive | true
|
|
123
123
|
isAppliable | true
|
|
124
|
-
contentFormats | ["file","email"]
|
|
125
124
|
hasProtection | false
|
|
126
125
|
parent | null
|
|
127
126
|
```
|
|
128
127
|
|
|
129
128
|
</TabItem>
|
|
130
129
|
</Tabs>
|
|
131
|
-
|
|
@@ -16,23 +16,23 @@ m365 purview threatassessment get [options]
|
|
|
16
16
|
|
|
17
17
|
```md definition-list
|
|
18
18
|
`-i, --id <id>`
|
|
19
|
-
: The Id of the threat assessment
|
|
19
|
+
: The Id of the threat assessment.
|
|
20
20
|
|
|
21
21
|
`--includeResults`
|
|
22
|
-
: Include the threat assessment results
|
|
22
|
+
: Include the threat assessment results.
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
<Global />
|
|
26
26
|
|
|
27
27
|
## Examples
|
|
28
28
|
|
|
29
|
-
Get a threat assessment
|
|
29
|
+
Get a threat assessment.
|
|
30
30
|
|
|
31
31
|
```sh
|
|
32
32
|
m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Get a threat assessment including results
|
|
35
|
+
Get a threat assessment including results.
|
|
36
36
|
|
|
37
37
|
```sh
|
|
38
38
|
m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e --includeResults
|
|
@@ -113,7 +113,6 @@ m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e --in
|
|
|
113
113
|
recipientEmail | john@contoso.com
|
|
114
114
|
destinationRoutingReason | notJunk
|
|
115
115
|
messageUri | https://graph.microsoft.com/v1.0/users/john@contoso.com/messages/AAMkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgBGAAAAAAC6jQfUzacTSIHqMw2yacnUBwBiOC8xvYmdT6G2E\_hLMK5kAAAAAAEMAABiOC8xvYmdT6G2E\_hLMK5kAALHNaMuAAA=
|
|
116
|
-
createdBy | {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
|
|
117
116
|
```
|
|
118
117
|
|
|
119
118
|
</TabItem>
|
|
@@ -203,10 +202,7 @@ When we make use of the option `includeResults` the response will differ.
|
|
|
203
202
|
recipientEmail | john@contoso.com
|
|
204
203
|
destinationRoutingReason | notJunk
|
|
205
204
|
messageUri | https://graph.microsoft.com/v1.0/users/john@contoso.com/messages/AAMkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgBGAAAAAAC6jQfUzacTSIHqMw2yacnUBwBiOC8xvYmdT6G2E\_hLMK5kAAAAAAEMAABiOC8xvYmdT6G2E\_hLMK5kAALHNaMuAAA=
|
|
206
|
-
createdBy | {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
|
|
207
|
-
results | [{"id":"a5455871-18d1-44d8-0866-08db16c68b85","createdDateTime":"2023-02-25T00:23:40.28Z","resultType":"checkPolicy","message":"No policy was hit."}]
|
|
208
205
|
```
|
|
209
206
|
|
|
210
207
|
</TabItem>
|
|
211
208
|
</Tabs>
|
|
212
|
-
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
2
4
|
|
|
3
5
|
# spo app add
|
|
4
6
|
|
|
@@ -14,16 +16,16 @@ m365 spo app add [options]
|
|
|
14
16
|
|
|
15
17
|
```md definition-list
|
|
16
18
|
`-p, --filePath <filePath>`
|
|
17
|
-
: Absolute or relative path to the solution package file to add to the app catalog
|
|
19
|
+
: Absolute or relative path to the solution package file to add to the app catalog.
|
|
18
20
|
|
|
19
21
|
`--overwrite`
|
|
20
|
-
: Set to overwrite the existing package file
|
|
22
|
+
: Set to overwrite the existing package file.
|
|
21
23
|
|
|
22
24
|
`-s, --appCatalogScope [appCatalogScope]`
|
|
23
|
-
: Scope of the app catalog: `tenant
|
|
25
|
+
: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`.
|
|
24
26
|
|
|
25
27
|
`-u, --appCatalogUrl [appCatalogUrl]`
|
|
26
|
-
: The URL of the app catalog where the solution package will be added. It must be specified when the scope is `sitecollection
|
|
28
|
+
: The URL of the app catalog where the solution package will be added. It must be specified when the scope is `sitecollection`.
|
|
27
29
|
```
|
|
28
30
|
|
|
29
31
|
<Global />
|
|
@@ -40,24 +42,109 @@ If you try to upload a package that already exists in the app catalog without sp
|
|
|
40
42
|
|
|
41
43
|
## Examples
|
|
42
44
|
|
|
43
|
-
Add the
|
|
45
|
+
Add the package to the tenant app catalog.
|
|
44
46
|
|
|
45
47
|
```sh
|
|
46
48
|
m365 spo app add --filePath /Users/pnp/spfx/sharepoint/solution/spfx.sppkg
|
|
47
49
|
```
|
|
48
50
|
|
|
49
|
-
Overwrite the
|
|
51
|
+
Overwrite the package in the tenant app catalog with the newer version.
|
|
50
52
|
|
|
51
53
|
```sh
|
|
52
54
|
m365 spo app add --filePath sharepoint/solution/spfx.sppkg --overwrite
|
|
53
55
|
```
|
|
54
56
|
|
|
55
|
-
Add the
|
|
57
|
+
Add the package to the site collection app catalog of the specified site.
|
|
56
58
|
|
|
57
59
|
```sh
|
|
58
60
|
m365 spo app add --filePath c:\spfx.sppkg --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1
|
|
59
61
|
```
|
|
60
62
|
|
|
63
|
+
## Response
|
|
64
|
+
|
|
65
|
+
<Tabs>
|
|
66
|
+
<TabItem value="JSON">
|
|
67
|
+
|
|
68
|
+
```json
|
|
69
|
+
{
|
|
70
|
+
"CheckInComment": "",
|
|
71
|
+
"CheckOutType": 2,
|
|
72
|
+
"ContentTag": "{4BBC7873-4638-487D-900B-EF917A907C5A},2,1",
|
|
73
|
+
"CustomizedPageStatus": 0,
|
|
74
|
+
"ETag": "\"{4BBC7873-4638-487D-900B-EF917A907C5A},2\"",
|
|
75
|
+
"Exists": true,
|
|
76
|
+
"ExistsAllowThrowForPolicyFailures": true,
|
|
77
|
+
"IrmEnabled": false,
|
|
78
|
+
"Length": "757211",
|
|
79
|
+
"Level": 1,
|
|
80
|
+
"LinkingUri": null,
|
|
81
|
+
"LinkingUrl": "",
|
|
82
|
+
"MajorVersion": 1,
|
|
83
|
+
"MinorVersion": 0,
|
|
84
|
+
"Name": "spfx.sppkg",
|
|
85
|
+
"ServerRelativeUrl": "/sites/apps/AppCatalog/spfx.sppkg",
|
|
86
|
+
"TimeCreated": "2023-10-02T06:53:30Z",
|
|
87
|
+
"TimeLastModified": "2023-10-02T06:53:30Z",
|
|
88
|
+
"Title": "spfx-client-side-solution",
|
|
89
|
+
"UIVersion": 512,
|
|
90
|
+
"UIVersionLabel": "1.0",
|
|
91
|
+
"UniqueId": "4bbc7873-4638-487d-900b-ef917a907c5a"
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
</TabItem>
|
|
96
|
+
<TabItem value="Text">
|
|
97
|
+
|
|
98
|
+
```text
|
|
99
|
+
e0f53330-61ec-4fee-882d-fadfb74b2033
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
</TabItem>
|
|
103
|
+
<TabItem value="CSV">
|
|
104
|
+
|
|
105
|
+
```csv
|
|
106
|
+
CheckInComment,CheckOutType,ContentTag,CustomizedPageStatus,ETag,Exists,ExistsAllowThrowForPolicyFailures,IrmEnabled,Length,Level,LinkingUrl,MajorVersion,MinorVersion,Name,ServerRelativeUrl,TimeCreated,TimeLastModified,Title,UIVersion,UIVersionLabel,UniqueId
|
|
107
|
+
,2,"{B9BCE524-2940-457B-A015-30CBAAB4C210},2,1",0,"""{B9BCE524-2940-457B-A015-30CBAAB4C210},2""",1,1,,757211,1,,1,0,spfx.sppkg,/sites/apps/AppCatalog/spfx.sppkg,2023-10-02T06:55:12Z,2023-10-02T06:55:12Z,spfx-client-side-solution,512,1.0,b9bce524-2940-457b-a015-30cbaab4c210
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
</TabItem>
|
|
111
|
+
<TabItem value="Markdown">
|
|
112
|
+
|
|
113
|
+
```md
|
|
114
|
+
# spo app add --filePath "C:\SPFx\sharepoint\solution\spfx.sppkg"
|
|
115
|
+
|
|
116
|
+
Date: 10/2/2023
|
|
117
|
+
|
|
118
|
+
## spfx-client-side-solution (b05196d4-65a3-4ee3-bf92-4acfb7a05cd7)
|
|
119
|
+
|
|
120
|
+
Property | Value
|
|
121
|
+
---------|-------
|
|
122
|
+
CheckInComment |
|
|
123
|
+
CheckOutType | 2
|
|
124
|
+
ContentTag | {B05196D4-65A3-4EE3-BF92-4ACFB7A05CD7},2,1
|
|
125
|
+
CustomizedPageStatus | 0
|
|
126
|
+
ETag | "{B05196D4-65A3-4EE3-BF92-4ACFB7A05CD7},2"
|
|
127
|
+
Exists | true
|
|
128
|
+
ExistsAllowThrowForPolicyFailures | true
|
|
129
|
+
IrmEnabled | false
|
|
130
|
+
Length | 757211
|
|
131
|
+
Level | 1
|
|
132
|
+
LinkingUrl |
|
|
133
|
+
MajorVersion | 1
|
|
134
|
+
MinorVersion | 0
|
|
135
|
+
Name | spfx.sppkg
|
|
136
|
+
ServerRelativeUrl | /sites/apps/AppCatalog/spfx.sppkg
|
|
137
|
+
TimeCreated | 2023-10-02T06:56:02Z
|
|
138
|
+
TimeLastModified | 2023-10-02T06:56:02Z
|
|
139
|
+
Title | spfx-client-side-solution
|
|
140
|
+
UIVersion | 512
|
|
141
|
+
UIVersionLabel | 1.0
|
|
142
|
+
UniqueId | b05196d4-65a3-4ee3-bf92-4acfb7a05cd7
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
</TabItem>
|
|
146
|
+
</Tabs>
|
|
147
|
+
|
|
61
148
|
## More information
|
|
62
149
|
|
|
63
150
|
- Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins)
|
|
@@ -14,19 +14,19 @@ m365 spo app deploy [options]
|
|
|
14
14
|
|
|
15
15
|
```md definition-list
|
|
16
16
|
`-i, --id [id]`
|
|
17
|
-
: ID of the app to deploy. Specify the `id` or the `name` but not both
|
|
17
|
+
: ID of the app to deploy. Specify the `id` or the `name` but not both.
|
|
18
18
|
|
|
19
19
|
`-n, --name [name]`
|
|
20
|
-
: Name of the app to deploy. Specify the `id` or the `name` but not both
|
|
20
|
+
: Name of the app to deploy. Specify the `id` or the `name` but not both.
|
|
21
21
|
|
|
22
22
|
`-u, --appCatalogUrl [appCatalogUrl]`
|
|
23
|
-
: URL of the tenant or site collection app catalog. It must be specified when the scope is `sitecollection
|
|
23
|
+
: URL of the tenant or site collection app catalog. It must be specified when the scope is `sitecollection`.
|
|
24
24
|
|
|
25
25
|
`--skipFeatureDeployment`
|
|
26
|
-
: If the app supports tenant-wide deployment, deploy it to the whole tenant
|
|
26
|
+
: If the app supports tenant-wide deployment, deploy it to the whole tenant.
|
|
27
27
|
|
|
28
28
|
`-s, --appCatalogScope [appCatalogScope]`
|
|
29
|
-
: Scope of the app catalog: `tenant
|
|
29
|
+
: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`.
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
<Global />
|
|
@@ -47,7 +47,7 @@ Deploy the specified app in the tenant app catalog. Try to resolve the URL of th
|
|
|
47
47
|
m365 spo app deploy --id 058140e3-0e37-44fc-a1d3-79c487d371a3
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Deploy the specified app in the site collection app catalog of site
|
|
50
|
+
Deploy the specified app in the site collection app catalog of the specified site.
|
|
51
51
|
|
|
52
52
|
```sh
|
|
53
53
|
m365 spo app deploy --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1
|
|
@@ -59,7 +59,7 @@ Deploy the app with the specified name in the tenant app catalog. Try to resolve
|
|
|
59
59
|
m365 spo app deploy --name solution.sppkg
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
Deploy the specified app in the tenant app catalog
|
|
62
|
+
Deploy the specified app in the tenant app catalog.
|
|
63
63
|
|
|
64
64
|
```sh
|
|
65
65
|
m365 spo app deploy --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --appCatalogUrl https://contoso.sharepoint.com/sites/apps
|
|
@@ -71,6 +71,10 @@ Deploy the specified app to the whole tenant at once. Features included in the s
|
|
|
71
71
|
m365 spo app deploy --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --skipFeatureDeployment
|
|
72
72
|
```
|
|
73
73
|
|
|
74
|
+
## Response
|
|
75
|
+
|
|
76
|
+
The command won't return a response on success.
|
|
77
|
+
|
|
74
78
|
## More information
|
|
75
79
|
|
|
76
80
|
- Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins)
|