Deleted Servers - List

Service:

SQL Database

API Version:

2023-08-01

Gets a list of all deleted servers in a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/deletedServers?api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	DeletedServerListResult	Successfully retrieved the list of deleted servers.
Other Status Codes	ErrorResponse	*** Error Responses: ***

Examples

List deleted servers in a subscription

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/deletedServers?api-version=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DeletedServerListBySubscription.json
// this example is just showing the usage of "DeletedServers_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (DeletedServerResource item in subscriptionResource.GetDeletedServersAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    DeletedServerData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/deletedServers/sqlcrudtest-d-1414",
      "name": "sqlcrudtest-d-1414",
      "type": "Microsoft.Sql/deletedServers",
      "properties": {
        "fullyQualifiedDomainName": "sqlcrudtest-d-1414.database.windows.net",
        "version": "12.0",
        "deletionTime": "2017-06-15T20:20:00.345Z",
        "originalId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sqlcrudtest-d-1414"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/deletedServers/sqlcrudtest-d-2424",
      "name": "sqlcrudtest-d-2424",
      "type": "Microsoft.Sql/deletedServers",
      "properties": {
        "fullyQualifiedDomainName": "sqlcrudtest-d-2424.database.windows.net",
        "version": "12.0",
        "deletionTime": "2017-06-13T10:10:00.678Z",
        "originalId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sqlcrudtest-d-2424"
      }
    }
  ]
}

Definitions

Name	Description
DeletedServer	A deleted server.
DeletedServerListResult	A list of deleted servers.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

DeletedServer

Object

A deleted server.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.deletionTime	string (date-time)	The deletion time of the deleted server.
properties.fullyQualifiedDomainName	string	The fully qualified domain name of the server.
properties.originalId	string	The original ID of the server before deletion.
properties.version	string	The version of the deleted server.
type	string	Resource type.

DeletedServerListResult

Object

A list of deleted servers.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	DeletedServer[]	Array of results.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.