Operations - List

Lists all of the available SQL Rest API operations.

GET https://management.azure.com/providers/Microsoft.Sql/operations?api-version=2014-04-01

URI Parameters

Name In Required Type Description
api-version
query True
  • string

The API version to use for the request.

Responses

Name Type Description
200 OK

OK. The request has succeeded.

Examples

Get a list of operations for a resource provider

Sample Request

GET https://management.azure.com/providers/Microsoft.Sql/operations?api-version=2014-04-01

Sample Response

{
  "value": [
    {
      "name": "Microsoft.Sql/servers/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server",
        "operation": "Get server details",
        "description": "Return a list of servers in a resource group on a subscription"
      }
    },
    {
      "name": "Microsoft.Sql/servers/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server",
        "operation": "Create new or update existing server",
        "description": "Create a new server or modify properties of existing server in a resource group on a subscription"
      }
    },
    {
      "name": "Microsoft.Sql/servers/delete",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server",
        "operation": "Delete existing server",
        "description": "Delete a server and all contained databases and elastic pools"
      }
    },
    {
      "name": "Microsoft.Sql/servers/import/action",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server",
        "operation": "Create new database from DacPac",
        "description": "Create a new database on the server and deploy schema and data from a DacPac package"
      }
    },
    {
      "name": "Microsoft.Sql/servers/upgrade/action",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server",
        "operation": "Upgrade server version",
        "description": "Enable new functionality available on the latest version of server and specify databases edition conversion map"
      }
    },
    {
      "name": "Microsoft.Sql/servers/firewallRules/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Firewall Rule",
        "operation": "Get server firewall rules",
        "description": "Retrieve server firewall rule details"
      }
    },
    {
      "name": "Microsoft.Sql/servers/firewallRules/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Firewall Rule",
        "operation": "Create new or update existing server firewall rule",
        "description": "Create or update server firewall rule that controls IP address range allowed to connect to the server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/firewallRules/delete",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Firewall Rule",
        "operation": "Delete server firewall rule",
        "description": "Delete firewall rule from the server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/administrators/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "The server administrator",
        "operation": "Get server administrator",
        "description": "Retrieve server administrator details"
      }
    },
    {
      "name": "Microsoft.Sql/servers/administrators/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "The server administrator",
        "operation": "Create new or update existing server administrator",
        "description": "Create or update server administrator"
      }
    },
    {
      "name": "Microsoft.Sql/servers/administrators/delete",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "The server administrator",
        "operation": "Delete server administrator",
        "description": "Delete server administrator from the server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/administratorOperationResults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "The server administrator operation results",
        "operation": "Get server administrator operation results",
        "description": "Retrieve server administrator operation results"
      }
    },
    {
      "name": "Microsoft.Sql/servers/serviceObjectives/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Service Level Objective",
        "operation": "Get service level objectives",
        "description": "Retrieve list of service level objectives (also known as performance tiers) available on a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/restorableDroppedDatabases/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Restorable Dropped Database",
        "operation": "Get list of restorable dropped databases",
        "description": "Retrieve a list of databases that were dropped on a given server that are still within retention policy. This operation returns a list of databases and associated metadata, like date of deletion."
      }
    },
    {
      "name": "Microsoft.Sql/servers/recoverableDatabases/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Recoverable Database",
        "operation": "Get the last known database recovery point",
        "description": "This operation is used for disaster recovery of live database to restore database to last-known good backup point. It returns information about the last good backup but it doesn't actually restore the database."
      }
    },
    {
      "name": "Microsoft.Sql/servers/importExportOperationResults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Database Import Operation Result",
        "operation": "Get details about database import operation on the server",
        "description": "Return the list with details for database import operations from storage account on a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/operationResults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Upgrade Operation Result",
        "operation": "Get status of server upgrade operation",
        "description": "Operation is used to track progress of server upgrade from lower version to higher"
      }
    },
    {
      "name": "Microsoft.Sql/servers/operationResults/delete",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Upgrade Operation Result",
        "operation": "Cancel server upgrade",
        "description": "Abort server version upgrade in progress"
      }
    },
    {
      "name": "Microsoft.Sql/servers/usages/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Usage",
        "operation": "Get server usage details",
        "description": "Return server DTU quota and current DTU consumption by all databases within the server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/recommendedElasticPools/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Recommended Elastic Database Pool",
        "operation": "Get recommended elastic database pools",
        "description": "Retrieve recommendation for elastic database pools to reduce cost or improve performance based on historical resource utilization"
      }
    },
    {
      "name": "Microsoft.Sql/servers/recommendedElasticPools/databases/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Recommended Elastic Pool Databases",
        "operation": "Get recommended elastic pools databases",
        "description": "Retrieve databases that should be added into recommended elastic database pools for a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/recommendedElasticPools/metrics/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Recommended Elastic Database Pool Metrics",
        "operation": "Get recommended elastic database pools metrics",
        "description": "Retrieve metrics for recommended elastic database pools for a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/disasterRecoveryConfiguration/operationResults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Disaster Recovery Configuration Operation Results",
        "operation": "Retrieve result for Operation Results on a Disaster Recovery Configuration",
        "description": "Get Disaster Recovery Configuration Operation Results"
      }
    },
    {
      "name": "Microsoft.Sql/servers/advisors/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server advisor",
        "operation": "Get advisors for a server",
        "description": "Returns list of advisors available for the server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/advisors/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server advisor",
        "operation": "Update auto-execute status of a server advisor",
        "description": "Updates auto-execute status of an advisor on server level."
      }
    },
    {
      "name": "Microsoft.Sql/servers/advisors/recommendedActions/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Returns list of recommended actions of specified advisor for the server",
        "operation": "Get recommended actions of a server",
        "description": "Returns list of recommended actions of specified advisor for the server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/advisors/recommendedActions/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Returns list of recommended actions of specified advisor for the server",
        "operation": "Update server recommended action state.",
        "description": "Apply the recommended action on the server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPoolEstimates/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic pool estimate",
        "operation": "Get elastic pool estimates of a server",
        "description": "Returns list of elastic pool estimates already created for this server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPoolEstimates/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic pool estimate",
        "operation": "Create an elastic pool estimate.",
        "description": "Creates new elastic pool estimate for list of databases provided"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database",
        "operation": "Get server details",
        "description": "Return a list of servers in a resource group on a subscription"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database",
        "operation": "Create new or update existing server",
        "description": "Create a new server or modify properties of existing server in a resource group on a subscription"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/delete",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database",
        "operation": "Delete existing server",
        "description": "Delete a server and all contained databases and elastic pools"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/export/action",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database",
        "operation": "Create new database from DacPac",
        "description": "Create a new database on the server and deploy schema and data from a DacPac package"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/usages/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Usage",
        "operation": "Get database usage details",
        "description": "Return database maximum size that can be reached and current size occupied by data"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/operationResults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Operation Result",
        "operation": "Get status of database operation",
        "description": "Operation is used to track progress of long running database operation, such as scale."
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/importExportOperationResults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Import/Export Operation Result",
        "operation": "Get details about database import or export operation on the server",
        "description": "Return details about database import or export operation from DacPac located in storage account"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/replicationLinks/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Replication Link",
        "operation": "Get database replication links",
        "description": "Return details about replication links established for a particular database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/replicationLinks/delete",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Replication Link",
        "operation": "Force-terminate the replication relationship",
        "description": "Terminate the replication relationship forcefully and with potential data loss"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/replicationLinks/unlink/action",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Replication Link",
        "operation": "Terminate the replication relationship",
        "description": "Terminate the replication relationship forcefully or after synchronizing with the partner"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/replicationLinks/failover/action",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Replication Link",
        "operation": "Failover replication relationship after synchronizing",
        "description": "Failover after synchronizing all changes from the primary, making this database into the replication relationship's primary and making the remote primary into a secondary"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/replicationLinks/forceFailoverAllowDataLoss/action",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Replication Link",
        "operation": "Failover replication relationship immediately",
        "description": "Failover immediately with potential data loss, making this database into the replication relationship's primary and making the remote primary into a secondary"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/replicationLinks/updateReplicationMode/action",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Replication Link",
        "operation": "Update replication mode for link",
        "description": "Update replication mode for link to synchronous or asynchronous mode"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/replicationLinks/operationResults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Replication Link Operation Result",
        "operation": "Get status of replication link operations",
        "description": "Get status of long-running operations on database replication links"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/providers/Microsoft.Insights/metricDefinitions/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Metric Definition",
        "operation": "Get database metric definitions",
        "description": "Return types of metrics that are available for databases"
      },
      "properties": {
        "serviceSpecification": {
          "metricSpecifications": [
            {
              "name": "cpu_percent",
              "displayName": "CPU percentage",
              "displayDescription": "CPU percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "physical_data_read_percent",
              "displayName": "Data IO percentage",
              "displayDescription": "Data IO percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "log_write_percent",
              "displayName": "Log IO percentage",
              "displayDescription": "Log IO percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "metricFilterPattern": "^((?!datawarehouse).)*$",
              "fillGapWithZero": true
            },
            {
              "name": "dtu_consumption_percent",
              "displayName": "DTU percentage",
              "displayDescription": "DTU percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "metricFilterPattern": "^((?!datawarehouse).)*$",
              "fillGapWithZero": true
            },
            {
              "name": "storage",
              "displayName": "Total database size",
              "displayDescription": "Total database size",
              "unit": "Bytes",
              "aggregationType": "Maximum"
            },
            {
              "name": "connection_successful",
              "displayName": "Successful Connections",
              "displayDescription": "Successful Connections",
              "unit": "Count",
              "aggregationType": "Total",
              "fillGapWithZero": true
            },
            {
              "name": "connection_failed",
              "displayName": "Failed Connections",
              "displayDescription": "Failed Connections",
              "unit": "Count",
              "aggregationType": "Total",
              "fillGapWithZero": true
            },
            {
              "name": "blocked_by_firewall",
              "displayName": "Blocked by Firewall",
              "displayDescription": "Blocked by Firewall",
              "unit": "Count",
              "aggregationType": "Total",
              "fillGapWithZero": true
            },
            {
              "name": "deadlock",
              "displayName": "Deadlocks",
              "displayDescription": "Deadlocks",
              "unit": "Count",
              "aggregationType": "Total",
              "metricFilterPattern": "^((?!datawarehouse).)*$",
              "fillGapWithZero": true
            },
            {
              "name": "storage_percent",
              "displayName": "Database size percentage",
              "displayDescription": "Database size percentage",
              "unit": "Percent",
              "aggregationType": "Maximum",
              "metricFilterPattern": "^((?!datawarehouse).)*$"
            },
            {
              "name": "xtp_storage_percent",
              "displayName": "In-Memory OLTP storage percent",
              "displayDescription": "In-Memory OLTP storage percent",
              "unit": "Percent",
              "aggregationType": "Average",
              "metricFilterPattern": "^((?!datawarehouse).)*$",
              "fillGapWithZero": true
            },
            {
              "name": "workers_percent",
              "displayName": "Workers percentage",
              "displayDescription": "Workers percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "metricFilterPattern": "^((?!datawarehouse).)*$",
              "fillGapWithZero": true
            },
            {
              "name": "sessions_percent",
              "displayName": "Sessions percentage",
              "displayDescription": "Sessions percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "metricFilterPattern": "^((?!datawarehouse).)*$",
              "fillGapWithZero": true
            },
            {
              "name": "dtu_limit",
              "displayName": "DTU Limit",
              "displayDescription": "DTU Limit",
              "unit": "Count",
              "aggregationType": "Average",
              "metricFilterPattern": "^((?!datawarehouse).)*$"
            },
            {
              "name": "dtu_used",
              "displayName": "DTU used",
              "displayDescription": "DTU used",
              "unit": "Count",
              "aggregationType": "Average",
              "metricFilterPattern": "^((?!datawarehouse).)*$",
              "fillGapWithZero": true
            },
            {
              "name": "dwu_limit",
              "displayName": "DWU limit",
              "displayDescription": "DWU limit",
              "unit": "Count",
              "aggregationType": "Maximum",
              "metricFilterPattern": ".*datawarehouse.*$"
            },
            {
              "name": "dwu_consumption_percent",
              "displayName": "DWU percentage",
              "displayDescription": "DWU percentage",
              "unit": "Percent",
              "aggregationType": "Maximum",
              "metricFilterPattern": ".*datawarehouse.*$",
              "fillGapWithZero": true
            },
            {
              "name": "dwu_used",
              "displayName": "DWU used",
              "displayDescription": "DWU used",
              "unit": "Count",
              "aggregationType": "Maximum",
              "metricFilterPattern": ".*datawarehouse.*$",
              "fillGapWithZero": true
            }
          ]
        }
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/metrics/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Metric",
        "operation": "Get database resource consumption metrics",
        "description": "Return database resource utilization metrics"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/providers/Microsoft.Insights/diagnosticSettings/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Diagnostic Settings",
        "operation": "Read diagnostic setting",
        "description": "Gets the diagnostic setting for the resource"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/providers/Microsoft.Insights/diagnosticSettings/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Diagnostic Settings",
        "operation": "Write diagnostic setting",
        "description": "Creates or updates the diagnostic setting for the resource"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/providers/Microsoft.Insights/logDefinitions/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "The log definition of databases",
        "operation": "Read databases log definitions",
        "description": "Gets the available logs for databases"
      },
      "properties": {
        "serviceSpecification": {
          "logSpecifications": [
            {
              "name": "QueryStore",
              "displayName": "Query Store",
              "blobDuration": "PT1H"
            }
          ]
        }
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/missingindexes/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Index Advisor",
        "operation": "Get recommended database indexes",
        "description": "Return suggestions about database indexes to create, modify or delete in order to improve query performance"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/missingindexes/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Index Advisor",
        "operation": "Apply recommended database index",
        "description": "Use database index recommendation in a particular database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/schemas/tables/recommendedIndexes/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Recommended Index",
        "operation": "Get list of index recommendations",
        "description": "Retrieve list of index recommendations on a database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/schemas/tables/recommendedIndexes/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Recommended Index",
        "operation": "Update Recommended Index State",
        "description": "Apply index recommendation"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/schemas/tables/columns/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database table column",
        "operation": "Get columns",
        "description": "Retrieve list of columns of a table"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/queryStore/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Query Store settings",
        "operation": "Get Query Store settings",
        "description": "Returns current values of Query Store settings for the database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/queryStore/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Query Store settings",
        "operation": "Update Query Store settings",
        "description": "Updates Query Store setting for the database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/topQueries/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Top Queries",
        "operation": "Get Top Queries for the database",
        "description": "Returns aggregated runtime statistics for selected query in selected time period"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/topQueries/statistics/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Top Queries Statistics",
        "operation": "Get Database Top Queries statistics",
        "description": "Returns aggregated runtime statistics for selected query in selected time period"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/topQueries/queryText/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Top Queries query text",
        "operation": "Get Database Top Queries query text",
        "description": "Returns the Transact-SQL text for selected query ID"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/serviceTierAdvisors/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Service Tier Advisor",
        "operation": "Get recommended database performance level",
        "description": "Return suggestion about scaling database up or down based on query execution statistics to improve performance or reduce cost"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/transparentDataEncryption/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Transparent Data Encryption",
        "operation": "Get database transparent data encryption details",
        "description": "Retrieve status and details of transparent data encryption security feature for a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/transparentDataEncryption/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Transparent Data Encryption",
        "operation": "Change transparent data encryption state",
        "description": "Enable or disable transparent data encryption for a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/transparentDataEncryption/operationResults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Transparent Data Encryption",
        "operation": "Get database transparent data encryption details",
        "description": "Retrieve status and details of transparent data encryption security feature for a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/auditingPolicies/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Table Auditing Policy",
        "operation": "Get database table auditing policy",
        "description": "Retrieve details of the table auditing policy configured on a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/auditingPolicies/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Table Auditing Policy",
        "operation": "Set database table auditing policy",
        "description": "Change the table auditing policy for a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/auditingPolicies/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Default Server Table Auditing Policy",
        "operation": "Get default server table auditing policy",
        "description": "Retrieve details of the default server table auditing policy configured on a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/auditingPolicies/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Default Server Table Auditing Policy",
        "operation": "Set default server table auditing policy",
        "description": "Change the default server table auditing for a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/auditingSettings/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Blob Auditing Policy",
        "operation": "Get database blob auditing policy",
        "description": "Retrieve details of the blob auditing policy configured on a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/auditingSettings/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Blob Auditing Policy",
        "operation": "Set database blob auditing policy",
        "description": "Change the blob auditing policy for a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/auditingSettings/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Blob Auditing Policy",
        "operation": "Get server blob auditing policy",
        "description": "Retrieve details of the server blob auditing policy configured on a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/auditingSettings/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Blob Auditing Policy",
        "operation": "Set server blob auditing policy",
        "description": "Change the server blob auditing for a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/auditingSettings/operationResults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Blob Auditing Operation Results",
        "operation": "Get server blob auditing operation results",
        "description": "Retrieve result of the server blob auditing policy Set operation"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/auditRecords/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Blob Audit Records",
        "operation": "Get database blob audit records",
        "description": "Retrieve the database blob audit records"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/connectionPolicies/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Connection Policy",
        "operation": "Get database connection policy",
        "description": "Retrieve details of the connection policy configured on a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/connectionPolicies/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Connection Policy",
        "operation": "Set database connection policy",
        "description": "Change connection policy for a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/dataMaskingPolicies/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Data Masking Policy",
        "operation": "Get database data masking policy",
        "description": "Retrieve details of the data masking policy configured on a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/dataMaskingPolicies/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Data Masking Policy",
        "operation": "Set database data masking policy",
        "description": "Change data masking policy for a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Data Masking Policy Rule",
        "operation": "Get database data masking policy rule",
        "description": "Retrieve details of the data masking policy rule configured on a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Data Masking Policy Rule",
        "operation": "Set database data masking policy rule",
        "description": "Change data masking policy rule for a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/securityAlertPolicies/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Threat Detection Policy",
        "operation": "Get database threat detection policy",
        "description": "Retrieve details of the threat detection policy configured on a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/securityAlertPolicies/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database Threat Detection Policy",
        "operation": "Set threat detection auditing policy",
        "description": "Change the threat detection policy for a given database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/securityAlertPolicies/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Threat Detection Policy",
        "operation": "Get server threat detection policy",
        "description": "Retrieve details of the server threat detection policy configured on a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/securityAlertPolicies/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Threat Detection Policy",
        "operation": "Set server threat detection policy",
        "description": "Change the server threat detection for a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/securityAlertPolicies/operationResults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Server Threat Detection Operation Results",
        "operation": "Get server Threat Detection operation results",
        "description": "Retrieve results of the server Threat Detection policy Set operation"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/VulnerabilityAssessmentScans/action",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Vulnerability Assessment Database Scan",
        "operation": "Execute vulnerability assessment database scan",
        "description": "Execute vulnerability assessment database scan."
      }
    },
    {
      "name": "Microsoft.Sql/servers/VulnerabilityAssessmentScans/action",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Vulnerability Assessment Server Scan",
        "operation": "Execute vulnerability assessment server scan",
        "description": "Execute vulnerability assessment server scan"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/advisors/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database advisor",
        "operation": "Get advisors for a database",
        "description": "Returns list of advisors available for the database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/advisors/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database advisor",
        "operation": "Update auto-execute status of a database advisor",
        "description": "Update auto-execute status of an advisor on database level."
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/advisors/recommendedActions/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database recommended action",
        "operation": "Get recommended actions for a database",
        "description": "Returns list of recommended actions of specified advisor for the database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/advisors/recommendedActions/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database recommended action",
        "operation": "Update database recommended action state.",
        "description": "Apply the recommended action on the database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic Database Pool",
        "operation": "Get elastic database pool details",
        "description": "Retrieve details of elastic database pool on a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic Database Pool",
        "operation": "Create new or update existing elastic database pool",
        "description": "Create a new or change properties of existing elastic database pool"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/delete",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic Database Pool",
        "operation": "Delete elastic database pool",
        "description": "Delete existing elastic database pool"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/databases/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database",
        "operation": "Get elastic pool databases",
        "description": "Retrieve list and details of databases that are part of elastic database pool on a given server"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/elasticPoolActivity/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic Database Pool Activity",
        "operation": "Get elastic database pool activity",
        "description": "Retrieve activities and details on a given elastic database pool"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/elasticPoolDatabaseActivity/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic Pool Database Activity",
        "operation": "Get elastic pool database activity",
        "description": "Retrieve activities and details on a given database that is part of elastic database pool"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/providers/Microsoft.Insights/metricDefinitions/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic Database Pool Metric Definition",
        "operation": "Get elastic pool metric definitions",
        "description": "Return types of metrics that are available for elastic database pools"
      },
      "properties": {
        "serviceSpecification": {
          "metricSpecifications": [
            {
              "name": "cpu_percent",
              "displayName": "CPU percentage",
              "displayDescription": "CPU percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "physical_data_read_percent",
              "displayName": "Data IO percentage",
              "displayDescription": "Data IO percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "log_write_percent",
              "displayName": "Log IO percentage",
              "displayDescription": "Log IO percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "dtu_consumption_percent",
              "displayName": "DTU percentage",
              "displayDescription": "DTU percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "storage_percent",
              "displayName": "Storage percentage",
              "displayDescription": "Storage percentage",
              "unit": "Percent",
              "aggregationType": "Average"
            },
            {
              "name": "workers_percent",
              "displayName": "Workers percentage",
              "displayDescription": "Workers percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "sessions_percent",
              "displayName": "Sessions percentage",
              "displayDescription": "Sessions percentage",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "eDTU_limit",
              "displayName": "eDTU limit",
              "displayDescription": "eDTU limit",
              "unit": "Count",
              "aggregationType": "Average"
            },
            {
              "name": "storage_limit",
              "displayName": "Storage limit",
              "displayDescription": "Storage limit",
              "unit": "Bytes",
              "aggregationType": "Average"
            },
            {
              "name": "eDTU_used",
              "displayName": "eDTU used",
              "displayDescription": "eDTU used",
              "unit": "Count",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "storage_used",
              "displayName": "Storage used",
              "displayDescription": "Storage used",
              "unit": "Bytes",
              "aggregationType": "Average"
            },
            {
              "name": "xtp_storage_percent",
              "displayName": "In-Memory OLTP storage percent",
              "displayDescription": "In-Memory OLTP storage percent",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            }
          ]
        }
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/metrics/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic Database Pool Metric",
        "operation": "Get elastic pool resource consumption metrics",
        "description": "Return elastic database pool resource utilization metrics"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/operationResults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic Database Pool Operation Result",
        "operation": "Get elastic database pool operation result",
        "description": "Retrieve details on a given elastic database pool operation"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/advisors/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic pool advisor",
        "operation": "Get advisors for an elastic pool",
        "description": "Returns list of advisors available for the elastic pool"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/advisors/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic pool advisor",
        "operation": "Update auto-execute status of a elastic pool advisor",
        "description": "Update auto-execute status of an advisor on elastic pool level."
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/advisors/recommendedActions/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic pool recommended action",
        "operation": "Get recommended actions for an elastic pool",
        "description": "Returns list of recommended actions of specified advisor for the elastic pool"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/advisors/recommendedActions/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic pool recommended action",
        "operation": "Update elastic pool recommended action state.",
        "description": "Apply the recommended action on the elastic pool"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/providers/Microsoft.Insights/diagnosticSettings/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic Database Pool Diagnostic Settings",
        "operation": "Read diagnostic setting",
        "description": "Gets the diagnostic setting for the resource"
      }
    },
    {
      "name": "Microsoft.Sql/servers/elasticPools/providers/Microsoft.Insights/diagnosticSettings/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Elastic Database Pool Diagnostic Settings",
        "operation": "Write diagnostic setting",
        "description": "Creates or updates the diagnostic setting for the resource"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/pause/action",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database",
        "operation": "Pause a database",
        "description": "Pause a DataWarehouse edition database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/resume/action",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Database",
        "operation": "Resume a database",
        "description": "Resume a DataWarehouse edition database"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/dataWarehouseQueries/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Data Warehouse Query",
        "operation": "Get details about data warehouse query",
        "description": "Returns the data warehouse distribution query information for selected query ID"
      }
    },
    {
      "name": "Microsoft.Sql/servers/databases/dataWarehouseQueries/dataWarehouseQuerySteps/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "Data Warehouse Query Step",
        "operation": "Get details about data warehouse query step",
        "description": "Returns the distributed query step information of data warehouse query for selected step ID"
      }
    },
    {
      "name": "Microsoft.Sql/servers/backupLongTermRetentionVaults/read",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "A backup long term retention vault",
        "operation": "Read a backup long term retention vault",
        "description": "This operation is used to get a backup long term retention vault. It returns information about the vault registered to this server."
      }
    },
    {
      "name": "Microsoft.Sql/servers/backupLongTermRetentionVaults/write",
      "display": {
        "provider": "Microsoft SQL Database",
        "resource": "A backup long term retention vault",
        "operation": "This operation is used to register a backup long term retention vault to a server.",
        "description": "Register a backup long term retention vault"
      }
    }
  ]
}

Definitions

Display

Display metadata associated with the operation.

Operation

SQL REST API operation definition.

OperationListResult

Result of the request to list SQL operations. It contains a list of operations and a URL link to get the next set of results.

Display

Display metadata associated with the operation.

Name Type Description
operation
  • string

Type of operation: get, read, delete, etc.

provider
  • string

Service provider: Microsoft SQL Database.

resource
  • string

Resource on which the operation is performed: Server, Database, etc.

Operation

SQL REST API operation definition.

Name Type Description
display

Display metadata associated with the operation.

name
  • string

Operation name: {provider}/{resource}/{operation}

OperationListResult

Result of the request to list SQL operations. It contains a list of operations and a URL link to get the next set of results.

Name Type Description
nextLink
  • string

URL to get the next set of operation list results if there are any.

value

List of SQL operations supported by the SQL resource provider.