@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.3b4f31c

package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md

@@ -1,69 +0,0 @@
-# spo contenttype field remove
-
-Removes a column from a site- or list content type
-
-## Usage
-
-```sh
-m365 spo contenttype field remove [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: Absolute URL of the site where the content type is located
-
-`-l, --listTitle [listTitle]`
-: Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
-
-`--listId [listId]`
-: ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
-
-`--listUrl [listUrl]`
-: Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
-
-`-i, --contentTypeId <contentTypeId>`
-: The ID of the content type to remove the column from
-
-`-f, --fieldLinkId <fieldLinkId>`
-: The ID of the column to remove
-
-`-c, --updateChildContentTypes`
-: Update child content types
-
-`--confirm`
-: Don't prompt for confirming removal of a column from content type
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Remove column with a specific ID from a content type with a specific ID from a specific site.
-
-```sh
-m365 spo contenttype field remove  --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --confirm
-```
-
-Remove column with a specific ID from a content type with a specific ID from a specific site and updating the child content types
-
-```sh
-m365 spo contenttype field remove  --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --updateChildContentTypes
-```
-
-Remove fieldLink with a specific ID from a list (obtained by Title) content type with a specific ID on a spefici site.
-
-```sh
-m365 spo contenttype field remove  --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listTitle "Documents"
-```
-
-Remove fieldLink with a specific ID from a list (obtained by ID) content type with a specific ID on a spefici site.
-
-```sh
-m365 spo contenttype field remove  --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listId "8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c"
-```
-
-Remove fieldLink with a specific ID from a list (obtained by URL) content type with a specific ID on a spefici site.
-
-```sh
-m365 spo contenttype field remove  --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listUrl "/shared documents"
-```

package/docs/docs/cmd/spo/contenttype/contenttype-field-set.md

@@ -1,52 +0,0 @@
-# spo contenttype field set
-
-Adds or updates a site column reference in a site content type
-
-## Usage
-
-```sh
-m365 spo contenttype field set [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: Absolute URL of the site where the content type is located
-
-`-c, --contentTypeId <contentTypeId>`
-: ID of the content type on which the field reference should be set
-
-`-f, --id <id>`
-: ID of the field to which the reference should be set
-
-`-r, --required [required]`
-: Set to `true`, if the field should be required or to `false` if it should be optional
-
-`--hidden [hidden]`
-: Set to `true`, if the field should be hidden or to `false` if it should be visible
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-If the field reference already exists, the command will update its _required_ and _hidden_ properties as specified in the command.
-
-## Examples
-
-Add the specified site column to the specified content type as an optional and visible field
-
-```sh
-m365 spo contenttype field set --webUrl https://contoso.sharepoint.com/sites/portal --contentTypeId 0x01007926A45D687BA842B947286090B8F67D --id ebe7e498-44ff-43da-a7e5-99b444f656a5
-```
-
-Add the specified site column to the specified content type as a required field
-
-```sh
-m365 spo contenttype field set --webUrl https://contoso.sharepoint.com/sites/portal --contentTypeId 0x01007926A45D687BA842B947286090B8F67D --id ebe7e498-44ff-43da-a7e5-99b444f656a5 --required true
-```
-
-Update the existing site column reference in the specified content type to optional
-
-```sh
-m365 spo contenttype field set --webUrl https://contoso.sharepoint.com/sites/portal --contentTypeId 0x01007926A45D687BA842B947286090B8F67D --id ebe7e498-44ff-43da-a7e5-99b444f656a5 --required false
-```

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

@@ -1,67 +0,0 @@
-# spo contenttype get
-
-Retrieves information about the specified list or site content type
-
-## Usage
-
-```sh
-m365 spo contenttype get [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: Absolute URL of the site where the content type is located
-
-`-l, --listTitle [listTitle]`
-: Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
-
-`--listId [listId]`
-: ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
-
-`--listUrl [listUrl]`
-: Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
-
-`-i, --id [id]`
-: The ID of the content type to retrieve. Specify either id or name but not both
-
-`-n, --name [name]`
-: The name of the content type to retrieve. Specify either id or name but not both
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-If no content type with the specified is found in the site or the list, you will get the _Content type with ID 0x010012 not found_ error.
-
-## Examples
-
-Retrieve site content type by id
-
-```sh
-m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --id 0x0100558D85B7216F6A489A499DB361E1AE2F
-```
-
-Retrieve site content type by name
-
-```sh
-m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'Document'
-```
-
-Retrieve list (retrieved by Title) content type 
-
-```sh
-m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 0x0100558D85B7216F6A489A499DB361E1AE2F
-```
-
-Retrieve list (retrieved by ID) content type 
-
-```sh
-m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
-```
-
-Retrieve list (retrieved by URL) content type 
-
-```sh
-m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
-```

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

@@ -1,33 +0,0 @@
-# spo contenttype list
-
-Lists content types from specified site
-
-## Usage
-
-```sh
-m365 spo contenttype list [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: Absolute URL of the site for which to list content types
-
-`-c, --category [category]`
-: Category name of content types. When defined will return only content types from specified category
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Retrieve site content types
-
-```PowerShell
-m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"
-```
-
-Retrieve site content types from the 'List Content Types' category
-
-```PowerShell
-m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --category "List Content Types"
-```

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

@@ -1,51 +0,0 @@
-# spo contenttype remove
-
-Deletes site content type
-
-## Usage
-
-```sh
-m365 spo contenttype remove [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: Absolute URL of the site where the content type is located
-
-`-i, --id [id]`
-: The ID of the content type to remove
-
-`-n, --name [name]`
-: The name of the content type to remove
-
-`--confirm`
-: Don't prompt for confirming removal of the content type
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-If the specified content type is in use by a list and cannot be removed, you will be returned the error: _Another site or list is still using this content type._ SharePoint will not allow a content type to be removed unless any dependent objects are also emptied from the recycle bin including the second-stage recycle bin.
-
-The content type you wish to remove can be selected by the ID or Name of the content type. Either ID or Name parameter must be specified.
-
-## Examples
-
-Remove a site content type by ID
-
-```sh
-m365 spo contenttype remove --id "0x01007926A45D687BA842B947286090B8F67D" --webUrl https://contoso.sharepoint.com
-```
-
-Remove a site content type by Name
-
-```sh
-m365 spo contenttype remove --name "My Content Type" --webUrl https://contoso.sharepoint.com --confirm
-```
-
-Remove a site content type without prompting for confirmation
-
-```sh
-m365 spo contenttype remove --name "My Content Type" --webUrl https://contoso.sharepoint.com --confirm
-```

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

@@ -1,59 +0,0 @@
-# spo contenttype set
-
-Updates an existing content type
-
-## Usage
-
-```sh
-m365 spo contenttype set [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site where the content type to update is defined.
-
-`-i, --id [id]`
-: ID of the content type to update. Specify `id` or `name` but not both, one is required.
-
-`-n, --name [name]`
-: Name of the content type to update. Specify the `id` or the `name` but not both, one is required.
-
-`--listTitle [listTitle]`
-: Title of the list if you want to update a list content type. Specify either `listTitle`, `listId` or `listUrl`.
-
-`--listId [listId]`
-: ID of the list if you want to update a list content type. Specify either `listTitle`, `listId` or `listUrl`.
-
-`--listUrl [listUrl]`
-: URL of the list if you want to update a list content type. Specify either `listTitle`, `listId` or `listUrl`.
-
-`--updateChildren`
-: Specify if you want to push updates to child content types.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important "Updating child content types"
-    When specifying the `--updateChildren` flag, SharePoint will only propagate the changes that are made in the current request. If you want to know more about updating a content type and propagating changes to child content types, be sure to [read more here](https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ms442695(v=office.14)#considerations-when-updating-child-content-types). 
-
-## Examples
-
-Move site content type to a different group
-
-```sh
-m365 spo contenttype set --id 0x001001 --webUrl https://contoso.sharepoint.com --Group "My group"
-```
-
-Rename list content type
-
-```sh
-m365 spo contenttype set --name "My old item" --webUrl https://contoso.sharepoint.com --listTitle "My list" --Name "My item"
-```
-
-Configure a form customizer with manifest ID _19890cce-15d8-4af9-bfcb-72da06d13ed8_ on a site content type and push changes to child content types.
-
-```sh
-m365 spo contenttype set --name "My content type" --webUrl https://contoso.sharepoint.com --DisplayFormClientSideComponentId "19890cce-15d8-4af9-bfcb-72da06d13ed8" --EditFormClientSideComponentId "19890cce-15d8-4af9-bfcb-72da06d13ed8" --NewFormClientSideComponentId "19890cce-15d8-4af9-bfcb-72da06d13ed8" --updateChildren
-```

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

@@ -1,21 +0,0 @@
-# spo contenttypehub get
-
-Returns the URL of the SharePoint Content Type Hub of the Tenant
-
-## Usage
-
-```sh
-m365 spo contenttypehub get [options]
-```
-
-## Options
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-  
-Retrieve the Content Type Hub URL
-
-```sh
-m365 spo contenttypehub get
-```

package/docs/docs/cmd/spo/customaction/customaction-add.md

@@ -1,139 +0,0 @@
-# spo customaction add
-
-Adds a user custom action for site or site collection
-
-## Usage
-
-```sh
-m365 spo customaction add [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: Url of the site or site collection to add the custom action
-
-`-n, --name <name>`
-: The name of the custom action
-
-`-t, --title <title>`
-: The title of the custom action
-
-`-l, --location <location>`
-: The actual location where this custom action need to be added like `CommandUI.Ribbon`
-
-`-g, --group [group]`
-: The group where this custom action needs to be added like `SiteActions`
-
-`-d, --description [description]`
-: The description of the custom action
-
-`--sequence [sequence]`
-: Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page
-
-`--actionUrl [actionUrl]`
-: The URL, URI or JavaScript function associated with the action. URL example `~site/_layouts/sampleurl.aspx` or `~sitecollection/_layouts/sampleurl.aspx`
-
-`--imageUrl [imageUrl]`
-: The URL of the image associated with the custom action
-
-`-e, --commandUIExtension [commandUIExtension]`
-: XML fragment that determines user interface properties of the custom action
-
-`--registrationId [registrationId]`
-: Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier
-
-`--registrationType [registrationType]`
-: Specifies the type of object associated with the custom action. Allowed values `None,List,ContentType,ProgId,FileType`. Default `None`
-
-`--rights [rights]`
-: A case sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask,ViewListItems,AddListItems,EditListItems,DeleteListItems,ApproveItems,OpenItems,ViewVersions,DeleteVersions,CancelCheckout,ManagePersonalViews,ManageLists,ViewFormPages,AnonymousSearchAccessList,Open,ViewPages,AddAndCustomizePages,ApplyThemeAndBorder,ApplyStyleSheets,ViewUsageData,CreateSSCSite,ManageSubwebs,CreateGroups,ManagePermissions,BrowseDirectories,BrowseUserInfo,AddDelPrivateWebParts,UpdatePersonalWebParts,ManageWeb,AnonymousSearchAccessWebLists,UseClientIntegration,UseRemoteAPIs,ManageAlerts,CreateAlerts,EditMyUserInfo,EnumeratePermissions,FullMask`. Default `EmptyMask`
-
-`-s, --scope [scope]`
-: Scope of the custom action. Allowed values `Site,Web`. Default `Web`
-
-`--scriptBlock [scriptBlock]`
-: Specifies a block of script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink
-
-`--scriptSrc [scriptSrc]`
-: Specifies a file that contains script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink
-
-`-c, --clientSideComponentId [clientSideComponentId]`
-: The Client Side Component Id (GUID) of the custom action
-
-`-p, --clientSideComponentProperties [clientSideComponentProperties]`
-: The Client Side Component Properties of the custom action. Specify values as a JSON string : `'{"testMessage":"Test message"}'`
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treats quotes differently. For example, this is how ApplicationCustomizer user custom action can be created from the Windows cmd.exe:
-
-```sh
-m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --name "YourName" --location "ClientSideExtension.ApplicationCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
-```
-
-Note, how the clientSideComponentProperties option (-p) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
-
-The `--rights` option accepts **case sensitive** values.
-
-!!! warning "Escaping JSON in PowerShell"
-    When using the `--clientSideComponentProperties` 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.
-
-## Examples
-
-Adds tenant-wide SharePoint Framework Application Customizer extension in site _https://contoso.sharepoint.com/sites/test_
-
-```sh
-m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --name "YourName" --location "ClientSideExtension.ApplicationCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{"testMessage":"Test message"}'
-```
-
-Adds tenant-wide SharePoint Framework **modern List View** Command Set extension in site _https://contoso.sharepoint.com/sites/test_
-
-```sh
-m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourCommandSet" --name "YourName" --location "ClientSideExtension.ListViewCommandSet" --clientSideComponentId db3e6e35-363c-42b9-a254-ca661e437848 --clientSideComponentProperties '{"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}' --registrationId 100 --registrationType List
-```
-
-Creates url custom action in the SiteActions menu in site _https://contoso.sharepoint.com/sites/test_
-
-```sh
-m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "Microsoft.SharePoint.StandardMenu" --group "SiteActions" --actionUrl "~site/SitePages/Home.aspx" --sequence 100
-```
-
-Creates custom action in **classic** Document Library edit context menu in site _https://contoso.sharepoint.com/sites/test_
-
-```sh
-m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "EditControlBlock" --actionUrl "javascript:(function(){ return console.log('CLI for Microsoft 365 rocks!'); })();" --registrationId 101 --registrationType List
-```
-
-Creates ScriptLink custom action with script source in **classic pages** in site collection _https://contoso.sharepoint.com/sites/test_
-
-```sh
-m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "ScriptLink" --scriptSrc "~sitecollection/SiteAssets/YourScript.js" --sequence 101 --scope Site
-```
-
-Creates ScriptLink custom action with script block in **classic pages** in site _https://contoso.sharepoint.com/sites/test_
-
-```sh
-m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "ScriptLink" --scriptBlock "(function(){ return console.log('Hello CLI for Microsoft 365!'); })();" --sequence 102
-```
-
-Creates **classic List View** custom action located in the Ribbon in site _https://contoso.sharepoint.com/sites/test_
-
-```sh
-m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "CommandUI.Ribbon" --commandUIExtension '<CommandUIExtension><CommandUIDefinitions><CommandUIDefinition Location="Ribbon.List.Share.Controls._children"><Button Id="Ribbon.List.Share.GetItemsCountButton" Alt="Get list items count" Sequence="11" Command="Invoke_GetItemsCountButtonRequest" LabelText="Get Items Count" TemplateAlias="o1" Image32by32="_layouts/15/images/placeholder32x32.png" Image16by16="_layouts/15/images/placeholder16x16.png" /></CommandUIDefinition></CommandUIDefinitions><CommandUIHandlers><CommandUIHandler Command="Invoke_GetItemsCountButtonRequest" CommandAction="javascript: alert(ctx.TotalListItems);" EnabledScript="javascript: function checkEnable() { return (true);} checkEnable();"/></CommandUIHandlers></CommandUIExtension>'
-```
-
-Creates custom action with delegated rights in the SiteActions menu in site _https://contoso.sharepoint.com/sites/test_
-
-```sh
-m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "Microsoft.SharePoint.StandardMenu" --group "SiteActions" --actionUrl "~site/SitePages/Home.aspx" --rights "AddListItems,DeleteListItems,ManageLists"
-```
-
-## More information
-
-- UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction)
-- UserCustomAction Locations and Group IDs: [https://msdn.microsoft.com/en-us/library/office/bb802730.aspx](https://msdn.microsoft.com/en-us/library/office/bb802730.aspx)
-- UserCustomAction Element: [https://msdn.microsoft.com/en-us/library/office/ms460194.aspx](https://msdn.microsoft.com/en-us/library/office/ms460194.aspx)
-- UserCustomAction Rights: [https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.spbasepermissions.aspx](https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.spbasepermissions.aspx)

package/docs/docs/cmd/spo/customaction/customaction-clear.md

@@ -1,43 +0,0 @@
-# spo customaction clear
-
-Deletes all custom actions from site or site collection
-
-## Usage
-
-```sh
-m365 spo customaction clear [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: Url of the site or site collection to clear the custom actions from
-
-`-s, --scope [scope]`
-: Scope of the custom action. Allowed values `Site,Web,All`. Default `All`
-
-`--confirm`
-: Don't prompt for confirming removing all custom actions
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Clears all user custom actions for both site and site collection _https://contoso.sharepoint.com/sites/test_.
-Skips the confirmation prompt message.
-
-```sh
-m365 spo customaction clear --webUrl https://contoso.sharepoint.com/sites/test --confirm
-```
-
-Clears all user custom actions for site _https://contoso.sharepoint.com/sites/test_. 
-
-```sh
-m365 spo customaction clear --webUrl https://contoso.sharepoint.com/sites/test --scope Web
-```
-
-Clears all user custom actions for site collection _https://contoso.sharepoint.com/sites/test_
-
-```sh
-m365 spo customaction clear --webUrl https://contoso.sharepoint.com/sites/test --scope Site
-```