@pnp/cli-microsoft365 6.2.0-beta.7b9fc77 → 6.2.0-beta.97d58e0

package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md

@@ -0,0 +1,99 @@
+# pp aibuildermodel get
+
+Gets a specific AI builder models in the specified Power Platform environment
+
+## Usage
+
+```sh
+pp aibuildermodel get [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment
+
+`-i, --id [id]`
+: The id of the AI Builder model. Specify either `id` or `name` but not both
+
+`-n, --name [name]`
+: The name of the AI Builder model. Specify either `id` or `name` but not both
+
+`--asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get an AI Builder model in a specific environment
+
+```sh
+m365 pp aibuildermodel get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "Document Processing 11/29/2022, 12:58:43 PM"
+```
+
+Get an AI Builder models in a specific environment by id as admin
+
+```sh
+m365 pp aibuildermodel get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "08ffffbe-ec1c-4e64-b64b-dd1db926c613" --asAdmin
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "statecode": 0,
+      "_msdyn_templateid_value": "10707e4e-1d56-e911-8194-000d3a6cd5a5",
+      "msdyn_modelcreationcontext": "{}",
+      "createdon": "2022-11-29T11:58:45Z",
+      "_ownerid_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "modifiedon": "2022-11-29T11:58:45Z",
+      "msdyn_sharewithorganizationoncreate": false,
+      "msdyn_aimodelidunique": "b0328b67-47e2-4202-8189-e617ec9a88bd",
+      "solutionid": "fd140aae-4df4-11dd-bd17-0019b9312238",
+      "ismanaged": false,
+      "versionnumber": 1458121,
+      "msdyn_name": "Document Processing 11/29/2022, 12:58:43 PM",
+      "introducedversion": "1.0",
+      "statuscode": 0,
+      "_modifiedby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "overwritetime": "1900-01-01T00:00:00Z",
+      "componentstate": 0,
+      "_createdby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "_owningbusinessunit_value": "6da087c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "_owninguser_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "msdyn_aimodelid": "08ffffbe-ec1c-4e64-b64b-dd1db926c613",
+      "_msdyn_activerunconfigurationid_value": null,
+      "overriddencreatedon": null,
+      "_msdyn_retrainworkflowid_value": null,
+      "importsequencenumber": null,
+      "_msdyn_scheduleinferenceworkflowid_value": null,
+      "_modifiedonbehalfby_value": null,
+      "utcconversiontimezonecode": null,
+      "_createdonbehalfby_value": null,
+      "_owningteam_value": null,
+      "timezoneruleversionnumber": null,
+      "iscustomizable": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "iscustomizableanddeletable"
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdon             modifiedon            msdyn_aimodelid                       msdyn_name
+    --------------------  --------------------  ------------------------------------  -------------------------------------------
+    2022-10-25T14:44:48Z  2022-10-25T14:44:48Z  08ffffbe-ec1c-4e64-b64b-dd1db926c613  Document Processing 11/29/2022, 12:58:43 PM
+    ```
+
+=== "CSV"
+
+    ```csv
+    msdyn_name,msdyn_aimodelid,createdon,modifiedon
+    "Document Processing 11/29/2022, 12:58:43 PM",08ffffbe-ec1c-4e64-b64b-dd1db926c613,2022-11-29T11:58:45Z,2022-11-29T11:58:45Z
+    ```

package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-remove.md

@@ -0,0 +1,53 @@
+# pp aibuildermodel remove
+
+Removes the specified Microsoft Power Platform aibuildermodel in the specified Power Platform environment
+
+## Usage
+
+```sh
+m365 pp aibuildermodel remove [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i, --id [id]`
+: The id of the AI builder model. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The name of the AI builder model. Specify either `id` or `name` but not both.
+
+`--asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes the AI builder model owned by the currently signed-in user based on the name parameter
+
+```sh
+m365 pp aibuildermodel remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "AI Builder Model Name"
+```
+
+Removes the AI builder model owned by the currently signed-in user based on the name parameter without confirmation
+
+```sh
+m365 pp aibuildermodel remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "AI Builder Model Name" --confirm
+```
+
+Removes the AI builder model owned by another user based on the id parameter
+
+```sh
+m365 pp aibuildermodel remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e  --asAdmin
+```
+
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/pp/solution/solution-publish.md

@@ -0,0 +1,52 @@
+# pp solution publish
+
+Publishes the components of a solution in a given Power Platform environment
+
+## Usage
+
+```sh
+m365 pp solution publish [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i, --id [id]`
+: The id of the solution. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The unique name (not the display name) of the solution. Specify either `id` or `name` but not both.
+
+`--asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+`--wait`
+: Wait for the job to complete
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Publishes the components of a specified solution with a specific name, owned by the currently signed-in user
+
+```sh
+m365 pp solution publish --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Solution Name"
+```
+
+Publishes the components of a specified solution owned by the currently signed-in user based on the id parameter and waits for completion
+
+```sh
+m365 pp solution publish --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 00000001-0000-0000-0001-00000000009b --wait
+```
+
+Publishes the components of a specified solution owned by another user based on the name parameter
+
+```sh
+m365 pp solution publish --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Solution Name" --asAdmin
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md

@@ -0,0 +1,128 @@
+# purview retentionlabel add
+
+Create a retention label
+
+## Usage
+
+```sh
+m365 purview retentionlabel add [options]
+```
+
+## Options
+
+`-n, --displayName <displayName>`
+: The display name of the label.
+
+`--behaviorDuringRetentionPeriod <behaviorDuringRetentionPeriod>`
+: Specifies how the behavior of a document with this label should be during the retention period. Allowed values: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`.
+
+`--actionAfterRetentionPeriod <actionAfterRetentionPeriod>`
+: Specifies the action to take on a document with this label applied after the retention period. Allowed values: `none`, `delete`, `startDispositionReview`.
+
+`--retentionDuration <retentionDuration>`
+: The number of days to retain the content.
+
+`-t, --retentionTrigger [retentionTrigger]`
+: Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. Allowed values: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`. Defaults to `dateLabeled`.
+
+`--defaultRecordBehavior [defaultRecordBehavior]`
+: Specifies the locked or unlocked state of a record label when it is created. Allowed values: `startLocked`, `startUnlocked`, Defaults to `startLocked`.
+
+`--descriptionForUsers [descriptionForUsers]`
+: The label information for the user.
+
+`--descriptionForAdmins [descriptionForAdmins]`
+: The label information for the admin.
+
+`--labelToBeApplied [labelToBeApplied]`
+: Specifies the replacement label to be applied automatically after the retention period of the current label ends.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Create a retention label that retains documents and deletes them after one year.
+
+```sh
+m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retain --actionAfterRetentionPeriod delete --retentionDuration 365
+```
+
+Create a retention label that retains documents as records and does not take any action one year after the last modification date.
+
+```sh
+m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retainAsRecord --actionAfterRetentionPeriod none --retentionDuration 365 --retentionTrigger dateModified
+```
+
+## Remarks
+
+!!! attention
+    This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+## More information
+
+- Create retentionLabel: [https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http](https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http)
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "displayName": "some label",
+      "descriptionForAdmins": "Description for admins",
+      "descriptionForUsers": "Description for users",
+      "isInUse": false,
+      "retentionTrigger": "dateLabeled",
+      "behaviorDuringRetentionPeriod": "retain",
+      "actionAfterRetentionPeriod": "delete",
+      "createdDateTime": "2022-12-21T09:28:37Z",
+      "lastModifiedDateTime": "2022-12-21T09:28:37Z",
+      "labelToBeApplied": "another label",
+      "defaultRecordBehavior": "startLocked",
+      "id": "f7e05955-210b-4a8e-a5de-3c64cfa6d9be",
+      "retentionDuration": {
+        "days": 365
+      },
+      "createdBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      },
+      "lastModifiedBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      },
+      "dispositionReviewStages": []
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    actionAfterRetentionPeriod   : delete
+    behaviorDuringRetentionPeriod: retain
+    createdBy                    : {"user":{"id":null,"displayName":"John Doe"}}
+    createdDateTime              : 2022-12-21T09:32:38Z
+    defaultRecordBehavior        : startLocked
+    descriptionForAdmins         : Description for admins
+    descriptionForUsers          : Description for users
+    displayName                  : some label
+    dispositionReviewStages      : []
+    id                           : 3b388f3c-541b-4696-ad0e-83f960695d89
+    isInUse                      : false
+    labelToBeApplied             : another label
+    lastModifiedBy               : {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedDateTime         : 2022-12-21T09:32:38Z
+    retentionDuration            : {"days":365}
+    retentionTrigger             : dateLabeled
+    ```
+
+=== "CSV"
+
+    ```csv
+    displayName,descriptionForAdmins,descriptionForUsers,isInUse,retentionTrigger,behaviorDuringRetentionPeriod,actionAfterRetentionPeriod,createdDateTime,lastModifiedDateTime,labelToBeApplied,defaultRecordBehavior,id,retentionDuration,createdBy,lastModifiedBy,dispositionReviewStages
+    some label,Description for admins,Description for users,,dateLabeled,retain,delete,2022-12-21T09:33:32Z,2022-12-21T09:33:32Z,another label,startLocked,cfc8b132-7aef-45f4-9fcf-3c199090ba2a,"{""days"":365}","{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}",[]
+    ```

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

@@ -38,4 +38,4 @@ m365 spo cdn get --type Private
 
 ## More information
 
-- General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
+- Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)

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

@@ -35,4 +35,4 @@ m365 spo cdn origin add --type Public --origin */CDN
 
 ## More information
 
-- General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
+- Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)

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

@@ -38,4 +38,4 @@ m365 spo cdn origin list --type Private
 
 ## More information
 
-- General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
+- Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)

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

@@ -38,4 +38,4 @@ m365 spo cdn origin remove --type Public --origin */CDN
 
 ## More information
 
-- General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
+- Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)

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

@@ -38,4 +38,4 @@ m365 spo cdn policy list --cdnType Private
 
 ## More information
 
-- General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
+- Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)

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

@@ -38,4 +38,4 @@ m365 spo cdn policy set --cdnType Public --policy IncludeFileExtensions --value
 
 ## More information
 
-- General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
+- Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)

package/docs/docs/cmd/spo/cdn/cdn-set.md

@@ -66,4 +66,4 @@ m365 spo cdn set --type Both --enabled true --noDefaultOrigins
 
 ## More information
 
-- General availability of Microsoft 365 CDN: [https://dev.office.com/blogs/general-availability-of-office-365-cdn](https://dev.office.com/blogs/general-availability-of-office-365-cdn)
+- Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)

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

@@ -0,0 +1,47 @@
+# 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 retentionlabel 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.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+You can also use [spo listitem retentionlabel remove](./../../../cmd/spo//listitem/listitem-retentionlabel-remove.md) for removing the retentionlabel from a listitem.
+
+## 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'
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,43 @@
+# 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 retentionlabel from a file to remove is located
+
+`--fileUrl [fileUrl]`
+: The site- or server 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-sharinglink-add.md

@@ -0,0 +1,89 @@
+# 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-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}"
+    ```