Geo Backup Policies - Get

Service:

SQL Database

API Version:

2021-11-01

Gets a Geo backup policy for the given database resource.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/geoBackupPolicies/Default?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
geoBackupPolicyName	path	True	GeoBackupPolicyName	The name of the Geo backup policy. This should always be 'Default'.
resourceGroupName	path	True	string	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	path	True	string	The name of the server.
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	GeoBackupPolicy	Successfully retrieved the specified Geo backup policy.
Other Status Codes		*** Error Responses: *** 404 ResourceNotFound - The requested resource was not found.

Examples

Gets the specified Geo backup policy.

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/testdw/geoBackupPolicies/Default?api-version=2021-11-01

Java

import com.azure.resourcemanager.sql.models.GeoBackupPolicyName;

/**
 * Samples for GeoBackupPolicies Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/GeoBackupPoliciesGet.json
     */
    /**
     * Sample code: Gets the specified Geo backup policy.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsTheSpecifiedGeoBackupPolicy(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getGeoBackupPolicies().getWithResponse("sqlcrudtest-4799",
            "sqlcrudtest-5961", "testdw", GeoBackupPolicyName.DEFAULT, com.azure.core.util.Context.NONE);
    }
}

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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/testdw/geoBackupPolicies/Default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/databases/geoBackupPolicies",
  "location": "Central US",
  "kind": null,
  "properties": {
    "state": "Enabled",
    "storageType": "Premium"
  }
}

Definitions

Name	Description
GeoBackupPolicy	A Geo backup policy.
GeoBackupPolicyName	The name of the Geo backup policy. This should always be 'Default'.
GeoBackupPolicyState	The state of the geo backup policy.

GeoBackupPolicy

A Geo backup policy.

Name	Type	Description
id	string	Resource ID.
kind	string	Kind of geo backup policy. This is metadata used for the Azure portal experience.
location	string	Backup policy location.
name	string	Resource name.
properties.state	GeoBackupPolicyState	The state of the geo backup policy.
properties.storageType	string	The storage type of the geo backup policy.
type	string	Resource type.

GeoBackupPolicyName

The name of the Geo backup policy. This should always be 'Default'.

Name	Type	Description
Default	string

GeoBackupPolicyState

The state of the geo backup policy.

Name	Type	Description
Disabled	string
Enabled	string