Microsoft Azure

SqlManagementClient: Long Term Retention

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…

Developer tools#openapi#cloud

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 13

LongTermRetentionBackups

  • GETLongTermRetentionBackups_ListByLocation/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=All&api-version=stringLists the long term retention backups for a given location.
  • GETLongTermRetentionBackups_ListByServer/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=All&api-version=stringLists 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=All&api-version=stringLists all long term retention backups for a database.
  • GETLongTermRetentionBackups_Get/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName?api-version=stringGets a long term retention backup.
  • DELETELongTermRetentionBackups_Delete/subscriptions/:subscriptionId/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName?api-version=stringDeletes a long term retention backup.
  • GETLongTermRetentionBackups_ListByResourceGroupLocation/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=All&api-version=stringLists the long term retention backups for a given location.
  • GETLongTermRetentionBackups_ListByResourceGroupServer/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=All&api-version=stringLists the long term retention backups for a given server.
  • GETLongTermRetentionBackups_ListByResourceGroupDatabase/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups?onlyLatestPerDatabase=true&databaseState=All&api-version=stringLists all long term retention backups for a database.
  • GETLongTermRetentionBackups_GetByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName?api-version=stringGets a long term retention backup.
  • DELETELongTermRetentionBackups_DeleteByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/locations/:locationName/longTermRetentionServers/:longTermRetentionServerName/longTermRetentionDatabases/:longTermRetentionDatabaseName/longTermRetentionBackups/:backupName?api-version=stringDeletes a long term retention backup.

BackupLongTermRetentionPolicies

  • GETBackupLongTermRetentionPolicies_ListByDatabase/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/backupLongTermRetentionPolicies?api-version=stringGets a database's long term retention policy.
  • GETBackupLongTermRetentionPolicies_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/backupLongTermRetentionPolicies/:policyName?api-version=stringGets a database's long term retention policy.
  • PUTBackupLongTermRetentionPolicies_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Sql/servers/:serverName/databases/:databaseName/backupLongTermRetentionPolicies/:policyName?api-version=stringSets a database's long term retention policy.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
13 operations on 10 pathsGET 10DELETE 2PUT 1
Main resources
LongTermRetentionBackups 10BackupLongTermRetentionPolicies 3
Response formats
application/json
Description format
Swagger 2.0, API version 2017-03-01-preview
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the SqlManagementClient: Long Term Retention 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 SqlManagementClient: Long Term Retention 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&api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the SqlManagementClient: Long Term Retention?

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 Developer tools and has 13 endpoints.

Who publishes the SqlManagementClient: Long Term Retention?

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 SqlManagementClient: Long Term Retention?

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

How do I authenticate with the SqlManagementClient: Long Term Retention?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the SqlManagementClient: Long Term Retention have?

13 operations on 10 paths (10 GET, 2 DELETE, 1 PUT). The largest groups are LongTermRetentionBackups, BackupLongTermRetentionPolicies.

Is forking the SqlManagementClient: Long Term Retention 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.