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

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

@@ -1,143 +0,0 @@
-# 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.
-
-`--eventTypeId [eventTypeId]`
-: The Id of the event type that is used to in case of an event-based label. Specify when using retentionTrigger with the value `dateOfEvent`. Specify either `eventTypeId` or `eventTypeName`, but not both.
-
-`--eventTypeName [eventTypeName]`
-:	The display name of the event type that is used to in case of an event-based label. Specify when using retentionTrigger with the value `dateOfEvent`. Specify either `eventTypeId` or `eventTypeName`, but not both.
-
---8<-- "docs/cmd/_global.md"
-
-## 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.
-
-!!! attention
-    This command currently only supports delegated permissions.
-
-## 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
-```
-
-Create an event-based retention label that retains documents as records and deletes them one year after a _Contract Expiry_ event date.
-
-```sh
-m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retain --actionAfterRetentionPeriod delete --retentionDuration 365 --retentionTrigger dateOfEvent --eventTypeName "Contract Expiry"
-```
-
-## 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""}}",[]
-    ```
-
-## 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)

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

@@ -1,97 +0,0 @@
-# purview retentionlabel get
-
-Get a retention label
-
-## Usage
-
-```sh
-m365 purview retentionlabel get [options]
-```
-
-## Options
-
-`-i, --id <id>`
-: The Id of the retention label.
-
---8<-- "docs/cmd/_global.md"
-
-## 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.
-
-!!! attention
-    This command currently only supports delegated permissions.
-
-## Examples
-
-Get a retention label
-
-```sh
-m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    {
-      "displayName": "TEST LABEL",
-      "descriptionForAdmins": "",
-      "descriptionForUsers": "",
-      "isInUse": false,
-      "retentionTrigger": "dateCreated",
-      "behaviorDuringRetentionPeriod": "retain",
-      "actionAfterRetentionPeriod": "delete",
-      "createdDateTime": "2022-12-12T15:14:53Z",
-      "lastModifiedDateTime": "2022-12-12T15:43:06Z",
-      "labelToBeApplied": "",
-      "defaultRecordBehavior": "startLocked",
-      "id": "5c8af2e2-b489-4fa0-9c16-180180245ac8",
-      "retentionDuration": {
-        "days": 100
-      },
-      "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-12T15:14:53Z
-    defaultRecordBehavior        : startLocked
-    descriptionForAdmins         :
-    descriptionForUsers          :
-    displayName                  : TEST LABEL
-    dispositionReviewStages      : []
-    id                           : 5c8af2e2-b489-4fa0-9c16-180180245ac8
-    isInUse                      : false
-    labelToBeApplied             :
-    lastModifiedBy               : {"user":{"id":null,"displayName":"John Doe"}}
-    lastModifiedDateTime         : 2022-12-12T15:43:06Z
-    retentionDuration            : {"days":100}
-    retentionTrigger             : dateCreated
-    ```
-
-=== "CSV"
-
-    ```csv
-    displayName,descriptionForAdmins,descriptionForUsers,isInUse,retentionTrigger,behaviorDuringRetentionPeriod,actionAfterRetentionPeriod,createdDateTime,lastModifiedDateTime,labelToBeApplied,defaultRecordBehavior,id,retentionDuration,createdBy,lastModifiedBy,dispositionReviewStages
-    TEST LABEL,,,,dateCreated,retain,delete,2022-12-12T15:14:53Z,2022-12-12T15:43:06Z,,startLocked,5c8af2e2-b489-4fa0-9c16-180180245ac8,"{""days"":100}","{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}",[]
-    ```

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

@@ -1,83 +0,0 @@
-# purview retentionlabel list
-
-Get a list of retention labels
-
-## Usage
-
-```sh
-m365 purview retentionlabel list [options]
-```
-
-## Options
-
---8<-- "docs/cmd/_global.md"
-
-## 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.
-
-!!! attention
-    This command currently only supports delegated permissions.
-
-## Examples
-
-Get a list of retention labels
-
-```sh
-m365 purview retentionlabel list
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "displayName": "Some label",
-        "descriptionForAdmins": "",
-        "descriptionForUsers": null,
-        "isInUse": true,
-        "retentionTrigger": "dateCreated",
-        "behaviorDuringRetentionPeriod": "retainAsRecord",
-        "actionAfterRetentionPeriod": "delete",
-        "createdDateTime": "2022-11-03T10:28:15Z",
-        "lastModifiedDateTime": "2022-11-03T10:28:15Z",
-        "labelToBeApplied": null,
-        "defaultRecordBehavior": "startLocked",
-        "id": "dc67203a-6cca-4066-b501-903401308f98",
-        "retentionDuration": {
-          "days": 365
-        },
-        "createdBy": {
-          "user": {
-            "id": "b52ffd35-d6fe-4b70-86d8-91cc01d76333",
-            "displayName": null
-          }
-        },
-        "lastModifiedBy": {
-          "user": {
-            "id": "b52ffd35-d6fe-4b70-86d8-91cc01d76333",
-            "displayName": null
-          }
-        },
-        "dispositionReviewStages": []
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    id                                    displayName     isInUse
-    ------------------------------------  --------------  --------
-    dc67203a-6cca-4066-b501-903401308f98  Some label      true
-    ```
-
-=== "CSV"
-
-    ```csv
-    id,displayName,isInUse
-    dc67203a-6cca-4066-b501-903401308f98,Some label,true
-    ```

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

@@ -1,39 +0,0 @@
-# purview retentionlabel remove
-
-Delete a retention label
-
-## Usage
-
-```sh
-m365 purview retentionlabel remove [options]
-```
-
-## Options
-
-`-i, --id <id>`
-: The Id of the retention label.
-
-`--confirm`
-: Don't prompt for confirming to remove the label.
-
---8<-- "docs/cmd/_global.md"
-
-## 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.
-
-!!! attention
-    This command currently only supports delegated permissions.
-
-## Examples
-
-Delete a retention label
-
-```sh
-m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
-```
-
-## Response
-
-The command won't return a response on success.

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

@@ -1,66 +0,0 @@
-# purview retentionlabel set
-
-Update a retention label
-
-## Usage
-
-```sh
-m365 purview retentionlabel set [options]
-```
-
-## Options
-
-`-i, --id <id>`
-: The Id of the retention 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`.
-
-`--defaultRecordBehavior [defaultRecordBehavior]`
-: Specifies the locked or unlocked state of a record label when it is created. Allowed values: `startLocked`, `startUnlocked`.
-
-`--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"
-
-## 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.
-
-!!! attention
-    This command currently only supports delegated permissions.
-
-## Examples
-
-Update a retention label so that it retains documents as records and deletes them after one year.
-
-```sh
-m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --behaviorDuringRetentionPeriod retainAsRecord --actionAfterRetentionPeriod delete --retentionDuration 365
-```
-
-Update a retention label so that it retains documents as regulatory records and starts a disposition review one year after the last modification date.
-
-```sh
-m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --behaviorDuringRetentionPeriod retainAsRegulatoryRecord --actionAfterRetentionPeriod startDispositionReview --retentionDuration 365 --retentionTrigger dateModified
-```
-
-## Response
-
-The command won't return a response on success.

package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.md

@@ -1,118 +0,0 @@
-# purview sensitivitylabel get
-
-Retrieve the specified sensitivity label
-
-## Usage
-
-```sh
-m365 purview sensitivitylabel get [options]
-```
-
-## Options
-
-`-i, --id <id>`
-: The Id of the sensitivity label.
-
-`--userId [userId]`
-: User's Azure AD ID. Optionally specify this if you want to get a list of sensitivity labels that the user has access to. Specify either `userId` or `userName` but not both.
-
-`--userName [userName]`
-: User's UPN (user principal name, e.g. johndoe@example.com). Optionally specify this if you want to get a list of sensitivity labels that the user has access to. Specify either `userId` or `userName` but not both.
-
---8<-- "docs/cmd/_global.md"
-
-## 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.
-
-!!! attention
-    When operating in app-only mode, you have the option to use either the `userName` or `userId` parameters to retrieve the sensitivity policy settings for a specific user. Without specifying either of these parameters, the command will retrieve the sensitivity policy settings for the currently authenticated user when operating in delegated mode.
-
-
-## Examples
-
-Get a sensitivity label
-
-```sh
-m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e
-```
-
-Get a sensitivity label that a specific user has access to by its Id
-
-```sh
-m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e --userId 59f80e08-24b1-41f8-8586-16765fd830d3
-```
-
-Get a sensitivity label that a specific user has access to by its UPN
-
-```sh
-m365 purview sensitivitylabel get --id 6f4fb2db-ecf4-4279-94ba-23d059bf157e --userName john.doe@contoso.com
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    {
-      "id": "6f4fb2db-ecf4-4279-94ba-23d059bf157e",
-      "name": "Unrestricted",
-      "description": "",
-      "color": "",
-      "sensitivity": 0,
-      "tooltip": "Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.",
-      "isActive": true,
-      "isAppliable": true,
-      "contentFormats": [
-        "file",
-        "email"
-      ],
-      "hasProtection": false
-    }
-    ```
-
-=== "Text"
-
-    ```text
-    color         :
-    contentFormats: ["file","email"]
-    description   :
-    hasProtection : false
-    id            : 6f4fb2db-ecf4-4279-94ba-23d059bf157e
-    isActive      : true
-    isAppliable   : true
-    name          : Unrestricted
-    sensitivity   : 0
-    tooltip       : Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.
-    ```
-
-=== "CSV"
-
-    ```csv
-    id,name,description,color,sensitivity,tooltip,isActive,isAppliable,contentFormats,hasProtection
-    6f4fb2db-ecf4-4279-94ba-23d059bf157e,Unrestricted,,,0,"Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.",1,1,"[""file"",""email""]",
-    ```
-
-=== "Markdown"
-
-    ```md
-    # purview sensitivitylabel get --id "6f4fb2db-ecf4-4279-94ba-23d059bf157e"
-
-    Date: 3/25/2023
-
-    ## Unrestricted (6f4fb2db-ecf4-4279-94ba-23d059bf157e)
-
-    Property | Value
-    ---------|-------
-    id | 6f4fb2db-ecf4-4279-94ba-23d059bf157e
-    name | Unrestricted
-    description |
-    color |
-    sensitivity | 0
-    tooltip | Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.
-    isActive | true
-    isAppliable | true
-    contentFormats | ["file","email"]
-    hasProtection | false
-    ```

package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.md

@@ -1,111 +0,0 @@
-# purview sensitivitylabel list
-
-Get a list of sensitivity labels
-
-## Usage
-
-```sh
-m365 purview sensitivitylabel list [options]
-```
-
-## Options
-
-`--userId [userId]`
-: User's Azure AD ID. Optionally specify this if you want to get a list of sensitivity labels that the user has access to. Specify either `userId` or `userName` but not both.
-
-`--userName [userName]`
-: User's UPN (user principal name, e.g. johndoe@example.com). Optionally specify this if you want to get a list of sensitivity labels that the user has access to. Specify either `userId` or `userName` but not both.
-
---8<-- "docs/cmd/_global.md"
-
-## 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.
-
-!!! attention
-    When operating in app-only mode, you have the option to use either the `userName` or `userId` parameters to retrieve the sensitivity label for a specific user. Without specifying either of these parameters, the command will retrieve the sensitivity label for the currently authenticated user when operating in delegated mode.
-
-## Examples
-
-Get a list of sensitivity labels
-
-```sh
-m365 purview sensitivitylabel list
-```
-
-Get a list of sensitivity labels that a specific user has access to by its Id
-
-```sh
-m365 purview sensitivitylabel list --userId 59f80e08-24b1-41f8-8586-16765fd830d3
-```
-
-Get a list of sensitivity labels that a specific user has access to by its UPN
-
-```sh
-m365 purview sensitivitylabel list --userName john.doe@contoso.com
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "id": "6f4fb2db-ecf4-4279-94ba-23d059bf157e",
-        "name": "Unrestricted",
-        "description": "",
-        "color": "",
-        "sensitivity": 0,
-        "tooltip": "Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.",
-        "isActive": true,
-        "isAppliable": true,
-        "contentFormats": [
-          "file",
-          "email"
-        ],
-        "hasProtection": false,
-        "parent": null
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    id                                    name                   isActive
-    ------------------------------------  ---------------------  --------
-    6f4fb2db-ecf4-4279-94ba-23d059bf157e  Unrestricted           true
-    ```
-
-=== "CSV"
-
-    ```csv
-    id,name,isActive
-    6f4fb2db-ecf4-4279-94ba-23d059bf157e,Unrestricted,1
-    ```
-
-=== "Markdown"
-
-    ```md
-    # purview sensitivitylabel list
-
-    Date: 3/26/2023
-
-    ## Unrestricted (6f4fb2db-ecf4-4279-94ba-23d059bf157e)
-
-    Property | Value
-    ---------|-------
-    id | 6f4fb2db-ecf4-4279-94ba-23d059bf157e
-    name | Unrestricted
-    description |
-    color |
-    sensitivity | 0
-    tooltip | Information either intended for general distribution, or which would not have any impact on the organization if it were to be distributed.
-    isActive | true
-    isAppliable | true
-    contentFormats | ["file","email"]
-    hasProtection | false
-    parent | null
-    ```