@pnp/cli-microsoft365 8.1.0-beta.3dec9fa → 8.1.0-beta.bf59841

package/dist/utils/zod.js

@@ -0,0 +1,124 @@
+import { z } from 'zod';
+function parseEffect(def, _options, _currentOption) {
+    return def.schema._def;
+}
+function parseIntersection(def, _options, _currentOption) {
+    if (def.left._def.typeName !== z.ZodFirstPartyTypeKind.ZodAny) {
+        return def.left._def;
+    }
+    if (def.right._def.typeName !== z.ZodFirstPartyTypeKind.ZodAny) {
+        return def.right._def;
+    }
+    return;
+}
+function parseObject(def, options, _currentOption) {
+    const properties = def.shape();
+    for (const key in properties) {
+        const property = properties[key];
+        const option = {
+            name: key,
+            long: key,
+            short: property._def.alias,
+            required: true,
+            type: 'string'
+        };
+        parseDef(property._def, options, option);
+        options.push(option);
+    }
+    return;
+}
+function parseString(_def, _options, currentOption) {
+    if (currentOption) {
+        currentOption.type = 'string';
+    }
+    return;
+}
+function parseNumber(_def, _options, currentOption) {
+    if (currentOption) {
+        currentOption.type = 'number';
+    }
+    return;
+}
+function parseBoolean(_def, _options, currentOption) {
+    if (currentOption) {
+        currentOption.type = 'boolean';
+    }
+    return;
+}
+function parseOptional(def, _options, currentOption) {
+    if (currentOption) {
+        currentOption.required = false;
+    }
+    return def.innerType._def;
+}
+function parseDefault(def, _options, currentOption) {
+    if (currentOption) {
+        currentOption.required = false;
+    }
+    return def.innerType._def;
+}
+function parseEnum(def, _options, currentOption) {
+    if (currentOption) {
+        currentOption.type = 'string';
+        currentOption.autocomplete = def.values;
+    }
+    return;
+}
+function parseNativeEnum(def, _options, currentOption) {
+    if (currentOption) {
+        currentOption.type = 'string';
+        currentOption.autocomplete = Object.getOwnPropertyNames(def.values);
+    }
+    return;
+}
+function getParseFn(typeName) {
+    switch (typeName) {
+        case z.ZodFirstPartyTypeKind.ZodEffects:
+            return parseEffect;
+        case z.ZodFirstPartyTypeKind.ZodObject:
+            return parseObject;
+        case z.ZodFirstPartyTypeKind.ZodOptional:
+            return parseOptional;
+        case z.ZodFirstPartyTypeKind.ZodString:
+            return parseString;
+        case z.ZodFirstPartyTypeKind.ZodNumber:
+            return parseNumber;
+        case z.ZodFirstPartyTypeKind.ZodBoolean:
+            return parseBoolean;
+        case z.ZodFirstPartyTypeKind.ZodEnum:
+            return parseEnum;
+        case z.ZodFirstPartyTypeKind.ZodNativeEnum:
+            return parseNativeEnum;
+        case z.ZodFirstPartyTypeKind.ZodDefault:
+            return parseDefault;
+        case z.ZodFirstPartyTypeKind.ZodIntersection:
+            return parseIntersection;
+        default:
+            return;
+    }
+}
+function parseDef(def, options, currentOption) {
+    let parsedDef = def;
+    do {
+        const parse = getParseFn(parsedDef.typeName);
+        if (!parse) {
+            break;
+        }
+        parsedDef = parse(parsedDef, options, currentOption);
+        if (!parsedDef) {
+            break;
+        }
+    } while (parsedDef);
+}
+export const zod = {
+    alias(alias, type) {
+        type._def.alias = alias;
+        return type;
+    },
+    schemaToOptions(schema) {
+        const options = [];
+        parseDef(schema._def, options);
+        return options;
+    }
+};
+//# sourceMappingURL=zod.js.map

package/docs/docs/cmd/connection/connection-use.mdx

@@ -15,7 +15,7 @@ m365 connection use [options]
 ## Options
 
 ```md definition-list
-`-n, --name <name>`
+`-n, --name [name]`
 : The name of the connection to switch to.
 ```
 
@@ -23,7 +23,13 @@ m365 connection use [options]
 
 ## Remarks
 
-The value for `--name` can be found by running [m365 connection list](connection-list.mdx). You can update the name of a connection by running [m365 connection set](connection-set.mdx). 
+:::tip
+
+If you haven't disabled the "prompt" setting, running this command without options will show a list of available connections. You can then select the connection to activate it.
+
+:::
+
+You can update the name of a connection by running [m365 connection set](connection-set.mdx).
 
 ## Examples
 

package/docs/docs/cmd/entra/multitenant/multitenant-add.mdx

@@ -0,0 +1,107 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# entra multitenant add
+
+Creates a new multitenant organization
+
+## Usage
+
+```sh
+m365 entra multitenant add [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --displayname <displayName>`
+: Display name for the multitenant organization.
+
+`-d, --description [description]`
+: Description for the multitenant organiztion.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be at least **Security Administrator**.
+
+:::
+
+## Examples
+
+Create a new multitenant organization with display name only.
+
+```sh
+m365 entra multitenant add --displayName 'Contoso organization'
+```
+
+Create a new multitenant organization with display name and description.
+
+```sh
+m365 entra multitenant add --displayName 'Contoso organization' --description 'Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "c231d4a5-138f-4bdf-9fee-f26a90ea3ad0",
+    "createdDateTime": "2024-05-05T05:05:05Z",
+    "state": "active",
+    "displayName": "Contoso organization",
+    "description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  createdDateTime: 2024-05-05T05:05:05Z
+  description    : Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
+  displayName    : Contoso organization
+  id             : c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
+  state          : active
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,createdDateTime,state,displayName,description
+  c231d4a5-138f-4bdf-9fee-f26a90ea3ad0,2024-05-05T05:05:05Z,active,Contoso organization,"Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # entra multitenant add
+
+  Date: 5/5/2024
+
+  ## Contoso organization (c231d4a5-138f-4bdf-9fee-f26a90ea3ad0)
+
+  Property | Value
+  ---------|-------
+  id | c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
+  createdDateTime | 2024-05-05T05:05:05Z
+  state | active
+  displayName | Contoso organization
+  description | Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview

package/docs/docs/cmd/entra/multitenant/multitenant-remove.mdx

@@ -0,0 +1,58 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# entra multitenant remove
+
+Removes a multitenant organization
+
+## Usage
+
+```sh
+m365 entra multitenant remove [options]
+```
+
+## options
+
+```md definition-list
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be at least **Security Administrator**.
+
+:::
+
+:::info
+
+When removing a Multi-Tenant Organization, all associations with other tenants will be removed too.
+
+The removing process can take up to 2 hours to complete.
+
+:::
+
+## Examples
+
+Remove the multitenant organization.
+
+```sh
+m365 entra multitenant remove
+```
+
+Remove the multitenant organization without prompting for confirmation.
+
+```sh
+m365 entra multitenant remove --force
+```
+
+## Response
+
+The command won't return a response on success
+
+## More information
+
+- Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview

package/docs/docs/cmd/entra/multitenant/multitenant-set.mdx

@@ -0,0 +1,53 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# entra multitenant set
+
+Updates the properties of a multitenant organization
+
+## Usage
+
+```sh
+m365 entra multitenant set [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --displayName [displayName]`
+: New display name of the multitenant organization. Both options, `displayName` and `description` are optional but at least must be specified.
+
+`-d, --description [description]`
+: New description of the multitenant organization. Both options, `displayName` and `description` are optional but at least must be specified.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be at least **Security Administrator**.
+
+:::
+
+## Examples
+
+Update display name of multitenant organization.
+
+```sh
+m365 entra multitenant set --displayName 'Fabrikam organization'
+```
+
+Update display name and description of multitenant organization.
+
+```sh
+m365 entra multitenant set --displayName 'Fabrikam organization' --description 'Multitenant organization between Fabrikam and Contoso'
+```
+
+## Response
+
+The command won't return a response on success
+
+## More information
+
+- Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview

package/docs/docs/cmd/planner/plan/plan-remove.mdx

@@ -13,7 +13,7 @@ m365 planner plan remove [options]
 ## Options
 
 ```md definition-list
-`i, --id [id]`
+`-i, --id [id]`
 : ID of the plan to remove. Specify either `id` or `title` but not both.
 
 `-t, --title [title]`

package/docs/docs/cmd/spe/containertype/containertype-list.mdx

@@ -0,0 +1,102 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spe containertype list
+
+Lists all Container Types
+
+## Usage
+
+```sh
+m365 spe containertype list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+Retrieves a list of Container Types created for a SharePoint Embedded Application from the tenant.
+
+```sh
+m365 spe containertype list
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "_ObjectType_": "Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties",
+      "ApplicationRedirectUrl": null,
+      "AzureSubscriptionId": "/Guid(00000000-0000-0000-0000-000000000000)/",
+      "ContainerTypeId": "/Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/",
+      "CreationDate": null,
+      "DisplayName": "test1",
+      "ExpiryDate": null,
+      "IsBillingProfileRequired": true,
+      "OwningAppId": "/Guid(df4085cc-9a38-4255-badc-5c5225610475)/",
+      "OwningTenantId": "/Guid(00000000-0000-0000-0000-000000000000)/",
+      "Region": null,
+      "ResourceGroup": null,
+      "SPContainerTypeBillingClassification": 0
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ContainerTypeId                               DisplayName                                    OwningAppId                                 
+  --------------------------------------------  ---------------------------------------------  --------------------------------------------
+  /Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/  test1                                          /Guid(df4085cc-9a38-4255-badc-5c5225610475)/
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  _ObjectType_,ApplicationRedirectUrl,AzureSubscriptionId,ContainerTypeId,CreationDate,DisplayName,ExpiryDate,IsBillingProfileRequired,OwningAppId,OwningTenantId,Region,ResourceGroup,SPContainerTypeBillingClassification
+  Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties,,/Guid(00000000-0000-0000-0000-000000000000)/,/Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/,,test1,,1,/Guid(df4085cc-9a38-4255-badc-5c5225610475)/,/Guid(00000000-0000-0000-0000-000000000000)/,,,0
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spe containertype list 
+
+  Date: 5/11/2024
+
+  ## test1
+
+  Property | Value
+  ---------|-------
+  \_ObjectType\_ | Microsoft.Online.SharePoint.TenantAdministration.SPContainerTypeProperties
+  AzureSubscriptionId | /Guid(00000000-0000-0000-0000-000000000000)/
+  ContainerTypeId | /Guid(073269af-f1d2-042d-2ef5-5bdd6ac83115)/
+  DisplayName | test1
+  IsBillingProfileRequired | true
+  OwningAppId | /Guid(df4085cc-9a38-4255-badc-5c5225610475)/
+  OwningTenantId | /Guid(00000000-0000-0000-0000-000000000000)/
+  SPContainerTypeBillingClassification | 0
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+In SharePoint Embedded, all files and documents are stored in Containers, and each Container is identified by a Container Type.
+
+Container Type is a property stamped on every Container instance. Each Container Type is owned by one Application, and each Application can own only one Container Type.
+
+The primary function of a Container Type is to manage the application workload that can access the Containers. Container Type defines the access permissions an Application has towards all Containers of that type, including create, read, write, delete containers; manage container permissions, etc.
+
+More information about SharePoint Embedded and the limits can be found at the following location: [SharePoint Embedded](https://learn.microsoft.com/en-us/sharepoint/dev/embedded/concepts/app-concepts/containertypes#sharepoint-embedded-trial-container-types)

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

@@ -29,10 +29,17 @@ m365 spo applicationcustomizer get [options]
 
 `-s, --scope [scope]`
 : Scope of the application customizer. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.
+
+`-p, --clientSideComponentProperties`
+: Only output the client-side component properties.
 ```
 
 <Global />
 
+## Remarks
+
+This command can be used for retrieving an application customizer from a specific site. To retrieve an application customizer that's installed tenant-wide, view our dedicated [spo tenant applicationcustomizer get](../tenant/tenant-applicationcustomizer-get.mdx) command.
+
 ## Examples
 
 Retrieves an application customizer by title.
@@ -59,36 +66,41 @@ Retrieves an application customizer by title available at the site scope.
 m365 spo applicationcustomizer get --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales --scope site
 ```
 
-## Remarks
+Retrieves the client-side component properties of a application customizer.
 
-This command can be used for retrieving an application customizer from a specific site. To retrieve an application customizer that's installed tenant-wide, view our dedicated [spo tenant applicationcustomizer get](../tenant/tenant-applicationcustomizer-get.mdx) command.
+```sh
+m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --clientSideComponentProperties
+```
 
 ## Response
 
+### Standard response
+
 <Tabs>
   <TabItem value="JSON">
 
   ```json
   {
-    "ClientSideComponentId": "7096cded-b83d-4eab-96f0-df477ed7c0bc",
-    "ClientSideComponentProperties": "",
+    "ClientSideComponentId": "9a8b100c-246b-4592-9454-67826523e159",
+    "ClientSideComponentProperties": "{\"testMessage\":\"Test message\"}",
     "CommandUIExtension": null,
     "Description": null,
     "Group": null,
-    "Id": "14125658-a9bc-4ddf-9c75-1b5767c9a337",
+    "HostProperties": "",
+    "Id": "4a428b32-08cf-45c7-9986-17585af38806",
     "ImageUrl": null,
     "Location": "ClientSideExtension.ApplicationCustomizer",
-    "Name": "Some customizer",
+    "Name": "{4a428b32-08cf-45c7-9986-17585af38806}",
     "RegistrationId": null,
     "RegistrationType": 0,
-    "Rights": "{\"High\":0,\"Low\":0}",
+    "Rights": "{\"High\":\"0\",\"Low\":\"0\"}",
     "Scope": "Web",
     "ScriptBlock": null,
     "ScriptSrc": null,
-    "Sequence": 0,
-    "Title": "Some customizer",
+    "Sequence": 65536,
+    "Title": "HelloWorld",
     "Url": null,
-    "VersionOfUserCustomAction": "16.0.1.0"
+    "VersionOfUserCustomAction": "1.0.1.0"
   }
   ```
 
@@ -96,65 +108,102 @@ This command can be used for retrieving an application customizer from a specifi
   <TabItem value="Text">
 
   ```text
-  ClientSideComponentId        : 7096cded-b83d-4eab-96f0-df477ed7c0bc
-  ClientSideComponentProperties:
+  ClientSideComponentId        : 9a8b100c-246b-4592-9454-67826523e159
+  ClientSideComponentProperties: {"testMessage":"Test message"}
   CommandUIExtension           : null
   Description                  : null
   Group                        : null
-  Id                           : 14125658-a9bc-4ddf-9c75-1b5767c9a337
+  HostProperties               :
+  Id                           : 4a428b32-08cf-45c7-9986-17585af38806
   ImageUrl                     : null
   Location                     : ClientSideExtension.ApplicationCustomizer
-  Name                         : Some customizer
+  Name                         : {4a428b32-08cf-45c7-9986-17585af38806}
   RegistrationId               : null
   RegistrationType             : 0
-  Rights                       : {"High":0,"Low":0}
+  Rights                       : {"High":"0","Low":"0"}
   Scope                        : Web
   ScriptBlock                  : null
   ScriptSrc                    : null
-  Sequence                     : 0
-  Title                        : Some customizer
+  Sequence                     : 65536
+  Title                        : HelloWorld
   Url                          : null
-  VersionOfUserCustomAction    : 16.0.1.0
+  VersionOfUserCustomAction    : 1.0.1.0
   ```
 
   </TabItem>
   <TabItem value="CSV">
 
   ```csv
-  ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
-  7096cded-b83d-4eab-96f0-df477ed7c0bc,,,,,14125658-a9bc-4ddf-9c75-1b5767c9a337,,ClientSideExtension.ApplicationCustomizer,Some customizer,,0,"{""High"":0,""Low"":0}",Web,,,0,Some customizer,,16.0.1.0
+  ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,HostProperties,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
+  9a8b100c-246b-4592-9454-67826523e159,"{""testMessage"":""Test message""}",,,,,4a428b32-08cf-45c7-9986-17585af38806,,ClientSideExtension.ApplicationCustomizer,{4a428b32-08cf-45c7-9986-17585af38806},,0,"{""High"":""0"",""Low"":""0""}",Web,,,65536,HelloWorld,,1.0.1.0
   ```
 
   </TabItem>
   <TabItem value="Markdown">
 
   ```md
-  # spo applicationcustomizer get --title "Some customizer" --webUrl "https://contoso.sharepoint.com/sites/sales" --scope "Web"
+  # spo applicationcustomizer get --webUrl "https://contoso.sharepoint.com/sites/Marketing" --id "4a428b32-08cf-45c7-9986-17585af38806"
 
-  Date: 3/6/2023
+  Date: 16/05/2024
 
-  ## Some customizer (14125658-a9bc-4ddf-9c75-1b5767c9a337)
+  ## HelloWorld (4a428b32-08cf-45c7-9986-17585af38806)
 
   Property | Value
   ---------|-------
-  ClientSideComponentId | 7096cded-b83d-4eab-96f0-df477ed7c0bc
-  ClientSideComponentProperties |
-  CommandUIExtension | null
-  Description | null
-  Group | null
-  Id | 14125658-a9bc-4ddf-9c75-1b5767c9a337
-  ImageUrl | null
+  ClientSideComponentId | 9a8b100c-246b-4592-9454-67826523e159
+  ClientSideComponentProperties | {"testMessage":"Test message"}
+  HostProperties |
+  Id | 4a428b32-08cf-45c7-9986-17585af38806
   Location | ClientSideExtension.ApplicationCustomizer
-  Name | Some customizer
-  RegistrationId | null
+  Name | {4a428b32-08cf-45c7-9986-17585af38806}
   RegistrationType | 0
+  Rights | {"High":"0","Low":"0"}
   Scope | Web
-  ScriptBlock | null
-  ScriptSrc | null
-  Sequence | 0
-  Title | Some customizer
-  Url | null
-  VersionOfUserCustomAction | 16.0.1.0
+  Sequence | 65536
+  Title | HelloWorld
+  VersionOfUserCustomAction | 1.0.1.0
+  ```
+
+  </TabItem>
+</Tabs>
+
+### `clientSideComponentProperties` response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "testMessage": "Test message"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  testMessage: Test message
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  testMessage
+  Test message
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo applicationcustomizer get --title "Some customizer" --webUrl "https://contoso.sharepoint.com/sites/sales" --scope "Web" --clientSideComponentProperties "true"
+
+  Date: 15/05/2024
+
+  Property | Value
+  ---------|-------
+  testMessage | Test message
   ```
 
   </TabItem>