search

MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.24k stars 21.41k forks source link

Unable to Connect with Rest API Endpoint for Connect Management API for data connectors Post Call #83678

Closed Tichandr closed 2 years ago

Tichandr commented 2 years ago

Title:- Unable to Connect with Rest API Endpoint for Connect Management API for data connectors Post Call

I am using the below Request for Connect Rest API Post Method:-

Url :- subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{connector-name-GUID}/connect?api-version={apiVersion}

{ "pollingConfig": { "auth": { "authType": "APIKey", "IsAPIKeyInPostPayload": true, "APIKeyIdentifier": "token [PAT]", "APIKeyName": "Authorization" } } }

Response Received:-

{ "error": { "code": "BadRequest", "message": "unsupported auth Kind" } }

If possible in the document can you enable the Try It option to test the API's directly from the documentation page. Also Please provide the correct configuration Request Body or Samples for Connect Rest API Post Call.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

batamig commented 2 years ago

hi @Tichandr, can you add the exact changes you'd like to see here? It's not clear to me from your comment. I don't know if we can add a "try it out" button to this page. Have you seen that elsewhere in microsoft docs?

Tichandr commented 2 years ago

Hi @batamig , I am referring to the https://review.docs.microsoft.com/en-us/azure/sentinel/create-codeless-connector?branch=pr-en-us-169233#supported-rest-api-actions documentation where I am trying to connect to the Azure Sentinel Connector through the Rest API endpoint.

Endpoint API URL:- https://management.azure.com/subscriptions/[SubscriptionId]/resourceGroups/[RGName]/providers/Microsoft.OperationalInsights/workspaces/[WorkspaceName]/providers/Microsoft.SecurityInsights/dataConnectors/[DataConnectorID]/Connect?api-version=2021-09-01-preview

I have used postman to test this API.

Request Method : POST Request Body :

{ "pollingConfig": { "auth": { "Kind": "APIKey", "APIKey": "token", "APIKeyName": "Authorization" }, "request": { "apiEndpoint": "https://api.github.com/orgs/{orgname}/invitations", "rateLimitQPS": 50, "queryWindowInMin": 15, "httpMethod": "Get", "queryTimeFormat": "yyyy-MM-ddTHH:mm:ssZ", "retryCount": 2, "timeoutInSeconds": 60, "headers": { "Accept": "application/json", "User-Agent": "Scuba" }, "queryParameters": { "phrase": "created:{_QueryWindowStartTime}..{_QueryWindowEndTime}" } }, "paging": { "pagingType": "LinkHeader", "pageSizeParaName": "per_page" }, "response": { "eventsJsonPaths": [ "$" ] } } }

After trying this out in Postman below error response I have received

{ "error": { "code": "BadRequest", "message": "unsupported auth Kind" } }

I have masked some of the details in request URL and payload considering the sensitivity of the data. Could you please help me how can I connect to dataconnector using API endpoint.

For TRY IT option I am referring to the below URL it can help to test it out in the documentation if possible. https://docs.microsoft.com/en-us/rest/api/automation/activity/get

batamig commented 2 years ago

hi, I'm afraid I don't have the answers for you. in docs we need to get the correct information from engineering...

JamesTran-MSFT commented 2 years ago

@Tichandr Thank you for your post!

When it comes to adding the "Try It" button to this article, I've assigned this doc-enhancement to the author @batamig to investigate and update as needed. image

For your issue of testing the API, since this isn't directly related to improving our docs, and to gain a better understanding of your issue, I'd recommend leveraging our Q&A forum by posting your issue there so our community, and MVPs can further assist you in troubleshooting this.

Thank you for your time and patience throughout this issue.

Tichandr commented 2 years ago

Hello @JamesTran-MSFT, Thanks for your response. I will post my questions in the https://github.com/MicrosoftDocs/azure-docs/issues/83678

batamig commented 2 years ago

Hi @Tichandr, as discussed over Teams, we should take this back to the engineering team to verify and get the correct answers. Also, as far as I understand, the "Try it" button is only available from the API docs, not the main guides. I'm going to close this issue in the meantime, but feel free to reach out on email or Teams with further questions / feedback. Thanks!

please-close