Microsoft.Synapse-werkruimten/sqlPools

Bicep-resourcedefinitie

Het resourcetype werkruimten/sqlPools kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.Synapse/workspaces/sqlPools wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.Synapse/workspaces/sqlPools@2021-06-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    collation: 'string'
    createMode: 'string'
    maxSizeBytes: int
    provisioningState: 'string'
    recoverableDatabaseId: 'string'
    restorePointInTime: 'string'
    sourceDatabaseDeletionDate: 'string'
    sourceDatabaseId: 'string'
    storageAccountType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

Microsoft.Synapse/workspaces/sqlPools

Naam Beschrijving Waarde
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
naam De resourcenaam tekenreeks (vereist)
ouder In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.		 Symbolische naam voor resource van het type: werkruimten
Eigenschappen Eigenschappen van SQL-pool SqlPoolResourceProperties-
Sku SKU van SQL-pool SKU-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

Sku

Naam Beschrijving Waarde
capaciteit Als de SKU uitschalen/inschalen ondersteunt, moet het gehele getal van de capaciteit worden opgenomen. Als uitschalen/inschalen niet mogelijk is voor de resource, kan dit worden weggelaten. Int
naam De SKU-naam snaar
rang De servicelaag snaar

SqlPoolResourceProperties

Naam Beschrijving Waarde
collatie Sorteringsmodus snaar
createMode Hiermee geeft u de modus voor het maken van sql-pools op.

Standaard: het maken van een gewone SQL-pool.

PointInTimeRestore: Hiermee maakt u een SQL-pool door een back-up van een bepaald tijdstip van een bestaande SQL-pool te herstellen. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande SQL-pool en restorePointInTime moet worden opgegeven.

Herstel: Hiermee maakt u een SQL-pool op basis van een geo-gerepliceerde back-up. sourceDatabaseId moet worden opgegeven als de recoverableDatabaseId om te herstellen.

Herstellen: Hiermee maakt u een SQL-pool door een back-up van een verwijderde SQL-pool te herstellen. SourceDatabaseId moet de oorspronkelijke resource-id van de sql-pool zijn. SourceDatabaseId en sourceDatabaseDeletionDate moeten worden opgegeven.		 'Standaard'
'PointInTimeRestore'
'Herstel'
'Herstellen'
maxSizeBytes Maximale grootte in bytes Int
voorzieningstoestand Resourcestatus snaar
recoverableDatabaseId Een back-up maken van de database waaruit u wilt herstellen snaar
restorePointInTime Momentopnametijd om te herstellen snaar
sourceDatabaseDeletionDate Hiermee geeft u de tijd op waarop de SQL-pool is verwijderd snaar
sourceDatabaseId Brondatabase waaruit moet worden gemaakt snaar
storageAccountType Het type opslagaccount dat wordt gebruikt voor het opslaan van back-ups voor deze SQL-pool. 'GRS'
'LRS'

TrackedResourceTags

Naam Beschrijving Waarde

Gebruiksvoorbeelden

Bicep-voorbeelden

Een eenvoudig voorbeeld van het implementeren van Synapse SQL Pool.

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@description('The SQL administrator login name for the Synapse workspace')
param sqlAdministratorLogin string
@secure()
@description('The SQL administrator login password for the Synapse workspace')
param sqlAdministratorLoginPassword string

resource blobService 'Microsoft.Storage/storageAccounts/blobServices@2022-09-01' existing = {
  name: 'default'
  parent: storageAccount
}

resource workspace 'Microsoft.Synapse/workspaces@2021-06-01' = {
  name: resourceName
  location: location
  properties: {
    defaultDataLakeStorage: {
      accountUrl: storageAccount.properties.primaryEndpoints.dfs
      filesystem: container.name
    }
    managedVirtualNetwork: ''
    publicNetworkAccess: 'Enabled'
    sqlAdministratorLogin: sqlAdministratorLogin
    sqlAdministratorLoginPassword: sqlAdministratorLoginPassword
  }
}

resource sqlPool 'Microsoft.Synapse/workspaces/sqlPools@2021-06-01' = {
  name: resourceName
  location: location
  parent: workspace
  sku: {
    name: 'DW100c'
  }
  properties: {
    createMode: 'Default'
  }
}

resource container 'Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01' = {
  name: resourceName
  parent: blobService
  properties: {
    metadata: {
      key: 'value'
    }
  }
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
  properties: {}
}

Resourcedefinitie van ARM-sjabloon

Het resourcetype werkruimten/sqlPools kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Synapse/workspaces/sqlPools-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.Synapse/workspaces/sqlPools",
  "apiVersion": "2021-06-01",
  "name": "string",
  "location": "string",
  "properties": {
    "collation": "string",
    "createMode": "string",
    "maxSizeBytes": "int",
    "provisioningState": "string",
    "recoverableDatabaseId": "string",
    "restorePointInTime": "string",
    "sourceDatabaseDeletionDate": "string",
    "sourceDatabaseId": "string",
    "storageAccountType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschapswaarden

Microsoft.Synapse/workspaces/sqlPools

Naam Beschrijving Waarde
apiVersion De API-versie '2021-06-01'
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
naam De resourcenaam tekenreeks (vereist)
Eigenschappen Eigenschappen van SQL-pool SqlPoolResourceProperties-
Sku SKU van SQL-pool SKU-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
soort Het resourcetype 'Microsoft.Synapse/workspaces/sqlPools'

Sku

Naam Beschrijving Waarde
capaciteit Als de SKU uitschalen/inschalen ondersteunt, moet het gehele getal van de capaciteit worden opgenomen. Als uitschalen/inschalen niet mogelijk is voor de resource, kan dit worden weggelaten. Int
naam De SKU-naam snaar
rang De servicelaag snaar

SqlPoolResourceProperties

Naam Beschrijving Waarde
collatie Sorteringsmodus snaar
createMode Hiermee geeft u de modus voor het maken van sql-pools op.

Standaard: het maken van een gewone SQL-pool.

PointInTimeRestore: Hiermee maakt u een SQL-pool door een back-up van een bepaald tijdstip van een bestaande SQL-pool te herstellen. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande SQL-pool en restorePointInTime moet worden opgegeven.

Herstel: Hiermee maakt u een SQL-pool op basis van een geo-gerepliceerde back-up. sourceDatabaseId moet worden opgegeven als de recoverableDatabaseId om te herstellen.

Herstellen: Hiermee maakt u een SQL-pool door een back-up van een verwijderde SQL-pool te herstellen. SourceDatabaseId moet de oorspronkelijke resource-id van de sql-pool zijn. SourceDatabaseId en sourceDatabaseDeletionDate moeten worden opgegeven.		 'Standaard'
'PointInTimeRestore'
'Herstel'
'Herstellen'
maxSizeBytes Maximale grootte in bytes Int
voorzieningstoestand Resourcestatus snaar
recoverableDatabaseId Een back-up maken van de database waaruit u wilt herstellen snaar
restorePointInTime Momentopnametijd om te herstellen snaar
sourceDatabaseDeletionDate Hiermee geeft u de tijd op waarop de SQL-pool is verwijderd snaar
sourceDatabaseId Brondatabase waaruit moet worden gemaakt snaar
storageAccountType Het type opslagaccount dat wordt gebruikt voor het opslaan van back-ups voor deze SQL-pool. 'GRS'
'LRS'

TrackedResourceTags

Naam Beschrijving Waarde

Gebruiksvoorbeelden

Azure-snelstartsjablonen

De volgende Azure-quickstartsjablonen dit resourcetype implementeren.

Sjabloon Beschrijving
Azure Synapse Proof-of-Concept-

implementeren in Azure 		Met deze sjabloon maakt u een proof-of-conceptomgeving voor Azure Synapse, waaronder SQL-pools en optionele Apache Spark-pools

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype werkruimten/sqlPools kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Synapse/workspaces/sqlPools-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      collation = "string"
      createMode = "string"
      maxSizeBytes = int
      provisioningState = "string"
      recoverableDatabaseId = "string"
      restorePointInTime = "string"
      sourceDatabaseDeletionDate = "string"
      sourceDatabaseId = "string"
      storageAccountType = "string"
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  }
}

Eigenschapswaarden

Microsoft.Synapse/workspaces/sqlPools

Naam Beschrijving Waarde
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
naam De resourcenaam tekenreeks (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: werkruimten
Eigenschappen Eigenschappen van SQL-pool SqlPoolResourceProperties-
Sku SKU van SQL-pool SKU-
Tags Resourcetags Woordenlijst met tagnamen en -waarden.
soort Het resourcetype "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"

Sku

Naam Beschrijving Waarde
capaciteit Als de SKU uitschalen/inschalen ondersteunt, moet het gehele getal van de capaciteit worden opgenomen. Als uitschalen/inschalen niet mogelijk is voor de resource, kan dit worden weggelaten. Int
naam De SKU-naam snaar
rang De servicelaag snaar

SqlPoolResourceProperties

Naam Beschrijving Waarde
collatie Sorteringsmodus snaar
createMode Hiermee geeft u de modus voor het maken van sql-pools op.

Standaard: het maken van een gewone SQL-pool.

PointInTimeRestore: Hiermee maakt u een SQL-pool door een back-up van een bepaald tijdstip van een bestaande SQL-pool te herstellen. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande SQL-pool en restorePointInTime moet worden opgegeven.

Herstel: Hiermee maakt u een SQL-pool op basis van een geo-gerepliceerde back-up. sourceDatabaseId moet worden opgegeven als de recoverableDatabaseId om te herstellen.

Herstellen: Hiermee maakt u een SQL-pool door een back-up van een verwijderde SQL-pool te herstellen. SourceDatabaseId moet de oorspronkelijke resource-id van de sql-pool zijn. SourceDatabaseId en sourceDatabaseDeletionDate moeten worden opgegeven.		 'Standaard'
'PointInTimeRestore'
'Herstel'
'Herstellen'
maxSizeBytes Maximale grootte in bytes Int
voorzieningstoestand Resourcestatus snaar
recoverableDatabaseId Een back-up maken van de database waaruit u wilt herstellen snaar
restorePointInTime Momentopnametijd om te herstellen snaar
sourceDatabaseDeletionDate Hiermee geeft u de tijd op waarop de SQL-pool is verwijderd snaar
sourceDatabaseId Brondatabase waaruit moet worden gemaakt snaar
storageAccountType Het type opslagaccount dat wordt gebruikt voor het opslaan van back-ups voor deze SQL-pool. 'GRS'
'LRS'

TrackedResourceTags

Naam Beschrijving Waarde

Gebruiksvoorbeelden

Terraform-monsters

Een eenvoudig voorbeeld van het implementeren van Synapse SQL Pool.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "sql_administrator_login" {
  type        = string
  description = "The SQL administrator login name for the Synapse workspace"
}

variable "sql_administrator_login_password" {
  type        = string
  description = "The SQL administrator login password for the Synapse workspace"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_action" "listKeys" {
  type                   = "Microsoft.Storage/storageAccounts@2022-09-01"
  resource_id            = azapi_resource.storageAccount.id
  action                 = "listKeys"
  response_export_values = ["*"]
}

data "azapi_resource" "blobService" {
  type      = "Microsoft.Storage/storageAccounts/blobServices@2022-09-01"
  parent_id = azapi_resource.storageAccount.id
  name      = "default"
}

resource "azapi_resource" "container" {
  type      = "Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01"
  name      = var.resource_name
  parent_id = data.azapi_resource.blobService.id
  body = {
    properties = {
      metadata = {
        key = "value"
      }
    }
  }
  response_export_values = ["*"]
}

resource "azapi_resource" "workspace" {
  type      = "Microsoft.Synapse/workspaces@2021-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      defaultDataLakeStorage = {
        accountUrl = azapi_resource.storageAccount.output.properties.primaryEndpoints.dfs
        filesystem = azapi_resource.container.name
      }

      managedVirtualNetwork         = ""
      publicNetworkAccess           = "Enabled"
      sqlAdministratorLogin         = var.sql_administrator_login
      sqlAdministratorLoginPassword = var.sql_administrator_login_password
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "sqlPool" {
  type      = "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"
  parent_id = azapi_resource.workspace.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      createMode = "Default"
    }
    sku = {
      name = "DW100c"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on