openapi-directory/api/azure.com/sql-ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"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/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"sql-ManagedRestorableDroppedDatabaseBackupShortTermRetenion","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}/backupShortTermRetentionPolicies":{"get":{"description":"Gets a dropped database's short term retention policy list.","operationId":"ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_ListByRestorableDroppedDatabase","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ManagedInstanceNameParameter"},{"in":"path","name":"restorableDroppedDatabaseId","required":true,"schema":{"type":"string"},"examples":{"Get the short term retention policy list for the database.":{"value":"testdb,131403269876900000"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the policies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedBackupShortTermRetentionPolicyListResult"},"examples":{"Get the short term retention policy list for the database.":{"$ref":"#/components/examples/Get_the_short_term_retention_policy_list_for_the_database."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}/backupShortTermRetentionPolicies/{policyName}":{"get":{"description":"Gets a dropped database's short term retention policy.","operationId":"ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ManagedInstanceNameParameter"},{"in":"path","name":"restorableDroppedDatabaseId","required":true,"schema":{"type":"string"},"examples":{"Get the short term retention policy for the database.":{"value":"testdb,131403269876900000"}}},{"description":"The policy name.","in":"path","name":"policyName","required":true,"x-ms-enum":{"modelAsString":true,"name":"ManagedShortTermRetentionPolicyName"},"schema":{"type":"string","enum":["default"]},"examples":{"Get the short term retention policy for the database.":{"value":"default"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the policies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedBackupShortTermRetentionPolicy"},"examples":{"Get the short term retention policy for the database.":{"$ref":"#/components/examples/Get_the_short_term_retention_policy_for_the_database."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies"]},"patch":{"description":"Sets a database's long term retention policy.","operationId":"ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_Update","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ManagedInstanceNameParameter"},{"in":"path","name":"restorableDroppedDatabaseId","required":true,"schema":{"type":"string"},"examples":{"Update the short term retention policy for the restorable dropped database.":{"value":"testdb,131403269876900000"}}},{"description":"The policy name. Should always be \"default\".","in":"path","name":"policyName","required":true,"x-ms-enum":{"modelAsString":true,"name":"ManagedShortTermRetentionPolicyName"},"schema":{"type":"string","enum":["default"]},"examples":{"Update the short term retention policy for the restorable dropped database.":{"value":"default"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ManagedBackupShortTermRetentionPolicy"},"responses":{"200":{"description":"Successfully updated the policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedBackupShortTermRetentionPolicy"},"examples":{"Update the short term retention policy for the restorable dropped database.":{"$ref":"#/components/examples/Update_the_short_term_retention_policy_for_the_restorable_dropped_database."}}}}},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\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":["ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies"],"x-ms-long-running-operation":true},"put":{"description":"Sets a database's long term retention policy.","operationId":"ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ManagedInstanceNameParameter"},{"in":"path","name":"restorableDroppedDatabaseId","required":true,"schema":{"type":"string"},"examples":{"Update the short term retention policy for the restorable dropped database.":{"value":"testdb,131403269876900000"}}},{"description":"The policy name. Should always be \"default\".","in":"path","name":"policyName","required":true,"x-ms-enum":{"modelAsString":true,"name":"ManagedShortTermRetentionPolicyName"},"schema":{"type":"string","enum":["default"]},"examples":{"Update the short term retention policy for the restorable dropped database.":{"value":"default"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ManagedBackupShortTermRetentionPolicy"},"responses":{"200":{"description":"Successfully updated the policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedBackupShortTermRetentionPolicy"},"examples":{"Update the short term retention policy for the restorable dropped database.":{"$ref":"#/components/examples/Update_the_short_term_retention_policy_for_the_restorable_dropped_database."}}}}},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\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":["ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_the_short_term_retention_policy_list_for_the_database.":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstance/testsvr/restorableDroppedDatabases/testdb,131403269876900000/backupShortTermRetentionPolicies/default","name":"default","properties":{"retentionDays":14},"type":"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstance/testsvr/restorableDroppedDatabases/testdb,131403269876900000/backupShortTermRetentionPolicies/default","name":"default","properties":{"retentionDays":14},"type":"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies"}]}},"Get_the_short_term_retention_policy_for_the_database.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstance/testsvr/restorableDroppedDatabases/testdb,131403269876900000/backupShortTermRetentionPolicies/default","name":"default","properties":{"retentionDays":14},"type":"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies"}},"Update_the_short_term_retention_policy_for_the_restorable_dropped_database.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/managedInstance/testsvr/restorableDroppedDatabases/testdb,131403269876900000/backupShortTermRetentionPolicies/default","name":"default","properties":{"retentionDays":14},"type":"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies"}}},"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 short term retention policy list for the database.":{"value":"2017-03-01-preview"},"Get the short term retention policy for the database.":{"value":"2017-03-01-preview"},"Update the short term retention policy for the restorable dropped database.":{"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"}},"ManagedInstanceNameParameter":{"description":"The name of the managed instance.","in":"path","name":"managedInstanceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the short term retention policy list for the database.":{"value":"testsvr"},"Get the short term retention policy for the database.":{"value":"testsvr"},"Update the short term retention policy for the restorable dropped database.":{"value":"testsvr"}}},"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 short term retention policy list for the database.":{"value":"Default-SQL-SouthEastAsia"},"Get the short term retention policy for the database.":{"value":"Default-SQL-SouthEastAsia"},"Update the short term retention policy for the restorable dropped database.":{"value":"resourceGroup"}}},"ServerNameParameter":{"description":"The name of the server.","in":"path","name":"serverName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"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 short term retention policy list for the database.":{"value":"00000000-1111-2222-3333-444444444444"},"Get the short term retention policy for the database.":{"value":"00000000-1111-2222-3333-444444444444"},"Update the short term retention policy for the restorable dropped database.":{"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"}}},"requestBodies":{"ManagedBackupShortTermRetentionPolicy":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedBackupShortTermRetentionPolicy"}}},"description":"The long term retention policy info.","required":true}},"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":{"ManagedBackupShortTermRetentionPolicy":{"allOf":[{"$ref":"#/components/schemas/ProxyResource"}],"description":"A short term retention policy.","properties":{"properties":{"$ref":"#/components/schemas/ManagedBackupShortTermRetentionPolicyProperties"}},"type":"object"},"ManagedBackupShortTermRetentionPolicyListResult":{"description":"A list of short term retention policies.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/ManagedBackupShortTermRetentionPolicy"},"readOnly":true,"type":"array"}},"type":"object"},"ManagedBackupShortTermRetentionPolicyProperties":{"description":"Properties of a short term retention policy","properties":{"retentionDays":{"description":"The backup retention period in days. This is how many days Point-in-Time Restore will be supported.","format":"int32","type":"integer"}},"type":"object"},"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}}}}