Azure Arc Data Services REST API reference

Azure Arc Data Services lets you run Azure data services on-premises, at the edge, and in multi-cloud environments using Kubernetes. The Microsoft.AzureArcData resource provider exposes REST APIs to create and manage the full lifecycle of Arc-enabled data resources—from deploying a data controller on a Kubernetes cluster to registering SQL Server instances, configuring licensing, and setting up high-availability topologies.

Target audience: Developers and platform engineers automating Arc-enabled data infrastructure through ARM templates, Bicep, Terraform, or direct REST calls.

Key resource types

Resource type Description
Microsoft.AzureArcData/dataControllers Arc data controllers that host Arc-enabled data services on a Kubernetes cluster
Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors Active Directory connectors scoped to a data controller for Kerberos authentication
Microsoft.AzureArcData/sqlManagedInstances Arc-enabled SQL Managed Instances running on Kubernetes
Microsoft.AzureArcData/sqlManagedInstances/failoverGroups Failover groups linking a primary and partner SQL Managed Instance
Microsoft.AzureArcData/sqlServerInstances Arc-enabled SQL Server instances running on Arc-connected servers
Microsoft.AzureArcData/sqlServerInstances/databases Databases hosted on an Arc-enabled SQL Server instance
Microsoft.AzureArcData/sqlServerInstances/availabilityGroups Always On availability groups on an Arc-enabled SQL Server instance
Microsoft.AzureArcData/postgresInstances Arc-enabled Azure Database for PostgreSQL instances running on Kubernetes
Microsoft.AzureArcData/sqlServerLicenses SQL Server Core licenses applied at tenant, subscription, or resource group scope
Microsoft.AzureArcData/sqlServerEsuLicenses Extended Security Update (ESU) licenses for Arc-enabled SQL Server instances

Overview

To learn more about Azure Arc Data Services, see Azure Arc-enabled data services overview.

REST API operations

Operation group Description
Operations List all available Microsoft.AzureArcData API operations
DataControllers Create, update, retrieve, and delete Arc data controllers
ActiveDirectoryConnectors Manage Active Directory connectors attached to a data controller
SqlManagedInstances Create, update, retrieve, and delete Arc-enabled SQL Managed Instances
FailoverGroups Configure and manage failover groups for SQL Managed Instances
SqlServerInstances Register, update, and manage Arc-enabled SQL Server instances; run assessments, pre/post-upgrade checks, and telemetry queries
SqlServerDatabases Create, update, retrieve, and delete databases on Arc-enabled SQL Server instances
SqlServerAvailabilityGroups Create, update, and delete Arc-enabled SQL Server availability groups; trigger manual and forced failover, manage distributed availability groups, create Managed Instance Links, and add databases to existing groups
SqlServerLicenses Create, update, and manage SQL Server Core licenses, including activation state and scope
SqlServerEsuLicenses Create and manage Extended Security Update (ESU) licenses for SQL Server
PostgresInstances Create, update, retrieve, and delete Arc-enabled PostgreSQL instances