@pnp/cli-microsoft365 6.8.0 → 6.9.0-beta.1cd2525

package/docs/docs/cmd/aad/app/app-role-list.mdx

@@ -0,0 +1,115 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad app role list
+
+Gets Azure AD app registration roles
+
+## Usage
+
+```sh
+m365 aad app role list [options]
+```
+
+## Options
+
+```md definition-list
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration for which to retrieve roles. Specify either `appId`, `appObjectId` or `appName`
+
+`--appObjectId [appObjectId]`
+: Object ID of the Azure AD application registration for which to retrieve roles. Specify either `appId`, `appObjectId` or `appName`
+
+`--appName [appName]`
+: Name of the Azure AD application registration for which to retrieve roles. Specify either `appId`, `appObjectId` or `appName`
+```
+
+<Global />
+
+## Remarks
+
+For best performance use the `appObjectId` option to reference the Azure AD application registration for which to retrieve roles. If you use `appId` or `appName`, 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.
+
+## Examples
+
+Get roles for the Azure AD application registration specified by its object ID
+
+```sh
+m365 aad app role list --appObjectId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Get roles for the Azure AD application registration specified by its app (client) ID
+
+```sh
+m365 aad app role list --appId e75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Get roles for the Azure AD application registration specified by its name
+
+```sh
+m365 aad app role list --appName "My app"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "allowedMemberTypes": [
+        "User"
+      ],
+      "description": "Managers",
+      "displayName": "Managers",
+      "id": "0a545986-9142-4c88-909c-34f3c11abbc4",
+      "isEnabled": true,
+      "origin": "Application",
+      "value": "managers"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  displayName  description  id
+  -----------  -----------  ------------------------------------
+  Managers     Managers     0a545986-9142-4c88-909c-34f3c11abbc4
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  description,displayName,id,isEnabled,origin,value
+  Managers,Managers,0a545986-9142-4c88-909c-34f3c11abbc4,1,Application,managers
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad app role list --appObjectId "29d99e17-96b7-46aa-816d-b52bfeeafeb9"
+
+  Date: 2023-06-01
+
+  ## Managers (0a545986-9142-4c88-909c-34f3c11abbc4)
+
+  Property | Value
+  ---------|-------
+  description | Managers
+  displayName | Managers
+  id | 0a545986-9142-4c88-909c-34f3c11abbc4
+  isEnabled | true
+  origin | Application
+  value | managers
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/aad/app/app-role-remove.mdx

@@ -0,0 +1,78 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad app role remove
+
+Removes role from the specified Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app role remove [options]
+```
+
+## Options
+
+```md definition-list
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration from which role should be removed. Specify either `appId`, `appObjectId` or `appName`
+
+`--appObjectId [appObjectId]`
+: Object ID of the Azure AD application registration from which role should be removed. Specify either `appId`, `appObjectId` or `appName`
+
+`--appName [appName]`
+: Name of the Azure AD application registration from which role should be removed. Specify either `appId`, `appObjectId` or `appName`
+
+`-n, --name [name]`
+: Name of the role to remove. Specify either `name`, `id` or `claim`
+
+`-i, --id [id]`
+: Id of the role to remove. Specify either `name`, `id` or `claim`
+
+`-c, --claim [claim]`
+: Claim value of the role to remove. Specify either `name`, `id` or `claim`
+
+`--confirm`
+: Don't prompt for confirmation to remove the role.
+```
+
+<Global />
+
+## Remarks
+
+For best performance use the `appObjectId` option to reference the Azure AD application registration from which to remove the role. If you use `appId` or `appName`, 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.
+
+If the command finds multiple roles with the specified role name, it will prompt you to disambiguate which role it should use, listing the claim values.
+
+If the role to be removed is 'Enabled', this command will disable the role first and then remove.
+
+## Examples
+
+Remove role from a Azure AD application registration using object ID and role name options. Will prompt for confirmation before deleting the role.
+
+```sh
+m365 aad app role remove --appObjectId d75be2e1-0204-4f95-857d-51a37cf40be8 --name "Get Product"
+```
+
+Remove role from a Azure AD application registration using app (client) ID and role claim options. Will prompt for confirmation before deleting the role.
+
+```sh
+m365 aad app role remove --appId e75be2e1-0204-4f95-857d-51a37cf40be8 --claim "Product.Get"
+```
+
+Remove role from a Azure AD application registration using app name and role claim options. Will prompt for confirmation before deleting the role.
+
+```sh
+m365 aad app role remove --appName "My app" --claim "Product.Get"
+```
+
+Remove role from a Azure AD application registration using object ID and role id options. Will NOT prompt for confirmation before deleting the role.
+
+```sh
+m365 aad app role remove --appObjectId d75be2e1-0204-4f95-857d-51a37cf40be8 --id 15927ce6-1933-4b2f-b029-4dee3d53f4dd --confirm
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,97 @@
+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"
+```
+
+## Response
+
+The command won't return a response on success.

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)