@pnp/cli-microsoft365 10.0.0-beta.a868b81 → 10.0.0-beta.d54aaac

package/dist/utils/spo.js

@@ -1613,6 +1613,51 @@ export const spo = {
         // Get the destination object information
         const objectInfo = logs.find(l => l.Event === 'JobFinishedObjectInfo');
         return objectInfo;
+    },
+    /**
+     * Gets the site collection URL for a given web URL using SP Admin site.
+     * @param adminUrl The SharePoint admin URL
+     * @param siteId The site ID
+     * @param logger The logger object
+     * @param verbose If in verbose mode
+     * @returns Owner login name
+     */
+    async getPrimaryAdminLoginNameAsAdmin(adminUrl, siteId, logger, verbose) {
+        if (verbose) {
+            await logger.logToStderr('Getting the primary admin login name...');
+        }
+        const requestOptions = {
+            url: `${adminUrl}/_api/SPO.Tenant/sites('${siteId}')?$select=OwnerLoginName`,
+            headers: {
+                accept: 'application/json;odata=nometadata',
+                'content-type': 'application/json;charset=utf-8'
+            }
+        };
+        const response = await request.get(requestOptions);
+        const responseContent = JSON.parse(response);
+        return responseContent.OwnerLoginName;
+    },
+    /**
+     * Gets the primary owner login from a site.
+     * @param siteUrl The site URL
+     * @param logger The logger object
+     * @param verbose If in verbose mode
+     * @returns Owner login name
+     */
+    async getPrimaryOwnerLoginFromSite(siteUrl, logger, verbose) {
+        if (verbose) {
+            await logger.logToStderr('Getting the primary admin login name...');
+        }
+        const requestOptions = {
+            url: `${siteUrl}/_api/site/owner`,
+            method: 'GET',
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const responseContent = await request.get(requestOptions);
+        return responseContent?.LoginName;
     }
 };
 //# sourceMappingURL=spo.js.map

package/dist/utils/zod.js

@@ -60,7 +60,7 @@ function parseDefault(def, _options, currentOption) {
 function parseEnum(def, _options, currentOption) {
     if (currentOption) {
         currentOption.type = 'string';
-        currentOption.autocomplete = def.values;
+        currentOption.autocomplete = [...def.values];
     }
     return;
 }

package/docs/docs/cmd/entra/m365group/m365group-report-activitystorage.mdx

@@ -9,13 +9,13 @@ Get the total storage used across all group mailboxes and group sites
 ## Usage
 
 ```sh
-m365 entra m365group report activitystorage  [options]
+m365 entra m365group report activitystorage [options]
 ```
 
 ## Alias
 
 ```sh
-m365 aad m365group report activitystorage  [options]
+m365 aad m365group report activitystorage [options]
 ```
 
 ## Options

package/docs/docs/cmd/file/file-move.mdx

@@ -0,0 +1,79 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# file move
+
+Moves a file to another location using the Microsoft Graph
+
+## Usage
+
+```sh
+m365 file move [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located.
+
+`-s, --sourceUrl <sourceUrl>`
+: Server-relative or absolute URL of the file.
+
+`-t, --targetUrl <targetUrl>`
+: Server-relative or absolute URL of the location.
+
+`--newName [newName]`
+: New name of the destination file.
+
+`--nameConflictBehavior [nameConflictBehavior]`
+: Behavior when a document with the same name is already present at the destination. Possible values: `fail`, `replace`, `rename`. Default is `fail`.
+```
+
+<Global />
+
+## Remarks
+
+- If the source and target locations are within the same document library or drive, the command will utilize the Move DriveItem API, preserving the version history of the file.
+- If the source and target locations are in different document libraries or drives, the command will use a copy-and-delete combination to move the file. Please note that in this case, version history will not be retained.
+
+## Examples
+
+Move a file by server-relative URL to a folder in the same document library
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com/sites/project" --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/project/Shared Documents/NewFolder"
+```
+
+Move a file by server-relative URL to a document library in another site collection with server relative URL
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com/sites/project" --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents"
+```
+
+Move a file by absolute URL to a document library in another site collection with absolute URL
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "https://contoso.sharepoint.com/Shared Documents/Document.pdf" --targetUrl "https://contoso.sharepoint.com/sites/IT/Shared Documents"
+```
+
+Move a file to a document library in another site collection and rename the file
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --newName "newName"
+```
+
+Move a file to a document library in another site collection and rename the file if a file with the same name already exists.
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --nameConflictBehavior rename
+```
+
+Move a file to Onedrive for business 
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/documents"
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-list.mdx

@@ -0,0 +1,132 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# flow recyclebinitem list
+
+Lists all soft-deleted Power Automate flows within an environment
+
+## Usage
+
+```sh
+m365 flow recyclebinitem list [options]
+```
+
+## Options
+
+```md definition-list
+`-e, --environmentName <environmentName>`
+: The name of the environment.
+```
+
+<Global />
+
+## Remarks
+
+:::warning
+
+This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
+
+:::
+
+:::info
+
+To use this command, you must be a Global or Power Platform administrator.
+
+:::
+
+A Power Automate flow is soft-deleted when:
+- It's a non-solution flow.
+- It's been deleted less than 21 days ago.
+
+If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
+
+## Examples
+
+List all soft-deleted flows within a specific environment
+
+```sh
+m365 flow recyclebinitem list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "name": "26a9a283-af42-4c09-aa3e-60c3cc166b90",
+      "id": "/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90",
+      "type": "Microsoft.ProcessSimple/environments/flows",
+      "properties": {
+        "apiId": "/providers/Microsoft.PowerApps/apis/shared_logicflows",
+        "displayName": "Invoicing flow",
+        "state": "Deleted",
+        "createdTime": "2024-08-05T23:13:54Z",
+        "lastModifiedTime": "2024-08-05T23:14:00Z",
+        "flowSuspensionReason": "None",
+        "environment": {
+          "name": "Default-d87a7535-dd31-4437-bfe1-95340acd55c5",
+          "type": "Microsoft.ProcessSimple/environments",
+          "id": "/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
+        },
+        "definitionSummary": {
+          "triggers": [],
+          "actions": []
+        },
+        "creator": {
+          "tenantId": "a16e76a1-837f-4bf9-82dc-78874d18e434",
+          "objectId": "bd51c64d-c262-4184-ba3f-5361ea553820",
+          "userId": "bd51c64d-c262-4184-ba3f-5361ea553820",
+          "userType": "ActiveDirectory"
+        },
+        "flowFailureAlertSubscribed": false,
+        "isManaged": false,
+        "machineDescriptionData": {},
+        "flowOpenAiData": {
+          "isConsequential": false,
+          "isConsequentialFlagOverwritten": false
+        }
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  name                                  displayName
+  ------------------------------------  --------------
+  26a9a283-af42-4c09-aa3e-60c3cc166b90  Invoicing flow
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  name,id,type
+  26a9a283-af42-4c09-aa3e-60c3cc166b90,/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90,Microsoft.ProcessSimple/environments/flows
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # flow recyclebinitem list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
+
+  Date: 06/08/2024
+
+  ## 26a9a283-af42-4c09-aa3e-60c3cc166b90 (/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90)
+
+  Property | Value
+  ---------|-------
+  name | 26a9a283-af42-4c09-aa3e-60c3cc166b90
+  id | /providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90
+  type | Microsoft.ProcessSimple/environments/flows
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-restore.mdx

@@ -0,0 +1,55 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# flow recyclebinitem restore
+
+Restores a soft-deleted Power Automate flow
+
+## Usage
+
+```sh
+m365 flow recyclebinitem restore [options]
+```
+
+## Options
+
+```md definition-list
+`-e, --environmentName <environmentName>`
+: The name of the environment where the flow is located.
+
+`-n, --flowName <flowName>`
+: The name of the Power Automate flow.
+```
+
+<Global />
+
+## Remarks
+
+:::warning
+
+This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
+
+:::
+
+:::info
+
+To use this command, you must be a Global or Power Platform administrator.
+
+:::
+
+When a Power Automate flow is restored, it will be automatically disabled. To make it operational again, you must [enable](../flow-enable.mdx) it.
+
+If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
+
+## Examples
+
+Restores a soft-deleted flow within a specific environment
+
+```sh
+m365 flow recyclebinitem restore --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/cdn/cdn-get.mdx

@@ -27,7 +27,7 @@ Using the `-t, --type` option you can choose whether you want to manage the sett
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx

@@ -28,7 +28,7 @@ Using the `-t, --type` option you can choose whether you want to manage the sett
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx

@@ -27,7 +27,7 @@ Using the `-t, --type` option you can choose whether you want to manage the sett
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx

@@ -31,7 +31,7 @@ Using the `-t, --type` option you can choose whether you want to manage the sett
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx

@@ -27,7 +27,7 @@ Using the `-t, --cdnType` option you can choose whether you want to manage the s
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx

@@ -31,7 +31,7 @@ Using the `-t, --cdnType` option you can choose whether you want to manage the s
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/externaluser/externaluser-list.mdx

@@ -37,7 +37,7 @@ m365 spo externaluser list [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/folder/folder-sharinglink-add.mdx

@@ -0,0 +1,125 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo folder sharinglink add
+
+Creates a new sharing link to a folder
+
+## Usage
+
+```sh
+m365 spo folder sharinglink add [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the folder is located.
+
+`--folderUrl [folderUrl]`
+: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`--folderId [folderId]`
+: The UniqueId (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`--type <type>`
+: The type of sharing link to create. Either `view` or `edit`.
+
+`--expirationDateTime [expirationDateTime]`
+: The date and time to set the expiration. This should be defined as a valid ISO 8601 string.
+
+`--scope [scope]`
+: The scope of link to create. Either `anonymous`, `organization` or `users`. If not specified, the default of the organization will be used.
+
+`--retainInheritedPermissions [retainInheritedPermissions]`
+: If `true`, any existing inherited permissions are retained on the shared item when sharing this item for the first time. If `false`, all existing permissions are removed when sharing for the first time.
+
+`--recipients [recipients]`
+: Comma separated list of users with whom we wish to share the item with. Required when using scope `users`.
+```
+
+<Global />
+
+## Examples
+
+Creates a view-only anonymous sharing link of a folder by id.
+
+```sh
+m365 spo folder sharinglink add --webUrl https://contoso.sharepoint.com/sites/demo --folderId daebb04b-a773-4baa-b1d1-3625418e3234 --type view --scope anonymous
+```
+
+Creates an edit organization sharing link of a folder by url with a specific expiration date.
+
+```sh
+m365 spo folder sharinglink add --webUrl https://contoso.sharepoint.com/sites/demo --folderUrl /sites/demo/shared%20documents/Folder --type edit --scope organization --expirationDateTime '2022-11-30T00:00:00Z'
+```
+
+Creates a user sharing link of a folder by id.
+
+```sh
+m365 spo folder sharinglink add --webUrl https://contoso.sharepoint.com/sites/demo --folderId daebb04b-a773-4baa-b1d1-3625418e3234 --type view --scope users --recipients john@contoso.com,doe@contoso.com
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "4fe11ccb-6c83-4927-8072-95642422b8ae",
+    "roles": [
+      "read"
+    ],
+    "shareId": "u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0V2QVFpdnpLV2ZoT3ZJOHJiNm1UVEhjQjNHWkRRNlVhQ3VwNEhWeFpiR25mRkE",
+    "hasPassword": false,
+    "link": {
+      "scope": "anonymous",
+      "type": "view",
+      "webUrl": "https://contoso.sharepoint.com/:f:/g/EvAQivzKWfhOvI8rb6mTTHcB3GZDQ6UaCup4HVxZbGnfFA",
+      "preventsDownload": false
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  hasPassword: false
+  id         : 4fe11ccb-6c83-4927-8072-95642422b8ae
+  link       : {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:f:/g/EvAQivzKWfhOvI8rb6mTTHcB3GZDQ6UaCup4HVxZbGnfFA","preventsDownload":false}
+  roles      : ["read"]
+  shareId    : u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0V2QVFpdnpLV2ZoT3ZJOHJiNm1UVEhjQjNHWkRRNlVhQ3VwNEhWeFpiR25mRkE
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,shareId,hasPassword
+  4fe11ccb-6c83-4927-8072-95642422b8ae,u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0V2QVFpdnpLV2ZoT3ZJOHJiNm1UVEhjQjNHWkRRNlVhQ3VwNEhWeFpiR25mRkE,
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo folder sharinglink add --webUrl "https://contoso.sharepoint.com" --folderUrl "/shared documents/folder1" --type "view" --scope "anonymous"
+
+  Date: 29/04/2024
+
+  ## 4fe11ccb-6c83-4927-8072-95642422b8ae
+
+  Property | Value
+  ---------|-------
+  id | 4fe11ccb-6c83-4927-8072-95642422b8ae
+  shareId | u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0V2QVFpdnpLV2ZoT3ZJOHJiNm1UVEhjQjNHWkRRNlVhQ3VwNEhWeFpiR25mRkE
+  hasPassword | false
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/folder/folder-sharinglink-clear.mdx

@@ -0,0 +1,50 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo folder sharinglink clear
+
+Removes sharing links of a folder
+
+## Usage
+
+```sh
+m365 spo folder sharinglink clear [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the folder is located.
+
+`--folderUrl [folderUrl]`
+: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`--folderId [folderId]`
+: The Unique ID (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`-s, --scope [scope]`
+: Scope of the sharing link. Possible options are: `anonymous`, `users` or `organization`. If not specified, all links will be removed.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Removes all sharing links from a folder specified by id without prompting for confirmation.
+
+```sh
+m365 spo folder sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --folderId daebb04b-a773-4baa-b1d1-3625418e3234 --force
+```
+
+Removes sharing links of type anonymous from a folder specified by url with prompting for confirmation.
+
+```sh
+m365 spo folder sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --folderUrl '/sites/demo/Shared Documents/folder1' --scope anonymous
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/folder/folder-sharinglink-remove.mdx

@@ -0,0 +1,50 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo folder sharinglink remove
+
+Removes a specific sharing link of a folder
+
+## Usage
+
+```sh
+m365 spo folder sharinglink remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the folder is located.
+
+`--folderUrl [folderUrl]`
+: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`--folderId [folderId]`
+: The UniqueId (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.
+
+`-i, --id <id>`
+: The ID of the sharing link.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Removes a specific sharing link from a folder by id without prompting for confirmation.
+
+```sh
+m365 spo folder sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --folderId daebb04b-a773-4baa-b1d1-3625418e3234 --id c391b57d-5783-4c53-9236-cefb5c6ef323 --force
+```
+
+Removes a specific sharing link from a folder by url with prompting for confirmation.
+
+```sh
+m365 spo folder sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --folderUrl /sites/demo/shared%20documents/Folder --id c391b57d-5783-4c53-9236-cefb5c6ef323
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.mdx

@@ -20,7 +20,7 @@ m365 spo hidedefaultthemes get [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx

@@ -23,7 +23,7 @@ m365 spo hidedefaultthemes set [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/homesite/homesite-remove.mdx

@@ -25,7 +25,7 @@ m365 spo homesite remove [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::