Microsoft.Synapse workspaces/sqlPools/metadataSync 2021-03-01

  • Article

Bicep resource definition

The workspaces/sqlPools/metadataSync resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/sqlPools/metadataSync resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-03-01' = {
  name: 'config'
  parent: resourceSymbolicName
  properties: {
    enabled: bool
    syncIntervalInMinutes: int
  }
}

Property values

workspaces/sqlPools/metadataSync

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 'config'
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: sqlPools
properties Metadata Sync Config properties MetadataSyncConfigProperties

MetadataSyncConfigProperties

Name Description Value
enabled Indicates whether the metadata sync is enabled or disabled bool
syncIntervalInMinutes The Sync Interval in minutes. int

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Synapse Proof-of-Concept

Deploy to Azure		 This template creates a proof of concept environment for Azure Synapse, including SQL Pools and optional Apache Spark Pools

ARM template resource definition

The workspaces/sqlPools/metadataSync resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/sqlPools/metadataSync resource, add the following JSON to your template.

{
  "type": "Microsoft.Synapse/workspaces/sqlPools/metadataSync",
  "apiVersion": "2021-03-01",
  "name": "config",
  "properties": {
    "enabled": "bool",
    "syncIntervalInMinutes": "int"
  }
}

Property values

workspaces/sqlPools/metadataSync

Name Description Value
type The resource type 'Microsoft.Synapse/workspaces/sqlPools/metadataSync'
apiVersion The resource api version '2021-03-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 'config'
properties Metadata Sync Config properties MetadataSyncConfigProperties

MetadataSyncConfigProperties

Name Description Value
enabled Indicates whether the metadata sync is enabled or disabled bool
syncIntervalInMinutes The Sync Interval in minutes. int

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Synapse Proof-of-Concept

Deploy to Azure		 This template creates a proof of concept environment for Azure Synapse, including SQL Pools and optional Apache Spark Pools

Terraform (AzAPI provider) resource definition

The workspaces/sqlPools/metadataSync resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/sqlPools/metadataSync resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-03-01"
  name = "config"
  parent_id = "string"
  body = jsonencode({
    properties = {
      enabled = bool
      syncIntervalInMinutes = int
    }
  })
}

Property values

workspaces/sqlPools/metadataSync

Name Description Value
type The resource type "Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-03-01"
name The resource name "config"
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sqlPools
properties Metadata Sync Config properties MetadataSyncConfigProperties

MetadataSyncConfigProperties

Name Description Value
enabled Indicates whether the metadata sync is enabled or disabled bool
syncIntervalInMinutes The Sync Interval in minutes. int