openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 18.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":"2017-03-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/2017-03-01-preview/restorePoints.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"sql-restorePoints","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints":{"get":{"description":"Gets a list of database restore points.","operationId":"RestorePoints_ListByDatabase","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully returned restore points.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestorePointListResult"},"examples":{"List database restore points.":{"$ref":"#/components/examples/List_database_restore_points."},"List datawarehouse database restore points.":{"$ref":"#/components/examples/List_datawarehouse_database_restore_points."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 BackupNotAllowedOnDeactivatedDatabase - Cannot create restore point on a deactivated database.\n\n * 400 RestorePointLimitReached - A restore point cannot be created because database would exceed the allowed quota of restore points.\n\n * 400 RestorePointAttemptToDeleteSystemBackup - Cannot delete system restore point.\n\n * 404 DatabaseRestorePointNotFound - Can not find database restore point.\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 * 408 DatabaseRestorePointTimedOut - Create database restore point failed."}},"tags":["RestorePoints"],"x-ms-pageable":{}},"post":{"description":"Creates a restore point for a data warehouse.","operationId":"RestorePoints_Create","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDatabaseRestorePointDefinition"}}},"description":"The definition for creating the restore point of this database.","required":true},"responses":{"200":{"description":"Successfully created the restore point request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestorePoint"},"examples":{"Creates datawarehouse database restore point.":{"$ref":"#/components/examples/Creates_datawarehouse_database_restore_point."}}}}},"201":{"description":"Successfully created the restore point request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestorePoint"}}}},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 BackupNotAllowedOnDeactivatedDatabase - Cannot create restore point on a deactivated database.\n\n * 400 RestorePointLimitReached - A restore point cannot be created because database would exceed the allowed quota of restore points.\n\n * 400 RestorePointAttemptToDeleteSystemBackup - Cannot delete system restore point.\n\n * 404 DatabaseRestorePointNotFound - Can not find database restore point.\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 * 408 DatabaseRestorePointTimedOut - Create database restore point failed."}},"tags":["RestorePoints"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints/{restorePointName}":{"delete":{"description":"Deletes a restore point.","operationId":"RestorePoints_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"description":"The name of the restore point.","in":"path","name":"restorePointName","required":true,"schema":{"type":"string"},"examples":{"Deletes a restore point.":{"value":"131546477590000000"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the restore point."},"default":{"description":"*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 BackupNotAllowedOnDeactivatedDatabase - Cannot create restore point on a deactivated database.\n\n * 400 RestorePointLimitReached - A restore point cannot be created because database would exceed the allowed quota of restore points.\n\n * 400 RestorePointAttemptToDeleteSystemBackup - Cannot delete system restore point.\n\n * 404 DatabaseRestorePointNotFound - Can not find database restore point.\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 * 408 DatabaseRestorePointTimedOut - Create database restore point failed."}},"tags":["RestorePoints"]},"get":{"description":"Gets a restore point.","operationId":"RestorePoints_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"description":"The name of the restore point.","in":"path","name":"restorePointName","required":true,"schema":{"type":"string"},"examples":{"Gets a database restore point.":{"value":"131546477590000000"},"Gets a datawarehouse database restore point.":{"value":"131546477590000000"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully returned the restore point.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestorePoint"},"examples":{"Gets a database restore point.":{"$ref":"#/components/examples/Gets_a_database_restore_point."},"Gets a datawarehouse database restore point.":{"$ref":"#/components/examples/Gets_a_datawarehouse_database_restore_point."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 BackupNotAllowedOnDeactivatedDatabase - Cannot create restore point on a deactivated database.\n\n * 400 RestorePointLimitReached - A restore point cannot be created because database would exceed the allowed quota of restore points.\n\n * 400 RestorePointAttemptToDeleteSystemBackup - Cannot delete system restore point.\n\n * 404 DatabaseRestorePointNotFound - Can not find database restore point.\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 * 408 DatabaseRestorePointTimedOut - Create database restore point failed."}},"tags":["RestorePoints"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_database_restore_points.":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6730/providers/Microsoft.Sql/servers/sqlcrudtest-9007/databases/3481/restorepoints/ContinuousRestorePoint","location":"West US","name":"ContinuousRestorePoint","properties":{"earliestRestoreDate":"2017-06-12T00:00:00Z","restorePointType":"CONTINUOUS"},"type":"Microsoft.Sql/servers/databases/restorePoints"}]}},"List_datawarehouse_database_restore_points.":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/restorePoints/131546477590000000","location":"japaneast","name":"131546477590000000","properties":{"restorePointCreationDate":"2017-03-10T08:00:00.000Z","restorePointLabel":"mylabel1","restorePointType":"DISCRETE"},"type":"Microsoft.Sql/servers/databases/restorePoints"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/restorePoints/131553636140000000","location":"japaneast","name":"131553636140000000","properties":{"restorePointCreationDate":"2017-11-17T03:40:14Z","restorePointLabel":"mylabel2","restorePointType":"DISCRETE"},"type":"Microsoft.Sql/servers/databases/restorePoints"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/restorePoints/131553619750000000","location":"japaneast","name":"131553619750000000","properties":{"restorePointCreationDate":"2017-11-17T03:12:55Z","restorePointType":"DISCRETE"},"type":"Microsoft.Sql/servers/databases/restorePoints"}]}},"Creates_datawarehouse_database_restore_point.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/restorePoints/131546477590000000","location":"japaneast","name":"131546477590000000","properties":{"restorePointCreationDate":"2017-03-10T08:00:00.000Z","restorePointLabel":"mylabel","restorePointType":"DISCRETE"},"type":"Microsoft.Sql/servers/databases/restorePoints"}},"Gets_a_database_restore_point.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/restorePoints/ContinuousRestorePoint","location":"japaneast","name":"ContinuousRestorePoint","properties":{"earliestRestoreDate":"2017-03-10T08:00:00.000Z","restorePointType":"CONTINUOUS"},"type":"Microsoft.Sql/servers/databases/restorePoints"}},"Gets_a_datawarehouse_database_restore_point.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/restorePoints/131546477590000000","location":"japaneast","name":"131546477590000000","properties":{"restorePointCreationDate":"2017-03-10T08:00:00.000Z","restorePointLabel":"mylabel","restorePointType":"DISCRETE"},"type":"Microsoft.Sql/servers/databases/restorePoints"}}},"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":{"List database restore points.":{"value":"2017-03-01-preview"},"List datawarehouse database restore points.":{"value":"2017-03-01-preview"},"Creates datawarehouse database restore point.":{"value":"2017-03-01-preview"},"Deletes a restore point.":{"value":"2017-03-01-preview"},"Gets a database restore point.":{"value":"2017-03-01-preview"},"Gets a datawarehouse database restore point.":{"value":"2017-03-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":{"List database restore points.":{"value":"3481"},"List datawarehouse database restore points.":{"value":"testDatabase"},"Creates datawarehouse database restore point.":{"value":"testDatabase"},"Deletes a restore point.":{"value":"testDatabase"},"Gets a database restore point.":{"value":"testDatabase"},"Gets a datawarehouse database restore point.":{"value":"testDatabase"}}},"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":{"List database restore points.":{"value":"sqlcrudtest-6730"},"List datawarehouse database restore points.":{"value":"Default-SQL-SouthEastAsia"},"Creates datawarehouse database restore point.":{"value":"Default-SQL-SouthEastAsia"},"Deletes a restore point.":{"value":"Default-SQL-SouthEastAsia"},"Gets a database restore point.":{"value":"Default-SQL-SouthEastAsia"},"Gets a datawarehouse database restore point.":{"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":{"List database restore points.":{"value":"sqlcrudtest-9007"},"List datawarehouse database restore points.":{"value":"testserver"},"Creates datawarehouse database restore point.":{"value":"testserver"},"Deletes a restore point.":{"value":"testserver"},"Gets a database restore point.":{"value":"testserver"},"Gets a datawarehouse database restore point.":{"value":"testserver"}}},"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":{"List database restore points.":{"value":"00000000-1111-2222-3333-444444444444"},"List datawarehouse database restore points.":{"value":"00000000-1111-2222-3333-444444444444"},"Creates datawarehouse database restore point.":{"value":"00000000-1111-2222-3333-444444444444"},"Deletes a restore point.":{"value":"00000000-1111-2222-3333-444444444444"},"Gets a database restore point.":{"value":"00000000-1111-2222-3333-444444444444"},"Gets a datawarehouse database restore point.":{"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":{"CreateDatabaseRestorePointDefinition":{"description":"Contains the information necessary to perform a create database restore point operation.","properties":{"restorePointLabel":{"description":"The restore point label to apply","type":"string"}},"required":["restorePointLabel"],"type":"object"},"RestorePoint":{"allOf":[{"allOf":[{"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}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"Database restore points.","properties":{"location":{"description":"Resource location.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/RestorePointProperties"}},"type":"object"},"RestorePointListResult":{"description":"A list of long term retention backups.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/RestorePoint"},"readOnly":true,"type":"array"}},"type":"object"},"RestorePointProperties":{"description":"Properties of a database restore point","properties":{"earliestRestoreDate":{"description":"The earliest time to which this database can be restored","format":"date-time","readOnly":true,"type":"string"},"restorePointCreationDate":{"description":"The time the backup was taken","format":"date-time","readOnly":true,"type":"string"},"restorePointLabel":{"description":"The label of restore point for backup request by user","readOnly":true,"type":"string"},"restorePointType":{"description":"The type of restore point","enum":["CONTINUOUS","DISCRETE"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":false,"name":"RestorePointType"}}},"type":"object"}}}}