Skip to content

Commit ba02459

Browse files
committed
Add update and review auth config
1 parent 4a05e5e commit ba02459

10 files changed

+78
-8
lines changed

articles/service-connector/how-to-manage-authentication.md

Lines changed: 78 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ In this guide, learn about the different authentication options available in Ser
2727

2828
Select one of the four different authentication options offered by Service Connector to connect your Azure services together:
2929

30-
- System assigned managed identity: provides an automatically managed identity tied to the resource in Azure Active Directory (Azure AD)
31-
- User assigned managed identity: provides an identity that can be used on multiple resources
32-
- Connection string: provides one or multiple key-value pairs with secrets or tokens
33-
- Service principal: creates a service principal that defines the access policy and permissions for the user/application in the Azure AD tenant
30+
- **System assigned managed identity**: provides an automatically managed identity tied to the resource in Azure Active Directory (Azure AD)
31+
- **User assigned managed identity**: provides an identity that can be used on multiple resources
32+
- **Connection string**: provides one or multiple key-value pairs with secrets or tokens
33+
- **Service principal**: creates a service principal that defines the access policy and permissions for the user/application in the Azure AD tenant
3434

3535
Different authentication options are available for different services:
3636

@@ -61,12 +61,82 @@ Different authentication options are available for different services:
6161
| WebPub Sub | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) |
6262
| Confluent Cloud | | | ![yes icon](./media/green-check.png) | |
6363

64-
## System assigned managed identity
64+
## Review or update authentication configuration
6565

66+
## [System assigned managed identity](#tab/managed-identity)
67+
68+
When using a system-assigned managed identity, optionally review or update its authentication configuration by following these steps:
69+
70+
1. Select **Advanced** to display more options.
71+
1. Under **Role**, review the default role selected for your source service or choose another one from the list.
72+
1. Under **Configuration information**, Service Connector lists a series of configuration settings that will be generated when you create the connection. This list consists of environment variables or application properties. It varies depending on the target resource and authentication method selected. Optionally select the edit button in front of each configuration setting to edit its key.
73+
1. Select **Done** to confirm.
74+
75+
:::image type="content" source="./media/manage-authentication/managed-identity-advanced.png" alt-text="Screenshot of the Azure portal, showing advanced authentication configuration for a system-assigned managed identity.":::
76+
77+
## [User assigned managed identity](#tab/user-assigned-identity)
78+
79+
When using a user-assigned managed identity, review or edit its authentication settings by following these steps:
80+
81+
1. Under **Subscription**, select the Azure subscription that contains your user-assigned managed identity.
82+
1. Under **User assigned managed identity**, select the managed identity you want to use.
83+
84+
:::image type="content" source="./media/manage-authentication/user-assigned-identity-basic.png" alt-text="Screenshot of the Azure portal, showing basic authentication configuration for a user-assigned managed identity.":::
85+
86+
1. Optionally select **Advanced** to display more options.
87+
1. Under **Role**, review the default role selected for your source service or choose another one from the list.
88+
1. Under **Configuration information**, Service Connector lists a series of configuration settings that will be generated when you create the connection. This list consists of environment variables or application properties and varies depending on the target resource and authentication method selected. Optionally select the edit button in front of each configuration setting to edit its key.
89+
1. Select **Done** to confirm.
90+
91+
:::image type="content" source="./media/manage-authentication/user-assigned-identity-advanced.png" alt-text="Screenshot of the Azure portal, showing advanced authentication configuration for a user-assigned managed identity.":::
92+
93+
## [Connection string](#tab/connection-string)
94+
95+
When using a connection string, review or edit its authentication settings by following these steps:
96+
97+
1. Optionally select **Store Secret in Key Vault** to save your connection credentials in Azure Key Vault. This option lets you select an existing Key Vault connection from a drop-down list or create a new connection to a new or an existing Key Vault.
98+
1. Under **Subscription**, select the Azure subscription that contains your user-assigned managed identity.
99+
1. Under **User assigned managed identity**, select the managed identity you want to use.
100+
101+
:::image type="content" source="./media/manage-authentication/connection-string-basic-with-key-vault.png" alt-text="Screenshot of the Azure portal, showing basic authentication configuration to authenticate with a connection-string.":::
102+
103+
1. Optionally select **Advanced** to display more options.
104+
1. Under **Configuration information**, Service Connector lists a series of configuration settings that will be generated when you create the connection. This list consists of environment variables or application properties and varies depending on the target resource and authentication method selected. Optionally select the edit button in front of each configuration setting to edit its key.
105+
1. Select **Done** to confirm.
106+
107+
:::image type="content" source="./media/manage-authentication/connection-string-advanced.png" alt-text="Screenshot of the Azure portal, showing advanced authentication configuration to authenticate with a connection-string.":::
108+
109+
## [Service principal](#tab/service-principal)
110+
111+
When connecting Azure services using a service principal, review or edit authentication settings by following these steps:
112+
113+
1. Choose a service principal by entering an object ID or name and selecting your service principal.
114+
1. Under **Secret**, enter the secret of the service principal.
115+
1. Optionally select **Store Secret in Key Vault** to save your connection credentials in Azure Key Vault. This option lets you select an existing Key Vault connection from a drop-down list or create a new connection to a new or an existing Key Vault.
116+
117+
:::image type="content" source="./media/manage-authentication/service-principal-basic-with-key-vault.png" alt-text="Screenshot of the Azure portal, showing basic authentication configuration to authenticate with a service principal.":::
118+
119+
1. Optionally select **Advanced** to display more options.
120+
1. Under **Configuration information**, Service Connector lists a series of configuration settings that will be generated when you create the connection. This list consists of environment variables or application properties and varies depending on the target resource and authentication method selected. Optionally select the edit button in front of each configuration setting to edit its key.
121+
1. Select **Done** to confirm.
122+
123+
:::image type="content" source="./media/manage-authentication/service-principal-advanced.png" alt-text="Screenshot of the Azure portal, showing advanced authentication configuration to authenticate with a service principal.":::
124+
125+
1. Select **Review + Create** and then **Create** to finalize the creation of the connection.
126+
127+
---
128+
129+
## Check authentication configuration
130+
131+
You can review authentication configuration on the following pages in the Azure portal:
132+
133+
- When creating the connection, select the **Review + Create** tab and check the information listed under **Authentication**.
134+
135+
:::image type="content" source="./media/manage-authentication/review-authentication.png" alt-text="Screenshot of the Azure portal, showing a summary of connection authentication configuration.":::
136+
137+
- After you've created the connection, in the **Service connector** page, configuration keys are listed.
138+
:::image type="content" source="./media/manage-authentication/review-keys-after-creation.png" alt-text="Screenshot of the Azure portal, showing a summary of authentication configuration keys.":::
66139

67-
1. In the Authentication tab, select **Advanced**
68-
1.
69-
:::image type="content" source="./media/manage-authentication/managed-identity-advanced.png" alt-text="Screenshot of the Azure portal, selecting Advanced in the Authentication tab.":::
70140

71141
## Next steps
72142

13 KB
Loading
32.8 KB
Loading
-272 Bytes
Loading
14.4 KB
Loading
17.1 KB
Loading
35.7 KB
Loading
48 KB
Loading
26.7 KB
Loading
6.83 KB
Loading

0 commit comments

Comments
 (0)