Azure SQL Database REST API

  • Article

The Azure SQL Database REST API includes operations for managing Azure SQL Database resources.

REST Operation Groups for 2022-02-01 Preview

Operation Group Description
Backup Short Term Retention Policies Create, get, update, list a database's short term retention policy.
Data Warehouse User Activities Get and list the user activities of a data warehouse which includes running and suspended queries.
Database Advanced Threat Protection Settings Create, get, update, list a database's Advanced Threat Protection state.
Database Advisors Get and list database advisors
Database Automatic Tuning Get and update a database's automatic tuning.
Database Columns Get and list database columns.
Database Extensions Perform a database extension operation, like polybase import.
Database Operations Get a list of operations performed on the database or cancels the asynchronous operation on the database.
Database Recommended Actions Get and update a database recommended action.
Database Schemas Get and list database schemas.
Database Security Alert Policies Create, get, update, list a database's security alert policy.
Database Tables Get and list database tables.
Database Usages Get database usages.
Database Vulnerability Assesment Rule Baselines Create, get, update, list, delete the database's vulnerability assessment rule baseline.
Database Vulnerability Assessment Scans Get, list, execute, export the vulnerability assessment scans of a database.
Database Vulnerability Assessments Create, get, update, list, delete the database's vulnerability assessment.
Databases Create, get, update, list, delete, import, export, rename, pause, resume, upgrade SQL databases.
Deleted Servers Get, list, recover the deleted servers
Elastic Pool Operations Gets a list of operations performed on the elastic pool or cancels the asynchronous operation on the elastic pool.
Elastic Pools Create, get, update, delete, failover the elastic pools.
Encryption Protectors Get, update, list, revalidate the existing encryption protectors.
Endpoint Certificates Get and list the certificates used on endpoints on the target instance.
Failover Groups Create, get, update, list, delete, and failover a failover group.
Firewall Rules Create, get, update, delete, list firewall rules.
Instance Failover Groups Create, get, update, list, delete, and failover an instance failover group.
Instance Pools Create, get, update, list, delete the instance pools.
Job Agents Create, get, update, list, delete the job agents.
Job Credentials Create, get, update, list, delete the job credentials.
Job Executions Create, get, update, list, cancel the job executions.
Job Step Executions Get and list the step executions of a job execution.
Job Steps Create, get, update, list, delete job steps for a job's current version.
Job Target Executions Get or list the target executions of a job step execution.
Job Target Groups Create, get, update, list, delete the job target groups.
Job Versions Get or list job versions.
Jobs Create, get, update, list, delete jobs.
Ledger Digest Uploads Create, get, update, list the ledger digest upload configuration for a database.
Location Capabilities Get the subscription capabilities available for the specified location.
Long Term Retention Backups Create, get, update, list, delete a long term retention backup.
Long Term Retention Managed Instance Backups Create, get, update, list, delete a long term retention backup for a managed database.
Long Term Retention Policies Get, list, set a database's long term retention policy.
Maintenance Window Options Get a list of available maintenance windows.
Maintenance Windows Get or set maintenance windows settings for a database.
Managed Backup Short Term Retention Policies Create, get, update, list a managed database's short term retention policy.
Managed Database Columns Get or list managed database columns.
Managed Database Queries Get query or query execution statistics by query id of a managed database.
Managed Database Restore Details Get managed database restore details.
Managed Database Schemas Get or list managed database schemas.
Managed Database Security Alert Policies Create, get, update, list the managed database security alert policies.
Managed Database Security Events Get a list of managed database security events.
Managed Database Sensitivity Labels Create, get, update, list the sensitivity labels of a given database. Or enable or disable sensitivity recommendations on a given column.
Managed Database Tables Get or list managed database tables.
Managed Database Transparent Data Encryption Create, get, update, list a managed database's transparent data encryption.
Managed Database Vulnerability Assessment Rule Baselines Create, get, update, list a managed database's vulnerability assessment rule baseline.
Managed Database Vulnerability Assessment Scans Get, list, execute, export a managed database's vulnerability assessment scans.
Managed Database Vulnerability Assessments Create, get, update, list, delete a managed database's vulnerability assessments.
Managed Databases Create, get, update, list, delete, restore the managed databases.
Managed Instance Administrators Create, get, update, list, delete managed instance administrators.
Managed Instance Azure AD Only Authentications Get, set, list, delete the existing server Active Directory only authentication properties.
Managed Instance Encryption Protectors Get, update, list, revalidate the existing encryption protectors of a managed instance.
Managed Instance Keys Create, get, update, list, delete the managed instance keys.
Managed Instance Long Term Retention Policies Create, get, list, update the managed instance's long term retention policies.
Managed Instance Operations Get, list, cancel the operations performed on the managed instance.
Managed Instance Private Endpoint Connections Create, get, list, update, delete the private endpoint connections on a managed instance.
Managed Instance Private Link Resources Get or list the private link resources on the managed instance.
Managed Instance Tde Certificates Create a Transparent Data Encryption certificate for a given managed instance.
Managed Instance Vulnerability Assessments Create, get, list, update, delete the managed instance's vulnerability assessment policies.
Managed Instances Create, get, update, list, delete, failover the managed instances.
Managed Restorable Dropped Database Backup Short Term Retention Policies Create, get, update, list the managed restorable dropped database's short term retention policies
Managed Server DNS Aliases Create, get, list, acquire a managed server DNS alias.
Managed Server Security Alert Policies Create, get, list, update the managed server's security alert policies.
Operations List all of the available SQL Database REST API operations.
Outbound Firewall Rules Create, get, update, list, delete the outbound firewall rules.
Private Endpoint Connections Create, get, update, list, delete the private endpoint connections on a server.
Private Link Resources Get or list the private link resources for SQL server.
Recoverable Managed Databases Get or list recoverable managed databases.
Replication Links Get, list, delete, and failover replication links.
Restorable Dropped Databases Get or list restorable dropped databases.
Restorable Dropped Managed Databases Get or list restorable dropped managed databases.
Restore Points Create, get, update, list, delete database restore points.
Sensitivity Labels Create, get, update, list the sensitivity labels of a given database. Or enable or disable sensitivity recommendations on a given column.
Server Advanced Threat Protection Settings Create, get, update, list the server's Advanced Threat Protection states.
Server Advisors Get, list, update server advisors.
Server Automatic Tuning Get or update automatic tuning options on server.
Server Azure AD Administrators Create, get, list, update, delete Azure Active Directory administrators in a server.
Server Azure AD Only Authentications Create, get, list, update, delete server Active Directory only authentication property.
Server Blob Auditing Policies Create, get, update, list an extended server or database's blob auditing policy.
Server Devops audit setting Create, get, list, update DevOps audit settings of a server.
Server Dns Aliases Create, get, list, acquire or delete a server DNS alias.
Server Keys Create, get, list, update, delete server keys.
Server Operations Get a list of operations performed on the server.
Server Security Alert Policies Create, get, list, update a server's security alert policies.
Server Trust Groups Create, get, list, update, delete server trust groups.
Server Vulnerability Assessments Create, get, list, update, delete the server vulnerability assessment policies.
Servers Create, get, update, list, delete information about an Azure SQL server. and determine whether a resource can be created with the specified name.
Sql Agent Get or set the sql agent configuration to instance.
Subscription Usages Get or list the subscription usage metrics.
Sync Agents Create, get, list, update, delete the sync agents. Or generate a sync agent key.
Sync Groups Create, get, list, update, delete the sync groups. Or refreshes a hub database schema.
Sync Members Create, get, list, update, delete the sync members.
Tde Certificates Create a Transparent Data Encryption certificate for a given server.
Time Zones Get or list the managed instance time zones.
Transparent Data Encryptions Create, get, list, update a logical database's transparent data encryption configurations.
Usages Gets all instance pool usage metrics.
Virtual Clusters Create, get, list, update, delete the virtual clusters.
Virtual Network Rules Create, get, list, update, delete the virtual network rules.
Workload Classifiers Create, get, list, update, delete the workload classifiers.
Workload Groups Create, get, list, update, delete the workload groups.
Elastic Pool Activities Get the activities for an elastic pool.
Elastic Pool Database Activities Get the activities for databases in an elastic pool.
Recoverable Databases Get a recoverable database, or list all recoverable databases for a server.
Transparent Data Encryption Activities Returns a database's transparent data encryption operation result.

REST Operation Groups for 2021-11-01 Stable

Operation Group Description
Backup Short Term Retention Policies Create, get, update, list a database's short term retention policy.
Data Warehouse User Activities Get and list the user activities of a data warehouse which includes running and suspended queries.
Database Advanced Threat Protection Settings Create, get, update, list a database's Advanced Threat Protection state.
Database Advisors Get and list database advisors
Database Automatic Tuning Get and update a database's automatic tuning.
Database Columns Get and list database columns.
Database Extensions Perform a database extension operation, like polybase import.
Database Operations Get a list of operations performed on the database or cancels the asynchronous operation on the database.
Database Recommended Actions Get and update a database recommended action.
Database Schemas Get and list database schemas.
Database Security Alert Policies Create, get, update, list a database's security alert policy.
Database Tables Get and list database tables.
Database Usages Get database usages.
Database Vulnerability Assesment Rule Baselines Create, get, update, list, delete the database's vulnerability assessment rule baseline.
Database Vulnerability Assessment Scans Get, list, execute, export the vulnerability assessment scans of a database.
Database Vulnerability Assessments Create, get, update, list, delete the database's vulnerability assessment.
Databases Create, get, update, list, delete, import, export, rename, pause, resume, upgrade SQL databases.
Deleted Servers Get, list, recover the deleted servers
Elastic Pool Operations Gets a list of operations performed on the elastic pool or cancels the asynchronous operation on the elastic pool.
Elastic Pools Create, get, update, delete, failover the elastic pools.
Encryption Protectors Get, update, list, revalidate the existing encryption protectors.
Endpoint Certificates Get and list the certificates used on endpoints on the target instance.
Failover Groups Create, get, update, list, delete, and failover a failover group.
Firewall Rules Create, get, update, delete, list firewall rules.
Instance Failover Groups Create, get, update, list, delete, and failover an instance failover group.
Instance Pools Create, get, update, list, delete the instance pools.
Job Agents Create, get, update, list, delete the job agents.
Job Credentials Create, get, update, list, delete the job credentials.
Job Executions Create, get, update, list, cancel the job executions.
Job Step Executions Get and list the step executions of a job execution.
Job Steps Create, get, update, list, delete job steps for a job's current version.
Job Target Executions Get or list the target executions of a job step execution.
Job Target Groups Create, get, update, list, delete the job target groups.
Job Versions Get or list job versions.
Jobs Create, get, update, list, delete jobs.
Ledger Digest Uploads Create, get, update, list the ledger digest upload configuration for a database.
Location Capabilities Get the subscription capabilities available for the specified location.
Long Term Retention Backups Create, get, update, list, delete a long term retention backup.
Long Term Retention Managed Instance Backups Create, get, update, list, delete a long term retention backup for a managed database.
Long Term Retention Policies Get, list, set a database's long term retention policy.
Maintenance Window Options Get a list of available maintenance windows.
Maintenance Windows Get or set maintenance windows settings for a database.
Managed Backup Short Term Retention Policies Create, get, update, list a managed database's short term retention policy.
Managed Database Columns Get or list managed database columns.
Managed Database Queries Get query or query execution statistics by query id of a managed database.
Managed Database Restore Details Get managed database restore details.
Managed Database Schemas Get or list managed database schemas.
Managed Database Security Alert Policies Create, get, update, list the managed database security alert policies.
Managed Database Security Events Get a list of managed database security events.
Managed Database Sensitivity Labels Create, get, update, list the sensitivity labels of a given database. Or enable or disable sensitivity recommendations on a given column.
Managed Database Tables Get or list managed database tables.
Managed Database Transparent Data Encryption Create, get, update, list a managed database's transparent data encryption.
Managed Database Vulnerability Assessment Rule Baselines Create, get, update, list a managed database's vulnerability assessment rule baseline.
Managed Database Vulnerability Assessment Scans Get, list, execute, export a managed database's vulnerability assessment scans.
Managed Database Vulnerability Assessments Create, get, update, list, delete a managed database's vulnerability assessments.
Managed Databases Create, get, update, list, delete, restore the managed databases.
Managed Instance Administrators Create, get, update, list, delete managed instance administrators.
Managed Instance Azure AD Only Authentications Get, set, list, delete the existing server Active Directory only authentication properties.
Managed Instance Encryption Protectors Get, update, list, revalidate the existing encryption protectors of a managed instance.
Managed Instance Keys Create, get, update, list, delete the managed instance keys.
Managed Instance Long Term Retention Policies Create, get, list, update the managed instance's long term retention policies.
Managed Instance Operations Get, list, cancel the operations performed on the managed instance.
Managed Instance Private Endpoint Connections Create, get, list, update, delete the private endpoint connections on a managed instance.
Managed Instance Private Link Resources Get or list the private link resources on the managed instance.
Managed Instance Tde Certificates Create a Transparent Data Encryption certificate for a given managed instance.
Managed Instance Vulnerability Assessments Create, get, list, update, delete the managed instance's vulnerability assessment policies.
Managed Instances Create, get, update, list, delete, failover the managed instances.
Managed Restorable Dropped Database Backup Short Term Retention Policies Create, get, update, list the managed restorable dropped database's short term retention policies
Managed Server DNS Aliases Create, get, list, acquire a managed server DNS alias.
Managed Server Security Alert Policies Create, get, list, update the managed server's security alert policies.
Operations List all of the available SQL Database REST API operations.
Outbound Firewall Rules Create, get, update, list, delete the outbound firewall rules.
Private Endpoint Connections Create, get, update, list, delete the private endpoint connections on a server.
Private Link Resources Get or list the private link resources for SQL server.
Recoverable Managed Databases Get or list recoverable managed databases.
Replication Links Get, list, delete, and failover replication links.
Restorable Dropped Databases Get or list restorable dropped databases.
Restorable Dropped Managed Databases Get or list restorable dropped managed databases.
Restore Points Create, get, update, list, delete database restore points.
Sensitivity Labels Create, get, update, list the sensitivity labels of a given database. Or enable or disable sensitivity recommendations on a given column.
Server Advanced Threat Protection Settings Create, get, update, list the server's Advanced Threat Protection states.
Server Advisors Get, list, update server advisors.
Server Automatic Tuning Get or update automatic tuning options on server.
Server Azure AD Administrators Create, get, list, update, delete Azure Active Directory administrators in a server.
Server Azure AD Only Authentications Create, get, list, update, delete server Active Directory only authentication property.
Server Blob Auditing Policies Create, get, update, list an extended server or database's blob auditing policy.
Server Devops audit setting Create, get, list, update DevOps audit settings of a server.
Server Dns Aliases Create, get, list, acquire or delete a server DNS alias.
Server Keys Create, get, list, update, delete server keys.
Server Operations Get a list of operations performed on the server.
Server Security Alert Policies Create, get, list, update a server's security alert policies.
Server Trust Groups Create, get, list, update, delete server trust groups.
Server Vulnerability Assessments Create, get, list, update, delete the server vulnerability assessment policies.
Servers Create, get, update, list, delete information about an Azure SQL server. and determine whether a resource can be created with the specified name.
Sql Agent Get or set the sql agent configuration to instance.
Subscription Usages Get or list the subscription usage metrics.
Sync Agents Create, get, list, update, delete the sync agents. Or generate a sync agent key.
Sync Groups Create, get, list, update, delete the sync groups. Or refreshes a hub database schema.
Sync Members Create, get, list, update, delete the sync members.
Tde Certificates Create a Transparent Data Encryption certificate for a given server.
Time Zones Get or list the managed instance time zones.
Transparent Data Encryptions Create, get, list, update a logical database's transparent data encryption configurations.
Usages Gets all instance pool usage metrics.
Virtual Clusters Create, get, list, update, delete the virtual clusters.
Virtual Network Rules Create, get, list, update, delete the virtual network rules.
Workload Classifiers Create, get, list, update, delete the workload classifiers.
Workload Groups Create, get, list, update, delete the workload groups.

See Also