Microsoft Azure

Azure Azurearcdata

The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources.

Endpoints 47

Operations

  • GETOperations_List/providers/Microsoft.AzureArcData/operations?api-version=stringLists all of the available Azure Data Services on Azure Arc API operations.

SqlManagedInstances

  • GETList sqlManagedInstance resources in the subscription/subscriptions/:subscriptionId/providers/Microsoft.AzureArcData/sqlManagedInstances?api-version=string
  • GETList sqlManagedInstance resources in the resource group/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlManagedInstances?api-version=stringGets all sqlManagedInstances in a resource group.
  • GETSqlManagedInstances_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlManagedInstances/:sqlManagedInstanceName?api-version=stringRetrieves a SQL Managed Instance resource
  • PUTSqlManagedInstances_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlManagedInstances/:sqlManagedInstanceName?api-version=stringCreates or replaces a SQL Managed Instance resource
  • DELETESqlManagedInstances_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlManagedInstances/:sqlManagedInstanceName?api-version=stringDeletes a SQL Managed Instance resource
  • PATCHSqlManagedInstances_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlManagedInstances/:sqlManagedInstanceName?api-version=stringUpdates a SQL Managed Instance resource

FailoverGroups

  • GETList the failover groups associated with the given sql managed instance./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlManagedInstances/:sqlManagedInstanceName/failoverGroups?api-version=string
  • GETFailoverGroups_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlManagedInstances/:sqlManagedInstanceName/failoverGroups/:failoverGroupName?api-version=stringRetrieves a failover group resource
  • PUTFailoverGroups_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlManagedInstances/:sqlManagedInstanceName/failoverGroups/:failoverGroupName?api-version=stringCreates or replaces a failover group resource.
  • DELETEFailoverGroups_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlManagedInstances/:sqlManagedInstanceName/failoverGroups/:failoverGroupName?api-version=stringDeletes a failover group resource

SqlServerInstances

  • GETList sqlServerInstance resources in the subscription/subscriptions/:subscriptionId/providers/Microsoft.AzureArcData/sqlServerInstances?api-version=string
  • GETList sqlServerInstance resources in the resource group/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances?api-version=stringGets all sqlServerInstances in a resource group.
  • GETSqlServerInstances_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName?api-version=stringRetrieves a SQL Server Instance resource
  • PUTSqlServerInstances_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName?api-version=stringCreates or replaces a SQL Server Instance resource
  • DELETESqlServerInstances_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName?api-version=stringDeletes a SQL Server Instance resource
  • PATCHSqlServerInstances_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName?api-version=stringUpdates a SQL Server Instance resource
  • POSTSqlServerInstances_getTelemetry/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName/getTelemetry?api-version=stringRetrieves SQL Server instance telemetry
  • POSTSqlServerInstances_getBestPracticesAssessment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName/getBestPracticesAssessment?api-version=stringRetrieves SQL best practices assessment results for the SQL Server instance.
  • POSTSqlServerInstances_runMigrationAssessment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName/runMigrationAssessment?api-version=stringRuns migration assessment for SQL Server instance
  • POSTSqlServerInstances_runBestPracticesAssessment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName/runBestPracticesAssessment?api-version=stringThe request to run SQL best practices assessment.
  • POSTSqlServerInstances_getJobsStatus/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName/getJobsStatus?api-version=stringGets jobs status details for sql arc resource
  • POSTSqlServerInstances_preUpgrade/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName/preUpgradeRequest Upgrade Permission before upgrading.
  • POSTSqlServerInstances_postUpgrade/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName/postUpgradeClean up after upgrading.
  • POSTSqlServerInstances_runManagedInstanceLinkAssessment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerInstances/:sqlServerInstanceName/runManagedInstanceLinkAssessmentRuns Managed Instance Link assessment for SQL Server instance

SqlServerLicenses

  • GETList sqlServerLicense resources in the subscription/subscriptions/:subscriptionId/providers/Microsoft.AzureArcData/sqlServerLicenses?api-version=string
  • GETList sqlServerLicense resources in the resource group/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerLicenses?api-version=stringGets all sqlServerLicenses in a resource group.
  • GETSqlServerLicenses_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerLicenses/:sqlServerLicenseName?api-version=stringRetrieves a SQL Server license resource
  • PUTSqlServerLicenses_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerLicenses/:sqlServerLicenseName?api-version=stringCreates or replaces a SQL Server license resource
  • DELETESqlServerLicenses_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerLicenses/:sqlServerLicenseName?api-version=stringDeletes a SQL Server license resource
  • PATCHSqlServerLicenses_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/sqlServerLicenses/:sqlServerLicenseName?api-version=stringUpdates a SQL Server license resource

DataControllers

  • GETList dataController resources in the subscription/subscriptions/:subscriptionId/providers/Microsoft.AzureArcData/dataControllers?api-version=string
  • GETList dataController resources in the resource group/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/dataControllers?api-version=string
  • GETDataControllers_GetDataController/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/dataControllers/:dataControllerName?api-version=stringRetrieves a dataController resource
  • PUTDataControllers_PutDataController/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/dataControllers/:dataControllerName?api-version=stringCreates or replaces a dataController resource
  • DELETEDataControllers_DeleteDataController/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/dataControllers/:dataControllerName?api-version=stringDeletes a dataController resource
  • PATCHDataControllers_PatchDataController/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/dataControllers/:dataControllerName?api-version=stringUpdates a dataController resource

ActiveDirectoryConnectors

  • GETList the active directory connectors associated with the given data controller./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/dataControllers/:dataControllerName/activeDirectoryConnectors?api-version=string
  • GETActiveDirectoryConnectors_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/dataControllers/:dataControllerName/activeDirectoryConnectors/:activeDirectoryConnectorName?api-version=stringRetrieves an Active Directory connector resource
  • PUTActiveDirectoryConnectors_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/dataControllers/:dataControllerName/activeDirectoryConnectors/:activeDirectoryConnectorName?api-version=stringCreates or replaces an Active Directory connector resource.
  • DELETEActiveDirectoryConnectors_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/dataControllers/:dataControllerName/activeDirectoryConnectors/:activeDirectoryConnectorName?api-version=stringDeletes an Active Directory connector resource

PostgresInstances

  • GETList postgres Instance resources in the subscription/subscriptions/:subscriptionId/providers/Microsoft.AzureArcData/postgresInstances?api-version=string
  • GETList postgres Instance resources in the resource group/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/postgresInstances?api-version=stringGet a postgres Instances list by Resource group name.
  • GETPostgresInstances_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/postgresInstances/:postgresInstanceName?api-version=stringRetrieves a postgres Instance resource
  • PUTPostgresInstances_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/postgresInstances/:postgresInstanceName?api-version=stringCreates or replaces a postgres Instance resource
  • DELETEPostgresInstances_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/postgresInstances/:postgresInstanceName?api-version=stringDeletes a postgres Instance resource
  • PATCHPostgresInstances_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureArcData/postgresInstances/:postgresInstanceName?api-version=stringUpdates a postgres Instance resource

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
47 operations on 28 pathsGET 20POST 8PUT 7DELETE 7PATCH 5
Main resources
SqlServerInstances 14DataControllers 6PostgresInstances 6SqlManagedInstances 6SqlServerLicenses 6ActiveDirectoryConnectors 4FailoverGroups 4Operations 1
Response formats
application/json
Description format
Swagger 2.0, API version 2026-01-01

How to test the Azure Azurearcdata in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Azurearcdata collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.AzureArcData/operations?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Azurearcdata?

The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources. It is listed under Developer tools and has 47 endpoints.

Who publishes the Azure Azurearcdata?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Azurearcdata?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Azurearcdata?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Azurearcdata have?

47 operations on 28 paths (20 GET, 8 POST, 7 PUT, 7 DELETE, 5 PATCH). The largest groups are SqlServerInstances, DataControllers, PostgresInstances, SqlManagedInstances.

Is forking the Azure Azurearcdata free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.