@pnp/cli-microsoft365 6.8.0-beta.f473be5 → 6.9.0-beta.1cd2525

package/docs/docs/cmd/spo/term/term-list.md

@@ -1,182 +0,0 @@
-# spo term list
-
-Lists taxonomy terms from the given term set
-
-## Usage
-
-```sh
-m365 spo term list [options]
-```
-
-## Options
-
-`--termGroupId [termGroupId]`
-: ID of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both
-
-`--termGroupName [termGroupName]`
-: Name of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both
-
-`--termSetId [termSetId]`
-: ID of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both
-
-`--termSetName [termSetName]`
-: Name of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both
-
-`--includeChildTerms`
-: If specified, child terms are loaded as well.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
-## Examples
-
-List taxonomy terms from the term group and term set with the given name
-
-```sh
-m365 spo term list --termGroupName PnPTermSets --termSetName PnP-Organizations
-```
-
-List taxonomy terms from the term group and term set with the given ID
-
-```sh
-m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec
-```
-
-List taxonomy terms from the term group and term set with the given ID including child terms if any are found
-
-```sh
-m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec --includeChildTerms
-```
-
-## Response
-
-### Standard response
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "_ObjectType_": "SP.Taxonomy.Term",
-        "_ObjectIdentity_": "430486a0-200a-6000-02cc-2eb89d8dd424|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNsaKRf7N4K0qppo4zwLIRZg==",
-        "CreatedDate": "2021-10-12T09:42:44.880Z",
-        "Id": "7f91a2b1-78b3-4a2b-a9a6-8e33c0b21166",
-        "LastModifiedDate": "2021-10-12T09:42:45.237Z",
-        "Name": "Departments",
-        "CustomProperties": {},
-        "CustomSortOrder": null,
-        "IsAvailableForTagging": true,
-        "Owner": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
-        "Description": "",
-        "IsDeprecated": false,
-        "IsKeyword": false,
-        "IsPinned": false,
-        "IsPinnedRoot": false,
-        "IsReused": false,
-        "IsRoot": true,
-        "IsSourceTerm": true,
-        "LocalCustomProperties": {
-          "Id": "termDepartments"
-        },
-        "MergedTermIds": [],
-        "PathOfTerm": "Departments",
-        "TermsCount": 1
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    Id                                    Name      
-    ------------------------------------  ---------
-    c387e91c-b553-4b92-886b-9af717cd73b0  Financing
-    ```
-
-=== "CSV"
-
-    ```csv
-    Id,Name
-    c387e91c-b553-4b92-886b-9af717cd73b0,Financing
-    ```
-
-### `includeChildTerms` response
-
-When we make use of the option `includeChildTerms` the response will differ. 
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "_ObjectType_": "SP.Taxonomy.Term",
-        "_ObjectIdentity_": "430486a0-200a-6000-02cc-2eb89d8dd424|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNsaKRf7N4K0qppo4zwLIRZg==",
-        "CreatedDate": "2021-10-12T09:42:44.880Z",
-        "Id": "7f91a2b1-78b3-4a2b-a9a6-8e33c0b21166",
-        "LastModifiedDate": "2021-10-12T09:42:45.237Z",
-        "Name": "Departments",
-        "CustomProperties": {},
-        "CustomSortOrder": null,
-        "IsAvailableForTagging": true,
-        "Owner": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
-        "Description": "",
-        "IsDeprecated": false,
-        "IsKeyword": false,
-        "IsPinned": false,
-        "IsPinnedRoot": false,
-        "IsReused": false,
-        "IsRoot": true,
-        "IsSourceTerm": true,
-        "LocalCustomProperties": {
-          "Id": "termDepartments"
-        },
-        "MergedTermIds": [],
-        "PathOfTerm": "Departments",
-        "TermsCount": 1,
-        "Children": [{
-          "_ObjectType_": "SP.Taxonomy.Term",
-          "_ObjectIdentity_": "d10486a0-4067-5000-de97-bf1ab5bff53c|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNf5ybB0mfG0Kx6YO5CODZ1A==",
-          "CreatedDate": "2022-12-25T23:59:15.200Z",
-          "Id": "079b9c7f-9f49-421b-b1e9-83b908e0d9d4",
-          "LastModifiedDate": "2022-12-25T23:59:15.200Z",
-          "Name": "Financing",
-          "CustomProperties": {},
-          "CustomSortOrder": null,
-          "IsAvailableForTagging": true,
-          "Owner": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
-          "Description": "",
-          "IsDeprecated": false,
-          "IsKeyword": false,
-          "IsPinned": false,
-          "IsPinnedRoot": false,
-          "IsReused": false,
-          "IsRoot": false,
-          "IsSourceTerm": true,
-          "LocalCustomProperties": {},
-          "MergedTermIds": [],
-          "PathOfTerm": "Departments;Financing",
-          "TermsCount": 0
-        }]
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    Id                                    Name       ParentTermId
-    ------------------------------------  ---------  ------------------------------------
-    c387e91c-b553-4b92-886b-9af717cd73b0  Financing  079b9c7f-9f49-421b-b1e9-83b908e0d9d4
-    ```
-
-=== "CSV"
-
-    ```csv
-    Id,Name,ParentTermId
-    c387e91c-b553-4b92-886b-9af717cd73b0,Financing,079b9c7f-9f49-421b-b1e9-83b908e0d9d4
-    ```
-

package/docs/docs/cmd/spo/term/term-set-add.md

@@ -1,65 +0,0 @@
-# spo term set add
-
-Adds taxonomy term set
-
-## Usage
-
-```sh
-m365 spo term set add [options]
-```
-
-## Options
-
-`-n, --name <name>`
-: Name of the term set to add
-
-`--termGroupId [termGroupId]`
-: ID of the term group in which to create the term set. Specify `termGroupId` or `termGroupName` but not both
-
-`--termGroupName [termGroupName]`
-: Name of the term group in which to create the term set. Specify `termGroupId` or `termGroupName` but not both
-
-`-i, --id [id]`
-: ID of the term set to add
-
-`-d, --description [description]`
-: Description of the term set to add
-
-`--customProperties [customProperties]`
-: JSON string with key-value pairs representing custom properties to set on the term set
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! warning "Escaping JSON in PowerShell"
-    When using the `--customProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
-## Examples
-
-Add taxonomy term set to the term group specified by ID
-
-```sh
-m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb
-```
-
-Add taxonomy term set to the term group specified by name. Create the term set with the specified ID
-
-```sh
-m365 spo term set add --name PnP-Organizations --termGroupName PnPTermSets --id aa70ede6-83d1-466d-8d95-30d29e9bbd7c
-```
-
-Add taxonomy term set and set its description
-
-```sh
-m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --description 'Contains a list of organizations'
-```
-
-Add taxonomy term set and set its custom properties
-
-```sh
-m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --customProperties '{"Property":"Value"}'
-```

package/docs/docs/cmd/spo/term/term-set-get.md

@@ -1,44 +0,0 @@
-# spo term set get
-
-Gets information about the specified taxonomy term set
-
-## Usage
-
-```sh
-m365 spo term set get [options]
-```
-
-## Options
-
-`-i, --id [id]`
-: ID of the term set to retrieve. Specify `name` or `id` but not both
-
-`-n, --name [name]`
-: Name of the term set to retrieve. Specify `name` or `id` but not both
-
-`--termGroupId [termGroupId]`
-: ID of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both
-
-`--termGroupName [termGroupName]`
-: Name of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
-## Examples
-
-Get information about a taxonomy term set using its ID
-
-```sh
-m365 spo term set get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termGroupName PnPTermSets
-```
-
-Get information about a taxonomy term set using its name
-
-```sh
-m365 spo term set get --name PnPTermSets --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb
-```

package/docs/docs/cmd/spo/term/term-set-list.md

@@ -1,38 +0,0 @@
-# spo term set list
-
-Lists taxonomy term sets from the given term group
-
-## Usage
-
-```sh
-m365 spo term set list [options]
-```
-
-## Options
-
-`--termGroupId [termGroupId]`
-: ID of the term group from which to retrieve term sets. Specify `termGroupName` or `termGroupId` but not both
-
-`--termGroupName [termGroupName]`
-: Name of the term group from which to retrieve term sets. Specify `termGroupName` or `termGroupId` but not both
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
-## Examples
-
-List taxonomy term sets from the term group with the given name
-
-```sh
-m365 spo term set list --termGroupName PnPTermSets
-```
-
-List taxonomy term sets from the term group with the given ID
-
-```sh
-m365 spo term set list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb
-```

package/docs/docs/cmd/spo/theme/theme-apply.md

@@ -1,48 +0,0 @@
-# spo theme apply
-
-Applies theme to the specified site
-
-## Usage
-
-```sh
-m365 spo theme apply [options]
-```
-
-## Options
-
-`-n, --name <name>`
-: Name of the theme to apply
-
-`-u, --webUrl <webUrl>`
-: URL of the site to which the theme should be applied
-
-`--sharePointTheme`
-: Set to specify if the supplied theme name is a standard SharePoint theme
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-Following standard SharePoint themes are supported by the CLI for Microsoft 365: Blue, Orange, Red, Purple, Green, Gray, Dark Yellow and Dark Blue.
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-    
-## Examples
-
-Apply theme to the specified site
-
-```sh
-m365 spo theme apply --name Contoso-Blue --webUrl https://contoso.sharepoint.com/sites/project-x
-```
-
-Apply a standard SharePoint theme to the specified site
-
-```sh
-m365 spo theme apply --name Blue --webUrl https://contoso.sharepoint.com/sites/project-x --sharePointTheme
-```
-
-## More information
-
-- SharePoint site theming: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview)
-- Theme Generator: [https://aka.ms/themedesigner](https://aka.ms/themedesigner)

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

@@ -1,33 +0,0 @@
-# spo theme get
-
-Gets custom theme information
-
-## Usage
-
-```sh
-m365 spo theme get [options]
-```
-
-## Options
-
-`-n, --name <name>`
-: The name of the theme to retrieve
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
-## Examples
-
-Get information about a theme
-
-```sh
-m365 spo theme get --name Contoso-Blue
-```
-
-## More information
-
-- SharePoint site theming: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview)

package/docs/docs/cmd/spo/theme/theme-list.md

@@ -1,30 +0,0 @@
-# spo theme list
-
-Retrieves the list of custom themes
-
-## Usage
-
-```sh
-m365 spo theme list [options]
-```
-
-## Options
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
-## Examples
-
-List available themes
-
-```sh
-m365 spo theme list
-```
-
-## More information
-
-- SharePoint site theming: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview)

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

@@ -1,42 +0,0 @@
-# spo theme remove
-
-Removes existing theme
-
-## Usage
-
-```sh
-m365 spo theme remove [options]
-```
-
-## Options
-
-`-n, --name <name>`
-: Name of the theme to remove
-
-`--confirm`
-: Do not prompt for confirmation before removing theme
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
-## Examples
-
-Remove theme. Will prompt for confirmation before removing the theme
-
-```sh
-m365 spo theme remove --name Contoso-Blue
-```
-
-Remove theme without prompting for confirmation
-
-```sh
-m365 spo theme remove --name Contoso-Blue --confirm
-```
-
-## More information
-
-- SharePoint site theming: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview)

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

@@ -1,84 +0,0 @@
-# spo theme set
-
-Add or update a theme
-
-## Usage
-
-```sh
-m365 spo theme set [options]
-```
-
-## Options
-
-`-n, --name <name>`
-: Name of the theme to add or update
-
-`-t, --theme <theme>`
-: Theme JSON contents
-
-`--isInverted`
-: Set to specify that the theme is inverted
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-To prevent the accidental creation of invalid themes the CLI for Microsoft 365 implements a set of checks. These checks are executed against the provided json file. A valid theme JSON file is as follows:
-
-```json
-{
-  "themePrimary": "#d81e05",
-  "themeLighterAlt": "#fdf5f4",
-  "themeLighter": "#f9d6d2",
-  "themeLight": "#f4b4ac",
-  "themeTertiary": "#e87060",
-  "themeSecondary": "#dd351e",
-  "themeDarkAlt": "#c31a04",
-  "themeDark": "#a51603",
-  "themeDarker": "#791002",
-  "neutralLighterAlt": "#eeeeee",
-  "neutralLighter": "#f5f5f5",
-  "neutralLight": "#e1e1e1",
-  "neutralQuaternaryAlt": "#d1d1d1",
-  "neutralQuaternary": "#c8c8c8",
-  "neutralTertiaryAlt": "#c0c0c0",
-  "neutralTertiary": "#c2c2c2",
-  "neutralSecondary": "#858585",
-  "neutralPrimaryAlt": "#4b4b4b",
-  "neutralPrimary": "#333333",
-  "neutralDark": "#272727",
-  "black": "#1d1d1d",
-  "white": "#f5f5f5"
-}
-```
-
-When executing the `m365 spo theme set` command the following checks are executed:
-
-- Validate if the provided theme is a valid `JSON` string.
-- Validate if the provided theme, once deserialized, contains all properties of the sample above.
-- Validate if the provided theme, once deserialized, contains only the properties of the sample above.
-- Validate if each of the properties contains a valid hex color value prefixed with a `#`.
-
-If any of these checks fails you are presented with a `The specified theme is not valid` error.
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-    
-## Examples
-
-Add or update a theme from a theme JSON file
-
-```sh
-m365 spo theme set --name Contoso-Blue --theme @/Users/rjesh/themes/contoso-blue.json
-```
-
-Add or update an inverted theme from a theme JSON file
-
-```sh
-m365 spo theme set --name Contoso-Blue --theme @/Users/rjesh/themes/contoso-blue.json --isInverted
-```
-
-## More information
-
-- SharePoint site theming: [https://docs.microsoft.com/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview](https://docs.microsoft.com/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview)
-- Theme Generator: [https://aka.ms/themedesigner](https://aka.ms/themedesigner)

package/docs/docs/cmd/spo/user/user-ensure.md

@@ -1,108 +0,0 @@
-# spo user ensure
-
-Ensures that a user is available on a specific site
-
-## Usage
-
-```sh
-m365 spo user ensure [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: Absolute URL of the site.
-
-`--aadId [--aadId]`
-: Id of the user in Azure AD. Specify either `aadId` or `userName` but not both.
-
-`--userName [userName]`
-: User's UPN (user principal name, e.g. john@contoso.com). Specify either `aadId` or `userName` but not both.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Ensures a user by its Azure AD Id
-
-```sh
-m365 spo user ensure --webUrl https://contoso.sharepoint.com/sites/project --aadId e254750a-eaa4-44f6-9517-b74f65cdb747
-```
-
-Ensures a user by its user principal name
-
-```sh
-m365 spo user ensure --webUrl https://contoso.sharepoint.com/sites/project --userName john@contoso.com
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    {
-      "Id": 35,
-      "IsHiddenInUI": false,
-      "LoginName": "i:0#.f|membership|john@contoso.com",
-      "Title": "John Doe",
-      "PrincipalType": 1,
-      "Email": "john@contoso.com",
-      "Expiration": "",
-      "IsEmailAuthenticationGuestUser": false,
-      "IsShareByEmailGuestUser": false,
-      "IsSiteAdmin": false,
-      "UserId": {
-        "NameId": "1003200274f51d2d",
-        "NameIdIssuer": "urn:federation:microsoftonline"
-      },
-      "UserPrincipalName": "john@contoso.com"
-    }
-    ```
-
-=== "Text"
-
-    ```text
-    Email                         : john@contoso.com
-    Expiration                    :
-    Id                            : 35
-    IsEmailAuthenticationGuestUser: false
-    IsHiddenInUI                  : false
-    IsShareByEmailGuestUser       : false
-    IsSiteAdmin                   : false
-    LoginName                     : i:0#.f|membership|john@contoso.com
-    PrincipalType                 : 1
-    Title                         : John Doe
-    UserId                        : {"NameId":"1003200274f51d2d","NameIdIssuer":"urn:federation:microsoftonline"}
-    UserPrincipalName             : john@contoso.com
-    ```
-
-=== "CSV"
-
-    ```csv
-    Id,IsHiddenInUI,LoginName,Title,PrincipalType,Email,Expiration,IsEmailAuthenticationGuestUser,IsShareByEmailGuestUser,IsSiteAdmin,UserId,UserPrincipalName
-    35,,i:0#.f|membership|john@contoso.com,John Doe,1,john@contoso.com,,,,,"{""NameId"":""100320009d80e5de"",""NameIdIssuer"":""urn:federation:microsoftonline""}",john@contoso.com
-    ```
-
-=== "Markdown"
-
-    ```md
-    # spo user ensure --webUrl "https://contoso.sharepoint.com" --userName "john@contoso.com"
-
-    Date: 18/02/2023
-
-    ## John Doe (35)
-
-    Property | Value
-    ---------|-------
-    Id | 35
-    IsHiddenInUI | false
-    LoginName | i:0#.f\|membership\|john@contoso.com
-    Title | John Doe
-    PrincipalType | 1
-    Email | john@contoso.com
-    Expiration |
-    IsEmailAuthenticationGuestUser | false
-    IsShareByEmailGuestUser | false
-    IsSiteAdmin | false
-    UserPrincipalName | john@contoso.com
-    ```