Microsoft Azure

Azure SQL: Long Term Retention Backups

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…

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 24

LongTermRetentionBackups

  • GETLongTermRetentionBackups_ListByLocation/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=AllLists the long term retention backups for a given location.
  • GETLongTermRetentionBackups_ListByServer/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=AllLists the long term retention backups for a given server.
  • GETLongTermRetentionBackups_ListByDatabase/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=AllLists all long term retention backups for a database.
  • GETLongTermRetentionBackups_Get/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupNameGets a long term retention backup.
  • DELETELongTermRetentionBackups_Delete/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupNameDeletes a long term retention backup.
  • POSTLongTermRetentionBackups_ChangeAccessTier/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/changeAccessTierChange a long term retention backup access tier.
  • POSTLongTermRetentionBackups_Copy/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/copyCopy an existing long term retention backup.
  • POSTLongTermRetentionBackups_LockTimeBasedImmutability/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/lockTimeBasedImmutabilityLock time based immutability of an existing long term retention backup.
  • POSTLongTermRetentionBackups_RemoveLegalHoldImmutability/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/removeLegalHoldImmutabilityRemove legal hold immutability of an existing long term retention backup.
  • POSTLongTermRetentionBackups_RemoveTimeBasedImmutability/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/removeTimeBasedImmutabilityRemove time based immutability of an existing long term retention backup.
  • POSTLongTermRetentionBackups_SetLegalHoldImmutability/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/setLegalHoldImmutabilitySet legal hold immutability of an existing long term retention backup.
  • POSTLongTermRetentionBackups_Update/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/updateUpdates an existing long term retention backup.
  • GETLongTermRetentionBackups_ListByResourceGroupLocation/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=AllLists the long term retention backups for a given location based on resource group.
  • GETLongTermRetentionBackups_ListByResourceGroupServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=AllLists the long term retention backups for a given server based on resource groups.
  • GETLongTermRetentionBackups_ListByResourceGroupDatabase/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=AllLists all long term retention backups for a database based on a particular resource group.
  • GETLongTermRetentionBackups_GetByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupNameGets a long term retention backup.
  • DELETELongTermRetentionBackups_DeleteByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupNameDeletes a long term retention backup.
  • POSTLongTermRetentionBackups_ChangeAccessTierByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/changeAccessTierChange a long term retention backup access tier.
  • POSTLongTermRetentionBackups_CopyByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/copyCopy an existing long term retention backup to a different server.
  • POSTLongTermRetentionBackups_LockTimeBasedImmutabilityByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/lockTimeBasedImmutabilityLock time based immutability of an existing long term retention backup.
  • POSTLongTermRetentionBackups_RemoveLegalHoldImmutabilityByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/removeLegalHoldImmutabilityRemove legal hold immutability of an existing long term retention backup.
  • POSTLongTermRetentionBackups_RemoveTimeBasedImmutabilityByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/removeTimeBasedImmutabilityRemove time based immutability of an existing long term retention backup.
  • POSTLongTermRetentionBackups_SetLegalHoldImmutabilityByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/setLegalHoldImmutabilitySet legal hold immutability of an existing long term retention backup.
  • POSTLongTermRetentionBackups_UpdateByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName/updateUpdates an existing long term retention backup.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
24 operations on 22 pathsPOST 14GET 8DELETE 2
Main resources
LongTermRetentionBackups 24
Response formats
application/json
Description format
Swagger 2.0, API version 2025-01-01

How to test the Azure SQL: Long Term Retention Backups in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure SQL: Long Term Retention Backups collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “LongTermRetentionBackups_ListByLocation” (GET /subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=All), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure SQL: Long Term Retention Backups?

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… It is listed under Data & analytics and has 24 endpoints.

Who publishes the Azure SQL: Long Term Retention Backups?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure SQL: Long Term Retention Backups?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure SQL: Long Term Retention Backups?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure SQL: Long Term Retention Backups have?

24 operations on 22 paths (14 POST, 8 GET, 2 DELETE). The largest groups are LongTermRetentionBackups.

Is forking the Azure SQL: Long Term Retention Backups free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.