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
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
kind	string	Kind of geo backup policy. This is metadata used for the Azure portal experience.
location	string	Backup policy location.
state	string	The state of the geo backup policy. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
storageType	string	The storage type of the geo backup policy.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
kind	string	Kind of geo backup policy. This is metadata used for the Azure portal experience.
location	string	Backup policy location.
state	string	The state of the geo backup policy. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
storageType	string	The storage type of the geo backup policy.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, database_name, geo_backup_policy_name, subscription_id		Gets a Geo backup policy for the given database resource.
list	select	resource_group_name, server_name, database_name, subscription_id		Gets a list of Geo backup policies for the given database resource.
create_or_update	insert	resource_group_name, server_name, database_name, geo_backup_policy_name, subscription_id		Create or update a database default Geo backup policy.
create_or_update	replace	resource_group_name, server_name, database_name, geo_backup_policy_name, subscription_id		Create or update a database default 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
database_name	string	The name of the database. Required.
geo_backup_policy_name	string	The name of the Geo backup policy. This should always be 'Default'. "Default" Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a Geo backup policy for the given database resource.

SELECT
id,
name,
kind,
location,
state,
storageType,
systemData,
type
FROM azure.sql.geo_backup_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND geo_backup_policy_name = '{{ geo_backup_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of Geo backup policies for the given database resource.

SELECT
id,
name,
kind,
location,
state,
storageType,
systemData,
type
FROM azure.sql.geo_backup_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a database default Geo backup policy.

INSERT INTO azure.sql.geo_backup_policies (
properties,
resource_group_name,
server_name,
database_name,
geo_backup_policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ database_name }}',
'{{ geo_backup_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: geo_backup_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the geo_backup_policies resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the geo_backup_policies resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the geo_backup_policies resource.
  - name: geo_backup_policy_name
    value: "{{ geo_backup_policy_name }}"
    description: Required parameter for the geo_backup_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the geo_backup_policies resource.
  - name: properties
    description: |
      Resource properties.
    value:
      state: "{{ state }}"
      storageType: "{{ storageType }}"

REPLACE examples

create_or_update

Create or update a database default Geo backup policy.

REPLACE azure.sql.geo_backup_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND geo_backup_policy_name = '{{ geo_backup_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
kind,
location,
properties,
systemData,
type;