@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.6a23aba

package/docs/docs/cmd/spo/file/file-remove.md

@@ -1,60 +0,0 @@
-# spo file remove
-
-Removes the specified file
-
-## Usage
-
-```sh
-m365 spo file remove [options]
-```
-
-## Alias
-
-```sh
-m365 spo page template remove
-```
-
-## Options
-
-`-w, --webUrl <webUrl>`
-: URL of the site where the file to remove is located
-
-`-i, --id [id]`
-: The ID of the file to remove. Specify either `id` or `url` but not both
-
-`-u, --url [url]`
-: The server- or site-relative URL of the file to remove. Specify either `id` or `url` but not both
-
-`--recycle`
-: Recycle the file instead of actually deleting it
-
-`--confirm`
-: Don't prompt for confirming removing the file
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Remove the file with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo file remove --webUrl https://contoso.sharepoint.com/sites/project-x --id 0cd891ef-afce-4e55-b836-fce03286cccf
-```
-
-Remove the file with site-relative URL _SharedDocuments/Test.docx_ from located in site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo file remove --webUrl https://contoso.sharepoint.com/sites/project-x --url SharedDocuments/Test.docx
-```
-
-Move the file with server-relative URL _/sites/project-x/SharedDocuments/Test.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_ to the recycle bin
-
-```sh
-m365 spo file remove --webUrl https://contoso.sharepoint.com/sites/project-x --url /sites/project-x/SharedDocuments/Test.docx --recycle
-```
-
-Remove the page template with site-relative URL _SharedDocuments/Test.docx_ from located in site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo page template remove --webUrl https://contoso.sharepoint.com/sites/project-x --url SharedDocuments/Forms/Template.dotx
-```

package/docs/docs/cmd/spo/file/file-rename.md

@@ -1,43 +0,0 @@
-# spo file rename
-
-Renames a file
-
-## Usage
-
-```sh
-m365 spo file rename [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: The URL of the site where the file is located
-
-`-s, --sourceUrl <sourceUrl>`
-: The server- or site-relative URL of the file to rename
-
-`-t, --targetFileName <targetFileName>`
-: New file name of the file
-
-`--force`
-: If a file already exists with target file name, it will be moved to the recycle bin. If omitted, the rename operation will be canceled if a file already exists with the specified file name
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-If you try to rename a file without the `--force` flag and a file with this name already exists, the operation will be cancelled.
-
-## Examples
-
-Renames a file with server-relative URL _/Shared Documents/Test1.docx_ located in site _<https://contoso.sharepoint.com/sites/project-x>_ to _Test2.docx_
-
-```sh
-m365 spo file rename --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl '/Shared Documents/Test1.docx' --targetFileName 'Test2.docx'
-```
-
-Renames a file with server-relative URL _/Shared Documents/Test1.docx_ located in site _<https://contoso.sharepoint.com/sites/project-x>_ to _Test2.docx_. If the file with the target file name already exists, this file will be moved to the recycle bin
-
-```sh
-m365 spo file rename --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl '/Shared Documents/Test1.docx' --targetFileName 'Test2.docx' --force
-```

package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.md

@@ -1,58 +0,0 @@
-# spo file retentionlabel ensure
-
-Apply a retention label to a file
-
-## Usage
-
-```sh
-m365 spo file retentionlabel ensure [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site where the retention label from a file to apply is located
-
-`--fileUrl [fileUrl]`
-: The site- or server-relative URL of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
-
-`i, --fileId [fileId]`
-: The UniqueId (GUID) of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
-
-`--name <name>`
-: Name of the retention label to apply to the file.
-
-`-a, --assetId [assetId]`
-: A Compliance Asset Id to set on the item when it's labeled. See below for more information.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-You can also use [spo listitem retentionlabel remove](./../../../cmd/spo//listitem/listitem-retentionlabel-remove.md) for removing the retention label from a listitem.
-
-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.
-
-## Examples
-
-Applies a retention label to a file based on the label name and the fileUrl
-
-```sh
-m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/Shared Documents/Document.docx' --name 'Some label'
-```
-
-Applies a retention label to a file based on the label name and the fileId
-
-```sh
-m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --fileId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label'
-```
-
-Applies a event-based retention label to a file and updates the Asset Id field
-
-```sh
-m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --fileId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label' --assetId 'XYZ'
-```
-
-## Response
-
-The command won't return a response on success.

package/docs/docs/cmd/spo/file/file-retentionlabel-remove.md

@@ -1,43 +0,0 @@
-# spo file retentionlabel remove
-
-Clears the retention label from a file
-
-## Usage
-
-```sh
-m365 spo file retentionlabel remove [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site where the retention label from a file to remove is located
-
-`--fileUrl [fileUrl]`
-: The server- or site-relative URL of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
-
-`-i, --fileId [fileId]`
-: The UniqueId (GUID) of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
-
-`--confirm`
-: Don't prompt for confirming removing the retention label from a file
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Removes the retention label from a file in a given site based on the file id
-
-```sh
-m365 spo file retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --fileId 0cd891ef-afce-4e55-b836-fce03286cccf
-```
-
-Removes the retention label from a file in a given site based on the file url
-
-```sh
-m365 spo file retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl /sites/project-x/Shared Documents/Document.docx --id 1
-```
-
-## Response
-
-The command won't return a response on success.

package/docs/docs/cmd/spo/file/file-roleassignment-add.md

@@ -1,57 +0,0 @@
-# spo file roleassignment add
-
-Adds a role assignment to the specified file.
-
-## Usage
-
-```sh
-m365 spo file roleassignment add [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site where the file is located.
-
-`--fileUrl [fileUrl]`
-: The server- or site-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
-
-`i, --fileId [fileId]`
-: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
-
-`--principalId [principalId]`
-: The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either `upn`, `groupName`, or `principalId` but not multiple.
-
-`--upn [upn]`
-: upn/email of user to assign role to. Specify either `upn`, `groupName`, or `principalId` but not multiple.
-
-`--groupName [groupName]`
-: The group name of Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId` but not multiple.
-
-`--roleDefinitionId [roleDefinitionId]`
-: ID of role definition. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
-
-`--roleDefinitionName [roleDefinitionName]`
-: Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Adds a role assignment to a file with a specified id. It will use a principal id and a specific role definition id.
-
-```sh
-m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 11 --roleDefinitionId 1073741829
-```
-
-Adds a role assignment to a file with a specified site-relative URL for a specific upn and a role definition name.
-
-```sh
-m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "Shared Documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Full Control"
-```
-
-Adds a role assignment to a file with a specified server-relative URL the for a specific group  and a role definition name.
-
-```sh
-m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Read"
-```

package/docs/docs/cmd/spo/file/file-roleassignment-remove.md

@@ -1,54 +0,0 @@
-# spo file roleassignment remove
-
-Removes a role assignment from a file.
-
-## Usage
-
-```sh
-m365 spo file roleassignment remove [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site where the file is located.
-
-`--fileUrl [fileUrl]`
-: The server- or site-relative URL of the file. Specify either `fileUrl` or `fileId` but not both.
-
-`-i, --fileId [fileId]`
-: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
-
-`--principalId [principalId]`
-: The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, or `principalId` but not multiple.
-
-`--upn [upn]`
-: Upn/email of the user. Specify either `upn`, `groupName`, or `principalId` but not multiple.
-
-`--groupName [groupName]`
-: The group name of an Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId` but not multiple.
-
-`--confirm [confirm]`
-: Don't prompt for confirmation.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Remove a role assignment by principal id from a file by id
-
-```sh
-m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 2
-```
-
-Remove a role assignment by upn from a file by url
-
-```sh
-m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileUrl "/sites/contoso-sales/documents/Test1.docx" --upn "user1@contoso.onmicrosoft.com"
-```
-
-Remove a role assignment by group name from a file by id
-
-```sh
-m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --groupName "saleGroup"
-```

package/docs/docs/cmd/spo/file/file-roleinheritance-break.md

@@ -1,54 +0,0 @@
-# spo file roleinheritance break
-
-Breaks inheritance of a file. Keeping existing permissions is the default behavior.
-
-## Usage
-
-```sh
-m365 spo file roleinheritance break [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site where the file is located
-
-`--fileUrl [fileUrl]`
-: The server- or site-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
-
-`i, --fileId [fileId]`
-: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both
-
-`-c, --clearExistingPermissions`
-: Clear all existing permissions from the file
-
-`--confirm`
-: Don't prompt for confirmation
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Break the inheritance of a file with a specific id (UniqueId).
-
-```sh
-m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
-```
-
-Break the inheritance of a file with a specific id (UniqueId) and clear all existing permissions.
-
-```sh
-m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --clearExistingPermissions
-```
-
-Break the inheritance of a file with a specific server-relative URL.
-
-```sh
-m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx"
-```
-
-Break the inheritance of a file with a specific server-relative URL and clear all existing permissions.
-
-```sh
-m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --clearExistingPermissions
-```

package/docs/docs/cmd/spo/file/file-roleinheritance-reset.md

@@ -1,39 +0,0 @@
-# spo file roleinheritance reset
-
-Restores the role inheritance of a file
-
-## Usage
-
-```sh
-m365 spo file roleinheritance reset [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site where the file is located
-
-`--fileUrl [fileUrl]`
-: The server- or site-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
-
-`i, --fileId [fileId]`
-: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
-
-`--confirm`
-: Don't prompt for confirmation
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Reset inheritance of file with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo file roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
-```
-
-Reset inheritance of file with server-relative url _/sites/project-x/documents/Test1_.docx located in site _https://contoso.sharepoint.com/sites/project-x_. It will **not** prompt for confirmation before resetting.
-
-```sh
-m365 spo file roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --confirm
-```

package/docs/docs/cmd/spo/file/file-sharinginfo-get.md

@@ -1,36 +0,0 @@
-# spo file sharinginfo get
-
-Generates a sharing information report for the specified file
-
-## Usage
-
-```sh
-m365 spo file sharinginfo get [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: The URL of the site where the file is located
-
-`-f, --fileUrl [fileUrl]`
-: The server- or site-relative URL of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both
-
-`-i, --fileId [fileId]`
-: The UniqueId (GUID) of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Get file sharing information report for the file with server-relative url _/sites/M365CLI/Shared Documents/SharedFile.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl "/sites/M365CLI/Shared Documents/SharedFile.docx"
-```
-
-Get file sharing information report for file with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
-```

package/docs/docs/cmd/spo/file/file-sharinglink-add.md

@@ -1,89 +0,0 @@
-# spo file sharinglink add
-
-Creates a new sharing link for a file
-
-## Usage
-
-```sh
-m365 spo file sharinglink add [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: The URL of the site where the file is located.
-
-`--fileUrl [fileUrl]`
-: The server- or site-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
-
-`--fileId [fileId]`
-: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` 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` or `organization`. If not specified, the default of the organization will be used.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Creates a sharing link of a specific type for a file by id
-
-```sh
-m365 spo file sharinglink add --webUrl https://contoso.sharepoint.com --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --type view
-```
-
-Creates a sharing link of a specific type for a file by url
-
-```sh
-m365 spo file sharinglink add --webUrl https://contoso.sharepoint.com --fileUrl "/sites/demo/Shared Documents/Test1.docx" --type edit
-```
-
-Creates a sharing link of a file by url with type, scope and expirationDateTime parameter
-
-```sh
-m365 spo file sharinglink add --webUrl https://contoso.sharepoint.com --fileUrl "/sites/demo/Shared Documents/Test1.docx" --type edit --scope anonymous --expirationDateTime "2023-01-09T16:20:00Z"
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    {
-      "id": "1e581e93-609e-4077-8152-c43865db684c",
-      "roles": [
-        "read"
-      ],
-      "expirationDateTime": "2023-10-01T07:00:00Z",
-      "hasPassword": false,
-      "link": {
-        "scope": "anonymous",
-        "type": "view",
-        "webUrl": "https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBSyMcgRPtyAxqqNAeiEp1kg",
-        "preventsDownload": false
-      }
-    }
-    ```
-
-=== "Text"
-
-    ```text
-    hasPassword       : false
-    expirationDateTime: 2023-10-01T07:00:00Z
-    id                : 1e581e93-609e-4077-8152-c43865db684c
-    link              : {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBSyMcgRPtyAxqqNAeiEp1kg","preventsDownload":false}
-    roles             : ["read"]
-    ```
-
-=== "CSV"
-
-    ```csv
-    id,expirationDateTime,roles,hasPassword,link
-    1e581e93-609e-4077-8152-c43865db684c,2023-10-01T07:00:00Z,"[""read""]",,"{""scope"":""anonymous"",""type"":""view"",""webUrl"":""https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBSyMcgRPtyAxqqNAeiEp1kg"",""preventsDownload"":false}"
-    ```

package/docs/docs/cmd/spo/file/file-sharinglink-clear.md

@@ -1,46 +0,0 @@
-# spo file sharinglink clear
-
-Removes sharing links of a file
-
-## Usage
-
-```sh
-m365 spo file sharinglink clear [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: The URL of the site where the file is located.
-
-`--fileUrl [fileUrl]`
-: The server- or site-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
-
-`--fileId [fileId]`
-: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` 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.
-
-`--confirm`
-: Don't prompt for confirmation.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Removes all sharing links from a file specified by id without prompting for confirmation
-
-```sh
-m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --confirm
-```
-
-Removes sharing links of type anonymous from a file specified by url with prompting for confirmation
-
-```sh
-m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl '/sites/demo/Shared Documents/document.docx' --scope anonymous
-```
-
-## Response
-
-The command won't return a response on success.