You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Registering the sample apps with the Microsoft identity platform and updating the configuration files using PowerShell
1
+
# Registering sample apps with the Microsoft identity platform and updating configuration files using PowerShell
2
2
3
3
## Overview
4
4
5
5
### Quick summary
6
6
7
-
1. On Windows run PowerShell as **Administrator** and navigate to the root of the cloned directory
7
+
1. On Windows, run PowerShell as **Administrator** and navigate to the root of the cloned directory
8
8
1. In PowerShell run:
9
9
10
10
```PowerShell
11
11
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process -Force
12
12
```
13
13
14
-
1. Run the script to create your Azure AD application and configure the code of the sample application accordingly. (Other ways of running the scripts are described below)
14
+
1. Run the script to create your Azure AD application and configure the code of the sample application accordingly.
15
15
16
16
```PowerShell
17
17
cd .\AppCreationScripts\
18
-
.\Configure.ps1
18
+
.\Configure.ps1 -TenantId "your test tenant's id" -AzureEnvironmentName "[Optional] - Azure environment, defaults to 'Global'"
19
19
```
20
20
21
-
1. Open the Visual Studio solution and click start
22
-
23
21
### More details
24
22
25
-
The following paragraphs:
26
-
27
-
-[Registering the sample apps with the Microsoft identity platform and updating the configuration files using PowerShell](#registering-the-sample-apps-with-the-Microsoft-identity-platform-and-updating-the-configuration-files-using-PowerShell)
28
-
-[Overview](#overview)
29
-
-[Quick summary](#quick-summary)
30
-
-[More details](#more-details)
31
-
-[Goal of the provided scripts](#goal-of-the-provided-scripts)
32
-
-[Presentation of the scripts](#presentation-of-the-scripts)
33
-
-[Usage pattern for tests and DevOps scenarios](#usage-pattern-for-tests-and-DevOps-scenarios)
34
-
-[How to use the app creation scripts?](#how-to-use-the-app-creation-scripts)
35
-
-[Pre-requisites](#pre-requisites)
36
-
-[Run the script and start running](#run-the-script-and-start-running)
37
-
-[Four ways to run the script](#four-ways-to-run-the-script)
-[Option 3 (Interactive, but create apps in a specified tenant)](#option-3-Interactive-but-create-apps-in-a-specified-tenant)
41
-
-[Option 4 (non-interactive, and create apps in a specified tenant)](#option-4-non-interactive-and-create-apps-in-a-specified-tenant)
42
-
-[Running the script on Azure Sovereign clouds](#running-the-script-on-Azure-Sovereign-clouds)
23
+
-[Goal of the provided scripts](#goal-of-the-provided-scripts)
24
+
-[Presentation of the scripts](#presentation-of-the-scripts)
25
+
-[Usage pattern for tests and DevOps scenarios](#usage-pattern-for-tests-and-DevOps-scenarios)
26
+
-[How to use the app creation scripts?](#how-to-use-the-app-creation-scripts)
27
+
-[Pre-requisites](#pre-requisites)
28
+
-[Run the script and start running](#run-the-script-and-start-running)
29
+
-[Four ways to run the script](#four-ways-to-run-the-script)
30
+
-[Option 1 (interactive)](#option-1-interactive)
31
+
-[Option 2 (Interactive, but create apps in a specified tenant)](#option-3-Interactive-but-create-apps-in-a-specified-tenant)
32
+
-[Running the script on Azure Sovereign clouds](#running-the-script-on-Azure-Sovereign-clouds)
43
33
44
34
## Goal of the provided scripts
45
35
@@ -50,14 +40,14 @@ This sample comes with two PowerShell scripts, which automate the creation of th
50
40
These scripts are:
51
41
52
42
-`Configure.ps1` which:
53
-
- creates Azure AD applications and their related objects (permissions, dependencies, secrets),
54
-
- changes the configuration files in the C# and JavaScript projects.
43
+
- creates Azure AD applications and their related objects (permissions, dependencies, secrets, app roles),
44
+
- changes the configuration files in the sample projects.
55
45
- creates a summary file named `createdApps.html` in the folder from which you ran the script, and containing, for each Azure AD application it created:
56
46
- the identifier of the application
57
47
- the AppId of the application
58
48
- the url of its registration in the [Azure portal](https://portal.azure.com).
59
49
60
-
-`Cleanup.ps1` which cleans-up the Azure AD objects created by `Configure.ps1`. Note that this script does not revert the changes done in the configuration files, though. You will need to undo the change from source control (from Visual Studio, or from the command line using, for instance, git reset).
50
+
-`Cleanup.ps1` which cleans-up the Azure AD objects created by `Configure.ps1`. Note that this script does not revert the changes done in the configuration files, though. You will need to undo the change from source control (from Visual Studio, or from the command line using, for instance, `git reset`).
61
51
62
52
### Usage pattern for tests and DevOps scenarios
63
53
@@ -75,22 +65,23 @@ The `Configure.ps1` will stop if it tries to create an Azure AD application whic
75
65
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process
The scripts install the required PowerShell module (Microsoft.Graph.Applications) for the current user if needed. However, if you want to install if for all users on the machine, you can follow the following steps:
79
71
80
-
The scripts install the required PowerShell module (AzureAD) for the current user if needed. However, if you want to install if for all users on the machine, you can follow the following steps:
72
+
1. If you have never done it already, in the PowerShell window, install the Microsoft.Graph.Applications PowerShell modules. For this:
81
73
82
-
1. If you have never done it already, in the PowerShell window, install the AzureAD PowerShell modules. For this:
83
-
1. Open PowerShell as admin (On Windows, Search Powershell in the search bar, right click on it and select Run as administrator).
74
+
1. Open PowerShell as admin (On Windows, Search Powershell in the search bar, right click on it and select **Run as administrator**).
84
75
2. Type:
85
76
86
77
```PowerShell
87
-
Install-Module AzureAD
78
+
Install-Module Microsoft.Graph.Applications
88
79
```
89
80
90
81
or if you cannot be administrator on your machine, run:
@@ -105,44 +96,29 @@ The scripts install the required PowerShell module (AzureAD) for the current use
105
96
1. Open the Visual Studio solution, and in the solution's context menu, choose **Set Startup Projects**.
106
97
1. select **Start** for the projects
107
98
108
-
You're done. this just works!
99
+
You're done!
109
100
110
-
### Four ways to run the script
101
+
### Two ways to run the script
111
102
112
103
We advise four ways of running the script:
113
104
114
105
- Interactive: you will be prompted for credentials, and the scripts decide in which tenant to create the objects,
115
-
- non-interactive: you will provide credentials, and the scripts decide in which tenant to create the objects,
116
-
- Interactive in specific tenant: you will provide the tenant in which you want to create the objects and then you will be prompted for credentials, and the scripts will create the objects,
117
-
- non-interactive in specific tenant: you will provide tenant in which you want to create the objects and credentials, and the scripts will create the objects.
106
+
- Interactive in specific tenant: you will provide the tenant in which you want to create the objects and then you will be prompted for credentials, and the scripts will create the objects,
118
107
119
108
Here are the details on how to do this.
120
109
121
110
#### Option 1 (interactive)
122
111
123
-
- Just run ``. .\Configure.ps1``, and you will be prompted to sign-in (email address, password, and if needed MFA).
112
+
- Just run ``.\Configure.ps1``, and you will be prompted to sign-in (email address, password, and if needed MFA).
124
113
- The script will be run as the signed-in user and will use the tenant in which the user is defined.
125
114
126
115
Note that the script will choose the tenant in which to create the applications, based on the user. Also to run the `Cleanup.ps1` script, you will need to re-sign-in.
127
116
128
-
#### Option 2 (non-interactive)
129
-
130
-
When you know the identity and credentials of the user in the name of whom you want to create the applications, you can use the non-interactive approach. It's more adapted to DevOps. Here is an example of script you'd want to run in a PowerShell Window
All the four options listed above, can be used on any Azure Sovereign clouds. By default, the script targets `AzureCloud`, but it can be changed using the parameter `-AzureEnvironmentName`.
135
+
All the four options listed above can be used on any Azure Sovereign clouds. By default, the script targets `AzureCloud`, but it can be changed using the parameter `-AzureEnvironmentName`.
0 commit comments