sql_pool_metadata_sync_configs

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

Overview

Name	sql_pool_metadata_sync_configs
Type	Resource
Id	azure.synapse.sql_pool_metadata_sync_configs

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.
enabled	boolean	Indicates whether the metadata sync is enabled or disabled.
syncIntervalInMinutes	integer	The Sync Interval in minutes.
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, subscription_id		Get SQL pool metadata sync config. Get the metadata sync configuration for a SQL pool.
create	insert	resource_group_name, workspace_name, sql_pool_name, subscription_id		Set SQL pool metadata sync config. Set the metadata sync configuration for a SQL pool.

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
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 SQL pool metadata sync config. Get the metadata sync configuration for a SQL pool.

SELECT
id,
name,
enabled,
syncIntervalInMinutes,
type
FROM azure.synapse.sql_pool_metadata_sync_configs
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

Set SQL pool metadata sync config. Set the metadata sync configuration for a SQL pool.

INSERT INTO azure.synapse.sql_pool_metadata_sync_configs (
properties,
resource_group_name,
workspace_name,
sql_pool_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ sql_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

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