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

package/docs/docs/cmd/aad/app/app-set.mdx

@@ -0,0 +1,93 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad app set
+
+Updates Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app set [options]
+```
+
+## Options
+
+```md definition-list
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration to update. Specify either `appId`, `objectId` or `name`
+
+`--objectId [objectId]`
+: Object ID of the Azure AD application registration to update. Specify either `appId`, `objectId` or `name`
+
+`--name [name]`
+: Name of the Azure AD application registration to update. Specify either `appId`, `objectId` or `name`
+
+`-u, --uri [uri]`
+: Comma-separated list of Application ID URIs to update
+
+`-r, --redirectUris [redirectUris]`
+: Comma-separated list of redirect URIs to add to the app registration. Requires `platform` to be specified
+
+`-p, --platform [platform]`
+: Platform for which the `redirectUri` should be configured. Allowed values `spa`, `web`, `publicClient`
+
+`--redirectUrisToRemove [redirectUrisToRemove]`
+: Comma-separated list of existing redirect URIs to remove. Specify, when you want to replace existing redirect URIs with another
+
+`--certificateFile [certificateFile]`
+: Path to the file with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
+
+`--certificateBase64Encoded [certificateBase64Encoded]`
+: Base64-encoded string with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
+
+`--certificateDisplayName [certificateDisplayName]`
+: Display name for the certificate. If not given, the displayName will be set to the certificate subject. When specified, also specify either `certificateFile` or `certificateBase64Encoded`
+```
+
+<Global />
+
+## Remarks
+
+For best performance use the `objectId` option to reference the Azure AD application registration to update. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+When a certificate is specified it will be added to the list of certificates of the app without changing existing certificates.
+
+## Examples
+
+Update the app URI of the Azure AD application registration specified by its object ID
+
+```sh
+m365 aad app set --objectId d75be2e1-0204-4f95-857d-51a37cf40be8 --uri https://contoso.com/e75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Update the app URI of the Azure AD application registration specified by its app (client) ID
+
+```sh
+m365 aad app set --appId e75be2e1-0204-4f95-857d-51a37cf40be8 --uri https://contoso.com/e75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Update the app URI of the Azure AD application registration specified by its name
+
+```sh
+m365 aad app set --name "My app" --uri https://contoso.com/e75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Add a new redirect URI for SPA authentication
+
+```sh
+m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa
+```
+
+Replace one redirect URI with another for SPA authentication
+
+```sh
+m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa --redirectUrisToRemove https://contoso.com/old-auth
+```
+
+Add a certificate to the app
+
+```sh
+m365 aad app set --appId e75be2e1-0204-4f95-857d-51a37cf40be8 --certificateDisplayName "Some certificate name" --certificateFile "c:\temp\some-certificate.cer"
+```

package/docs/docs/cmd/aad/approleassignment/approleassignment-add.mdx

@@ -0,0 +1,66 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad approleassignment add
+
+Adds service principal permissions also known as scopes and app role assignments for specified Azure AD application registration
+
+## Usage
+
+```sh
+m365 aad approleassignment add [options]
+```
+
+## Options
+
+```md definition-list
+`--appId [appId]`
+: Application appId also known as clientId of the App Registration to which the configured scopes (app roles) should be applied
+
+`--appObjectId [appObjectId]`
+: Application objectId of the App Registration to which the configured scopes (app roles) should be applied
+
+`--appDisplayName [appDisplayName]`
+: Application name of the App Registration to which the configured scopes (app roles) should be applied
+
+`-r, --resource <resource>`
+: Service principal name, appId or objectId that has the scopes (roles) e.g. `SharePoint`.
+
+`-s, --scope <scope>`
+: Permissions known also as scopes and roles to grant the application with. If multiple permissions have to be granted, they have to be comma-separated e.g. `Sites.Read.All`, `Sites.ReadWrite.all`
+```
+
+<Global />
+
+## Remarks
+
+This command requires tenant administrator permissions.
+
+Specify either the `appId`, `appObjectId` or `appDisplayName` but not multiple. If you specify more than one option value, the command will fail with an error.
+
+Autocomplete values for the `resource` option do not mean allowed values. The autocomplete will just suggest some known names, but that doesn't restrict you to use the name of your own custom application or other application within your tenant.
+
+This command can also be used to assign permissions to system or user-assigned managed identity.
+
+## Examples
+
+Adds SharePoint _Sites.Read.All_ application permissions to Azure AD application with app id _57907bf8-73fa-43a6-89a5-1f603e29e451_
+
+```sh
+m365 aad approleassignment add --appId "57907bf8-73fa-43a6-89a5-1f603e29e451" --resource "SharePoint" --scope "Sites.Read.All"
+```
+
+Adds multiple Microsoft Graph application permissions to an Azure AD application with the name _MyAppName__
+
+```sh
+m365 aad approleassignment add --appDisplayName "MyAppName" --resource "Microsoft Graph" --scope "Mail.Read,Mail.Send"
+```
+
+Adds Microsoft Graph _Mail.Read_ application permissions to a system-managed identity app with objectId _57907bf8-73fa-43a6-89a5-1f603e29e451_
+
+```sh
+m365 aad approleassignment add --appObjectId "57907bf8-73fa-43a6-89a5-1f603e29e451" --resource "Microsoft Graph" --scope "Mail.Read"
+```
+
+## More information
+
+- Microsoft Graph permissions reference: [https://docs.microsoft.com/en-us/graph/permissions-reference](https://docs.microsoft.com/en-us/graph/permissions-reference)

package/docs/docs/cmd/aad/approleassignment/approleassignment-list.mdx

@@ -0,0 +1,54 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad approleassignment list
+
+Lists app role assignments for the specified application registration
+
+## Usage
+
+```sh
+m365 aad approleassignment list [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --appId [appId]`
+: Application (client) Id of the App Registration for which the configured app roles should be retrieved
+
+`-n, --appDisplayName [appDisplayName]`
+: Display name of the application for which the configured app roles should be retrieved
+
+`--appObjectId [appObjectId]`
+: ObjectId of the application for which the configured app roles should be retrieved
+```
+
+<Global />
+
+## Remarks
+
+Specify either the `appId`, `appObjectId` or `appDisplayName`. If you specify more than one option value, the command will fail with an error.
+
+## Examples
+
+List app roles assigned to service principal with Application (client) ID _b2307a39-e878-458b-bc90-03bc578531d6_.
+
+```sh
+m365 aad approleassignment list --appId b2307a39-e878-458b-bc90-03bc578531d6
+```
+
+List app roles assigned to service principal with Application display name _MyAppName_.
+
+```sh
+m365 aad approleassignment list --appDisplayName 'MyAppName'
+```
+
+List app roles assigned to service principal with ObjectId _b2307a39-e878-458b-bc90-03bc578531dd_.
+
+```sh
+m365 aad approleassignment list --appObjectId b2307a39-e878-458b-bc90-03bc578531dd
+```
+
+## More information
+
+- Application and service principal objects in Azure Active Directory (Azure AD): [https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects)

package/docs/docs/cmd/aad/approleassignment/approleassignment-remove.mdx

@@ -0,0 +1,69 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad approleassignment remove
+
+Deletes an app role assignment for the specified Azure AD Application Registration
+
+## Usage
+
+```sh
+m365 aad approleassignment remove [options]
+```
+
+## Options
+
+```md definition-list
+`--appId [appId]`
+: Application appId also known as clientId of the App Registration for which the configured scopes (app roles) should be deleted
+
+`--appObjectId [appObjectId]`
+: Application objectId of the App Registration for which the configured scopes (app roles) should be deleted
+
+`--appDisplayName [appDisplayName]`
+: Application name of the App Registration for which the configured scopes (app roles) should be deleted
+
+`-r, --resource <resource>`
+: Service principal name, appId or objectId that has the scopes (roles) e.g. `SharePoint`
+
+`-s, --scope <scope>`
+: Permissions known also as scopes and roles to be deleted from the application. If multiple permissions have to be deleted, they have to be comma-separated e.g. `Sites.Read.All`,`Sites.ReadWrite.All`
+
+`--confirm`
+: Don't prompt for confirming removing the all role assignment
+```
+
+<Global />
+
+## Remarks
+
+This command requires tenant administrator permissions.
+
+Specify either the `appId`, `appObjectId` or `appDisplayName` but not multiple. If you specify more than one option value, the command will fail with an error.
+
+Autocomplete values for the `resource` option do not mean allowed values. The autocomplete will just suggest some known names, but that doesn't restrict you to use name of your own custom application or other application within your tenant.
+
+This command can also be used to assign permissions to system- or user-assigned managed identity.
+
+## Examples
+
+Deletes SharePoint _Sites.Read.All_ application permissions from Azure AD application with app id _57907bf8-73fa-43a6-89a5-1f603e29e451_
+
+```sh
+m365 aad approleassignment remove --appId "57907bf8-73fa-43a6-89a5-1f603e29e451" --resource "SharePoint" --scope "Sites.Read.All"
+```
+
+Deletes multiple Microsoft Graph application permissions from an Azure AD application with name _MyAppName_
+
+```sh
+m365 aad approleassignment remove --appDisplayName "MyAppName" --resource "Microsoft Graph" --scope "Mail.Read,Mail.Send"
+```
+
+Deletes Microsoft Graph _Mail.Read_ application permissions from a system-managed identity app with objectId _57907bf8-73fa-43a6-89a5-1f603e29e451_
+
+```sh
+m365 aad approleassignment remove --appObjectId "57907bf8-73fa-43a6-89a5-1f603e29e451" --resource "Microsoft Graph" --scope "Mail.Read"
+```
+
+## More information
+
+- Microsoft Graph permissions reference: [https://docs.microsoft.com/en-us/graph/permissions-reference](https://docs.microsoft.com/en-us/graph/permissions-reference)

package/docs/docs/cmd/aad/group/group-get.mdx

@@ -0,0 +1,140 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad group get
+
+Gets information about the specified Azure AD Group
+
+## Usage
+
+```sh
+m365 aad group get [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: The object Id of the Azure AD group. Specify either `id` or `title` but not both
+
+`-t, --title [title]`
+: The display name of the Azure AD group. Specify either `id` or `title` but not both
+```
+
+<Global />
+
+## Examples
+
+Get information about an Azure AD Group by id
+
+```sh
+m365 aad group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844
+```
+
+Get information about an Azure AD Group by title
+
+```sh
+m365 aad group get --title "Finance"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "c541afac-508e-40c7-8880-5a601b41737b",
+    "deletedDateTime": null,
+    "classification": null,
+    "createdDateTime": "2022-11-13T19:16:32Z",
+    "creationOptions": [
+      "YammerProvisioning"
+    ],
+    "description": "This is the default group for everyone in the network",
+    "displayName": "All Company",
+    "expirationDateTime": null,
+    "groupTypes": [
+      "Unified"
+    ],
+    "isAssignableToRole": null,
+    "mail": "allcompany@contoso.onmicrosoft.com",
+    "mailEnabled": true,
+    "mailNickname": "allcompany",
+    "membershipRule": null,
+    "membershipRuleProcessingState": null,
+    "onPremisesDomainName": null,
+    "onPremisesLastSyncDateTime": null,
+    "onPremisesNetBiosName": null,
+    "onPremisesSamAccountName": null,
+    "onPremisesSecurityIdentifier": null,
+    "onPremisesSyncEnabled": null,
+    "preferredDataLocation": null,
+    "preferredLanguage": null,
+    "proxyAddresses": [
+      "SPO:SPO_c3e7794d-0726-49ac-805b-2d6b0edaefdc@SPO_44744d00-3da0-45e5-9e28-da5ab48c61ac",
+      "SMTP:allcompany@contoso.onmicrosoft.com"
+    ],
+    "renewedDateTime": "2022-11-13T19:16:32Z",
+    "resourceBehaviorOptions": [
+      "CalendarMemberReadOnly"
+    ],
+    "resourceProvisioningOptions": [],
+    "securityEnabled": false,
+    "securityIdentifier": "S-1-12-1-4076547856-1079300050-1399127439-2879739702",
+    "theme": null,
+    "visibility": "Public",
+    "onPremisesProvisioningErrors": []
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  classification               : null
+  createdDateTime              : 2022-11-13T19:16:32Z
+  creationOptions              : ["YammerProvisioning"]
+  deletedDateTime              : null
+  description                  : This is the default group for everyone in the network
+  displayName                  : All Company
+  expirationDateTime           : null
+  groupTypes                   : ["Unified"]
+  id                           : c541afac-508e-40c7-8880-5a601b41737b
+  isAssignableToRole           : null
+  mail                         : allcompany@contoso.onmicrosoft.com
+  mailEnabled                  : true
+  mailNickname                 : allcompany
+  membershipRule               : null
+  membershipRuleProcessingState: null
+  onPremisesDomainName         : null
+  onPremisesLastSyncDateTime   : null
+  onPremisesNetBiosName        : null
+  onPremisesProvisioningErrors : []
+  onPremisesSamAccountName     : null
+  onPremisesSecurityIdentifier : null
+  onPremisesSyncEnabled        : null
+  preferredDataLocation        : null
+  preferredLanguage            : null
+  proxyAddresses               : ["SPO:SPO_c3e7794d-0726-49ac-805b-2d6b0edaefdc@SPO_44744d00-3da0-45e5-9e28-da5ab48c61ac","SMTP:allcompany@contoso.onmicrosoft.com"]
+  renewedDateTime              : 2022-11-13T19:16:32Z
+  resourceBehaviorOptions      : ["CalendarMemberReadOnly"]
+  resourceProvisioningOptions  : []
+  securityEnabled              : false
+  securityIdentifier           : S-1-12-1-4076547856-1079300050-1399127439-2879739702
+  theme                        : null
+  visibility                   : Public
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,deletedDateTime,classification,createdDateTime,creationOptions,description,displayName,expirationDateTime,groupTypes,isAssignableToRole,mail,mailEnabled,mailNickname,membershipRule,membershipRuleProcessingState,onPremisesDomainName,onPremisesLastSyncDateTime,onPremisesNetBiosName,onPremisesSamAccountName,onPremisesSecurityIdentifier,onPremisesSyncEnabled,preferredDataLocation,preferredLanguage,proxyAddresses,renewedDateTime,resourceBehaviorOptions,resourceProvisioningOptions,securityEnabled,securityIdentifier,theme,visibility,onPremisesProvisioningErrors
+  c541afac-508e-40c7-8880-5a601b41737b,,,2022-11-13T19:16:32Z,"[""YammerProvisioning""]",This is the default group for everyone in the network,All Company,,"[""Unified""]",,allcompany@contoso.onmicrosoft.com,1,allcompany,,,,,,,,,,,"[""SPO:SPO_c3e7794d-0726-49ac-805b-2d6b0edaefdc@SPO_44744d00-3da0-45e5-9e28-da5ab48c61ac"",""SMTP:allcompany@contoso.onmicrosoft.com""]",2022-11-13T19:16:32Z,"[""CalendarMemberReadOnly""]",[],,S-1-12-1-4076547856-1079300050-1399127439-2879739702,,Public,[]
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/aad/group/group-list.mdx

@@ -0,0 +1,34 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad group list
+
+Lists Azure AD groups
+
+## Usage
+
+```sh
+m365 aad group list [options]
+```
+
+## Options
+
+```md definition-list
+`-d, --deleted`
+: Use to retrieve deleted groups
+```
+
+<Global />
+
+## Examples
+
+Lists all groups defined in Azure Active Directory.
+
+```sh
+m365 aad group list
+```
+
+List all recently deleted groups in the tenant
+
+```sh
+m365 aad group list --deleted
+```

package/docs/docs/cmd/aad/groupsetting/groupsetting-add.mdx

@@ -0,0 +1,40 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad groupsetting add
+
+Creates a group setting
+
+## Usage
+
+```sh
+m365 aad groupsetting add [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --templateId <templateId>`
+: The ID of the group setting template to use to create the group setting
+```
+
+<Global />
+
+## Remarks
+
+To create a group setting, you have to specify the ID of the group setting template that should be used to create the setting. You can retrieve the ID of the template using the [aad groupsettingtemplate list](../groupsettingtemplate/groupsettingtemplate-list.mdx) command.
+
+To specify values for the different properties specified in the group setting template, include additional options that match the property in the group setting template. For example `--ClassificationList 'HBI, MBI, LBI, GDPR'` will set the list of classifications to use on modern SharePoint sites.
+
+Each group setting template specifies default value for each property. If you don't specify a value for the particular property yourself, the default value from the group setting template will be used. To find out which properties are available for the particular group setting template, use the [aad groupsettingtemplate get](../groupsettingtemplate/groupsettingtemplate-get.mdx) command.
+
+If the specified templateId doesn't reference a valid group setting template, you will get a _Resource 'xyz' does not exist or one of its queried reference-property objects are not present._ error.
+
+If you try to add a group setting using a template, for which a setting already exists, you will get a _A conflicting object with one or more of the specified property values is present in the directory._ error.
+
+## Examples
+
+Configure classification for modern SharePoint sites
+
+```sh
+m365 aad groupsetting add --templateId 62375ab9-6b52-47ed-826b-58e47e0e304b --UsageGuidelinesUrl https://contoso.sharepoint.com/sites/compliance --ClassificationList 'HBI, MBI, LBI, GDPR' --DefaultClassification MBI
+```

package/docs/docs/cmd/aad/groupsetting/groupsetting-get.mdx

@@ -0,0 +1,28 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad groupsetting get
+
+Gets information about the particular group setting
+
+## Usage
+
+```sh
+m365 aad groupsetting get [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the group setting to retrieve
+```
+
+<Global />
+
+## Examples
+
+Get information about the group setting with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
+
+```sh
+m365 aad groupsetting get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844
+```

package/docs/docs/cmd/aad/groupsetting/groupsetting-list.mdx

@@ -0,0 +1,23 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad groupsetting list
+
+Lists Azure AD group settings
+
+## Usage
+
+```sh
+m365 aad groupsetting list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+List all group settings in the tenant
+
+```sh
+m365 aad groupsetting list
+```

package/docs/docs/cmd/aad/groupsetting/groupsetting-remove.mdx

@@ -0,0 +1,41 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad groupsetting remove
+
+Removes the particular group setting
+
+## Usage
+
+```sh
+m365 aad groupsetting remove [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the group setting to remove
+
+`--confirm`
+: Don't prompt for confirming removing the group setting
+```
+
+<Global />
+
+## Remarks
+
+If the specified _id_ doesn't refer to an existing group setting, you will get a `Resource does not exist` error.
+
+## Examples
+
+Remove group setting with id _28beab62-7540-4db1-a23f-29a6018a3848_. Will prompt for confirmation before removing the group setting
+
+```sh
+m365 aad groupsetting remove --id 28beab62-7540-4db1-a23f-29a6018a3848
+```
+
+Remove group setting with id _28beab62-7540-4db1-a23f-29a6018a3848_ without prompting for confirmation
+
+```sh
+m365 aad groupsetting remove --id 28beab62-7540-4db1-a23f-29a6018a3848 --confirm
+```

package/docs/docs/cmd/aad/groupsetting/groupsetting-set.mdx

@@ -0,0 +1,38 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad groupsetting set
+
+Updates the particular group setting
+
+## Usage
+
+```sh
+m365 aad groupsetting set [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the group setting to update
+```
+
+<Global />
+
+## Remarks
+
+To update a group setting, you have to specify the ID of the group setting. You can retrieve the ID of the group setting using the [aad groupsetting list](./groupsetting-list.mdx) command.
+
+To update values for the different properties specified in the group setting, include additional options that match the property in the group setting. For example `--ClassificationList 'HBI, MBI, LBI, GDPR'` will set the list of classifications to use on modern SharePoint sites.
+
+If you don't specify a value for the particular property, it will remain unchanged. To find out which properties are available for the particular group setting, use the [aad groupsetting get](./groupsetting-get.mdx) command.
+
+If the specified id doesn't reference a valid group setting, you will get a _Resource 'xyz' does not exist or one of its queried reference-property objects are not present._ error.
+
+## Examples
+
+Configure classification for modern SharePoint sites
+
+```sh
+m365 aad groupsetting set --id c391b57d-5783-4c53-9236-cefb5c6ef323 --UsageGuidelinesUrl https://contoso.sharepoint.com/sites/compliance --ClassificationList 'HBI, MBI, LBI, GDPR' --DefaultClassification MBI
+```

package/docs/docs/cmd/aad/groupsettingtemplate/groupsettingtemplate-get.mdx

@@ -0,0 +1,37 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad groupsettingtemplate get
+
+Gets information about the specified Azure AD group settings template
+
+## Usage
+
+```sh
+m365 aad groupsettingtemplate get [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: The ID of the settings template to retrieve. Specify the `id` or `displayName` but not both
+
+`-n, --displayName [displayName]`
+: The display name of the settings template to retrieve. Specify the `id` or `displayName` but not both
+```
+
+<Global />
+
+## Examples
+
+Get information about the group setting template with id _62375ab9-6b52-47ed-826b-58e47e0e304b_
+
+```sh
+m365 aad groupsettingtemplate get --id 62375ab9-6b52-47ed-826b-58e47e0e304b
+```
+
+Get information about the group setting template with display name _Group.Unified_
+
+```sh
+m365 aad groupsettingtemplate get --displayName Group.Unified
+```