@pnp/cli-microsoft365 8.1.0-beta.3bc5759 → 8.1.0-beta.a4eba60

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.
Files changed (54) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/Auth.js +1 -1
  4. package/dist/m365/connection/commands/connection-remove.js +6 -2
  5. package/dist/m365/connection/commands/connection-set.js +4 -1
  6. package/dist/m365/connection/commands/connection-use.js +25 -4
  7. package/dist/m365/entra/commands/m365group/m365group-user-add.js +109 -32
  8. package/dist/m365/entra/commands/m365group/m365group-user-set.js +159 -84
  9. package/dist/m365/entra/commands/multitenant/multitenant-add.js +65 -0
  10. package/dist/m365/entra/commands/multitenant/multitenant-remove.js +118 -0
  11. package/dist/m365/entra/commands/multitenant/multitenant-set.js +72 -0
  12. package/dist/m365/entra/commands.js +3 -0
  13. package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -1
  14. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +1 -1
  15. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +1 -1
  16. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -1
  17. package/dist/m365/spo/commands/folder/folder-sharinglink-get.js +86 -0
  18. package/dist/m365/spo/commands/folder/folder-sharinglink-list.js +110 -0
  19. package/dist/m365/spo/commands/list/ListInstance.js +6 -1
  20. package/dist/m365/spo/commands/list/list-get.js +9 -3
  21. package/dist/m365/spo/commands/list/list-roleassignment-add.js +46 -21
  22. package/dist/m365/spo/commands/list/list-roleassignment-remove.js +48 -46
  23. package/dist/m365/spo/commands.js +2 -0
  24. package/dist/utils/drive.js +61 -0
  25. package/dist/utils/spo.js +69 -6
  26. package/docs/docs/cmd/connection/connection-use.mdx +8 -2
  27. package/docs/docs/cmd/entra/m365group/m365group-user-add.mdx +28 -10
  28. package/docs/docs/cmd/entra/m365group/m365group-user-set.mdx +35 -11
  29. package/docs/docs/cmd/entra/multitenant/multitenant-add.mdx +107 -0
  30. package/docs/docs/cmd/entra/multitenant/multitenant-remove.mdx +58 -0
  31. package/docs/docs/cmd/entra/multitenant/multitenant-set.mdx +53 -0
  32. package/docs/docs/cmd/planner/plan/plan-remove.mdx +1 -1
  33. package/docs/docs/cmd/spe/containertype/containertype-list.mdx +24 -53
  34. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +4 -4
  35. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +4 -4
  36. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  37. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +2 -2
  38. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  39. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +1 -1
  40. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +1 -1
  41. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +2 -2
  42. package/docs/docs/cmd/spo/folder/folder-sharinglink-get.mdx +110 -0
  43. package/docs/docs/cmd/spo/folder/folder-sharinglink-list.mdx +114 -0
  44. package/docs/docs/cmd/spo/list/list-get.mdx +6 -0
  45. package/docs/docs/cmd/spo/list/list-roleassignment-add.mdx +15 -3
  46. package/docs/docs/cmd/spo/list/list-roleassignment-remove.mdx +15 -3
  47. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.mdx +4 -4
  48. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.mdx +1 -1
  49. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.mdx +9 -9
  50. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.mdx +7 -7
  51. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.mdx +1 -1
  52. package/docs/docs/cmd/spo/web/web-roleassignment-add.mdx +1 -1
  53. package/docs/docs/cmd/spo/web/web-roleassignment-remove.mdx +1 -1
  54. package/package.json +1 -1
@@ -2,7 +2,7 @@ import Global from '/docs/cmd/_global.mdx';
2
2
 
3
3
  # entra m365group user set
4
4
 
5
- Updates role of the specified user in the specified Microsoft 365 Group or Microsoft Teams team
5
+ Updates role of the specified users in the specified Microsoft 365 Group or Microsoft Teams team
6
6
 
7
7
  ## Usage
8
8
 
@@ -24,13 +24,25 @@ m365 aad teams user set
24
24
 
25
25
  ```md definition-list
26
26
  `-i, --groupId [groupId]`
27
- : The ID of the Microsoft 365 group for which to update user
27
+ : The ID of the Microsoft 365 group. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
28
+
29
+ `--groupName [groupName]`
30
+ : The display name of the Microsoft 365 group. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
28
31
 
29
32
  `--teamId [teamId]`
30
- : The ID of the Microsoft Teams team for which to update user
33
+ : The ID of the Teams team. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
34
+
35
+ `--teamName [teamName]`
36
+ : The display name of the Microsoft Teams team. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
37
+
38
+ `-n, --userName [userName]`
39
+ : (deprecated) User's UPN (User Principal Name), e.g. johndoe@example.com.
31
40
 
32
- `-n, --userName <userName>`
33
- : UPN of the user for whom to update the role (eg. johndoe@example.com)
41
+ `--ids [ids]`
42
+ : Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify only one of the following `userName`, `ids` or `userNames`.
43
+
44
+ `--userNames [userNames]`
45
+ : The user principal names of users. You can also pass a comma-separated list of UPNs. Specify only one of the following `userName`, `ids` or `userNames`.
34
46
 
35
47
  `-r, --role <role>`
36
48
  : Role to set for the given user in the specified Microsoft 365 Group or Microsoft Teams team. Allowed values: `Owner`, `Member`
@@ -44,28 +56,40 @@ The command will return an error if the user already has the specified role in t
44
56
 
45
57
  ## Examples
46
58
 
47
- Promote the specified user to owner of the given Microsoft 365 Group
59
+ Promote a single user to Owner of the given Microsoft 365 Group
48
60
 
49
61
  ```sh
50
62
  m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --role Owner
51
63
  ```
52
64
 
53
- Demote the specified user from owner to member in the given Microsoft 365 Group
65
+ Promote multiple users specified by the userNames parameter to Owner of the given Microsoft 365 Group
66
+
67
+ ```sh
68
+ m365 entra m365group user set --groupName 'Contoso' --userNames 'anne.matthews@contoso.onmicrosoft.com,john.doe@contoso.onmicrosoft.com' --role Owner
69
+ ```
70
+
71
+ Promote multiple users specified by the ids parameter to Owner of the given Microsoft 365 Group
72
+
73
+ ```sh
74
+ m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' --ids '74a3b772-3122-447b-b9da-10895e238219,dd3d21e4-a142-46b9-8482-bca8fe9596b3' --role Owner
75
+ ```
76
+
77
+ Demote a single user from Owner to Member in the given Microsoft 365 Group
54
78
 
55
79
  ```sh
56
80
  m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --role Member
57
81
  ```
58
82
 
59
- Promote the specified user to owner of the given Microsoft Teams team
83
+ Demote multiple users specified by the userNames parameter from Owner to Member of the given Microsoft Teams team
60
84
 
61
85
  ```sh
62
- m365 entra teams user set --teamId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --role Owner
86
+ m365 entra teams user set --teamId '00000000-0000-0000-0000-000000000000' --userNames 'anne.matthews@contoso.onmicrosoft.com,john.doe@contoso.onmicrosoft.com' --role Member
63
87
  ```
64
88
 
65
- Demote the specified user from owner to member in the given Microsoft Teams team
89
+ Demote multiple users specified by the ids parameter from Owner to Member in the given Microsoft Teams team
66
90
 
67
91
  ```sh
68
- m365 entra teams user set --teamId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --role Member
92
+ m365 entra teams user set --teamName 'Engineering' --ids '74a3b772-3122-447b-b9da-10895e238219,dd3d21e4-a142-46b9-8482-bca8fe9596b3' --role Member
69
93
  ```
70
94
 
71
95
  ## Response
@@ -0,0 +1,107 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # entra multitenant add
6
+
7
+ Creates a new multitenant organization
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 entra multitenant add [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-n, --displayname <displayName>`
19
+ : Display name for the multitenant organization.
20
+
21
+ `-d, --description [description]`
22
+ : Description for the multitenant organiztion.
23
+ ```
24
+
25
+ <Global />
26
+
27
+ ## Remarks
28
+
29
+ :::info
30
+
31
+ To use this command you must be at least **Security Administrator**.
32
+
33
+ :::
34
+
35
+ ## Examples
36
+
37
+ Create a new multitenant organization with display name only.
38
+
39
+ ```sh
40
+ m365 entra multitenant add --displayName 'Contoso organization'
41
+ ```
42
+
43
+ Create a new multitenant organization with display name and description.
44
+
45
+ ```sh
46
+ m365 entra multitenant add --displayName 'Contoso organization' --description 'Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank'
47
+ ```
48
+
49
+ ## Response
50
+
51
+ <Tabs>
52
+ <TabItem value="JSON">
53
+
54
+ ```json
55
+ {
56
+ "id": "c231d4a5-138f-4bdf-9fee-f26a90ea3ad0",
57
+ "createdDateTime": "2024-05-05T05:05:05Z",
58
+ "state": "active",
59
+ "displayName": "Contoso organization",
60
+ "description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
61
+ }
62
+ ```
63
+
64
+ </TabItem>
65
+ <TabItem value="Text">
66
+
67
+ ```text
68
+ createdDateTime: 2024-05-05T05:05:05Z
69
+ description : Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
70
+ displayName : Contoso organization
71
+ id : c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
72
+ state : active
73
+ ```
74
+
75
+ </TabItem>
76
+ <TabItem value="CSV">
77
+
78
+ ```csv
79
+ id,createdDateTime,state,displayName,description
80
+ c231d4a5-138f-4bdf-9fee-f26a90ea3ad0,2024-05-05T05:05:05Z,active,Contoso organization,"Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
81
+ ```
82
+
83
+ </TabItem>
84
+ <TabItem value="Markdown">
85
+
86
+ ```md
87
+ # entra multitenant add
88
+
89
+ Date: 5/5/2024
90
+
91
+ ## Contoso organization (c231d4a5-138f-4bdf-9fee-f26a90ea3ad0)
92
+
93
+ Property | Value
94
+ ---------|-------
95
+ id | c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
96
+ createdDateTime | 2024-05-05T05:05:05Z
97
+ state | active
98
+ displayName | Contoso organization
99
+ description | Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
100
+ ```
101
+
102
+ </TabItem>
103
+ </Tabs>
104
+
105
+ ## More information
106
+
107
+ - Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview
@@ -0,0 +1,58 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # entra multitenant remove
4
+
5
+ Removes a multitenant organization
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 entra multitenant remove [options]
11
+ ```
12
+
13
+ ## options
14
+
15
+ ```md definition-list
16
+ `-f, --force`
17
+ : Don't prompt for confirmation.
18
+ ```
19
+
20
+ <Global />
21
+
22
+ ## Remarks
23
+
24
+ :::info
25
+
26
+ To use this command you must be at least **Security Administrator**.
27
+
28
+ :::
29
+
30
+ :::info
31
+
32
+ When removing a Multi-Tenant Organization, all associations with other tenants will be removed too.
33
+
34
+ The removing process can take up to 2 hours to complete.
35
+
36
+ :::
37
+
38
+ ## Examples
39
+
40
+ Remove the multitenant organization.
41
+
42
+ ```sh
43
+ m365 entra multitenant remove
44
+ ```
45
+
46
+ Remove the multitenant organization without prompting for confirmation.
47
+
48
+ ```sh
49
+ m365 entra multitenant remove --force
50
+ ```
51
+
52
+ ## Response
53
+
54
+ The command won't return a response on success
55
+
56
+ ## More information
57
+
58
+ - Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview
@@ -0,0 +1,53 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # entra multitenant set
4
+
5
+ Updates the properties of a multitenant organization
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 entra multitenant set [options]
11
+ ```
12
+
13
+ ## Options
14
+
15
+ ```md definition-list
16
+ `-n, --displayName [displayName]`
17
+ : New display name of the multitenant organization. Both options, `displayName` and `description` are optional but at least must be specified.
18
+
19
+ `-d, --description [description]`
20
+ : New description of the multitenant organization. Both options, `displayName` and `description` are optional but at least must be specified.
21
+ ```
22
+
23
+ <Global />
24
+
25
+ ## Remarks
26
+
27
+ :::info
28
+
29
+ To use this command you must be at least **Security Administrator**.
30
+
31
+ :::
32
+
33
+ ## Examples
34
+
35
+ Update display name of multitenant organization.
36
+
37
+ ```sh
38
+ m365 entra multitenant set --displayName 'Fabrikam organization'
39
+ ```
40
+
41
+ Update display name and description of multitenant organization.
42
+
43
+ ```sh
44
+ m365 entra multitenant set --displayName 'Fabrikam organization' --description 'Multitenant organization between Fabrikam and Contoso'
45
+ ```
46
+
47
+ ## Response
48
+
49
+ The command won't return a response on success
50
+
51
+ ## More information
52
+
53
+ - Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview
@@ -13,7 +13,7 @@ m365 planner plan remove [options]
13
13
  ## Options
14
14
 
15
15
  ```md definition-list
16
- `i, --id [id]`
16
+ `-i, --id [id]`
17
17
  : ID of the plan to remove. Specify either `id` or `title` but not both.
18
18
 
19
19
  `-t, --title [title]`
@@ -2,14 +2,14 @@ import Global from '/docs/cmd/_global.mdx';
2
2
  import Tabs from '@theme/Tabs';
3
3
  import TabItem from '@theme/TabItem';
4
4
 
5
- # Container Types list
5
+ # spe containertype list
6
6
 
7
- Retrieves a list of Container Types created for a SharePoint Embedded Application
7
+ Lists all Container Types
8
8
 
9
9
  ## Usage
10
10
 
11
11
  ```sh
12
- m365 containertype list [options]
12
+ m365 spe containertype list [options]
13
13
  ```
14
14
 
15
15
  ## Options
@@ -21,7 +21,7 @@ m365 containertype list [options]
21
21
  Retrieves a list of Container Types created for a SharePoint Embedded Application from the tenant.
22
22
 
23
23
  ```sh
24
- m365 containertype list
24
+ m365 spe containertype list
25
25
  ```
26
26
 
27
27
  ## Response
@@ -30,47 +30,32 @@ m365 containertype list
30
30
  <TabItem value="JSON">
31
31
 
32
32
  ```json
33
- [{
34
- "_ObjectType_": "Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties",
35
- "ApplicationRedirectUrl": null,
36
- "AzureSubscriptionId": "/Guid(00000000-0000-0000-0000-000000000000)/",
37
- "ContainerTypeId": "/Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/",
38
- "CreationDate": null,
39
- "DisplayName": "test1",
40
- "ExpiryDate": null,
41
- "IsBillingProfileRequired": true,
42
- "OwningAppId": "/Guid(df4085cc-9a38-4255-badc-5c5225610475)/",
43
- "OwningTenantId": "/Guid(00000000-0000-0000-0000-000000000000)/",
44
- "Region": null,
45
- "ResourceGroup": null,
46
- "SPContainerTypeBillingClassification": 0
47
- },
48
- {
49
- "_ObjectType_": "Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties",
50
- "ApplicationRedirectUrl": null,
51
- "AzureSubscriptionId": "/Guid(00000000-0000-0000-0000-000000000000)/",
52
- "ContainerTypeId": "/Guid(3ec7c59d-ef31-0752-1ab5-5c343a5e8557)/",
53
- "CreationDate": null,
54
- "DisplayName": "SharePoint Embedded Free Trial Container Type",
55
- "ExpiryDate": null,
56
- "IsBillingProfileRequired": true,
57
- "OwningAppId": "/Guid(e6b529fe-84db-412a-8e9c-5bbb75f7b037)/",
58
- "OwningTenantId": "/Guid(00000000-0000-0000-0000-000000000000)/",
59
- "Region": null,
60
- "ResourceGroup": null,
61
- "SPContainerTypeBillingClassification": 1
62
- }]
33
+ [
34
+ {
35
+ "_ObjectType_": "Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties",
36
+ "ApplicationRedirectUrl": null,
37
+ "AzureSubscriptionId": "/Guid(00000000-0000-0000-0000-000000000000)/",
38
+ "ContainerTypeId": "/Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/",
39
+ "CreationDate": null,
40
+ "DisplayName": "test1",
41
+ "ExpiryDate": null,
42
+ "IsBillingProfileRequired": true,
43
+ "OwningAppId": "/Guid(df4085cc-9a38-4255-badc-5c5225610475)/",
44
+ "OwningTenantId": "/Guid(00000000-0000-0000-0000-000000000000)/",
45
+ "Region": null,
46
+ "ResourceGroup": null,
47
+ "SPContainerTypeBillingClassification": 0
48
+ }
49
+ ]
63
50
  ```
64
51
 
65
52
  </TabItem>
66
53
  <TabItem value="Text">
67
54
 
68
55
  ```text
69
- ContainerTypeId DisplayName OwningAppId
70
- -------------------------------------------- --------------------------------------------- --------------------------------------------
71
- /Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/ test1 /Guid(df4085cc-9a38-4255-badc-5c5225610475)/
72
- /Guid(880ab3bd-5b68-01d4-3744-01a7656cf2ba)/ test1 /Guid(50785fde-3082-47ac-a36d-06282ac5c7da)/
73
- /Guid(3ec7c59d-ef31-0752-1ab5-5c343a5e8557)/ SharePoint Embedded Free Trial Container Type /Guid(e6b529fe-84db-412a-8e9c-5bbb75f7b037)/
56
+ ContainerTypeId DisplayName OwningAppId
57
+ -------------------------------------------- --------------------------------------------- --------------------------------------------
58
+ /Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/ test1 /Guid(df4085cc-9a38-4255-badc-5c5225610475)/
74
59
  ```
75
60
 
76
61
  </TabItem>
@@ -79,7 +64,6 @@ ContainerTypeId DisplayName
79
64
  ```csv
80
65
  _ObjectType_,ApplicationRedirectUrl,AzureSubscriptionId,ContainerTypeId,CreationDate,DisplayName,ExpiryDate,IsBillingProfileRequired,OwningAppId,OwningTenantId,Region,ResourceGroup,SPContainerTypeBillingClassification
81
66
  Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties,,/Guid(00000000-0000-0000-0000-000000000000)/,/Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/,,test1,,1,/Guid(df4085cc-9a38-4255-badc-5c5225610475)/,/Guid(00000000-0000-0000-0000-000000000000)/,,,0
82
- Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties,,/Guid(00000000-0000-0000-0000-000000000000)/,/Guid(3ec7c59d-ef31-0752-1ab5-5c343a5e8557)/,,SharePoint Embedded Free Trial Container Type,,1,/Guid(e6b529fe-84db-412a-8e9c-5bbb75f7b037)/,/Guid(00000000-0000-0000-0000-000000000000)/,,,1
83
67
  ```
84
68
 
85
69
  </TabItem>
@@ -102,19 +86,6 @@ ContainerTypeId DisplayName
102
86
  OwningAppId | /Guid(df4085cc-9a38-4255-badc-5c5225610475)/
103
87
  OwningTenantId | /Guid(00000000-0000-0000-0000-000000000000)/
104
88
  SPContainerTypeBillingClassification | 0
105
-
106
- ## SharePoint Embedded Free Trial Container Type
107
-
108
- Property | Value
109
- ---------|-------
110
- \_ObjectType\_ | Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties
111
- AzureSubscriptionId | /Guid(00000000-0000-0000-0000-000000000000)/
112
- ContainerTypeId | /Guid(3ec7c59d-ef31-0752-1ab5-5c343a5e8557)/
113
- DisplayName | SharePoint Embedded Free Trial Container Type
114
- IsBillingProfileRequired | true
115
- OwningAppId | /Guid(e6b529fe-84db-412a-8e9c-5bbb75f7b037)/
116
- OwningTenantId | /Guid(00000000-0000-0000-0000-000000000000)/
117
- SPContainerTypeBillingClassification | 1
118
89
  ```
119
90
 
120
91
  </TabItem>
@@ -36,6 +36,10 @@ m365 spo applicationcustomizer get [options]
36
36
 
37
37
  <Global />
38
38
 
39
+ ## Remarks
40
+
41
+ This command can be used for retrieving an application customizer from a specific site. To retrieve an application customizer that's installed tenant-wide, view our dedicated [spo tenant applicationcustomizer get](../tenant/tenant-applicationcustomizer-get.mdx) command.
42
+
39
43
  ## Examples
40
44
 
41
45
  Retrieves an application customizer by title.
@@ -68,10 +72,6 @@ Retrieves the client-side component properties of a application customizer.
68
72
  m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --clientSideComponentProperties
69
73
  ```
70
74
 
71
- ## Remarks
72
-
73
- This command can be used for retrieving an application customizer from a specific site. To retrieve an application customizer that's installed tenant-wide, view our dedicated [spo tenant applicationcustomizer get](../tenant/tenant-applicationcustomizer-get.mdx) command.
74
-
75
75
  ## Response
76
76
 
77
77
  ### Standard response
@@ -24,6 +24,10 @@ m365 spo applicationcustomizer list [options]
24
24
 
25
25
  <Global />
26
26
 
27
+ ## Remarks
28
+
29
+ This command can be used for retrieving a list of application customizers from a specific site. To retrieve a list of application customizers that are installed tenant-wide, view our dedicated [spo tenant applicationcustomizer list](../tenant/tenant-applicationcustomizer-list.mdx) command.
30
+
27
31
  ## Examples
28
32
 
29
33
  Retrieves a list of application customizers.
@@ -32,10 +36,6 @@ Retrieves a list of application customizers.
32
36
  m365 spo applicationcustomizer list --webUrl https://contoso.sharepoint.com/sites/sales
33
37
  ```
34
38
 
35
- ## Remarks
36
-
37
- This command can be used for retrieving a list of application customizers from a specific site. To retrieve a list of application customizers that are installed tenant-wide, view our dedicated [spo tenant applicationcustomizer list](../tenant/tenant-applicationcustomizer-list.mdx) command.
38
-
39
39
  ## Response
40
40
 
41
41
  <Tabs>
@@ -33,7 +33,7 @@ m365 spo file retentionlabel ensure [options]
33
33
 
34
34
  ## Remarks
35
35
 
36
- You can also use [spo listitem retentionlabel remove](./../../../cmd/spo/listitem/listitem-retentionlabel-remove.mdx) for removing the retention label from a listitem.
36
+ You can also use [spo listitem retentionlabel remove](./../../../cmd/spo/listitem/listitem-retentionlabel-remove.mdx) for removing the retention label from a list item.
37
37
 
38
38
  The `--assetId` option has to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
39
39
 
@@ -19,7 +19,7 @@ m365 spo file roleassignment add [options]
19
19
  `--fileUrl [fileUrl]`
20
20
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
21
21
 
22
- `i, --fileId [fileId]`
22
+ `-i, --fileId [fileId]`
23
23
  : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
24
24
 
25
25
  `--principalId [principalId]`
@@ -29,7 +29,7 @@ m365 spo file roleassignment add [options]
29
29
  : The upn/email of user to assign role to. Specify either `upn`, `groupName`, or `principalId` but not multiple.
30
30
 
31
31
  `--groupName [groupName]`
32
- : The group name of Microsoft Entra or SharePoint group. Specify either `upn`, `groupName`, or `principalId` but not multiple.
32
+ : The group name of the SharePoint group Specify either `upn`, `groupName`, or `principalId` but not multiple.
33
33
 
34
34
  `--roleDefinitionId [roleDefinitionId]`
35
35
  : ID of role definition. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
@@ -29,7 +29,7 @@ m365 spo file roleassignment remove [options]
29
29
  : The upn/email of the user. Specify either `upn`, `groupName`, or `principalId` but not multiple.
30
30
 
31
31
  `--groupName [groupName]`
32
- : The group name of a Microsoft Entra or SharePoint group. Specify either `upn`, `groupName`, or `principalId` but not multiple.
32
+ : The group name of the SharePoint group Specify either `upn`, `groupName`, or `principalId` but not multiple.
33
33
 
34
34
  `-f, --force`
35
35
  : Don't prompt for confirmation.
@@ -19,7 +19,7 @@ m365 spo file roleinheritance break [options]
19
19
  `--fileUrl [fileUrl]`
20
20
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
21
21
 
22
- `i, --fileId [fileId]`
22
+ `-i, --fileId [fileId]`
23
23
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
24
24
 
25
25
  `-c, --clearExistingPermissions`
@@ -19,7 +19,7 @@ m365 spo file roleinheritance reset [options]
19
19
  `--fileUrl [fileUrl]`
20
20
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
21
21
 
22
- `i, --fileId [fileId]`
22
+ `-i, --fileId [fileId]`
23
23
  : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
24
24
 
25
25
  `-f, --force`
@@ -19,7 +19,7 @@ m365 spo folder retentionlabel ensure [options]
19
19
  `--folderUrl [folderUrl]`
20
20
  : The server- or site-relative decoded URL of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
21
21
 
22
- `i, --folderId [folderId]`
22
+ `-i, --folderId [folderId]`
23
23
  : The UniqueId (GUID) of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
24
24
 
25
25
  `--name <name>`
@@ -30,7 +30,7 @@ m365 spo folder retentionlabel ensure [options]
30
30
 
31
31
  ## Remarks
32
32
 
33
- You can also use [spo listitem retentionlabel remove](./../../../cmd/spo/listitem/listitem-retentionlabel-remove.mdx) for removing the retention label from a listitem.
33
+ You can also use [spo listitem retentionlabel remove](./../../../cmd/spo/listitem/listitem-retentionlabel-remove.mdx) for removing the retention label from a list item.
34
34
 
35
35
  ## Examples
36
36
 
@@ -0,0 +1,110 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # spo folder sharinglink get
6
+
7
+ Gets details about a specific sharing link on a folder
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 spo folder sharinglink get [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-u, --webUrl <webUrl>`
19
+ : The URL of the site where the folder is located.
20
+
21
+ `--folderUrl [folderUrl]`
22
+ : The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
23
+
24
+ `--folderId [folderId]`
25
+ : The Unique ID (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
26
+
27
+ `-i, --id <id>`
28
+ : The sharing link ID.
29
+ ```
30
+
31
+ <Global />
32
+
33
+ ## Examples
34
+
35
+ Gets a specific sharing link of a folder by id.
36
+
37
+ ```sh
38
+ m365 spo folder sharinglink get --webUrl https://contoso.sharepoint.com/sites/demo --id 45fa6aed-362f-48b1-b04e-6da85a526506 --folderId daebb04b-a773-4baa-b1d1-3625418e3234
39
+ ```
40
+
41
+ Gets a specific sharing link of a folder by url.
42
+
43
+ ```sh
44
+ m365 spo folder sharinglink get --webUrl https://contoso.sharepoint.com/sites/demo --id 45fa6aed-362f-48b1-b04e-6da85a526506 --folderUrl "/sites/demo/shared documents/folder"
45
+ ```
46
+
47
+ ## Response
48
+
49
+ <Tabs>
50
+ <TabItem value="JSON">
51
+
52
+ ```json
53
+ {
54
+ "id": "d6f6a428-9857-471f-9635-edd68d5aa6c1",
55
+ "roles": [
56
+ "write"
57
+ ],
58
+ "shareId": "u!aHR0cHM6Ly9uYWNoYW4zNjUuc2hhcmVwb2ludC5jb20vOmY6L3MvU1BEZW1vL0VxXzlYcXRIdks1RW9wd3NfX1kteko0QlNybFFNUy1qUTBFOWJsazhVLVNTdVE",
59
+ "hasPassword": false,
60
+ "grantedToIdentitiesV2": [],
61
+ "grantedToIdentities": [],
62
+ "link": {
63
+ "scope": "anonymous",
64
+ "type": "edit",
65
+ "webUrl": "https://contoso.sharepoint.com/:f:/s/demo/Eq_9XqtHvK5Eopws__Y-zJ4BSrlQMS-jQ0E9blk8U-SSuQ",
66
+ "preventsDownload": false
67
+ }
68
+ }
69
+ ```
70
+
71
+ </TabItem>
72
+ <TabItem value="Text">
73
+
74
+ ```text
75
+ grantedToIdentities : []
76
+ grantedToIdentitiesV2 : []
77
+ hasPassword : false
78
+ id : d6f6a428-9857-471f-9635-edd68d5aa6c1
79
+ link : {"scope":"anonymous","type":"edit","webUrl":"https://contoso.sharepoint.com/:f:/s/demo/Eq_9XqtHvK5Eopws__Y-zJ4BSrlQMS-jQ0E9blk8U-SSuQ","preventsDownload":false}
80
+ roles : ["write"]
81
+ shareId : u!aHR0cHM6Ly9uYWNoYW4zNjUuc2hhcmVwb2ludC5jb20vOmY6L3MvU1BEZW1vL0VxXzlYcXRIdks1RW9wd3NfX1kteko0QlNybFFNUy1qUTBFOWJsazhVLVNTdVE
82
+ ```
83
+
84
+ </TabItem>
85
+ <TabItem value="CSV">
86
+
87
+ ```csv
88
+ id,shareId,hasPassword
89
+ d6f6a428-9857-471f-9635-edd68d5aa6c1,u!aHR0cHM6Ly9uYWNoYW4zNjUuc2hhcmVwb2ludC5jb20vOmY6L3MvU1BEZW1vL0VxXzlYcXRIdks1RW9wd3NfX1kteko0QlNybFFNUy1qUTBFOWJsazhVLVNTdVE,
90
+ ```
91
+
92
+ </TabItem>
93
+ <TabItem value="Markdown">
94
+
95
+ ```md
96
+ # spo folder sharinglink get --webUrl "https://contoso.sharepoint.com/sites/demo" --id "d6f6a428-9857-471f-9635-edd68d5aa6c1" --folderUrl "/sites/demo/shared documents/Test"
97
+
98
+ Date: 5/2/2024
99
+
100
+ ## d6f6a428-9857-471f-9635-edd68d5aa6c1
101
+
102
+ Property | Value
103
+ ---------|-------
104
+ id | d6f6a428-9857-471f-9635-edd68d5aa6c1
105
+ shareId | u!aHR0cHM6Ly9uYWNoYW4zNjUuc2hhcmVwb2ludC5jb20vOmY6L3MvU1BEZW1vL0VxXzlYcXRIdks1RW9wd3NfX1kteko0QlNybFFNUy1qUTBFOWJsazhVLVNTdVE
106
+ hasPassword | false
107
+ ```
108
+
109
+ </TabItem>
110
+ </Tabs>