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

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

@@ -0,0 +1,127 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# 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"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#servicePrincipals('6c519c5d-829a-47f9-9d5c-fd564ce103bd')/appRoleAssignments/$entity",
+      "id": "XZxRbJqC-UedXP1WTOEDvZ09aHLQDvVMkhUbT02pPp4",
+      "deletedDateTime": null,
+      "appRoleId": "d13f72ca-a275-4b96-b789-48ebcc4da984",
+      "createdDateTime": "2023-06-01T19:00:20.8353382Z",
+      "principalDisplayName": "QuillBot",
+      "principalId": "6c519c5d-829a-47f9-9d5c-fd564ce103bd",
+      "principalType": "ServicePrincipal",
+      "resourceDisplayName": "Office 365 SharePoint Online",
+      "resourceId": "eafaa868-bc8f-43ac-a882-b65a62a668fd"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  objectId            : XZxRbJqC-UedXP1WTOEDvVMwQLIAP8hMvuwGaXMPtnU
+  principalDisplayName: QuillBot
+  resourceDisplayName : Microsoft Graph
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  objectId,principalDisplayName,resourceDisplayName
+  XZxRbJqC-UedXP1WTOEDvQXFZlURrFFAtQb0mvJV_Q8,QuillBot,Microsoft Graph
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad approleassignment add --appId "e89804ac-a571-48cf-b2ba-fd57b5d49993" --resource "Microsoft Graph" --scope "Mail.Read"
+
+  Date: 2023-06-01
+
+  ## XZxRbJqC-UedXP1WTOEDvcoGqG8eRNlBmAqkiGbkNuk
+
+  Property | Value
+  ---------|-------
+  objectId | XZxRbJqC-UedXP1WTOEDvcoGqG8eRNlBmAqkiGbkNuk
+  principalDisplayName | QuillBot
+  resourceDisplayName | Microsoft Graph
+  ```
+
+  </TabItem>
+</Tabs>
+
+## 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,113 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# 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)
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "appRoleId": "810c84a8-4a9e-49e6-bf7d-12d183f40d01",
+      "resourceDisplayName": "Microsoft Graph",
+      "resourceId": "cd143b5c-7693-42ec-89fb-377e8e97a8ff",
+      "roleId": "810c84a8-4a9e-49e6-bf7d-12d183f40d01",
+      "roleName": "Mail.Read",
+      "created": "2023-06-01T19:10:29.7299757Z",
+      "deleted": null
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  resourceDisplayName           roleName
+  ----------------------------  --------------
+  Microsoft Graph               Mail.Read
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  appRoleId,resourceDisplayName,resourceId,roleId,roleName,created
+  810c84a8-4a9e-49e6-bf7d-12d183f40d01,Microsoft Graph,cd143b5c-7693-42ec-89fb-377e8e97a8ff,810c84a8-4a9e-49e6-bf7d-12d183f40d01,Mail.Read,2023-06-01T19:10:29.7299757Z
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad approleassignment list --appId "e89804ac-a571-48cf-b2ba-fd57b5d49993"
+
+  Date: 2023-06-01
+
+  Property | Value
+  ---------|-------
+  appRoleId | 810c84a8-4a9e-49e6-bf7d-12d183f40d01
+  resourceDisplayName | Microsoft Graph
+  resourceId | cd143b5c-7693-42ec-89fb-377e8e97a8ff
+  roleId | 810c84a8-4a9e-49e6-bf7d-12d183f40d01
+  roleName | Mail.Read
+  created | 2023-06-01T19:10:29.7299757Z
+  ```
+
+  </TabItem>
+</Tabs>

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

@@ -0,0 +1,73 @@
+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"
+```
+
+## Response
+
+The command won't return a response on success.
+
+## 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,164 @@
+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>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad group get --id "c541afac-508e-40c7-8880-5a601b41737b"
+
+  Date: 2022-11-13
+
+  ## All Company (c541afac-508e-40c7-8880-5a601b41737b)
+
+  Property | Value
+  ---------|-------
+  id | c541afac-508e-40c7-8880-5a601b41737b
+  createdDateTime | 2022-11-13T19:16:32Z
+  displayName | All Company
+  mail | allcompany@contoso.onmicrosoft.com
+  mailEnabled | true
+  mailNickname | allcompany
+  renewedDateTime | 2022-11-13T19:16:32Z
+  securityEnabled | false
+  securityIdentifier | S-1-12-1-82404220-1279621588-4267113344-4065130549
+  visibility | Private
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,132 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# 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
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "04e9637c-79d4-4c45-80fb-56fe35f84cf2",
+      "deletedDateTime": null,
+      "classification": null,
+      "createdDateTime": "2019-04-22T09:24:11Z",
+      "creationOptions": [
+        "HubSiteId:00000000-0000-0000-0000-000000000000",
+        "ProvisionGroupHomepage"
+      ],
+      "description": null,
+      "displayName": "Human Resources",
+      "expirationDateTime": null,
+      "groupTypes": [
+        "Unified"
+      ],
+      "isAssignableToRole": null,
+      "mail": "PNP-Contosohr@contoso.onmicrosoft.com",
+      "mailEnabled": true,
+      "mailNickname": "PNP-Contosohr",
+      "membershipRule": null,
+      "membershipRuleProcessingState": null,
+      "onPremisesDomainName": null,
+      "onPremisesLastSyncDateTime": null,
+      "onPremisesNetBiosName": null,
+      "onPremisesSamAccountName": null,
+      "onPremisesSecurityIdentifier": null,
+      "onPremisesSyncEnabled": null,
+      "preferredDataLocation": null,
+      "preferredLanguage": null,
+      "proxyAddresses": [
+        "SMTP:PNP-Contosohr@contoso.onmicrosoft.com",
+        "SPO:SPO_c9c080ff-bc85-4f49-9ec2-0a683b15bd19@SPO_1e852b49-bf4b-4ba5-bcd4-a8c4706c8ed4"
+      ],
+      "renewedDateTime": "2019-04-22T09:24:11Z",
+      "resourceBehaviorOptions": [],
+      "resourceProvisioningOptions": [],
+      "securityEnabled": false,
+      "securityIdentifier": "S-1-12-1-82404220-1279621588-4267113344-4065130549",
+      "theme": null,
+      "visibility": "Private",
+      "onPremisesProvisioningErrors": []
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                    displayName                     groupType
+  ------------------------------------  ------------------------------  ---------------------
+  04e9637c-79d4-4c45-80fb-56fe35f84cf2  Human Resources                 Microsoft 365
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,createdDateTime,displayName,mail,mailEnabled,mailNickname,renewedDateTime,securityEnabled,securityIdentifier,visibility
+  04e9637c-79d4-4c45-80fb-56fe35f84cf2,2019-04-22T09:24:11Z,Human Resources,PNP-Contosohr@contoso.onmicrosoft.com,1,PNP-Contosohr,2019-04-22T09:24:11Z,,S-1-12-1-82404220-1279621588-4267113344-4065130549,Private
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad group list
+
+  Date: 2023-06-01
+
+  ## Human Resources (04e9637c-79d4-4c45-80fb-56fe35f84cf2)
+
+  Property | Value
+  ---------|-------
+  id | 04e9637c-79d4-4c45-80fb-56fe35f84cf2
+  createdDateTime | 2019-04-22T09:24:11Z
+  displayName | Human Resources
+  mail | PNP-Contosohr@contoso.onmicrosoft.com
+  mailEnabled | true
+  mailNickname | PNP-Contosohr
+  renewedDateTime | 2019-04-22T09:24:11Z
+  securityEnabled | false
+  securityIdentifier | S-1-12-1-82404220-1279621588-4267113344-4065130549
+  visibility | Private
+  ```
+
+  </TabItem>
+</Tabs>