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

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

@@ -0,0 +1,36 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo storageentity get
+
+Get details for the specified tenant property
+
+## Usage
+
+```sh
+m365 spo storageentity get [options]
+```
+
+## Options
+
+```md defintion-list
+`-k, --key <key>`
+: Name of the tenant property to retrieve
+```
+
+<Global />
+
+## Remarks
+
+Tenant properties are stored in the app catalog site associated with the site to which you are currently connected. When retrieving the specified tenant property, SharePoint will automatically find the associated app catalog and try to retrieve the property from it.
+
+## Examples
+
+Show the value, description and comment of the _AnalyticsId_ tenant property
+
+```sh
+m365 spo storageentity get -k AnalyticsId
+```
+
+## More information
+
+- SharePoint Framework Tenant Properties: [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-properties](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-properties)

package/docs/docs/cmd/spo/storageentity/storageentity-list.mdx

@@ -0,0 +1,36 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo storageentity list
+
+Lists tenant properties stored on the specified SharePoint Online app catalog
+
+## Usage
+
+```sh
+m365 spo storageentity list [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --appCatalogUrl <appCatalogUrl>`
+: URL of the app catalog site
+```
+
+<Global />
+
+## Remarks
+
+Tenant properties are stored in the app catalog site. To list all tenant properties, you have to specify the absolute URL of the app catalog site. If you specify an incorrect URL, or the site at the given URL is not an app catalog site, no properties will be retrieved.
+
+## Examples
+
+List all tenant properties stored in the _https://contoso.sharepoint.com/sites/appcatalog_ app catalog site
+
+```sh
+m365 spo storageentity list -u https://contoso.sharepoint.com/sites/appcatalog
+```
+
+## More information
+
+- SharePoint Framework Tenant Properties: [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-properties](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-properties)

package/docs/docs/cmd/spo/storageentity/storageentity-remove.mdx

@@ -0,0 +1,54 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo storageentity remove
+
+Removes tenant property stored on the specified SharePoint Online app catalog
+
+## Usage
+
+```sh
+m365 spo storageentity remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --appCatalogUrl <appCatalogUrl>`
+: URL of the app catalog site
+
+`-k, --key <key>`
+: Name of the tenant property to retrieve
+
+`--confirm`
+: Don't prompt for confirming removal of a tenant property
+```
+
+<Global />
+
+## Remarks
+
+Tenant properties are stored in the app catalog site associated with that tenant. To remove a property, you have to specify the absolute URL of the app catalog site. If you specify the URL of a site different than the app catalog, you will get an access denied error.
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+    
+## Examples
+
+Remove the _AnalyticsId_ tenant property. Yields a confirmation prompt before actually removing the property
+
+```sh
+m365 spo storageentity remove -k AnalyticsId -u https://contoso.sharepoint.com/sites/appcatalog
+```
+
+Remove the _AnalyticsId_ tenant property. Suppresses the confirmation prompt
+
+```sh
+m365 spo storageentity remove -k AnalyticsId --confirm -u https://contoso.sharepoint.com/sites/appcatalog
+```
+
+## More information
+
+- SharePoint Framework Tenant Properties: [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-properties](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-properties)

package/docs/docs/cmd/spo/storageentity/storageentity-set.mdx

@@ -0,0 +1,56 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo storageentity set
+
+Sets tenant property on the specified SharePoint Online app catalog
+
+## Usage
+
+```sh
+m365 spo storageentity set [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --appCatalogUrl <appCatalogUrl>`
+: URL of the app catalog site
+
+`-k, --key <key>`
+: Name of the tenant property to retrieve
+
+`-v, --value <value>`
+: Value to set for the property
+
+`-d, --description [description]`
+: Description to set for the property (optional)
+
+`-c, --comment [comment]`
+: Comment to set for the property (optional)
+```
+
+<Global />
+
+## Remarks
+
+Tenant properties are stored in the app catalog site associated with that tenant. To set a property, you have to specify the absolute URL of the app catalog site without a trailing slash. If you specify the URL with trailing slash you get the error `The managed path sites/apps is not a managed path in this tenant.`
+
+If you specify the URL of a site different than the app catalog, you will get an access denied error.
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+
+## Examples
+
+Set _123_ as the value of the _AnalyticsId_ tenant property. Also include a description and a comment for additional clarification of the usage of the property.
+
+```sh
+m365 spo storageentity set -k AnalyticsId -v 123 -d 'Web analytics ID' -c 'Use on all sites' -u https://contoso.sharepoint.com/sites/appcatalog
+```
+
+## More information
+
+- SharePoint Framework Tenant Properties: [https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-properties](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-properties)

package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.mdx

@@ -0,0 +1,66 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo tenant appcatalog add
+
+Creates new tenant app catalog site
+
+## Usage
+
+```sh
+m365 spo tenant appcatalog add [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --url <url>`
+: The absolute site url
+
+`--owner <owner>`
+: The account name of the site owner
+
+`-z, --timeZone <timeZone>`
+: Integer representing time zone to use for the site
+
+`--wait`
+: Wait for the site to be provisioned before completing the command
+
+`--force`
+: Force creating a new app catalog site if one already exists
+```
+
+<Global />
+
+## Remarks
+
+If there is an app catalog registered in your tenant, creating a new app catalog using this command will fail, unless you use the `force` option.
+
+If you use the `force` option, and either the app catalog or the site at the specified URL exists (or both), this command will delete both sites bypassing the recycle bin.
+
+Creating an app catalog site might take a while. If you need to wait for the site to be created before continuing, use the `wait` option.
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+    
+## Examples
+
+Creates new app catalog. Will fail if another app catalog or site at the specified URL exists
+
+```sh
+m365 spo tenant appcatalog add --url https://contoso.sharepoint.com/sites/apps --owner admin@contoso.com --timeZone 4
+```
+
+Creates new app catalog and waits for completion. Will fail if another app catalog or site at the specified URL exists
+
+```sh
+m365 spo tenant appcatalog add --url https://contoso.sharepoint.com/sites/apps --owner admin@contoso.com --timeZone 4 --wait
+```
+
+Creates new app catalog and deletes existing app catalog and existing site at the specified URL
+
+```sh
+m365 spo tenant appcatalog add --url https://contoso.sharepoint.com/sites/apps --owner admin@contoso.com --timeZone 4 --force
+```

package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.mdx

@@ -0,0 +1,31 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo tenant appcatalogurl get
+
+Gets the URL of the tenant app catalog
+
+## Usage
+
+```sh
+m365 spo tenant appcatalogurl get [options]
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+
+## Examples
+
+Get the URL of the tenant app catalog
+
+```sh
+m365 spo tenant appcatalogurl get
+```

package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.mdx

@@ -0,0 +1,69 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo tenant applicationcustomizer add
+
+Add an application customizer as a tenant wide extension.
+
+## Usage
+
+```sh
+m365 spo tenant applicationcustomizer add [options]
+```
+
+## Options
+
+```md defintion-list
+`-t, --title <title>`
+: The title of the Application Customizer.
+
+`-i, --clientSideComponentId <clientSideComponentId>`
+: The Client Side Component Id (GUID) of the application customizer.
+
+`-p, --clientSideComponentProperties [clientSideComponentProperties]`
+: The Client Side Component properties of the application customizer.
+
+`-w, --webTemplate [webTemplate]`
+: Optionally add a web template (e.g. STS#3, SITEPAGEPUBLISHING#0, etc) as a filter for what kind of sites the application customizer is registered on.
+```
+
+<Global />
+
+## 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 tenant applicationcustomizer add --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
+```
+
+Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
+
+:::caution 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.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
+
+:::
+
+:::info
+
+To use this command, you need to be a SharePoint Admin.
+
+:::
+
+## Examples
+
+Adds an application customizer that's deployed tenant wide
+
+```sh
+m365 spo tenant applicationcustomizer add --title "Some customizer" --clientSideComponentId  799883f5-7962-4384-a10a-105adaec6ffc 
+```
+
+Adds an application customizer that is configured for all communication sites.
+
+```sh
+m365 spo tenant applicationcustomizer add --title "Some customizer" --clientSideComponentId  799883f5-7962-4384-a10a-105adaec6ffc --webTemplate "SITEPAGEPUBLISHING#0"
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx

@@ -0,0 +1,156 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo tenant applicationcustomizer get
+
+Get an application customizer that is installed tenant wide
+
+## Usage
+
+```sh
+spo tenant applicationcustomizer get [options]
+```
+
+## Options
+
+```md defintion-list
+`-t, --title [title]`
+: The title of the application customizer. Specify either `title`, `id`, or `clientSideComponentId`.
+
+`-i, --id [id]`
+: The product id of the application customizer. Specify either `title`, `id`, or `clientSideComponentId`.
+
+`-c, --clientSideComponentId  [clientSideComponentId]`
+: The Client Side Component Id (GUID) of the application customizer. Specify either `title`, `id`, or `clientSideComponentId`.
+```
+
+<Global />
+
+## Examples
+
+Retrieves an application customizer by title.
+
+```sh
+m365 spo tenant applicationcustomizer get --title "Some customizer"
+```
+
+Retrieves an application customizer by id.
+
+```sh
+m365 spo tenant applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337
+```
+
+Retrieves an application customizer by clientSideComponentId.
+
+```sh
+m365 spo tenant applicationcustomizer get --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "FileSystemObjectType": 0,
+    "Id": 4,
+    "ServerRedirectedEmbedUri": null,
+    "ServerRedirectedEmbedUrl": "",
+    "ContentTypeId": "0x00693E2C487575B448BD420C12CEAE7EFE",
+    "Title": "Some customizer",
+    "Modified": "2023-01-11T15:47:38Z",
+    "Created": "2023-01-11T15:47:38Z",
+    "AuthorId": 9,
+    "EditorId": 9,
+    "OData__UIVersionString": "1.0",
+    "Attachments": false,
+    "GUID": "14125658-a9bc-4ddf-9c75-1b5767c9a337",
+    "ComplianceAssetId": null,
+    "TenantWideExtensionComponentId": "7096cded-b83d-4eab-96f0-df477ed7c0bc",
+    "TenantWideExtensionComponentProperties": "{\"testMessage\":\"Test message\"}",
+    "TenantWideExtensionWebTemplate": null,
+    "TenantWideExtensionListTemplate": 0,
+    "TenantWideExtensionLocation": "ClientSideExtension.ApplicationCustomizer",
+    "TenantWideExtensionSequence": 0,
+    "TenantWideExtensionHostProperties": null,
+    "TenantWideExtensionDisabled": false
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Attachments                           : false
+  AuthorId                              : 9
+  ComplianceAssetId                     : null
+  ContentTypeId                         : 0x00693E2C487575B448BD420C12CEAE7EFE
+  Created                               : 2023-01-11T15:47:38Z
+  EditorId                              : 9
+  FileSystemObjectType                  : 0
+  GUID                                  : 14125658-a9bc-4ddf-9c75-1b5767c9a337
+  Id                                    : 4
+  Modified                              : 2023-01-11T15:47:38Z
+  OData__UIVersionString                : 1.0
+  ServerRedirectedEmbedUri              : null
+  ServerRedirectedEmbedUrl              :
+  TenantWideExtensionComponentId        : 7096cded-b83d-4eab-96f0-df477ed7c0bc
+  TenantWideExtensionComponentProperties: {"testMessage":"Test message"}
+  TenantWideExtensionDisabled           : false
+  TenantWideExtensionHostProperties     : null
+  TenantWideExtensionListTemplate       : 0
+  TenantWideExtensionLocation           : ClientSideExtension.ApplicationCustomizer
+  TenantWideExtensionSequence           : 0
+  TenantWideExtensionWebTemplate        : null
+  Title                                 : Some customizer
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  FileSystemObjectType,Id,ServerRedirectedEmbedUri,ServerRedirectedEmbedUrl,ContentTypeId,Title,Modified,Created,AuthorId,EditorId,OData__UIVersionString,Attachments,GUID,ComplianceAssetId,TenantWideExtensionComponentId,TenantWideExtensionComponentProperties,TenantWideExtensionWebTemplate,TenantWideExtensionListTemplate,TenantWideExtensionLocation,TenantWideExtensionSequence,TenantWideExtensionHostProperties,TenantWideExtensionDisabled
+  0,4,,,0x00693E2C487575B448BD420C12CEAE7EFE,Some customizer,2023-01-11T15:47:38Z,2023-01-11T15:47:38Z,9,9,1.0,,14125658-a9bc-4ddf-9c75-1b5767c9a337,,7096cded-b83d-4eab-96f0-df477ed7c0bc,"{""testMessage"":""Test message""}",,0,ClientSideExtension.ApplicationCustomizer,0,,
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo tenant applicationcustomizer get --title "Some customizer"
+
+  Date: 1/13/2023
+
+  ## Some customizer (4)
+
+  Property | Value
+  ---------|-------
+  FileSystemObjectType | 0
+  Id | 4
+  ServerRedirectedEmbedUri | null
+  ServerRedirectedEmbedUrl |
+  ContentTypeId | 0x00693E2C487575B448BD420C12CEAE7EFE
+  Title | Some customizer
+  Modified | 2023-01-11T15:47:38Z
+  Created | 2023-01-11T15:47:38Z
+  AuthorId | 9
+  EditorId | 9
+  OData\_\_UIVersionString | 1.0
+  Attachments | false
+  GUID | 14125658-a9bc-4ddf-9c75-1b5767c9a337
+  ComplianceAssetId | null
+  TenantWideExtensionComponentId | 7096cded-b83d-4eab-96f0-df477ed7c0bc
+  TenantWideExtensionComponentProperties | {"testMessage":"Test message"}
+  TenantWideExtensionWebTemplate | null
+  TenantWideExtensionListTemplate | 0
+  TenantWideExtensionLocation | ClientSideExtension.ApplicationCustomizer
+  TenantWideExtensionSequence | 0
+  TenantWideExtensionHostProperties | null
+  TenantWideExtensionDisabled | false
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx

@@ -0,0 +1,115 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo tenant applicationcustomizer list
+
+Retrieves a list of application customizers that are installed tenant-wide.
+
+## Usage
+
+```sh
+spo tenant applicationcustomizer list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+Retrieves a list of application customizers.
+
+```sh
+m365 spo tenant applicationcustomizer list
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "FileSystemObjectType": 0,
+      "Id": 8,
+      "ServerRedirectedEmbedUri": null,
+      "ServerRedirectedEmbedUrl": "",
+      "ID": 8,
+      "ContentTypeId": "0x00693E2C487575B448BD420C12CEAE7EFE",
+      "Title": "HelloWorld",
+      "Modified": "2023-05-21T14:31:30Z",
+      "Created": "2023-05-21T14:31:30Z",
+      "AuthorId": 9,
+      "EditorId": 9,
+      "OData__UIVersionString": "1.0",
+      "Attachments": false,
+      "GUID": "23951a41-f613-440e-8119-8f1e87df1d1a",
+      "OData__ColorTag": null,
+      "ComplianceAssetId": null,
+      "TenantWideExtensionComponentId": "d54e75e7-af4d-455f-9101-a5d906692ecd",
+      "TenantWideExtensionComponentProperties": "{\"testMessage\":\"Test message\"}",
+      "TenantWideExtensionWebTemplate": null,
+      "TenantWideExtensionListTemplate": 0,
+      "TenantWideExtensionLocation": "ClientSideExtension.ApplicationCustomizer",
+      "TenantWideExtensionSequence": 0,
+      "TenantWideExtensionHostProperties": null,
+      "TenantWideExtensionDisabled": false
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  TenantWideExtensionComponentId: d54e75e7-af4d-455f-9101-a5d906692ecd
+  TenantWideExtensionWebTemplate: null
+  Title                         : HelloWorld
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  FileSystemObjectType,Id,ServerRedirectedEmbedUrl,ID,ContentTypeId,Title,Modified,Created,AuthorId,EditorId,OData__UIVersionString,Attachments,GUID,TenantWideExtensionComponentId,TenantWideExtensionComponentProperties,TenantWideExtensionListTemplate,TenantWideExtensionLocation,TenantWideExtensionSequence,TenantWideExtensionDisabled
+  0,8,,8,0x00693E2C487575B448BD420C12CEAE7EFE,HelloWorld,2023-05-21T14:31:30Z,2023-05-21T14:31:30Z,9,9,1.0,,23951a41-f613-440e-8119-8f1e87df1d1a,d54e75e7-af4d-455f-9101-a5d906692ecd,"{""testMessage"":""Test message""}",0,ClientSideExtension.ApplicationCustomizer,0,
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo tenant applicationcustomizer list
+
+  Date: 5/21/2023
+
+  ## HelloWorld (8)
+
+  Property | Value
+  ---------|-------
+  FileSystemObjectType | 0
+  Id | 8
+  ServerRedirectedEmbedUrl |
+  ID | 8
+  ContentTypeId | 0x00693E2C487575B448BD420C12CEAE7EFE
+  Title | HelloWorld
+  Modified | 2023-05-21T14:31:30Z
+  Created | 2023-05-21T14:31:30Z
+  AuthorId | 9
+  EditorId | 9
+  OData\_\_UIVersionString | 1.0
+  Attachments | false
+  GUID | 23951a41-f613-440e-8119-8f1e87df1d1a
+  TenantWideExtensionComponentId | d54e75e7-af4d-455f-9101-a5d906692ecd
+  TenantWideExtensionComponentProperties | {"testMessage":"Test message"}
+  TenantWideExtensionListTemplate | 0
+  TenantWideExtensionLocation | ClientSideExtension.ApplicationCustomizer
+  TenantWideExtensionSequence | 0
+  TenantWideExtensionDisabled | false
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-remove.mdx

@@ -0,0 +1,53 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo tenant applicationcustomizer remove
+
+Removes an application customizer that is installed tenant wide.
+
+## Usage
+
+```sh
+spo tenant applicationcustomizer remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-t, --title [title]`
+: The title of the Application Customizer. Specify either `title`, `id`, or `clientSideComponentId`.
+
+`-i, --id [id]`
+: The id of the Application Customizer. Specify either `title`, `id`, or `clientSideComponentId`.
+
+`-c, --clientSideComponentId  [clientSideComponentId]`
+: The Client Side Component Id (GUID) of the application customizer. Specify either `title`, `id`, or `clientSideComponentId`.
+
+`--confirm`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Removes an application customizer by title.
+
+```sh
+m365 spo tenant applicationcustomizer remove --title "Some customizer"
+```
+
+Removes an application customizer by id.
+
+```sh
+m365 spo tenant applicationcustomizer remove --id 3
+```
+
+Removes an application customizer by clientSideComponentId.
+
+```sh
+m365 spo tenant applicationcustomizer remove --clientSideComponentId "7096cded-b83d-4eab-96f0-df477ed7c0bc"
+```
+
+## Response
+
+The command won't return a response on success.