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
properties	object	Metadata Sync Config properties (title: Metadata Sync Config properties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Get the metadata sync configuration for a SQL pool
create	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		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
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 metadata sync configuration for a SQL pool

SELECT
properties
FROM azure.synapse.sql_pool_metadata_sync_configs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
;

INSERT examples

create

Set the metadata sync configuration for a SQL pool

INSERT INTO azure.synapse.sql_pool_metadata_sync_configs (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sqlPoolName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sqlPoolName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_metadata_sync_configs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_pool_metadata_sync_configs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_pool_metadata_sync_configs resource.
    - name: workspaceName
      value: string
      description: Required parameter for the sql_pool_metadata_sync_configs resource.
    - name: sqlPoolName
      value: string
      description: Required parameter for the sql_pool_metadata_sync_configs resource.
    - name: properties
      value: object
      description: |
        Metadata Sync Config properties