openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 23.1 kB
JSON
{"openapi":"3.0.0","info":{"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.","title":"SqlManagementClient","version":"2019-06-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/WorkloadClassifiers.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"sql-WorkloadClassifiers","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}/workloadClassifiers":{"get":{"description":"Gets the list of workload classifiers for a workload group","operationId":"WorkloadClassifiers_ListByWorkloadGroup","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"description":"The name of the workload group from which to receive the classifiers from.","in":"path","name":"workloadGroupName","required":true,"schema":{"type":"string"},"examples":{"Get the list of workload classifiers for a workload group":{"value":"wlm_workloadgroup"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of workload groups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadClassifierListResult"},"examples":{"Get the list of workload classifiers for a workload group":{"$ref":"#/components/examples/Get_the_list_of_workload_classifiers_for_a_workload_group"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."}},"tags":["WorkloadClassifiers"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}/workloadClassifiers/{workloadClassifierName}":{"delete":{"description":"Deletes a workload classifier.","operationId":"WorkloadClassifiers_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"description":"The name of the workload group from which to receive the classifier from.","in":"path","name":"workloadGroupName","required":true,"schema":{"type":"string"},"examples":{"Delete a workload classifier":{"value":"wlm_workloadgroup"}}},{"description":"The name of the workload classifier to delete.","in":"path","name":"workloadClassifierName","required":true,"schema":{"type":"string"},"examples":{"Delete a workload classifier":{"value":"wlm_workloadclassifier"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the workload classifier."},"202":{"description":"Deleting the workload classifier is in progress."},"204":{"description":"The specified workload classifier does not exist."},"default":{"description":"*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."}},"tags":["WorkloadClassifiers"],"x-ms-long-running-operation":true},"get":{"description":"Gets a workload classifier","operationId":"WorkloadClassifiers_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"description":"The name of the workload group from which to receive the classifier from.","in":"path","name":"workloadGroupName","required":true,"schema":{"type":"string"},"examples":{"Gets a workload classifier for a data warehouse":{"value":"wlm_workloadgroup"}}},{"description":"The name of the workload classifier.","in":"path","name":"workloadClassifierName","required":true,"schema":{"type":"string"},"examples":{"Gets a workload classifier for a data warehouse":{"value":"wlm_classifier"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the specifies workload classifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadClassifier"},"examples":{"Gets a workload classifier for a data warehouse":{"$ref":"#/components/examples/Gets_a_workload_classifier_for_a_data_warehouse"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."}},"tags":["WorkloadClassifiers"]},"put":{"description":"Creates or updates a workload classifier.","operationId":"WorkloadClassifiers_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"description":"The name of the workload group from which to receive the classifier from.","in":"path","name":"workloadGroupName","required":true,"schema":{"type":"string"},"examples":{"Create a workload group with all properties specified.":{"value":"wlm_workloadgroup"},"Create a workload group with the required properties specified.":{"value":"wlm_workloadgroup"}}},{"description":"The name of the workload classifier to create/update.","in":"path","name":"workloadClassifierName","required":true,"schema":{"type":"string"},"examples":{"Create a workload group with all properties specified.":{"value":"wlm_workloadclassifier"},"Create a workload group with the required properties specified.":{"value":"wlm_workloadclassifier"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadClassifier"}}},"description":"The properties of the workload classifier.","required":true},"responses":{"200":{"description":"Successfully updated the workload classifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadClassifier"},"examples":{"Create a workload group with all properties specified.":{"$ref":"#/components/examples/Create_a_workload_group_with_all_properties_specified."},"Create a workload group with the required properties specified.":{"$ref":"#/components/examples/Create_a_workload_group_with_the_required_properties_specified."}}}}},"201":{"description":"Successfully created the workload classifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadClassifier"},"examples":{"Create a workload group with all properties specified.":{"$ref":"#/components/examples/Create_a_workload_group_with_all_properties_specified."},"Create a workload group with the required properties specified.":{"$ref":"#/components/examples/Create_a_workload_group_with_the_required_properties_specified."}}}}},"202":{"description":"Create or update for the workload classifier is in progress."},"default":{"description":"*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 400 InvalidMemberNameParameter - Invalid member name parameter for this workload classifier.\n\n * 400 InvalidStartTimeAndEndTimeParameters - Invalid start time and end time parameters for the workload classifier.\n\n * 400 InvalidImportanceParameter - Importance must be one of the following strings: Low, Below_Normal, Normal, Above_Normal, High.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."}},"tags":["WorkloadClassifiers"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_the_list_of_workload_classifiers_for_a_workload_group":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/wlm_workloadgroup/workloadClassifiers/classifier3","name":"classifier3","properties":{"context":"","endTime":"","importance":"high","label":"","memberName":"dbo","startTime":""},"type":"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/wlm_workloadgroup/workloadClassifiers/classifier1","name":"classifier1","properties":{"context":"test_context","endTime":"14:00","importance":"high","label":"test_label","memberName":"dbo","startTime":"12:00"},"type":"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/wlm_workloadgroup/workloadClassifiers/classifier2","name":"classifier2","properties":{"context":"","endTime":"17:00","importance":"high","label":"","memberName":"dbo","startTime":"11:00"},"type":"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers"}]}},"Gets_a_workload_classifier_for_a_data_warehouse":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_classifier","name":"wlm_classifier","properties":{"context":"test_context","endTime":"14:00","importance":"high","label":"test_label","memberName":"dbo","startTime":"12:00"},"type":"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers"}},"Create_a_workload_group_with_all_properties_specified.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_workloadclassifier","name":"wlm_workloadclassifier","properties":{"context":"test_context","endTime":"14:00","importance":"high","label":"test_label","memberName":"dbo","startTime":"12:00"},"type":"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers"}},"Create_a_workload_group_with_the_required_properties_specified.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_workloadclassifier","name":"wlm_workloadclassifier","properties":{"context":"","endTime":"","importance":"","label":"","memberName":"dbo","startTime":""},"type":"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers"}}},"parameters":{"ApiVersionParameter":{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Get the list of workload classifiers for a workload group":{"value":"2019-06-01-preview"},"Delete a workload classifier":{"value":"2019-06-01-preview"},"Gets a workload classifier for a data warehouse":{"value":"2019-06-01-preview"},"Create a workload group with all properties specified.":{"value":"2019-06-01-preview"},"Create a workload group with the required properties specified.":{"value":"2019-06-01-preview"}}},"BlobAuditingPolicyNameParameter":{"description":"The name of the blob auditing policy.","in":"path","name":"blobAuditingPolicyName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","enum":["default"]}},"DatabaseNameParameter":{"description":"The name of the database.","in":"path","name":"databaseName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the list of workload classifiers for a workload group":{"value":"testdb"},"Delete a workload classifier":{"value":"testdb"},"Gets a workload classifier for a data warehouse":{"value":"testdb"},"Create a workload group with all properties specified.":{"value":"testdb"},"Create a workload group with the required properties specified.":{"value":"testdb"}}},"ManagedInstanceNameParameter":{"description":"The name of the managed instance.","in":"path","name":"managedInstanceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ResourceGroupParameter":{"description":"The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the list of workload classifiers for a workload group":{"value":"Default-SQL-SouthEastAsia"},"Delete a workload classifier":{"value":"Default-SQL-SouthEastAsia"},"Gets a workload classifier for a data warehouse":{"value":"Default-SQL-SouthEastAsia"},"Create a workload group with all properties specified.":{"value":"Default-SQL-SouthEastAsia"},"Create a workload group with the required properties specified.":{"value":"Default-SQL-SouthEastAsia"}}},"ServerNameParameter":{"description":"The name of the server.","in":"path","name":"serverName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the list of workload classifiers for a workload group":{"value":"testsvr"},"Delete a workload classifier":{"value":"testsvr"},"Gets a workload classifier for a data warehouse":{"value":"testsvr"},"Create a workload group with all properties specified.":{"value":"testsvr"},"Create a workload group with the required properties specified.":{"value":"testsvr"}}},"SqlVirtualMachineContainerNameParameter":{"description":"The name of the SqlVirtualMachineContainer.","in":"path","name":"sqlVirtualMachineContainerName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SqlVirtualMachineInstanceNameParameter":{"description":"The name of the SqlVirtualMachineInstance.","in":"path","name":"sqlVirtualMachineInstanceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SubscriptionIdParameter":{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Get the list of workload classifiers for a workload group":{"value":"00000000-1111-2222-3333-444444444444"},"Delete a workload classifier":{"value":"00000000-1111-2222-3333-444444444444"},"Gets a workload classifier for a data warehouse":{"value":"00000000-1111-2222-3333-444444444444"},"Create a workload group with all properties specified.":{"value":"00000000-1111-2222-3333-444444444444"},"Create a workload group with the required properties specified.":{"value":"00000000-1111-2222-3333-444444444444"}}},"VirtualClusterNameParameter":{"description":"The name of the virtual cluster.","in":"path","name":"virtualClusterName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"ProxyResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"ARM proxy resource.","properties":{},"type":"object"},"Resource":{"description":"ARM resource.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true},"WorkloadClassifier":{"allOf":[{"$ref":"#/components/schemas/ProxyResource"}],"description":"Workload classifier operations for a data warehouse","properties":{"properties":{"$ref":"#/components/schemas/WorkloadClassifierProperties"}},"type":"object"},"WorkloadClassifierListResult":{"description":"A list of workload classifiers for a workload group.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/WorkloadClassifier"},"readOnly":true,"type":"array"}},"type":"object"},"WorkloadClassifierProperties":{"description":"Workload classifier definition. For more information look at sys.workload_management_workload_classifiers (DMV).","properties":{"context":{"description":"The workload classifier context.","type":"string"},"endTime":{"description":"The workload classifier end time for classification.","type":"string"},"importance":{"description":"The workload classifier importance.","type":"string"},"label":{"description":"The workload classifier label.","type":"string"},"memberName":{"description":"The workload classifier member name.","type":"string"},"startTime":{"description":"The workload classifier start time for classification.","type":"string"}},"required":["memberName"],"type":"object"}}}}