sql_pool_geo_backup_policies

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

Overview

Name	sql_pool_geo_backup_policies
Type	Resource
Id	azure.synapse.sql_pool_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: "Disabled" and "Enabled".
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".

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: "Disabled" and "Enabled".
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, sql_pool_name, geo_backup_policy_name, subscription_id		Get a SQL pool geo backup policy. Get the specified SQL pool geo backup policy.
list	select	resource_group_name, workspace_name, sql_pool_name, subscription_id		List SQL pool geo backup policies. Get list of SQL pool geo backup policies.
create_or_update	insert	resource_group_name, workspace_name, sql_pool_name, geo_backup_policy_name, subscription_id, properties		Updates a SQL Pool geo backup policy.
create_or_update	replace	resource_group_name, workspace_name, sql_pool_name, geo_backup_policy_name, subscription_id, properties		Updates a SQL Pool 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
geo_backup_policy_name	string	The name of the geo backup policy. "Default" Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

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

SELECT
id,
name,
kind,
location,
state,
storageType,
type
FROM azure.synapse.sql_pool_geo_backup_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND geo_backup_policy_name = '{{ geo_backup_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List SQL pool geo backup policies. Get list of SQL pool geo backup policies.

SELECT
id,
name,
kind,
location,
state,
storageType,
type
FROM azure.synapse.sql_pool_geo_backup_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Updates a SQL Pool geo backup policy.

INSERT INTO azure.synapse.sql_pool_geo_backup_policies (
properties,
resource_group_name,
workspace_name,
sql_pool_name,
geo_backup_policy_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ sql_pool_name }}',
'{{ geo_backup_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_geo_backup_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_pool_geo_backup_policies resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the sql_pool_geo_backup_policies resource.
  - name: sql_pool_name
    value: "{{ sql_pool_name }}"
    description: Required parameter for the sql_pool_geo_backup_policies resource.
  - name: geo_backup_policy_name
    value: "{{ geo_backup_policy_name }}"
    description: Required parameter for the sql_pool_geo_backup_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_pool_geo_backup_policies resource.
  - name: properties
    value:
      state: "{{ state }}"

REPLACE examples

create_or_update

Updates a SQL Pool geo backup policy.

REPLACE azure.synapse.sql_pool_geo_backup_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND geo_backup_policy_name = '{{ geo_backup_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
kind,
location,
properties,
type;