Skip to content

Commit

Permalink
[DO NOT MERGE]update swaggers for azure elastic pool operation (Azure…
Browse files Browse the repository at this point in the history
…#2520)

* update swaggers for azure database and elastic pool operation

* update ListDatabaseOperations and ListElasticPoolOperations examples

* Only update the swagger for elastic pool operations

* end

* remove two not needed folders. Fix the error in ListElasticPoolOperation

* Update the cancel operations swagger on database and pool, and corresponding examples

* fix indentation in cancelOperations.json and cancelPoolOperations.json
  • Loading branch information
payiAzure authored and alvadb committed Feb 28, 2018
1 parent 07744ca commit b07a8f1
Show file tree
Hide file tree
Showing 8 changed files with 994 additions and 63 deletions.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@
"percentComplete": 100,
"serverName": "sqlcrudtest-4645",
"startTime": "2017-06-01T09:10:08.10Z",
"state": "Succeeded"
"state": "Succeeded",
"estimatedCompletionTime": "2017-06-01T13:10:10Z",
"description": "UpdateLogicalDatabase on 'testdb', target ServiceLevelObjective S3",
"isCancellable": false
}
},
{
Expand All @@ -35,7 +38,10 @@
"percentComplete": 19,
"serverName": "sqlcrudtest-4645",
"startTime": "2017-06-01T10:10:08.10Z",
"state": "InProgress"
"state": "InProgress",
"estimatedCompletionTime": "2017-06-01T13:10:10Z",
"description": "UpdateLogicalDatabase on 'testdb', target ServiceLevelObjective S3",
"isCancellable": true
}
}
]
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,364 @@
{
"swagger": "2.0",
"info": {
"version": "2017-10-01-preview",
"title": "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}/elasticPools/{elasticPoolName}/operations/{operationId}/cancel": {
"post": {
"tags": [
"ElasticPools"
],
"description": "Cancels the asynchronous operation on the elastic pool.",
"operationId": "ElasticPoolOperations_Cancel",
"parameters": [
{
"$ref": "#/parameters/ResourceGroupParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"name": "elasticPoolName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "operationId",
"in": "path",
"description": "The operation identifier.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The request for cancel has been executed successfully."
},
"default": {
"description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\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 * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation."
}
},
"x-ms-examples": {
"Cancel the elastic pool management operation": {
"$ref": "./examples/CancelElasticPoolOperation.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/operations": {
"get": {
"tags": [
"ElasticPools"
],
"description": "Gets a list of operations performed on the elastic pool.",
"operationId": "ElasticPoolOperations_ListByElasticPool",
"parameters": [
{
"$ref": "#/parameters/ResourceGroupParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"name": "elasticPoolName",
"in": "path",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The request for getting elastic pool operations has been executed successfully.",
"schema": {
"$ref": "#/definitions/ElasticPoolOperationListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\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."
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List the elastic pool management operations": {
"$ref": "./examples/ListElasticPoolOperations.json"
}
}
}
}
},
"definitions": {
"ElasticPoolOperationListResult": {
"description": "The response to a list elastic pool operations request",
"type": "object",
"properties": {
"value": {
"description": "Array of results.",
"type": "array",
"items": {
"$ref": "#/definitions/ElasticPoolOperation"
},
"readOnly": true
},
"nextLink": {
"description": "Link to retrieve next page of results.",
"type": "string",
"readOnly": true
}
}
},
"ElasticPoolOperationProperties": {
"description": "The properties of a elastic pool operation.",
"type": "object",
"properties": {
"elasticPoolName": {
"description": "The name of the elastic pool the operation is being performed on.",
"type": "string",
"readOnly": true
},
"operation": {
"description": "The name of operation.",
"type": "string",
"readOnly": true
},
"operationFriendlyName": {
"description": "The friendly name of operation.",
"type": "string",
"readOnly": true
},
"percentComplete": {
"format": "int32",
"description": "The percentage of the operation completed.",
"type": "integer",
"readOnly": true
},
"serverName": {
"description": "The name of the server.",
"type": "string",
"readOnly": true
},
"startTime": {
"format": "date-time",
"description": "The operation start time.",
"type": "string",
"readOnly": true
},
"state": {
"description": "The operation state.",
"type": "string",
"readOnly": true
},
"errorCode": {
"format": "int32",
"description": "The operation error code.",
"type": "integer",
"readOnly": true
},
"errorDescription": {
"description": "The operation error description.",
"type": "string",
"readOnly": true
},
"errorSeverity": {
"format": "int32",
"description": "The operation error severity.",
"type": "integer",
"readOnly": true
},
"isUserError": {
"description": "Whether or not the error is a user error.",
"type": "boolean",
"readOnly": true
},
"estimatedCompletionTime": {
"format": "date-time",
"description": "The estimated completion time of the operation.",
"type": "string",
"readOnly": true
},
"description": {
"description": "The operation description.",
"type": "string",
"readOnly": true
},
"isCancellable": {
"description": "Whether the operation can be cancelled.",
"type": "boolean",
"readOnly": true
}
}
},
"ProxyResource": {
"description": "ARM proxy resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {}
},
"ElasticPoolOperation": {
"description": "A elastic pool operation.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/ElasticPoolOperationProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
}
},
"Resource": {
"description": "ARM resource.",
"type": "object",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string",
"readOnly": true
},
"name": {
"description": "Resource name.",
"type": "string",
"readOnly": true
},
"type": {
"description": "Resource type.",
"type": "string",
"readOnly": true
}
},
"x-ms-azure-resource": true
}
},
"parameters": {
"SubscriptionIdParameter": {
"name": "subscriptionId",
"in": "path",
"description": "The subscription ID that identifies an Azure subscription.",
"required": true,
"type": "string",
"x-ms-parameter-location": "client"
},
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"description": "The API version to use for the request.",
"required": true,
"type": "string",
"x-ms-parameter-location": "client"
},
"ResourceGroupParameter": {
"name": "resourceGroupName",
"in": "path",
"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.",
"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"
},
"ManagedInstanceNameParameter": {
"name": "managedInstanceName",
"in": "path",
"description": "The name of the managed instance.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"DatabaseNameParameter": {
"name": "databaseName",
"in": "path",
"description": "The name of the database.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"BlobAuditingPolicyNameParameter": {
"name": "blobAuditingPolicyName",
"in": "path",
"description": "The name of the blob auditing policy.",
"required": true,
"type": "string",
"enum": [
"default"
],
"x-ms-parameter-location": "method"
},
"SqlVirtualMachineInstanceNameParameter": {
"name": "sqlVirtualMachineInstanceName",
"in": "path",
"description": "The name of the SqlVirtualMachineInstance.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"SqlVirtualMachineContainerNameParameter": {
"name": "sqlVirtualMachineContainerName",
"in": "path",
"description": "The name of the SqlVirtualMachineContainer.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"VirtualClusterNameParameter": {
"name": "virtualClusterName",
"in": "path",
"description": "The name of the virtual cluster.",
"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"
}
}
}
}
Loading

0 comments on commit b07a8f1

Please sign in to comment.