Skip to content

Commit 9982fd4

Browse files
PMEds28PMEds28
authored
Merge pull request #248403 from terencefan/tefa/reformat-signalr-aad-docs
Reformat AAD related docs for further rebrand PRs
2 parents dd246da + 8ef31de commit 9982fd4

14 files changed

+1141
-1068
lines changed

‎articles/azure-signalr/concept-connection-string.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -37,32 +37,32 @@ The connection string contains:
3737

3838
The following table lists all the valid names for key/value pairs in the connection string.
3939

40-
| Key | Description | Required | Default value| Example value
41-
| --- | --- | --- | --- | --- |
42-
| Endpoint | The URL of your ASRS instance. | Y | N/A |`https://foo.service.signalr.net` |
43-
| Port | The port that your ASRS instance is listening on. on. | N| 80/443, depends on the endpoint URI schema | 8080|
44-
| Version| The version of given connection. string. | N| 1.0 | 1.0 |
45-
| ClientEndpoint | The URI of your reverse proxy, such as the App Gateway or API. Management | N| null | `https://foo.bar` |
46-
| AuthType | The auth type. By default the service uses the AccessKey authorize requests. **Case insensitive** | N | null | Azure, azure.msi, azure.app |
40+
| Key | Description | Required | Default value | Example value |
41+
| -------------- | ------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------ | --------------------------------- |
42+
| Endpoint | The URL of your ASRS instance. | Y | N/A | `https://foo.service.signalr.net` |
43+
| Port | The port that your ASRS instance is listening on. on. | N | 80/443, depends on the endpoint URI schema | 8080 |
44+
| Version | The version of given connection. string. | N | 1.0 | 1.0 |
45+
| ClientEndpoint | The URI of your reverse proxy, such as the App Gateway or API. Management | N | null | `https://foo.bar` |
46+
| AuthType | The auth type. By default the service uses the AccessKey authorize requests. **Case insensitive** | N | null | Azure, azure.msi, azure.app |
4747

4848
### Use AccessKey
4949

5050
The local auth method is used when `AuthType` is set to null.
5151

52-
| Key | Description| Required | Default value | Example value|
53-
| --- | --- | --- | --- | --- |
54-
| AccessKey | The key string in base64 format for building access token. | Y | null | ABCDEFGHIJKLMNOPQRSTUVWEXYZ0123456789+=/ |
52+
| Key | Description | Required | Default value | Example value |
53+
| --------- | ---------------------------------------------------------- | -------- | ------------- | ---------------------------------------- |
54+
| AccessKey | The key string in base64 format for building access token. | Y | null | ABCDEFGHIJKLMNOPQRSTUVWEXYZ0123456789+=/ |
5555

5656
### Use Azure Active Directory
5757

5858
The Azure AD auth method is used when `AuthType` is set to `azure`, `azure.app` or `azure.msi`.
5959

60-
| Key| Description| Required | Default value | Example value|
61-
| -------------- | ------------------------------------------------------------------ | -------- | ------------- | ------------------------------------------ |
62-
| ClientId | A GUID of an Azure application or an Azure identity. | N| null| `00000000-0000-0000-0000-000000000000` |
63-
| TenantId | A GUID of an organization in Azure Active Directory. | N| null| `00000000-0000-0000-0000-000000000000` |
64-
| ClientSecret | The password of an Azure application instance. | N| null| `***********************.****************` |
65-
| ClientCertPath | The absolute path of a client certificate (cert) file to an Azure application instance. | N| null| `/usr/local/cert/app.cert` |
60+
| Key | Description | Required | Default value | Example value |
61+
| -------------- | --------------------------------------------------------------------------------------- | -------- | ------------- | ------------------------------------------ |
62+
| ClientId | A GUID of an Azure application or an Azure identity. | N | null | `00000000-0000-0000-0000-000000000000` |
63+
| TenantId | A GUID of an organization in Azure Active Directory. | N | null | `00000000-0000-0000-0000-000000000000` |
64+
| ClientSecret | The password of an Azure application instance. | N | null | `***********************.****************` |
65+
| ClientCertPath | The absolute path of a client certificate (cert) file to an Azure application instance. | N | null | `/usr/local/cert/app.cert` |
6666

6767
A different `TokenCredential` is used to generate Azure AD tokens depending on the parameters you have given.
6868

@@ -81,7 +81,7 @@ A different `TokenCredential` is used to generate Azure AD tokens depending on t
8181
```
8282
Endpoint=xxx;AuthType=azure.msi;ClientId=<client_id>
8383
```
84-
84+
8585
- [ManagedIdentityCredential(clientId)](/dotnet/api/azure.identity.managedidentitycredential) is used.
8686
8787
1. A system-assigned managed identity is used.
@@ -140,7 +140,7 @@ For more information about how to authenticate using Azure AD application, see [
140140

141141
## Authenticate with Managed identity
142142

143-
You can also use a system assigned or user assigned [managed identity](../active-directory/managed-identities-azure-resources/overview.md) to authenticate with SignalR service.
143+
You can also use a system assigned or user assigned [managed identity](../active-directory/managed-identities-azure-resources/overview.md) to authenticate with SignalR service.
144144

145145
To use a system assigned identity, add `AuthType=azure.msi` to the connection string:
146146

@@ -163,7 +163,7 @@ For more information about how to configure managed identity, see [Authorize fro
163163
164164
### Use the connection string generator
165165

166-
It may be cumbersome and error-prone to build connection strings manually. To avoid making mistakes, SignalR provides a connection string generator to help you generate a connection string that includes Azure AD identities like `clientId`, `tenantId`, etc. To use the tool open your SignalR instance in Azure portal, select **Connection strings** from the left side menu.
166+
It may be cumbersome and error-prone to build connection strings manually. To avoid making mistakes, SignalR provides a connection string generator to help you generate a connection string that includes Azure AD identities like `clientId`, `tenantId`, etc. To use the tool open your SignalR instance in Azure portal, select **Connection strings** from the left side menu.
167167

168168
:::image type="content" source="media/concept-connection-string/generator.png" alt-text="Screenshot showing connection string generator of SignalR service in Azure portal.":::
169169

@@ -178,7 +178,7 @@ For more information about how access tokens are generated and validated, see [A
178178

179179
A connection string contains the HTTP endpoint for app server to connect to SignalR service. The server returns the HTTP endpoint to the clients in a negotiate response, so the client can connect to the service.
180180

181-
In some applications, there may be an extra component in front of SignalR service. All client connections need to go through that component first. For example, [Azure Application Gateway](../application-gateway/overview.md) is a common service that provides additional network security.
181+
In some applications, there may be an extra component in front of SignalR service. All client connections need to go through that component first. For example, [Azure Application Gateway](../application-gateway/overview.md) is a common service that provides additional network security.
182182

183183
In such case, the client needs to connect to an endpoint different than SignalR service. Instead of manually replacing the endpoint at the client side, you can add `ClientEndpoint` to connection string:
184184

@@ -206,15 +206,15 @@ services.AddSignalR().AddAzureSignalR("<connection_string>");
206206

207207
Or you can call `AddAzureSignalR()` without any arguments. The service SDK returns the connection string from a config named `Azure:SignalR:ConnectionString` in your [configuration provider](/dotnet/core/extensions/configuration-providers).
208208

209-
In a local development environment, the configuration is stored in a file (*appsettings.json* or *secrets.json*) or environment variables. You can use one of the following ways to configure connection string:
209+
In a local development environment, the configuration is stored in a file (_appsettings.json_ or _secrets.json_) or environment variables. You can use one of the following ways to configure connection string:
210210

211211
- Use .NET secret manager (`dotnet user-secrets set Azure:SignalR:ConnectionString "<connection_string>"`)
212-
- Set an environment variable named `Azure__SignalR__ConnectionString` to the connection string. The colons need to be replaced with double underscore in the [environment variable configuration provider](/dotnet/core/extensions/configuration-providers#environment-variable-configuration-provider).
212+
- Set an environment variable named `Azure__SignalR__ConnectionString` to the connection string. The colons need to be replaced with double underscore in the [environment variable configuration provider](/dotnet/core/extensions/configuration-providers#environment-variable-configuration-provider).
213213

214214
In a production environment, you can use other Azure services to manage config/secrets like Azure [Key Vault](../key-vault/general/overview.md) and [App Configuration](../azure-app-configuration/overview.md). See their documentation to learn how to set up configuration provider for those services.
215215

216216
> [!NOTE]
217-
> Even when you're directly setting a connection string using code, it's not recommended to hardcode the connection string in source code You should read the connection string from a secret store like key vault and pass it to `AddAzureSignalR()`.
217+
> Even when you're directly setting a connection string using code, it's not recommended to hardcode the connection string in source code You should read the connection string from a secret store like key vault and pass it to `AddAzureSignalR()`.
218218
219219
### Configure multiple connection strings
220220

@@ -252,4 +252,4 @@ There are also two ways to configure multiple instances:
252252

253253
```text
254254
Azure:SignalR:ConnectionString:<name>:<type>
255-
```
255+
```

‎articles/azure-signalr/howto-disable-local-auth.md

Lines changed: 66 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ There are two ways to authenticate to Azure SignalR Service resources: Azure Act
1616

1717
> [!IMPORTANT]
1818
> Disabling local authentication can have following influences.
19-
> - The current set of access keys will be permanently deleted.
20-
> - Tokens signed with current set of access keys will become unavailable.
19+
>
20+
> - The current set of access keys will be permanently deleted.
21+
> - Tokens signed with current set of access keys will become unavailable.
2122
2223
## Use Azure portal
2324

@@ -39,71 +40,69 @@ You can disable local authentication by setting `disableLocalAuth` property to t
3940

4041
```json
4142
{
42-
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
43-
"contentVersion": "1.0.0.0",
44-
"parameters": {
45-
"resource_name": {
46-
"defaultValue": "test-for-disable-aad",
47-
"type": "String"
48-
}
49-
},
50-
"variables": {},
51-
"resources": [
52-
{
53-
"type": "Microsoft.SignalRService/SignalR",
54-
"apiVersion": "2022-08-01-preview",
55-
"name": "[parameters('resource_name')]",
56-
"location": "eastus",
57-
"sku": {
58-
"name": "Premium_P1",
59-
"tier": "Premium",
60-
"size": "P1",
61-
"capacity": 1
62-
},
63-
"kind": "SignalR",
64-
"properties": {
65-
"tls": {
66-
"clientCertEnabled": false
67-
},
68-
"features": [
69-
{
70-
"flag": "ServiceMode",
71-
"value": "Default",
72-
"properties": {}
73-
},
74-
{
75-
"flag": "EnableConnectivityLogs",
76-
"value": "True",
77-
"properties": {}
78-
}
79-
],
80-
"cors": {
81-
"allowedOrigins": [
82-
"*"
83-
]
84-
},
85-
"serverless": {
86-
"connectionTimeoutInSeconds": 30
87-
},
88-
"upstream": {},
89-
"networkACLs": {
90-
"defaultAction": "Deny",
91-
"publicNetwork": {
92-
"allow": [
93-
"ServerConnection",
94-
"ClientConnection",
95-
"RESTAPI",
96-
"Trace"
97-
]
98-
},
99-
"privateEndpoints": []
100-
},
101-
"publicNetworkAccess": "Enabled",
102-
"disableLocalAuth": true,
103-
"disableAadAuth": false
104-
}
105-
}
106-
]
43+
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
44+
"contentVersion": "1.0.0.0",
45+
"parameters": {
46+
"resource_name": {
47+
"defaultValue": "test-for-disable-aad",
48+
"type": "String"
49+
}
50+
},
51+
"variables": {},
52+
"resources": [
53+
{
54+
"type": "Microsoft.SignalRService/SignalR",
55+
"apiVersion": "2022-08-01-preview",
56+
"name": "[parameters('resource_name')]",
57+
"location": "eastus",
58+
"sku": {
59+
"name": "Premium_P1",
60+
"tier": "Premium",
61+
"size": "P1",
62+
"capacity": 1
63+
},
64+
"kind": "SignalR",
65+
"properties": {
66+
"tls": {
67+
"clientCertEnabled": false
68+
},
69+
"features": [
70+
{
71+
"flag": "ServiceMode",
72+
"value": "Default",
73+
"properties": {}
74+
},
75+
{
76+
"flag": "EnableConnectivityLogs",
77+
"value": "True",
78+
"properties": {}
79+
}
80+
],
81+
"cors": {
82+
"allowedOrigins": ["*"]
83+
},
84+
"serverless": {
85+
"connectionTimeoutInSeconds": 30
86+
},
87+
"upstream": {},
88+
"networkACLs": {
89+
"defaultAction": "Deny",
90+
"publicNetwork": {
91+
"allow": [
92+
"ServerConnection",
93+
"ClientConnection",
94+
"RESTAPI",
95+
"Trace"
96+
]
97+
},
98+
"privateEndpoints": []
99+
},
100+
"publicNetworkAccess": "Enabled",
101+
"disableLocalAuth": true,
102+
"disableAadAuth": false
103+
}
104+
}
105+
]
107106
}
108107
```
109108

0 commit comments

Comments
 (0)