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
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

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, workspaceName, sqlPoolName, geoBackupPolicyName		Get the specified SQL pool geo backup policy
list	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Get list of SQL pool geo backup policies
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, geoBackupPolicyName, data__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
geoBackupPolicyName	string	The name of the geo backup policy.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sqlPoolName	string	SQL pool name
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get the specified SQL pool geo backup policy

SELECT
kind,
location,
properties
FROM azure.synapse.sql_pool_geo_backup_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND geoBackupPolicyName = '{{ geoBackupPolicyName }}' -- required
;

list

Get list of SQL pool geo backup policies

SELECT
kind,
location,
properties
FROM azure.synapse.sql_pool_geo_backup_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
;

INSERT examples

create_or_update

Updates a SQL Pool geo backup policy.

INSERT INTO azure.synapse.sql_pool_geo_backup_policies (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sqlPoolName,
geoBackupPolicyName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sqlPoolName }}',
'{{ geoBackupPolicyName }}'
RETURNING
kind,
location,
properties
;

Manifest

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