The Microsoft Azure SQL Management Client is a powerful tool that allows users to easily manage and monitor their Azure SQL databases. With this client, users can perform a wide range of tasks such as creating, editing, and deleting databases, as well as managing permissions and backups. The client also provides real-time monitoring and alerting capabilities, allowing users to quickly identify and respond to any issues or performance bottlenecks.
swagger: '2.0'
info:
version: 2023-08-01-preview
title: Microsoft Azure SqlManagementClient
description: >-
The Azure SQL Database management API provides a RESTful set of web APIs
that interact with Azure SQL Database services to manage your databases. The
API enables users to create, retrieve, update, and delete databases,
servers, and other entities.
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups
: get:
tags:
- WorkloadGroups
description: Gets the list of workload groups
operationId: microsoftAzureWorkloadgroupsListbydatabase
parameters:
- $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
- $ref: '#/parameters/ServerNameParameter'
- $ref: '#/parameters/DatabaseNameParameter'
- $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Successfully retrieved the list of workload groups.
schema:
$ref: '#/definitions/WorkloadGroupListResult'
default:
description: |-
*** Error Responses: ***
* 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state
* 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state
* 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.
* 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.
* 404 SubscriptionDoesNotHaveServer - The requested server was not found
* 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
* 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.
* 404 ResourceNotFound - The requested resource was not found.
* 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.
* 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.
* 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
* 503 DatabaseUnavailable - The operation failed because the database is unavailable.
* 504 RequestTimeout - Service request exceeded the allowed timeout.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Get the list of workload groups for a data warehouse:
$ref: ./examples/GetWorkloadGroupList.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Databases Databasename Workloadgroups
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}
: get:
tags:
- WorkloadGroups
description: Gets a workload group
operationId: microsoftAzureWorkloadgroupsGet
parameters:
- $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
- $ref: '#/parameters/ServerNameParameter'
- $ref: '#/parameters/DatabaseNameParameter'
- name: workloadGroupName
in: path
description: The name of the workload group.
required: true
type: string
- $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Successfully retrieved the specifies workload group.
schema:
$ref: '#/definitions/WorkloadGroup'
default:
description: |-
*** Error Responses: ***
* 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state
* 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state
* 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.
* 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.
* 404 SubscriptionDoesNotHaveServer - The requested server was not found
* 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
* 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.
* 404 ResourceNotFound - The requested resource was not found.
* 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.
* 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.
* 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
* 503 DatabaseUnavailable - The operation failed because the database is unavailable.
* 504 RequestTimeout - Service request exceeded the allowed timeout.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Gets a workload group for a data warehouse:
$ref: ./examples/GetWorkloadGroup.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Databases Databasename Workloadgroups Workloadgroupname
put:
tags:
- WorkloadGroups
description: Creates or updates a workload group.
operationId: microsoftAzureWorkloadgroupsCreateorupdate
parameters:
- $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
- $ref: '#/parameters/ServerNameParameter'
- $ref: '#/parameters/DatabaseNameParameter'
- name: workloadGroupName
in: path
description: The name of the workload group.
required: true
type: string
- name: parameters
in: body
description: The requested workload group state.
required: true
schema:
$ref: '#/definitions/WorkloadGroup'
- $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Successfully updated the workload group.
schema:
$ref: '#/definitions/WorkloadGroup'
'201':
description: Successfully created the workload group.
schema:
$ref: '#/definitions/WorkloadGroup'
'202':
description: Create or update for the workload group accepted.
default:
description: |-
*** Error Responses: ***
* 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state
* 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state
* 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.
* 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.
* 400 InvalidWorkloadGroupNameParameter - Invalid workload group name
* 400 InvalidMinResourcePercentParameter - Invalid min resource percent for this workload group.
* 400 InvalidMinResourcePercentPerRequestParameter - Invalid min resource percent per query for this workload group.
* 400 InvalidMaxResourcePercentParameter - Invalid max resource percent to allocate for this workload group.
* 400 InvalidMaxResourcePercentPerRequestParameter - Invalid max resource percent per query for this workload group.
* 400 InvalidImportanceParameter - Importance must be one of the following strings: Low, Below_Normal, Normal, Above_Normal, High.
* 400 InvalidQueryExecutionTimeoutParameter - Invalid query execution timeout value for this workload group.
* 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.
* 404 SubscriptionDoesNotHaveServer - The requested server was not found
* 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
* 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.
* 404 ResourceNotFound - The requested resource was not found.
* 404 OperationIdNotFound - The operation with Id does not exist.
* 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.
* 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.
* 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.
* 409 OperationCancelled - The operation has been cancelled by user.
* 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.
* 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.
* 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
* 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.
* 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
* 503 DatabaseUnavailable - The operation failed because the database is unavailable.
* 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
* 504 RequestTimeout - Service request exceeded the allowed timeout.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-examples:
Create a workload group with the required properties specified.:
$ref: ./examples/CreateOrUpdateWorkloadGroupMin.json
Create a workload group with all properties specified.:
$ref: ./examples/CreateOrUpdateWorkloadGroupMax.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Databases Databasename Workloadgroups Workloadgroupname
delete:
tags:
- WorkloadGroups
description: Deletes a workload group.
operationId: microsoftAzureWorkloadgroupsDelete
parameters:
- $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
- $ref: '#/parameters/ServerNameParameter'
- $ref: '#/parameters/DatabaseNameParameter'
- name: workloadGroupName
in: path
description: The name of the workload group to delete.
required: true
type: string
- $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Successfully deleted the workload group.
'202':
description: Deleting the workload group is in progress.
'204':
description: The specified workload group does not exist.
default:
description: |-
*** Error Responses: ***
* 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state
* 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state
* 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.
* 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.
* 404 SubscriptionDoesNotHaveServer - The requested server was not found
* 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
* 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.
* 404 ResourceNotFound - The requested resource was not found.
* 404 OperationIdNotFound - The operation with Id does not exist.
* 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.
* 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.
* 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.
* 409 OperationCancelled - The operation has been cancelled by user.
* 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.
* 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.
* 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
* 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.
* 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
* 503 DatabaseUnavailable - The operation failed because the database is unavailable.
* 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
* 504 RequestTimeout - Service request exceeded the allowed timeout.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-examples:
Delete a workload group:
$ref: ./examples/DeleteWorkloadGroup.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Databases Databasename Workloadgroups Workloadgroupname
definitions:
WorkloadGroup:
description: Workload group operations for a data warehouse
type: object
allOf:
- $ref: ../../../common/v1/types.json#/definitions/ProxyResource
properties:
properties:
$ref: '#/definitions/WorkloadGroupProperties'
description: Resource properties.
x-ms-client-flatten: true
WorkloadGroupListResult:
description: A list of workload groups.
type: object
properties:
value:
description: Array of results.
type: array
items:
$ref: '#/definitions/WorkloadGroup'
readOnly: true
nextLink:
description: Link to retrieve next page of results.
type: string
readOnly: true
WorkloadGroupProperties:
description: >-
Workload group definition. For more information look at
sys.workload_management_workload_groups (DMV).
required:
- minResourcePercent
- maxResourcePercent
- minResourcePercentPerRequest
type: object
properties:
minResourcePercent:
format: int32
description: The workload group minimum percentage resource.
type: integer
maxResourcePercent:
format: int32
description: The workload group cap percentage resource.
type: integer
minResourcePercentPerRequest:
format: double
description: The workload group request minimum grant percentage.
type: number
maxResourcePercentPerRequest:
format: double
description: The workload group request maximum grant percentage.
type: number
importance:
description: The workload group importance level.
type: string
queryExecutionTimeout:
format: int32
description: The workload group query execution timeout.
type: integer
parameters:
DatabaseNameParameter:
name: databaseName
in: path
description: The name of the database.
required: true
type: string
x-ms-parameter-location: method
ServerNameParameter:
name: serverName
in: path
description: The name of the server.
required: true
type: string
x-ms-parameter-location: method
securityDefinitions:
azure_auth:
type: oauth2
description: Azure Active Directory OAuth2 Flow
flow: implicit
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
user_impersonation: impersonate your user account
tags:
- name: WorkloadGroups