@pnp/cli-microsoft365 6.8.0 → 6.9.0-beta.148279d

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

@@ -0,0 +1,135 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo term set list
+
+Lists taxonomy term sets from the given term group
+
+## Usage
+
+```sh
+m365 spo term set list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl [webUrl]`
+: If specified, allows you to list term sets from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
+
+`--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.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command without the --webUrl option you have to have permissions to access the tenant admin site.
+
+:::
+
+When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to list term sets from the tenant term store as well as term sets from the sitecollection term store.
+
+## 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
+```
+
+List taxonomy term sets from the specified sitecollection, from the term group with the given name.
+
+```sh
+m365 spo term set list --termGroupName PnPTermSets --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "_ObjectType_": "SP.Taxonomy.TermSet",
+      "_ObjectIdentity_": "676eb2a0-80e7-2000-3976-610eb3f5a91e|fec14c62-7c3b-481b-851b-c80d7802b224:se:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g/qydiOUnAdTKTXucEL/+pv",
+      "CreatedDate": "2019-09-03T06:41:32.110Z",
+      "Id": "8ed8c9ea-7052-4c1d-a4d7-b9c10bffea6f",
+      "LastModifiedDate": "2019-09-03T06:41:32.260Z",
+      "Name": "Department",
+      "CustomProperties": {
+        "SearchCenterNavVer": "15"
+      },
+      "CustomSortOrder": null,
+      "IsAvailableForTagging": true,
+      "Owner": "",
+      "Contact": "",
+      "Description": "",
+      "IsOpenForTermCreation": true,
+      "Names": {
+        "1033": "Department"
+      },
+      "Stakeholders": []
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Id                                    Name
+  ------------------------------------  ----------
+  8ed8c9ea-7052-4c1d-a4d7-b9c10bffea6f  Department
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  _ObjectType_,_ObjectIdentity_,CreatedDate,Id,LastModifiedDate,Name,IsAvailableForTagging,Owner,Contact,Description,IsOpenForTermCreation
+  SP.Taxonomy.TermSet,7c6eb2a0-20fe-2000-47f1-69774ac909f5|fec14c62-7c3b-481b-851b-c80d7802b224:se:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g/qydiOUnAdTKTXucEL/+pv,2019-09-03T06:41:32.110Z,8ed8c9ea-7052-4c1d-a4d7-b9c10bffea6f,2019-09-03T06:41:32.260Z,Department,1,,,,1
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo term set list --termGroupName "PnPTermSets"
+
+  Date: 5/13/2023
+
+  ## Department (8ed8c9ea-7052-4c1d-a4d7-b9c10bffea6f)
+
+  Property | Value
+  ---------|-------
+  \_ObjectType\_ | SP.Taxonomy.TermSet
+  \_ObjectIdentity\_ | 826eb2a0-405f-2000-41be-bfe56d4cdc73\|fec14c62-7c3b-481b-851b-c80d7802b224:se:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g/qydiOUnAdTKTXucEL/+pv
+  CreatedDate | 2019-09-03T06:41:32.110Z
+  Id | 8ed8c9ea-7052-4c1d-a4d7-b9c10bffea6f
+  LastModifiedDate | 2019-09-03T06:41:32.260Z
+  Name | Department
+  IsAvailableForTagging | true
+  Owner |
+  Contact |
+  Description |
+  IsOpenForTermCreation | true
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,55 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo theme apply
+
+Applies theme to the specified site
+
+## Usage
+
+```sh
+m365 spo theme apply [options]
+```
+
+## Options
+
+```md definition-list
+`-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
+```
+
+<Global />
+
+## Remarks
+
+Following standard SharePoint themes are supported by the CLI for Microsoft 365: Blue, Orange, Red, Purple, Green, Gray, Dark Yellow and Dark Blue.
+
+:::info
+
+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.mdx

@@ -0,0 +1,40 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo theme get
+
+Gets custom theme information
+
+## Usage
+
+```sh
+m365 spo theme get [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --name <name>`
+: The name of the theme to retrieve
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+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.mdx

@@ -0,0 +1,35 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo theme list
+
+Retrieves the list of custom themes
+
+## Usage
+
+```sh
+m365 spo theme list [options]
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+:::info
+
+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.mdx

@@ -0,0 +1,49 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo theme remove
+
+Removes existing theme
+
+## Usage
+
+```sh
+m365 spo theme remove [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --name <name>`
+: Name of the theme to remove
+
+`--confirm`
+: Do not prompt for confirmation before removing theme
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+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.mdx

@@ -0,0 +1,91 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo theme set
+
+Add or update a theme
+
+## Usage
+
+```sh
+m365 spo theme set [options]
+```
+
+## Options
+
+```md definition-list
+`-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
+```
+
+<Global />
+
+## 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.
+
+:::info
+
+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.mdx

@@ -0,0 +1,122 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo user ensure
+
+Ensures that a user is available on a specific site
+
+## Usage
+
+```sh
+m365 spo user ensure [options]
+```
+
+## Options
+
+```md definition-list
+`-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.
+```
+
+<Global />
+
+## 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
+
+<Tabs>
+  <TabItem value="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"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,131 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo user get
+
+Gets a site user within specific web
+
+## Usage
+
+```sh
+m365 spo user get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the web to get the user within
+
+`-i, --id [id]`
+: ID of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.
+
+`--email [email]`
+: Email of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.
+
+`--loginName [loginName]`
+: Login name of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.
+```
+
+<Global />
+
+## Examples
+
+Get user by email for a web
+
+```sh
+m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --email john.doe@mytenant.onmicrosoft.com
+```
+
+Get user with ID _6_ for a web
+
+```sh
+m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --id 6
+```
+
+Get user with login name 'i:0#.f|membership|john.doe@mytenant.onmicrosoft.com' for a web
+
+```sh
+m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --loginName "i:0#.f|membership|john.doe@mytenant.onmicrosoft.com"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "Id": 10,
+    "IsHiddenInUI": false,
+    "LoginName": "i:0#.f|membership|johndoe@contoso.onmicrosoft.com",
+    "Title": "John Doe",
+    "PrincipalType": 1,
+    "Email": "johndoe@contoso.onmicrosoft.com",
+    "Expiration": "",
+    "IsEmailAuthenticationGuestUser": false,
+    "IsShareByEmailGuestUser": false,
+    "IsSiteAdmin": false,
+    "UserId": {
+      "NameId": "100320022ec308a7",
+      "NameIdIssuer": "urn:federation:microsoftonline"
+    },
+    "UserPrincipalName": "johndoe@contoso.onmicrosoft.com"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Email                         : johndoe@contoso.onmicrosoft.com
+  Expiration                    :
+  Id                            : 10
+  IsEmailAuthenticationGuestUser: false
+  IsHiddenInUI                  : false
+  IsShareByEmailGuestUser       : false
+  IsSiteAdmin                   : false
+  LoginName                     : i:0#.f|membership|johndoe@contoso.onmicrosoft.com
+  PrincipalType                 : 1
+  Title                         : John Doe
+  UserId                        : {"NameId":"100320022ec308a7","NameIdIssuer":"urn:federation:microsoftonline"}
+  UserPrincipalName             : johndoe@contoso.onmicrosoft.com
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Id,IsHiddenInUI,LoginName,Title,PrincipalType,Email,Expiration,IsEmailAuthenticationGuestUser,IsShareByEmailGuestUser,IsSiteAdmin,UserId,UserPrincipalName
+  10,,i:0#.f|membership|johndoe@contoso.onmicrosoft.com,John Doe,1,johndoe@contoso.onmicrosoft.com,,,,,"{""NameId"":""100320022ec308a7"",""NameIdIssuer"":""urn:federation:microsoftonline""}",johndoe@contoso.onmicrosoft.com
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo user get --webUrl "https://contoso.sharepoint.com" --loginName "i:0#.f|membership|john.doe@contoso.onmicrosoft.com"
+
+  Date: 4/10/2023
+
+  ## John Doe (9)
+
+  Property | Value
+  ---------|-------
+  Id | 10
+  IsHiddenInUI | false
+  LoginName | i:0#.f\|membership\|john.doe@contoso.onmicrosoft.com
+  Title | Reshmee Auckloo
+  PrincipalType | 1
+  Email | john.doe@contoso.onmicrosoft.com
+  Expiration | 
+  IsEmailAuthenticationGuestUser | false
+  IsShareByEmailGuestUser | false
+  IsSiteAdmin | false
+  UserPrincipalName | john.doe@contoso.onmicrosoft.com
+  ```
+
+  </TabItem>
+</Tabs>
+