Skip to content

Commit 5291e80

Browse files
v-regandownerv-regandowner
authored
Merge pull request #197867 from TimShererWithAquent/t596438n
Edits to improve SEO and usability
2 parents 9a34d6f + b44bf98 commit 5291e80

File tree

3 files changed

+53
-48
lines changed

3 files changed

+53
-48
lines changed

‎articles/service-connector/how-to-integrate-signalr.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
11
---
22
title: Integrate Azure SignalR Service with Service Connector
3-
description: Integrate Azure SignalR Service into your application with Service Connector
3+
description: Integrate Azure SignalR Service into your application with Service Connector. Learn about authentication types and client types of Azure SignalR Service.
44
author: shizn
55
ms.author: xshi
66
ms.service: service-connector
77
ms.topic: how-to
8-
ms.date: 10/29/2021
9-
ms.custom: ignite-fall-2021, event-tier1-build-2022
8+
ms.date: 5/25/2022
9+
ms.custom:
10+
- ignite-fall-2021
11+
- kr2b-contr-experiment
12+
- event-tier1-build-2022
1013
---
1114

1215
# Integrate Azure SignalR Service with Service Connector
1316

14-
This page shows the supported authentication types and client types of Azure SignalR Service using Service Connector. You might still be able to connect to Azure SignalR Service in other programming languages without using Service Connector. This page also shows default environment variable name and value (or Spring Boot configuration) you get when you create the service connection. You can learn more about [Service Connector environment variable naming convention](concept-service-connector-internals.md).
17+
This article shows the supported authentication types and client types of Azure SignalR Service using Service Connector. This article also shows default environment variable name and value or Spring Boot configuration that you get when you create the service connection. For more information, see [Service Connector environment variable naming convention](concept-service-connector-internals.md).
1518

1619
## Supported compute service
1720

1821
- Azure App Service
1922

20-
## Supported Authentication types and client types
23+
## Supported authentication types and client types
2124

2225
| Client Type | System-assigned Managed Identity | User-assigned Managed Identity | Secret/ConnectionString | Service Principal |
2326
| --- | --- | --- | --- | --- |
@@ -27,33 +30,31 @@ This page shows the supported authentication types and client types of Azure Sig
2730

2831
### .NET
2932

30-
**Secret/ConnectionString**
33+
- Secret/ConnectionString
3134

32-
| Default environment variable name | Description | Example value |
33-
| --- | --- | --- |
34-
| AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string | `Endpoint=https://{signalrName}.service.signalr.net;AccessKey={};Version=1.0;` |
35+
| Default environment variable name | Description | Example value |
36+
| --- | --- | --- |
37+
| AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string | `Endpoint=https://{signalrName}.service.signalr.net;AccessKey={};Version=1.0;` |
3538

36-
**System-assigned Managed Identity**
39+
- System-assigned Managed Identity
3740

38-
| Default environment variable name | Description | Example value |
39-
| --- | --- | --- |
40-
| AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string with Managed Identity | `Endpoint=https://{signalrName}.service.signalr.net;AuthType=aad;ClientId={};Version=1.0;` |
41+
| Default environment variable name | Description | Example value |
42+
| --- | --- | --- |
43+
| AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string with Managed Identity | `Endpoint=https://{signalrName}.service.signalr.net;AuthType=aad;ClientId={};Version=1.0;` |
4144

42-
**User-assigned Managed Identity**
45+
- User-assigned Managed Identity
4346

44-
| Default environment variable name | Description | Example value |
45-
| --- | --- | --- |
46-
| AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string with Managed Identity | `Endpoint=https://{signalrName}.service.signalr.net;AuthType=aad;ClientId={};Version=1.0;` |
47+
| Default environment variable name | Description | Example value |
48+
| --- | --- | --- |
49+
| AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string with Managed Identity | `Endpoint=https://{signalrName}.service.signalr.net;AuthType=aad;ClientId={};Version=1.0;` |
4750

48-
**Service Principal**
51+
- Service Principal
4952

50-
| Default environment variable name | Description | Example value |
51-
| --- | --- | --- |
52-
| AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string with Service Principal | `Endpoint=https://{signalrName}.service.signalr.net;AuthType=aad;ClientId={};ClientSecret={};TenantId={};Version=1.0;` |
53+
| Default environment variable name | Description | Example value |
54+
| --- | --- | --- |
55+
| AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string with Service Principal | `Endpoint=https://{signalrName}.service.signalr.net;AuthType=aad;ClientId={};ClientSecret={};TenantId={};Version=1.0;` |
5356

5457
## Next steps
5558

56-
Follow the tutorials listed below to learn more about Service Connector.
57-
5859
> [!div class="nextstepaction"]
5960
> [Learn about Service Connector concepts](./concept-service-connector-internals.md)

‎articles/service-connector/how-to-troubleshoot-front-end-error.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
11
---
2-
title: Service Connector Troubleshooting Guidance
3-
description: Error list and suggested actions of Service Connector
2+
title: Service Connector troubleshooting guidance
3+
description: This article lists error messages and suggested actions of Service Connector to use for troubleshooting issues.
44
author: shizn
55
ms.author: xshi
66
ms.service: service-connector
7-
ms.custom: event-tier1-build-2022
8-
ms.topic: how-to
9-
ms.date: 05/03/2022
7+
ms.topic: troubleshooting
8+
ms.date: 5/25/2022
9+
ms.custom:
10+
- ignite-fall-2021
11+
- kr2b-contr-experiment
12+
- event-tier1-build-2022
1013
---
1114

1215
# How to troubleshoot with Service Connector
1316

14-
If you come across an issue, you can refer to the error message to find suggested actions or fixes. This how-to guide shows you several options to troubleshoot Service Connector.
17+
This article lists error messages and suggestions to troubleshoot Service Connector.
1518

16-
## Troubleshooting from the Azure portal
19+
## Error message and suggested actions from the Azure portal
1720

1821
| Error message | Suggested Action |
1922
| --- | --- |
20-
| Unknown resource type | <ul><li>Check source and target resource to verify whether the service types are supported by Service Connector.</li><li>Check whether the specified source-target connection combination is supported by Service Connector.</li></ul> |
21-
| Unknown resource type | <ul><li>Check whether the target resource exists.</li><li>Check the correctness of the target resource ID.</li></ul> |
23+
| Unknown resource type | <ul><li>Check source and target resource to verify whether the service types are supported by Service Connector.</li><li>Check whether the specified source-target connection combination is supported by Service Connector.</li><li>Check whether the target resource exists.</li><li>Check the correctness of the target resource ID.</li></ul> |
2224
| Unsupported resource | <ul><li>Check whether the authentication type is supported by the specified source-target connection combination.</li></ul> |
2325

24-
### Troubleshooting using the Azure CLI
25-
26-
#### InvalidArgumentValueError
26+
## Error type，error message, and suggested actions using Azure CLI
2727

28+
### InvalidArgumentValueError
2829

2930
| Error message | Suggested Action |
3031
| --- | --- |
@@ -38,18 +39,18 @@ If you come across an issue, you can refer to the error message to find suggeste
3839
| Error message | Suggested Action |
3940
| --- | --- |
4041
| `{Argument}` shouldn't be blank | User should provide argument value for interactive input |
41-
| Required keys missing for parameter `{Parameter}`. All possible keys are: `{Keys}` | Provide value for the auth info parameter, usually in the form of `--param key1=val1 key2=val2`. |
42+
| Required keys missing for parameter `{Parameter}`. All possible keys are: `{Keys}` | Provide value for the authentication information parameter, usually in the form of `--param key1=val1 key2=val2`. |
4243
| Required argument is missing, please provide the arguments: `{Arguments}` | Provide the required argument. |
4344

4445
#### ValidationError
4546

4647
| Error message | Suggested Action |
4748
| --- | --- |
48-
| Only one auth info is needed | User can only provide one auth info parameter. Check whether auth info is missing or multiple auth info parameters are provided. |
49-
| Auth info argument should be provided when updating the connection: `{ConnectionName}` | When you update a secret type connection, auth info parameter should be provided. This error occurs because user's secret cannot be accessed through the ARM API.
50-
| Either client type or auth info should be specified to update | When you update a connection, either client type or auth info should be provided. |
51-
| Usage error: {} [KEY=VALUE ...] | Check the available keys and provide values for the auth info parameter, usually in the form of `--param key1=val1 key2=val2`. |
52-
| Unsupported Key `{Key}` is provided for parameter `{Parameter}`. All possible keys are: `{Keys}` | Check the available keys and provide values for the auth info parameter, usually in the form of `--param key1=val1 key2=val2`. |
49+
| Only one auth info is needed | User can only provide one authentication information parameter. Check whether it isn't provided or multiple parameters are provided. |
50+
| Auth info argument should be provided when updating the connection: `{ConnectionName}` | The authentication information should be provided when updating a secret type connection. This error occurs because a user's secret can't be accessed through the Azure Resource Manager API. |
51+
| Either client type or auth info should be specified to update | Either client type or authentication information should be provided when updating a connection. |
52+
| Usage error: `{} [KEY=VALUE ...]` | Check the available keys and provide values for the auth info parameter, usually in the form of `--param key1=val1 key2=val2`. |
53+
| Unsupported Key `{Key}` is provided for parameter `{Parameter}`. All possible keys are: `{Keys}` | Check the available keys and provide values for the authentication information parameter, usually in the form of `--param key1=val1 key2=val2`. |
5354
| Provision failed, please create the target resource manually and then create the connection. Error details: `{ErrorTrace}` | <ul><li>Retry.</li><li>Create the target resource manually and then create the connection.</li></ul> |
5455

5556
## Next steps

‎articles/service-connector/quickstart-portal-spring-cloud-connection.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
---
2-
title: Quickstart - Create a service connection in Spring Cloud from the Azure portal
3-
description: Quickstart showing how to create a service connection in Spring Cloud from Azure portal
2+
title: Create a service connection in Spring Cloud from Azure portal
3+
description: This quickstart shows you how to create a service connection in Spring Cloud from the Azure portal.
44
author: shizn
55
ms.author: xshi
66
ms.service: service-connector
7-
ms.custom: event-tier1-build-2022
8-
ms.topic: overview
9-
ms.date: 05/03/2022
7+
ms.topic: quickstart
8+
ms.date: 5/25/2022
9+
ms.custom:
10+
- ignite-fall-2021
11+
- kr2b-contr-experiment
12+
- event-tier1-build-2022
1013
---
1114

1215
# Quickstart: Create a service connection in Spring Cloud from the Azure portal
@@ -37,15 +40,15 @@ Sign in to the Azure portal at [https://portal.azure.com/](https://portal.azure.
3740
| **Storage account** | Your storage account | The target storage account you want to connect to. If you choose a different service type, select the corresponding target service instance. |
3841

3942
1. Select **Next: Authentication** to select the authentication type. Then select **Connection string** to use access key to connect your Blob storage account.
40-
1. Then select **Next: Review + Create** to review the provided information. Then select **Create** to create the service connection. It might take 1 minute to complete the operation.
43+
1. Then select **Next: Review + Create** to review the provided information. Then select **Create** to create the service connection. It might take one minute to complete the operation.
4144

4245
## View service connections in Spring Cloud
4346

4447
1. Select **Service Connector** to view the Spring Cloud connection to the target service.
4548

4649
1. Select **>** to expand the list and access the properties required by your Spring boot application.
4750

48-
1. Select the ellipsis **...** and **Validate**. You can see the connection validation details in the pop-up blade from the right.
51+
1. Select the ellipsis **...** and **Validate**. You can see the connection validation details in the context pane from the right.
4952

5053
## Next steps
5154

0 commit comments

Comments
 (0)