Skip to content

Commit 008fb58

Browse files
author
Chinmaya Rath
committed
- Azure AD rebranding to Microsoft Entra ID
- Updated NuGet packages (including Azure.Identity and ADAL to MSAL)
1 parent b0eb522 commit 008fb58

File tree

64 files changed

+1072
-731
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+1072
-731
lines changed

README.md

Lines changed: 42 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ These instructions will get the project up and running in Azure.
1919

2020
Before running the project on local machine/ or deploy the following things needs to be setup on Azure:
2121
- Azure Subscription
22-
- Azure Active Directory (AAD) App (along with secret)
22+
- Microsoft Entra ID App (along with secret)
2323

2424
Apart from these keep the following items handy as it would be required during deployment:
25-
- AAD App's ClientId for Authentication in case of API
26-
- AAD App's Secret for Authentication in case of API
27-
- Assign a default `user_impersonation` scope for the AAD app (with Admin Consent only)
28-
- AAD App's resource/AAP ID URI used for generating token (audience)
25+
- Microsoft Entra ID App's ClientId for Authentication in case of API
26+
- Microsoft Entra ID App's Secret for Authentication in case of API
27+
- Assign a default `user_impersonation` scope for the Microsoft Entra ID app (with Admin Consent only)
28+
- Microsoft Entra ID App's resource/AAP ID URI used for generating token (audience)
2929
- TenantId for Authentication in case of API
30-
- Issuer Url for Authentication : https://sts.windows.net/{AADTenantId}
30+
- Issuer Url for Authentication : https://sts.windows.net/{IdentityProviderTenantId}
3131
- Custom Application Name which would be used to create AppServices/Functions (resource_name_prefix)
3232
- Custom Resource Group Name where all the resources will be deployed
33-
- Location/code to deploy the Azure Resources (e.g. Central US/centralus. Powershell Command: Get-AzureRmLocation)
33+
- Location/code to deploy the Azure Resources (e.g. Central US/centralus. Powershell Command: Get-AzureRmLocation |Format-Table)
3434

3535

3636
### Installing
@@ -96,39 +96,38 @@ Step 2: Add/update the values for the following keys in the JSON
9696
```
9797
| Key Name | Source | In KeyVault ? |
9898
|--------|------|--------|
99-
| AADTenantId | Azure Active Directory (AAD) Tenant ID | No |
100-
| AntiCorruptionMessage | Message to be shown on the UI while taking action (if applicable) | No |
101-
| ApprovalsAudienceUrl | AAD Resource (APP ID URL) | No |
102-
| ApprovalsBaseUrl | Approvals Website Base URL | No |
103-
| ApprovalsCoreServicesURL | Approvals API's Base URL | No |
104-
| AzureSearchServiceName | Azure Search | No |
105-
| AzureSearchServiceQueryApiKey | Azure Search | Yes |
106-
| CosmosDbAuthKey | Azure Cosmos DB | Yes |
107-
| CosmosDbEndPoint | Azure Cosmos DB | No |
108-
| DetailControllerExceptionMessage | Error message to be shown on the UI when details loading fails | No |
109-
| EnvironmentName | Environment Name where this solution is getting deployed (e.g., DEV/ TEST etc.) | No |
110-
| GraphAPIAuthString | AAD Authority URL with {0} replaced with the TenantID - https://login.windows.net/{0} | No |
111-
| GraphAPIClientId | AAD Client ID which has permissions to Access Microsoft Graph to get user data | No |
112-
| GraphAPIClientSecret | AAD Client Secret - used to access Microsoft Graph | Yes |
113-
| NotificationBroadcastUri | Notification Service's REST endpoint | No |
114-
| NotificationFrameworkAuthKey | AAD Client Secret - used for Authentication with Notification Framework/service | Yes |
115-
| NotificationFrameworkClientId | AAD Client ID - used for Authentication with Notification Framework/service | No |
116-
| ReceiptAcknowledgmentMessage | Message to be shown on the UI while taking action (if applicable | No |
117-
| ServiceBusConnectionString | Azure Service Bus | Yes |
118-
| ServiceBusIssuerSecret | Azure Service Bus | Yes |
119-
| ServiceBusNamespace | Azure Service Bus | No |
120-
| ServiceComponentId | [Optional] Used for Logging | No |
121-
| ServiceLineName | [Optional] Used for Logging | No |
122-
| ServiceName | [Optional] Used for Logging | No |
123-
| ServiceOfferingName | [Optional] Used for Logging | No |
124-
| ServiceParameterAuthKey | AAD Client Secret - used for Authentication with LoB apps endpoints/service | Yes |
125-
| ServiceParameterClientID | AAD Client ID - used for Authentication with LoB apps endpoints/service | No |
126-
| StorageAccountKey | Azure Storage | Yes |
127-
| StorageAccountName | Azure Storage | No |
128-
| SupportEmailId | e.g., mailto:help@contoso.com | No |
129-
| SyntheticTransactionsApproverAliasList | [Optional] (;) separated list of aliases which would be the allowed approvers for creating synthetic transaction requests | No |
130-
| UrlPlaceholderTenants | [Optional] Int32 identifiers for simulating LoB apps in self-server portal | No |
131-
| WhitelistDomains | Domains which will be allowed to access Assent | No |
99+
| AntiCorruptionMessage | ```Message to be shown on the UI while taking action (if applicable)``` | No |
100+
| ApprovalsAudienceUrl | ```Microsoft Entra ID Resource (APP ID URL)``` | No |
101+
| ApprovalsBaseUrl | ```Approvals Website Base URL``` | No |
102+
| ApprovalsCoreServicesURL | ```Approvals API's Base URL``` | No |
103+
| AzureSearchServiceName | ```Azure Search``` | No |
104+
| AzureSearchServiceQueryApiKey | ```Azure Search``` | Yes |
105+
| CosmosDbAuthKey | ```Azure Cosmos DB``` | Yes |
106+
| CosmosDbEndPoint | ```Azure Cosmos DB``` | No |
107+
| DetailControllerExceptionMessage | ```Error message to be shown on the UI when details loading fails``` | No |
108+
| EnvironmentName | ``` Environment Name where this solution is getting deployed (e.g., DEV/ TEST etc.)``` | No |
109+
| GraphAPIAuthString | ```Microsoft Entra ID Authority URL with {0} replaced with the TenantID - https://login.windows.net/{0}``` | No |
110+
| GraphAPIClientId | ```Microsoft Entra ID Client ID which has permissions to Access Microsoft Graph to get user data``` | No |
111+
| GraphAPIClientSecret | ```Microsoft Entra ID Client Secret - used to access Microsoft Graph``` | Yes |
112+
| NotificationBroadcastUri | ```Notification Service's REST endpoint``` | No |
113+
| NotificationFrameworkAuthKey | ```Microsoft Entra ID Client Secret - used for Authentication with Notification Framework/service``` | Yes |
114+
| NotificationFrameworkClientId | ```Microsoft Entra ID Client ID - used for Authentication with Notification Framework/service``` | No |
115+
| ReceiptAcknowledgmentMessage | ```Message to be shown on the UI while taking action (if applicable)``` | No |
116+
| ServiceBusConnectionString | ```Azure Service Bus``` | Yes |
117+
| ServiceBusIssuerSecret | ```Azure Service Bus``` | Yes |
118+
| ServiceBusNamespace | ```Azure Service Bus``` | No |
119+
| ServiceComponentId | ```[Optional] Used for Logging``` | No |
120+
| ServiceLineName | ```[Optional] Used for Logging``` | No |
121+
| ServiceName | ```[Optional] Used for Logging``` | No |
122+
| ServiceOfferingName | ```[Optional] Used for Logging``` | No |
123+
| ServiceParameterAuthKey | ```Microsoft Entra ID Client Secret - used for Authentication with LoB apps endpoints/service``` | Yes |
124+
| ServiceParameterClientID | ```Microsoft Entra ID Client ID - used for Authentication with LoB apps endpoints/service``` | No |
125+
| StorageAccountKey | ```Azure Storage``` | Yes |
126+
| StorageAccountName | ```Azure Storage``` | No |
127+
| SupportEmailId | ```e.g., mailto:help@contoso.com``` | No |
128+
| SyntheticTransactionsApproverAliasList | ```[Optional](;) separated list of aliases which would be the allowed approvers for creating synthetic transaction requests``` | No |
129+
| UrlPlaceholderTenants | ```[Optional] Int32 identifiers for simulating LoB apps in self-server portal``` | No |
130+
| WhitelistDomains | ```Domains which will be allowed to access Assent``` | No |
132131

133132
```
134133
Step 3: Go to the App Configuration service on Azure Portal and select the resource
@@ -195,7 +194,7 @@ Select the 'Label' under which the configurations needs to be added (e.g., DEV)
195194
> > Name of the component which could be name of the component like *ApprovalsCoreServicesAPI or ApprovalsPayloadServiceAPI*.
196195
>
197196
> ValidAppIds
198-
> > This is AzureAD App's ClientIds which are authorized to access this component (; separated).
197+
> This is Microsoft Entra ID App's ClientIds which are authorized to access this component (; separated).
199198
>
200199
```
201200
Note: The connection string should be the KeyVault url
@@ -204,10 +203,10 @@ Select the 'Label' under which the configurations needs to be added (e.g., DEV)
204203
#### Setup Authentication/Access Permission
205204

206205
* Setup Authentication for APIs and Function Apps
207-
* Update the Reply Urls section of the AzureAD App created earlier with the URLs of the App Services and FunctionApps (HttpTriggered) URLs suffixed with '/auth/login/aad/callback'
206+
* Update the Reply Urls section of the Microsoft Entra ID App created earlier with the URLs of the App Services and FunctionApps (HttpTriggered) URLs suffixed with '/auth/login/aad/callback'
208207
* In the 'Authentication' section of the AppServices / FunctionApps (HttpTriggered),
209208
* Add or update the Authentication values (ClientId/Secret/Issuer/Audience)
210-
* Select 'Login with Azure Active Directory' for the option 'Action to take when the request is not authenticated'
209+
* Select 'Return HTTP 302 Found (Redirect to identity provider)' for the option 'Unauthenticated requests'
211210

212211
* Permissions needed needed for System assigned Managed Identity of below Azure Components
213212
* Payload Receiver Service API:

SETUP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Make a note of all keys or secrets or Client Ids of the newly created resources:
5555
>
5656
> Application Insights Client Id
5757
>
58-
> AADs Client Id and Client Secret
58+
> Microsoft Entra ID Client Id and Client Secret
5959
>
6060
> Managed Identity Client Id and Client Secret
6161

0 commit comments

Comments
 (0)