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

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

@@ -1,121 +0,0 @@
-# spo web list
-
-Lists subsites of the specified site
-
-## Usage
-
-```sh
-m365 spo web list [options]
-```
-
-## Options
-
-`-u, --url <url>`
-: URL of the parent site for which to retrieve the list of subsites
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Return all subsites from site _https://contoso.sharepoint.com/_
-
-```sh
-m365 spo web list --url https://contoso.sharepoint.com
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "AllowRssFeeds": true,
-        "AlternateCssUrl": "",
-        "AppInstanceId": "00000000-0000-0000-0000-000000000000",
-        "ClassicWelcomePage": null,
-        "Configuration": 0,
-        "Created": "2022-11-05T14:07:51",
-        "CurrentChangeToken": {
-          "StringValue": "1;2;b60137df-c3dc-4984-9def-8edcf7c98ab9;638032561833570000;715587227"
-        },
-        "CustomMasterUrl": "/subsite/_catalogs/masterpage/seattle.master",
-        "Description": "Subsite",
-        "DesignPackageId": "00000000-0000-0000-0000-000000000000",
-        "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled": false,
-        "EnableMinimalDownload": true,
-        "FooterEmphasis": 0,
-        "FooterEnabled": false,
-        "FooterLayout": 0,
-        "HeaderEmphasis": 0,
-        "HeaderLayout": 0,
-        "HideTitleInHeader": false,
-        "HorizontalQuickLaunch": false,
-        "Id": "b60137df-c3dc-4984-9def-8edcf7c98ab9",
-        "IsEduClass": false,
-        "IsEduClassProvisionChecked": false,
-        "IsEduClassProvisionPending": false,
-        "IsHomepageModernized": false,
-        "IsMultilingual": false,
-        "IsRevertHomepageLinkHidden": false,
-        "Language": 1033,
-        "LastItemModifiedDate": "2022-11-05T14:08:03Z",
-        "LastItemUserModifiedDate": "2022-11-05T14:08:03Z",
-        "LogoAlignment": 0,
-        "MasterUrl": "/subsite/_catalogs/masterpage/seattle.master",
-        "MegaMenuEnabled": false,
-        "NavAudienceTargetingEnabled": false,
-        "NoCrawl": false,
-        "ObjectCacheEnabled": false,
-        "OverwriteTranslationsOnChange": false,
-        "ResourcePath": {
-          "DecodedUrl": "https://contoso.sharepoint.com/subsite"
-        },
-        "QuickLaunchEnabled": true,
-        "RecycleBinEnabled": true,
-        "SearchScope": 0,
-        "ServerRelativeUrl": "/subsite",
-        "SiteLogoUrl": null,
-        "SyndicationEnabled": true,
-        "TenantAdminMembersCanShare": 0,
-        "Title": "Subsite",
-        "TreeViewEnabled": false,
-        "UIVersion": 15,
-        "UIVersionConfigurationEnabled": false,
-        "Url": "https://contoso.sharepoint.com/subsite",
-        "WebTemplate": "STS",
-        "WelcomePage": "SitePages/Home.aspx"
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    Title    Url                                      Id
-    -------  ---------------------------------------  ------------------------------------
-    Subsite  https://contoso.sharepoint.com/subsite   b60137df-c3dc-4984-9def-8edcf7c98ab9
-    ```
-
-=== "CSV"
-
-    ```csv
-    Title,Url,Id
-    Subsite,https://contoso.sharepoint.com/subsite,b60137df-c3dc-4984-9def-8edcf7c98ab9
-    ```
-
-=== "Markdown"
-
-    ```md
-    # spo web list --url "https://contoso.sharepoint.com"
-
-    Date: 4/10/2023
-
-    ## Subsite (b60137df-c3dc-4984-9def-8edcf7c98ab9)
-
-    Property | Value
-    ---------|-------
-    Id | b60137df-c3dc-4984-9def-8edcf7c98ab9
-    Title | Subsite
-    Url | https://contoso.sharepoint.com/subsite    
-    ```

package/docs/docs/cmd/spo/web/web-reindex.md

@@ -1,32 +0,0 @@
-# spo web reindex
-
-Requests reindexing the specified subsite
-
-## Usage
-
-```sh
-m365 spo web reindex [options]
-```
-
-## Options
-
-`-u, --url <url>`
-: URL of the subsite to reindex
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-If the subsite to be reindexed is a no-script site, the command will request reindexing all lists from the subsite that haven't been excluded from the search index.
-
-## Examples
-
-Request reindexing the subsite _https://contoso.sharepoint.com/subsite_
-
-```sh
-m365 spo web reindex --url https://contoso.sharepoint.com/subsite
-```
-
-## Response
-
-The command won't return a response on success.

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

@@ -1,31 +0,0 @@
-# spo web remove
-
-Delete specified subsite
-
-## Usage
-
-```sh
-m365 spo web remove [options]
-```
-
-## Options
-
-`-u, --url <url>`
-: URL of the subsite to remove
-
-`--confirm`
-: Do not prompt for confirmation before deleting the subsite
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Delete subsite without prompting for confirmation
-
-```sh
-m365 spo web remove --url https://contoso.sharepoint.com/subsite --confirm
-```
-
-## Response
-
-The command won't return a response on success.

package/docs/docs/cmd/spo/web/web-retentionlabel-list.md

@@ -1,101 +0,0 @@
-# spo web retentionlabel list
-
-Get a list of retention labels that are available on a site.
-
-## Usage
-
-```sh
-m365 spo web retentionlabel list [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Get a list of retention labels for the _Sales_ site
-
-```sh
-m365 spo web retentionlabel list --webUrl 'https://contoso.sharepoint.com/sites/sales'
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "AcceptMessagesOnlyFromSendersOrMembers": false,
-        "AccessType": null,
-        "AllowAccessFromUnmanagedDevice": null,
-        "AutoDelete": true,
-        "BlockDelete": true,
-        "BlockEdit": false,
-        "ComplianceFlags": 1,
-        "ContainsSiteLabel": false,
-        "DisplayName": "",
-        "EncryptionRMSTemplateId": null,
-        "HasRetentionAction": true,
-        "IsEventTag": false,
-        "MultiStageReviewerEmail": null,
-        "NextStageComplianceTag": null,
-        "Notes": null,
-        "RequireSenderAuthenticationEnabled": false,
-        "ReviewerEmail": null,
-        "SharingCapabilities": null,
-        "SuperLock": false,
-        "TagDuration": 2555,
-        "TagId": "def61080-111c-4aea-b72f-5b60e516e36c",
-        "TagName": "Some label",
-        "TagRetentionBasedOn": "CreationAgeInDays",
-        "UnlockedAsDefault": false
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    TagId                                 TagName
-    ------------------------------------  --------------
-    def61080-111c-4aea-b72f-5b60e516e36c  Some label
-    ```
-
-=== "CSV"
-
-    ```csv
-    AcceptMessagesOnlyFromSendersOrMembers,AutoDelete,BlockDelete,BlockEdit,ComplianceFlags,ContainsSiteLabel,DisplayName,HasRetentionAction,IsEventTag,RequireSenderAuthenticationEnabled,SuperLock,TagDuration,TagId,TagName,TagRetentionBasedOn,UnlockedAsDefault
-    ,1,1,,1,,,1,,,,2555,def61080-111c-4aea-b72f-5b60e516e36c,Some label,CreationAgeInDays,
-    ```
-    
-=== "Markdown"
-
-    ```md
-    # spo web retentionlabel list --webUrl "https://contoso.sharepoint.com/sites/sales"
-
-    Date: 4/11/2023
-
-    Property | Value
-    ---------|-------
-    AcceptMessagesOnlyFromSendersOrMembers | false
-    AutoDelete | true
-    BlockDelete | true
-    BlockEdit | false
-    ComplianceFlags | 1
-    ContainsSiteLabel | false
-    DisplayName | 
-    HasRetentionAction | true
-    IsEventTag | false
-    RequireSenderAuthenticationEnabled | false
-    SuperLock | false
-    TagDuration | 2555
-    TagId | def61080-111c-4aea-b72f-5b60e516e36c
-    TagName | Some Label
-    TagRetentionBasedOn | CreationAgeInDays
-    UnlockedAsDefault | false
-    ```

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

@@ -1,61 +0,0 @@
-# spo web roleassignment add
-
-Adds a role assignment to web permissions.
-
-## Usage
-
-```sh
-m365 spo web roleassignment add [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site.
-
-`--principalId [principalId]`
-: SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
-
-`--upn [upn]`
-: upn/email of user to assign role to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
-
-`--groupName [groupName]`
-: enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` 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
-
-add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition id _1073741829_
-
-```sh
-m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --principalId 11 --roleDefinitionId 1073741829
-```
-
-add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for upn _someaccount@tenant.onmicrosoft.com_ and role definition id _1073741829_
-
-```sh
-m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --upn "someaccount@tenant.onmicrosoft.com" --roleDefinitionId 1073741829
-```
-
-add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for group _someGroup_ and role definition id _1073741829_
-
-```sh
-m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --groupName "someGroup" --roleDefinitionId 1073741829
-```
-
-add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition name _Full Control_
-
-```sh
-m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --principalId 11 --roleDefinitionName "Full Control"
-```
-
-## Response
-
-The command won't return a response on success.

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

@@ -1,58 +0,0 @@
-# spo web roleassignment remove
-
-Removes a role assignment from web permissions.
-
-## Usage
-
-```sh
-m365 spo web roleassignment remove [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site.
-
-`--principalId [principalId]`
-: SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
-
-`--upn [upn]`
-: Upn/email of user to assign role to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
-
-`--groupName [groupName]`
-: Enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` but not multiple.
-
-`--confirm [confirm]`
-: Don't prompt for confirming removing the roleassignment.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Remove roleassignment from web based on group name
-
-```sh
-m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --groupName "saleGroup"
-```
-
-Remove roleassignment from web based on principal Id
-
-```sh
-m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --principalId 2
-```
-
-Remove roleassignment from web based on upn
-
-```sh
-m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --upn "someaccount@tenant.onmicrosoft.com"
-```
-
-Remove roleassignment from web based on principal Id without prompting for confirmation
-
-```sh
-m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --principalId 2 --confirm
-```
-
-## Response
-
-The command won't return a response on success.

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

@@ -1,44 +0,0 @@
-# spo web roleinheritance break
-
-Break role inheritance of subsite
-
-## Usage
-
-```sh
-m365 spo web roleinheritance break [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site.
-
-`-c, --clearExistingPermissions`
-: Clears all existing permissions from the web.
-
-`--confirm`
-: Don't prompt for confirmation.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-By default, when breaking permissions inheritance, the web will retain existing permissions. To remove existing permissions, use the `--clearExistingPermissions` option.
-
-## Examples
-
-Break role inheritance of a web and keep the existing permissions
-
-```sh
-m365 spo web roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x
-```
-
-Break role inheritance of a web and clear the existing permissions
-
-```sh
-m365 spo web roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --clearExistingPermissions
-```
-
-## Response
-
-The command won't return a response on success.

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

@@ -1,37 +0,0 @@
-# spo web roleinheritance reset
-
-Restores role inheritance of subsite.
-
-## Usage
-
-```sh
-m365 spo web roleinheritance reset [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site
-
-`--confirm`
-: Do not prompt for confirmation before resetting role inheritance.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Restore role inheritance of subsite _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo web roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x
-```
-
-Restore role inheritance of subsite _https://contoso.sharepoint.com/sites/project-x_ without prompting for confirmation
-
-```sh
-m365 spo web roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --confirm
-```
-
-## Response
-
-The command won't return a response on success.

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

@@ -1,117 +0,0 @@
-# spo web set
-
-Updates subsite properties
-
-## Usage
-
-```sh
-m365 spo web set [options]
-```
-
-## Options
-
-`-u, --url <url>`
-: URL of the subsite to update
-
-`-t, --title [title]`
-: New title for the subsite
-
-`-d, --description [description]`
-: New description for the subsite
-
-`--siteLogoUrl [siteLogoUrl]`
-: New site logo URL for the subsite. Set to empty string to reset to default.
-
-`--quickLaunchEnabled [quickLaunchEnabled]`
-: Set to `true` to enable quick launch and to `false` to disable it
-
-`--headerLayout [headerLayout]`
-: Configures the site header. Allowed values `standard,compact`
-
-`--headerEmphasis [headerEmphasis]`
-: Configures the site header background. Allowed values `0,1,2,3`
-
-`--megaMenuEnabled [megaMenuEnabled]`
-: Set to `true` to change the menu style to megamenu. Set to `false` to use the cascading menu style
-
-`--footerEnabled [footerEnabled]`
-: Set to `true` to enable footer and to `false` to disable it
-
-`--navAudienceTargetingEnabled [navAudienceTargetingEnabled]`
-: Enable or disable site navigation audience targeting. Allowed values: `true` or `false`.
-
-`--searchScope [searchScope]`
-: Search scope to set in the site. Allowed values `DefaultScope,Tenant,Hub,Site`
-
-`--welcomePage [welcomePage]`
-: Site-relative URL of the welcome page for the site
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-Next to updating web properties corresponding to the options of this command, you can update the value of any other web property using its CSOM name, eg. `--AllowAutomaticASPXPageIndexing`. At this moment, the CLI supports properties of types `Boolean`, `String` and `Int32`.
-
-## Examples
-
-Update subsite title
-
-```sh
-m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --title Team-a
-```
-
-Hide quick launch on the subsite
-
-```sh
-m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --quickLaunchEnabled false
-```
-
-Set site header layout to compact
-
-```sh
-m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --headerLayout compact
-```
-
-Set site header color to primary theme background color
-
-```sh
-m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --headerEmphasis 0
-```
-
-Enable megamenu in the site
-
-```sh
-m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --megaMenuEnabled true
-```
-
-Hide footer in the site
-
-```sh
-m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --footerEnabled false
-```
-
-Enable navigation audience targetting in the site
-
-```sh
-m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --navAudienceTargetingEnabled true
-```
-
-Set search scope to tenant scope
-
-```sh
-m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --searchScope tenant
-```
-
-Set welcome page for the web
-
-```sh
-m365 spo web set  --url https://contoso.sharepoint.com/sites/team-a --welcomePage "SitePages/new-home.aspx"
-```
-
-## Response
-
-The command won't return a response on success.
-
-## More information
-
-- Web properties: [https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee545886(v=office.15)](https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee545886(v=office.15))

package/docs/docs/cmd/status.md

@@ -1,71 +0,0 @@
-# status
-
-Shows Microsoft 365 login status
-
-## Usage
-
-```sh
-m365 status [options]
-```
-
-## Options
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-If you are logged in to Microsoft 365, the `status` command will show you information about the user or application name used to sign in and the details about the stored refresh and access tokens and their expiration date and time when run in debug mode.
-
-## Examples
-
-Show the information about the current login to the Microsoft 365
-
-```sh
-m365 status
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    {
-      "connectedAs": "john.doe@contoso.onmicrosoft.com",
-      "authType": "DeviceCode",
-      "appId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
-      "appTenant": "common"
-    }
-    ```
-
-=== "Text"
-
-    ```text
-    appId      : 31359c7f-bd7e-475c-86db-fdb8c937548e
-    appTenant  : common
-    authType   : DeviceCode
-    connectedAs: john.doe@contoso.onmicrosoft.com
-    ```
-
-=== "CSV"
-
-    ```csv
-    connectedAs,authType,appId,appTenant
-    john.doe@contoso.onmicrosoft.com,DeviceCode,31359c7f-bd7e-475c-86db-fdb8c937548e,common
-    ```
-
-=== "Markdown"
-
-    ```md
-    # status
-
-    Date: 7/2/2023
-
-
-
-    Property | Value
-    ---------|-------
-    connectedAs | john.doe@contoso.onmicrosoft.com
-    authType | DeviceCode
-    appId | 31359c7f-bd7e-475c-86db-fdb8c937548e
-    appTenant | common
-    ```