|
1 | 1 | --- |
2 | | -title: Service Connector troubleshooting guidance |
3 | | -description: This article lists error messages and suggested actions to troubleshooting issues with Service Connector. |
| 2 | +title: Service Connector troubleshooting |
| 3 | +description: See error messages and suggested actions for troubleshooting issues with Service Connector. |
4 | 4 | author: maud-lv |
5 | 5 | ms.author: malev |
6 | 6 | ms.service: service-connector |
7 | 7 | ms.topic: troubleshooting |
8 | | -ms.date: 10/19/2023 |
| 8 | +ms.date: 04/09/2026 |
9 | 9 | ms.custom: kr2b-contr-experiment, devx-track-azurecli |
| 10 | +#customer intent: As a Service Connector user, I need to understand the Service Connector error messages and suggested actions so I can use them to troubleshoot Service Connector. |
10 | 11 | --- |
11 | 12 |
|
12 | | -# How to troubleshoot Service Connector |
| 13 | +# Service Connector troubleshooting |
13 | 14 |
|
14 | | -This article lists error messages and suggestions to troubleshoot Service Connector. |
| 15 | +This article lists Service Connector error messages you might encounter in the Azure portal or Azure CLI, and suggests actions you can take to troubleshoot them. |
15 | 16 |
|
16 | | -## Error message and suggested actions from the Azure portal |
| 17 | +## Azure portal |
17 | 18 |
|
18 | | -| Error message | Suggested Action | |
19 | | -|-----------------------|-----------------------------------------------------------------------------------------------------------| |
20 | | -| Unknown resource type | Check source and target resource to verify whether the service types are supported by Service Connector. | |
21 | | -| | Check whether the specified source-target connection combination is supported by Service Connector. | |
22 | | -| | Check whether the target resource exists. | |
23 | | -| | Check the correctness of the target resource ID. | |
24 | | -| Unsupported resource | Check whether the authentication type is supported by the specified source-target connection combination. | |
| 19 | +The following Service Connector errors can occur in the Azure portal. |
25 | 20 |
|
26 | | -## Error type,error message, and suggested actions using Azure CLI |
| 21 | +### Unknown resource type |
27 | 22 |
|
28 | | -### InvalidArgumentValueError |
| 23 | +To troubleshoot, make sure that: |
29 | 24 |
|
30 | | -| Error message | Suggested Action | |
31 | | -|-------------------------------------------------|--------------------------------------------------------------------------| |
32 | | -| The source resource ID is invalid: `{SourceId}` | Check whether the source resource ID supported by Service Connector. | |
33 | | -| | Check the correctness of source resource ID. | |
34 | | -| Target resource ID is invalid: `{TargetId}` | Check whether the target service type is supported by Service Connector. | |
35 | | -| | Check the correctness of target resource ID. | |
36 | | -| Connection ID is invalid: `{ConnectionId}` | Check the correctness of the connection ID. | |
| 25 | +- Service Connector supports the source and target resource service types. |
| 26 | +- Service Connector supports the specified source-target connection combination. |
| 27 | +- The target resource exists. |
| 28 | +- The target resource ID is correct. |
37 | 29 |
|
38 | | -#### RequiredArgumentMissingError |
| 30 | +### Unsupported resource |
39 | 31 |
|
40 | | -| Error message | Suggested Action | |
41 | | -|------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| |
42 | | -| `{Argument}` shouldn't be blank | User should provide argument value for interactive input | |
43 | | -| 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`. | |
44 | | -| Required argument is missing, please provide the arguments: `{Arguments}` | Provide the required argument. | |
| 32 | +To troubleshoot, make sure that the selected authentication type supports the specified source-target connection combination. |
45 | 33 |
|
46 | | -#### ValidationError |
| 34 | +## Azure CLI |
47 | 35 |
|
48 | | -| Error message | Suggested Action | |
49 | | -|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
50 | | -| 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. | |
51 | | -| 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. | |
52 | | -| Either client type or auth info should be specified to update | Either client type or authentication information should be provided when updating a connection. | |
53 | | -| 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`. | |
54 | | -| 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`. | |
55 | | -| Provision failed, please create the target resource manually and then create the connection. Error details: `{ErrorTrace}` | Retry. Create the target resource manually and then create the connection. | |
| 36 | +The following Service Connector errors can occur in Azure CLI. |
56 | 37 |
|
57 | | -## Next steps |
| 38 | +### InvalidArgumentValue errors |
58 | 39 |
|
59 | | -Follow the tutorials listed below to learn more about Service Connector. |
| 40 | +| Error message | Suggested action | |
| 41 | +|--------------------|-----------------------------| |
| 42 | +| `The source resource ID is invalid: {SourceId}` | - Make sure Service Connector supports the source resource ID.<br> - Make sure the source resource ID is correct. | |
| 43 | +| `Target resource ID is invalid: {TargetId}` | - Make sure Service Connector supports the target service type.<br> - Make sure the target resource ID is correct. | |
| 44 | +| `Connection ID is invalid: {ConnectionId}` | Make sure the connection ID is correct. | |
60 | 45 |
|
61 | | -> [!div class="nextstepaction"] |
62 | | -> [Learn about Service Connector concepts](./concept-service-connector-internals.md) |
| 46 | +### RequiredArgumentMissing errors |
63 | 47 |
|
64 | | -> [!div class="nextstepaction"] |
65 | | -> [Known limitations](./known-limitations.md) |
| 48 | +| Error message | Suggested action | |
| 49 | +|--------------------|-----------------------------| |
| 50 | +| `{Argument} shouldn't be blank` | Provide an argument value for interactive input. | |
| 51 | +| `Required keys missing for parameter {Parameter}. All possible keys are: {Keys}` | Provide a value for the authentication information parameter, usually in the form `--param key1=val1 key2=val2`. | |
| 52 | +| `Required argument is missing, please provide the arguments: {Arguments}` | Provide the required argument. | |
| 53 | + |
| 54 | +### Validation errors |
| 55 | + |
| 56 | +| Error message | Suggested action | |
| 57 | +|--------------------|-----------------------------| |
| 58 | +| `Only one auth info is needed` | Make sure to provide one and only one authentication information parameter. | |
| 59 | +| `Auth info argument should be provided when updating the connection: {ConnectionName}` | Provide the authentication information when you update a secret connection type. The Azure Resource Manager API can't access a user's secret. | |
| 60 | +| `Either client type or auth info should be specified to update` | Provide either client type or authentication information when you update a connection. | |
| 61 | +| `Usage error: {} [KEY=VALUE ...]` | Check the available keys and provide values for the authentication information parameter, usually in the form `--param key1=val1 key2=val2`. | |
| 62 | +| `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 `--param key1=val1 key2=val2`. | |
| 63 | +| `Provision failed, please create the target resource manually and then create the connection. Error details: {ErrorTrace}` | Retry. If necessary, create the target resource manually and then create the connection. | |
| 64 | + |
| 65 | +## Related content |
| 66 | + |
| 67 | +- [Service Connector concepts](./concept-service-connector-internals.md) |
| 68 | +- [Service Connector known limitations](./known-limitations.md) |
0 commit comments