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

package/docs/docs/cmd/aad/app/app-get.md

@@ -1,59 +0,0 @@
-# aad app get
-
-Gets an Azure AD app registration
-
-## Usage
-
-```sh
-m365 aad app get [options]
-```
-
-## Options
-
-`--appId [appId]`
-: Application (client) ID of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
-
-`--objectId [objectId]`
-: Object ID of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
-
-`--name [name]`
-: Name of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
-
-`--save`
-: Use to store the information about the created app in a local file
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-For best performance use the `objectId` option to reference the Azure AD application registration to get. 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.
-
-If you want to store the information about the Azure AD app registration, use the `--save` option. This is useful when you build solutions connected to Microsoft 365 and want to easily manage app registrations used with your solution. When you use the `--save` option, after you get the app registration, the command will write its ID and name to the `.m365rc.json` file in the current directory. If the file already exists, it will add the information about the App registration to it if it's not already present, allowing you to track multiple apps. If the file doesn't exist, the command will create it.
-
-## Examples
-
-Get the Azure AD application registration by its app (client) ID
-
-```sh
-m365 aad app get --appId d75be2e1-0204-4f95-857d-51a37cf40be8
-```
-
-Get the Azure AD application registration by its object ID
-
-```sh
-m365 aad app get --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
-```
-
-Get the Azure AD application registration by its name
-
-```sh
-m365 aad app get --name "My app"
-```
-
-Get the Azure AD application registration by its name. Store information about the retrieved app registration in the _.m365rc.json_ file in the current directory.
-
-```sh
-m365 aad app get --name "My app" --save
-```

package/docs/docs/cmd/aad/app/app-list.md

@@ -1,152 +0,0 @@
-# aad app list
-
-Retrieves a list of Azure AD app registrations
-
-## Usage
-
-```sh
-m365 aad app list [options]
-```
-
-## Options
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Retrieve a list of Azure AD app registrations
-
-```sh
-m365 aad app list
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "id": "ff2798f7-1c7a-4607-8a7b-3d5e0c18c756",
-        "deletedDateTime": null,
-        "appId": "61ed4fab-a861-4307-bb87-a6a53dbe39f5",
-        "applicationTemplateId": null,
-        "disabledByMicrosoftStatus": null,
-        "createdDateTime": "2021-03-16T14:51:28Z",
-        "displayName": "TestAppPermissions",
-        "description": null,
-        "groupMembershipClaims": null,
-        "identifierUris": [],
-        "isDeviceOnlyAuthSupported": null,
-        "isFallbackPublicClient": null,
-        "notes": null,
-        "publisherDomain": "Contoso.onmicrosoft.com",
-        "serviceManagementReference": null,
-        "signInAudience": "AzureADMyOrg",
-        "tags": [],
-        "tokenEncryptionKeyId": null,
-        "samlMetadataUrl": null,
-        "defaultRedirectUri": null,
-        "certification": null,
-        "optionalClaims": null,
-        "addIns": [],
-        "api": {
-          "acceptMappedClaims": null,
-          "knownClientApplications": [],
-          "requestedAccessTokenVersion": null,
-          "oauth2PermissionScopes": [],
-          "preAuthorizedApplications": []
-        },
-        "appRoles": [],
-        "info": {
-          "logoUrl": null,
-          "marketingUrl": null,
-          "privacyStatementUrl": null,
-          "supportUrl": null,
-          "termsOfServiceUrl": null
-        },
-        "keyCredentials": [
-          {
-            "customKeyIdentifier": "7D20AB8DD09B653E9A3880F9046314B76917EF62",
-            "displayName": "CN=TestCertificate",
-            "endDateTime": "2022-01-01T00:00:00Z",
-            "key": null,
-            "keyId": "8928a06f-fa2d-4d92-98c3-b0f544804f64",
-            "startDateTime": "2020-01-01T00:00:00Z",
-            "type": "AsymmetricX509Cert",
-            "usage": "Verify"
-          }
-        ],
-        "parentalControlSettings": {
-          "countriesBlockedForMinors": [],
-          "legalAgeGroupRule": "Allow"
-        },
-        "passwordCredentials": [
-          {
-            "customKeyIdentifier": null,
-            "displayName": "TestSecret",
-            "endDateTime": "2022-03-16T14:58:45.602Z",
-            "hint": "~03",
-            "keyId": "714c9628-4bb8-4f08-84b4-7fd8d7a7b8c5",
-            "secretText": null,
-            "startDateTime": "2021-03-16T14:59:07.642Z"
-          }
-        ],
-        "publicClient": {
-          "redirectUris": []
-        },
-        "requiredResourceAccess": [
-          {
-            "resourceAppId": "00000003-0000-0000-c000-000000000000",
-            "resourceAccess": [
-              {
-                "id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d",
-                "type": "Scope"
-              },
-              {
-                "id": "18228521-a591-40f1-b215-5fad4488c117",
-                "type": "Role"
-              },
-              {
-                "id": "09850681-111b-4a89-9bed-3f2cae46d706",
-                "type": "Role"
-              }
-            ]
-          }
-        ],
-        "verifiedPublisher": {
-          "displayName": null,
-          "verifiedPublisherId": null,
-          "addedDateTime": null
-        },
-        "web": {
-          "homePageUrl": null,
-          "logoutUrl": null,
-          "redirectUris": [],
-          "implicitGrantSettings": {
-            "enableAccessTokenIssuance": false,
-            "enableIdTokenIssuance": false
-          },
-          "redirectUriSettings": []
-        },
-        "spa": {
-          "redirectUris": []
-        }
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    appId                                 id                                    displayName                                                              signInAudience
-    ------------------------------------  ------------------------------------  -----------------------------------------------------------------------  ----------------------------------
-    61ed4fab-a861-4307-bb87-a6a53dbe39f5  ff2798f7-1c7a-4607-8a7b-3d5e0c18c756  TestAppPermissions                                                       AzureADMyOrg
-    ```
-
-=== "CSV"
-
-    ```csv
-    appId,id,displayName,signInAudience
-    61ed4fab-a861-4307-bb87-a6a53dbe39f5,ff2798f7-1c7a-4607-8a7b-3d5e0c18c756,TestAppPermissions,AzureADMyOrg
-    ```

package/docs/docs/cmd/aad/app/app-remove.md

@@ -1,55 +0,0 @@
-# aad app remove
-
-Removes an Azure AD app registration
-
-## Usage
-
-```sh
-m365 aad app remove [options]
-```
-
-## Options
-
-`--appId [appId]`
-: Application (client) ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name` but not multiple.
-
-`--objectId [objectId]`
-: Object ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name` but not multiple.
-
-`--name [name]`
-: Name of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name` but not multiple.
-
-`--confirm`
-: Don't prompt for confirmation to remove the app.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-For best performance use the `objectId` option to reference the Azure AD application registration to remove. 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.
-
-## Examples
-
-Remove the Azure AD application registration by its app (client) ID.
-
-```sh
-m365 aad app remove --appId d75be2e1-0204-4f95-857d-51a37cf40be8
-```
-
-Remove the Azure AD application registration by its object ID.
-
-```sh
-m365 aad app remove --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
-```
-
-Remove the Azure AD application registration by its name. Will NOT prompt for confirmation before deleting.
-
-```sh
-m365 aad app remove --name "My app" --confirm
-```
-
-## Response
-
-The command won't return a response on success.

package/docs/docs/cmd/aad/app/app-role-add.md

@@ -1,60 +0,0 @@
-# aad app role add
-
-Adds role to the specified Azure AD app registration
-
-## Usage
-
-```sh
-m365 aad app role add [options]
-```
-
-## Options
-
-`--appId [appId]`
-: Application (client) ID of the Azure AD application registration to which to add the role. Specify either `appId`, `appObjectId` or `appName`
-
-`--appObjectId [appObjectId]`
-: Object ID of the Azure AD application registration to which to add the role. Specify either `appId`, `appObjectId` or `appName`
-
-`--appName [appName]`
-: Name of the Azure AD application registration to which to add the role. Specify either `appId`, `appObjectId` or `appName`
-
-`-n, --name <name>`
-: Name of the role to add
-
-`-d, --description <description>`
-: Description of the role to add
-
-`-m, --allowedMembers <allowedMembers>`
-: Types of members that can be added to the group. Allowed values: `usersGroups`, `applications`, `both`
-
-`-c, --claim <claim>`
-: Claim value
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-For best performance use the `appObjectId` option to reference the Azure AD application registration for which to add 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.
-
-## Examples
-
-Add role to the Azure AD application registration specified by its object ID
-
-```sh
-m365 aad app role add --appObjectId d75be2e1-0204-4f95-857d-51a37cf40be8 --name Managers --description "Managers" --allowedMembers usersGroups --claim managers
-```
-
-Add role to the Azure AD application registration specified by its app (client) ID
-
-```sh
-m365 aad app role add --appId e75be2e1-0204-4f95-857d-51a37cf40be8 --name Managers --description "Managers" --allowedMembers usersGroups --claim managers
-```
-
-Add role to the Azure AD application registration specified by its name
-
-```sh
-m365 aad app role add --appName "My app" --name Managers --description "Managers" --allowedMembers usersGroups --claim managers
-```

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

@@ -1,48 +0,0 @@
-# aad app role list
-
-Gets Azure AD app registration roles
-
-## Usage
-
-```sh
-m365 aad app role list [options]
-```
-
-## Options
-
-`--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`
-
---8<-- "docs/cmd/_global.md"
-
-## 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"
-```

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

@@ -1,70 +0,0 @@
-# aad app role remove
-
-Removes role from the specified Azure AD app registration
-
-## Usage
-
-```sh
-m365 aad app role remove [options]
-```
-
-## Options
-
-`--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.
-
---8<-- "docs/cmd/_global.md"
-
-## 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
-```

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

@@ -1,89 +0,0 @@
-# aad app set
-
-Updates Azure AD app registration
-
-## Usage
-
-```sh
-m365 aad app set [options]
-```
-
-## Options
-
-`--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`
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,62 +0,0 @@
-# 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
-
-`--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`
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,50 +0,0 @@
-# aad approleassignment list
-
-Lists app role assignments for the specified application registration
-
-## Usage
-
-```sh
-m365 aad approleassignment list [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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)