geo_backup_policies

Creates, updates, deletes, gets or lists a geo_backup_policies resource.

Overview

Name	geo_backup_policies
Type	Resource
Id	azure.sql.geo_backup_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
kind	string	Kind of geo backup policy. This is metadata used for the Azure portal experience.
location	string	Backup policy location.
properties	object	The properties of the geo backup policy.

list_by_database

Name	Datatype	Description
kind	string	Kind of geo backup policy. This is metadata used for the Azure portal experience.
location	string	Backup policy location.
properties	object	The properties of the geo backup policy.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serverName, databaseName, geoBackupPolicyName		Gets a geo backup policy.
list_by_database	select	subscriptionId, resourceGroupName, serverName, databaseName		Returns a list of geo backup policies.
create_or_update	insert	subscriptionId, resourceGroupName, serverName, databaseName, geoBackupPolicyName, data__properties		Updates a database geo backup policy.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
databaseName	string	The name of the database.
geoBackupPolicyName	string	The name of the geo backup policy.
resourceGroupName	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	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a geo backup policy.

SELECT
kind,
location,
properties
FROM azure.sql.geo_backup_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND geoBackupPolicyName = '{{ geoBackupPolicyName }}' -- required
;

list_by_database

Returns a list of geo backup policies.

SELECT
kind,
location,
properties
FROM azure.sql.geo_backup_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
;

INSERT examples

create_or_update

Updates a database geo backup policy.

INSERT INTO azure.sql.geo_backup_policies (
data__properties,
subscriptionId,
resourceGroupName,
serverName,
databaseName,
geoBackupPolicyName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ geoBackupPolicyName }}'
RETURNING
kind,
location,
properties
;

Manifest

# Description fields are for documentation purposes
- name: geo_backup_policies
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the geo_backup_policies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the geo_backup_policies resource.
    - name: serverName
      value: string
      description: Required parameter for the geo_backup_policies resource.
    - name: databaseName
      value: string
      description: Required parameter for the geo_backup_policies resource.
    - name: geoBackupPolicyName
      value: string
      description: Required parameter for the geo_backup_policies resource.
    - name: properties
      value: object
      description: |
        The properties of the geo backup policy.