Sql Pool Geo Backup Policies - Get

Get a SQL pool geo backup policy
Get the specified SQL pool geo backup policy

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/geoBackupPolicies/Default?api-version=2021-06-01

URI Parameters

Name In Required Type Description
geoBackupPolicyName
path True

GeoBackupPolicyName

The name of the geo backup policy.

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

sqlPoolName
path True

string

SQL pool name

subscriptionId
path True

string

The ID of the target subscription.

workspaceName
path True

string

The name of the workspace.

api-version
query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

GeoBackupPolicy

OK

Other Status Codes

ErrorResponse

Examples

Get Sql pool geo backup policy

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-5961/sqlPools/testdw/geoBackupPolicies/Default?api-version=2021-06-01

Sample Response

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

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

GeoBackupPolicy

A database geo backup policy.

GeoBackupPolicyName

The name of the geo backup policy.

GeoBackupPolicyState

The state of the geo backup policy.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

GeoBackupPolicy

A database geo backup policy.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind

string

Kind of geo backup policy. This is metadata used for the Azure portal experience.

location

string

Backup policy location.

name

string

The name of the resource

properties.state

GeoBackupPolicyState

The state of the geo backup policy.

properties.storageType

string

The storage type of the geo backup policy.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

GeoBackupPolicyName

The name of the geo backup policy.

Name Type Description
Default

string

GeoBackupPolicyState

The state of the geo backup policy.

Name Type Description
Disabled

string

Enabled

string