{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-sql-longtermretention","description":"SqlManagementClient","version":"2017-03-01-preview","base_url":"https://management.azure.com","endpoints":13,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api SqlManagementClient\n@base https://management.azure.com\n@version 2017-03-01-preview\n@auth OAuth2\n@common_fields {subscriptionId: any # The subscription ID that identifies an Azure subscription., api-version: any # The API version to use for the request.}\n@endpoints 13\n@toc subscriptions(13)\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}\n@desc Gets a long term retention backup.\n@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., locationName: any # The location of the database., longTermRetentionServerName: any # The name of the server, longTermRetentionDatabaseName: any # The name of the database, backupName: any # The backup name.}\n@returns(200) Successfully retrieved the backup.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}\n@desc Deletes a long term retention backup.\n@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., locationName: any # The location of the database, longTermRetentionServerName: any # The name of the server, longTermRetentionDatabaseName: any # The name of the database, backupName: any # The backup name.}\n@returns(200) Successfully deleted the backup.\n@returns(202) Accepted\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups\n@desc Lists all long term retention backups for a database.\n@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., locationName: any # The location of the database, longTermRetentionServerName: any # The name of the server, longTermRetentionDatabaseName: any # The name of the database}\n@optional {onlyLatestPerDatabase: any # Whether or not to only get the latest backup for each database., databaseState: any # Whether to query against just live databases, just deleted databases, or all databases.}\n@returns(200) Successfully retrieved the list of backups.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionBackups\n@desc Lists the long term retention backups for a given location.\n@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., locationName: any # The location of the database}\n@optional {onlyLatestPerDatabase: any # Whether or not to only get the latest backup for each database., databaseState: any # Whether to query against just live databases, just deleted databases, or all databases.}\n@returns(200) Successfully retrieved the list of backups.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionBackups\n@desc Lists the long term retention backups for a given server.\n@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., locationName: any # The location of the database, longTermRetentionServerName: any # The name of the server}\n@optional {onlyLatestPerDatabase: any # Whether or not to only get the latest backup for each database., databaseState: any # Whether to query against just live databases, just deleted databases, or all databases.}\n@returns(200) Successfully retrieved the list of backups.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}\n@desc Gets a long term retention backup.\n@required {locationName: any # The location of the database., longTermRetentionServerName: any # The name of the server, longTermRetentionDatabaseName: any # The name of the database, backupName: any # The backup name.}\n@returns(200) Successfully retrieved the backup.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}\n@desc Deletes a long term retention backup.\n@required {locationName: any # The location of the database, longTermRetentionServerName: any # The name of the server, longTermRetentionDatabaseName: any # The name of the database, backupName: any # The backup name.}\n@returns(200) Successfully deleted the backup.\n@returns(202) Accepted\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups\n@desc Lists all long term retention backups for a database.\n@required {locationName: any # The location of the database, longTermRetentionServerName: any # The name of the server, longTermRetentionDatabaseName: any # The name of the database}\n@optional {onlyLatestPerDatabase: any # Whether or not to only get the latest backup for each database., databaseState: any # Whether to query against just live databases, just deleted databases, or all databases.}\n@returns(200) Successfully retrieved the list of backups.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionBackups\n@desc Lists the long term retention backups for a given location.\n@required {locationName: any # The location of the database}\n@optional {onlyLatestPerDatabase: any # Whether or not to only get the latest backup for each database., databaseState: any # Whether to query against just live databases, just deleted databases, or all databases.}\n@returns(200) Successfully retrieved the list of backups.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionBackups\n@desc Lists the long term retention backups for a given server.\n@required {locationName: any # The location of the database, longTermRetentionServerName: any # The name of the server}\n@optional {onlyLatestPerDatabase: any # Whether or not to only get the latest backup for each database., databaseState: any # Whether to query against just live databases, just deleted databases, or all databases.}\n@returns(200) Successfully retrieved the list of backups.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}\n@desc Gets a database's long term retention policy.\n@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database., policyName: any # The policy name. Should always be Default.}\n@returns(200) Successfully get the policy.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}\n@desc Sets a database's long term retention policy.\n@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database., policyName: any # The policy name. Should always be Default., parameters: map # The long term retention policy info.}\n@returns(200) Successfully set the policy.\n@returns(202) Accepted\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies\n@desc Gets a database's long term retention policy.\n@required {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., databaseName: any # The name of the database.}\n@returns(200) Successfully get the policy.\n\n@end\n"}