{ "swagger": "2.0", "info": { "title": "SqlManagementClient", "version": "2025-01-01", "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.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "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": "BackupShortTermRetentionPolicies" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies": { "get": { "operationId": "BackupShortTermRetentionPolicies_ListByDatabase", "tags": [ "BackupShortTermRetentionPolicies" ], "description": "Gets a database's short term retention policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BackupShortTermRetentionPolicyListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the short term retention policy for the database.": { "$ref": "./examples/ListShortTermRetentionPoliciesByDatabase.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}": { "get": { "operationId": "BackupShortTermRetentionPolicies_Get", "tags": [ "BackupShortTermRetentionPolicies" ], "description": "Gets a database's short term retention policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "policyName", "in": "path", "description": "The policy name. Should always be default.", "required": true, "type": "string", "enum": [ "default" ], "x-ms-enum": { "name": "ShortTermRetentionPolicyName", "modelAsString": true, "values": [ { "name": "default", "value": "default", "description": "default" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BackupShortTermRetentionPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the short term retention policy for the database.": { "$ref": "./examples/GetShortTermRetentionPolicy.json" } } }, "put": { "operationId": "BackupShortTermRetentionPolicies_CreateOrUpdate", "tags": [ "BackupShortTermRetentionPolicies" ], "description": "Updates a database's short term retention policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "policyName", "in": "path", "description": "The policy name. Should always be default.", "required": true, "type": "string", "enum": [ "default" ], "x-ms-enum": { "name": "ShortTermRetentionPolicyName", "modelAsString": true, "values": [ { "name": "default", "value": "default", "description": "default" } ] } }, { "name": "parameters", "in": "body", "description": "The short term retention policy info.", "required": true, "schema": { "$ref": "#/definitions/BackupShortTermRetentionPolicy" } } ], "responses": { "200": { "description": "Resource 'BackupShortTermRetentionPolicy' update operation succeeded", "schema": { "$ref": "#/definitions/BackupShortTermRetentionPolicy" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update the short term retention policy for the database.": { "$ref": "./examples/CreateShortTermRetentionPolicy.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BackupShortTermRetentionPolicy" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "BackupShortTermRetentionPolicies_Update", "tags": [ "BackupShortTermRetentionPolicies" ], "description": "Updates a database's short term retention policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "policyName", "in": "path", "description": "The policy name. Should always be default.", "required": true, "type": "string", "enum": [ "default" ], "x-ms-enum": { "name": "ShortTermRetentionPolicyName", "modelAsString": true, "values": [ { "name": "default", "value": "default", "description": "default" } ] } }, { "name": "parameters", "in": "body", "description": "The short term retention policy info.", "required": true, "schema": { "$ref": "#/definitions/BackupShortTermRetentionPolicy" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BackupShortTermRetentionPolicy" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update the short term retention policy for the database.": { "$ref": "./examples/UpdateShortTermRetentionPolicy.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BackupShortTermRetentionPolicy" }, "x-ms-long-running-operation": true } } }, "definitions": { "BackupShortTermRetentionPolicy": { "type": "object", "description": "A short term retention policy.", "properties": { "properties": { "$ref": "#/definitions/BackupShortTermRetentionPolicyProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BackupShortTermRetentionPolicyListResult": { "type": "object", "description": "The response of a BackupShortTermRetentionPolicy list operation.", "properties": { "value": { "type": "array", "description": "The BackupShortTermRetentionPolicy items on this page", "items": { "$ref": "#/definitions/BackupShortTermRetentionPolicy" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "BackupShortTermRetentionPolicyProperties": { "type": "object", "description": "Properties of a short term retention policy", "properties": { "retentionDays": { "type": "integer", "format": "int32", "description": "The backup retention period in days. This is how many days Point-in-Time Restore will be supported." }, "diffBackupIntervalInHours": { "$ref": "./common.json#/definitions/DiffBackupIntervalInHours", "description": "The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases." } } } }, "parameters": {} }