Microsoft.Synapse-arbetsytor/sqlPools 2021-06-01

Bicep-resursdefinition

Resurstypen arbetsytor/sqlPools kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Användningsexempel

Bicep-exempel

Ett grundläggande exempel på distribution av 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: {}
}

Azure-verifierade moduler

Följande Azure-verifierade moduler kan användas för att distribuera den här resurstypen.

Modul Beskrivning
Azure Synapse Analytics Workspace - SQL Pool AVM Child Module for Azure Synapse Analytics Workspace - SQL Pool

Resursformat

Om du vill skapa en Microsoft.Synapse/workspaces/sqlPools-resurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

Microsoft.Synapse/workspaces/sqlPools

Namn Beskrivning Värde
plats Den geo-plats där resursen finns sträng (krävs)
Namn Resursnamnet sträng (krävs)
förälder I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför den överordnade resursen.
Symboliskt namn för resurs av typen: arbetsytor
Egenskaper Egenskaper för SQL-pool SqlPoolResourceProperties
Sku SQL-pool-SKU Sku
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

Sku

Namn Beskrivning Värde
kapacitet Om SKU:n stöder utskalning/in bör kapacitets heltal inkluderas. Om det inte går att skala ut/in för resursen kan detta utelämnas. Int
Namn SKU-namnet sträng
Nivå Tjänstnivån sträng

SqlPoolResourceProperties

Namn Beskrivning Värde
Sortering Sorteringsläge sträng
createMode Anger läget för skapande av SQL-pool.

Standard: vanlig skapande av sql-pool.

PointInTimeRestore: Skapar en SQL-pool genom att återställa en tidpunktssäkerhetskopia av en befintlig SQL-pool. sourceDatabaseId måste anges som resurs-ID för den befintliga sql-poolen och restorePointInTime måste anges.

Återställning: Skapar en SQL-pool med en geo-replikerad säkerhetskopia. sourceDatabaseId måste anges som återställningsbartDatabaseId för återställning.

Återställning: Skapar en SQL-pool genom att återställa en säkerhetskopia av en borttagen SQL-pool. SourceDatabaseId ska vara sql-poolens ursprungliga resurs-ID. SourceDatabaseId och sourceDatabaseDeletionDate måste anges.
"Standard"
"PointInTimeRestore"
"Återställning"
"Återställ"
maxSizeBytes Maximal storlek i byte Int
försörjningsstatus Resurstillstånd sträng
recoverableDatabaseId Säkerhetskopiera databas som ska återställas från sträng
restorePointInTime Tid för ögonblicksbild att återställa sträng
sourceDatabaseDeletionDate Anger den tid då SQL-poolen togs bort sträng
sourceDatabaseId Källdatabas att skapa från sträng
storageAccountType Lagringskontotypen som används för att lagra säkerhetskopior för den här SQL-poolen. "GRS"
"LRS"

TrackedResourceTags

Namn Beskrivning Värde

Resursdefinition för ARM-mall

Resurstypen arbetsytor/sqlPools kan distribueras med åtgärder som mål:

Användningsexempel

Azure-snabbstartsmallar

Följande Azure-snabbstartsmallar distribuera den här resurstypen.

Mall Beskrivning
Konceptbevis för Azure Synapse

Distribuera till Azure
Den här mallen skapar en konceptbevismiljö för Azure Synapse, inklusive SQL-pooler och valfria Apache Spark-pooler

Resursformat

Om du vill skapa en Microsoft.Synapse/workspaces/sqlPools-resurs lägger du till följande JSON i mallen.

{
  "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"
  }
}

Egenskapsvärden

Microsoft.Synapse/workspaces/sqlPools

Namn Beskrivning Värde
apiVersion API-versionen '2021-06-01'
plats Den geo-plats där resursen finns sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för SQL-pool SqlPoolResourceProperties
Sku SQL-pool-SKU Sku
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.Synapse/workspaces/sqlPools"

Sku

Namn Beskrivning Värde
kapacitet Om SKU:n stöder utskalning/in bör kapacitets heltal inkluderas. Om det inte går att skala ut/in för resursen kan detta utelämnas. Int
Namn SKU-namnet sträng
Nivå Tjänstnivån sträng

SqlPoolResourceProperties

Namn Beskrivning Värde
Sortering Sorteringsläge sträng
createMode Anger läget för skapande av SQL-pool.

Standard: vanlig skapande av sql-pool.

PointInTimeRestore: Skapar en SQL-pool genom att återställa en tidpunktssäkerhetskopia av en befintlig SQL-pool. sourceDatabaseId måste anges som resurs-ID för den befintliga sql-poolen och restorePointInTime måste anges.

Återställning: Skapar en SQL-pool med en geo-replikerad säkerhetskopia. sourceDatabaseId måste anges som återställningsbartDatabaseId för återställning.

Återställning: Skapar en SQL-pool genom att återställa en säkerhetskopia av en borttagen SQL-pool. SourceDatabaseId ska vara sql-poolens ursprungliga resurs-ID. SourceDatabaseId och sourceDatabaseDeletionDate måste anges.
"Standard"
"PointInTimeRestore"
"Återställning"
"Återställ"
maxSizeBytes Maximal storlek i byte Int
försörjningsstatus Resurstillstånd sträng
recoverableDatabaseId Säkerhetskopiera databas som ska återställas från sträng
restorePointInTime Tid för ögonblicksbild att återställa sträng
sourceDatabaseDeletionDate Anger den tid då SQL-poolen togs bort sträng
sourceDatabaseId Källdatabas att skapa från sträng
storageAccountType Lagringskontotypen som används för att lagra säkerhetskopior för den här SQL-poolen. "GRS"
"LRS"

TrackedResourceTags

Namn Beskrivning Värde

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen arbetsytor/sqlPools kan distribueras med åtgärder som mål:

  • Resursgrupper För en lista över ändrade egenskaper i varje API-version, se ändringslogg.

Användningsexempel

Terraform-exempel

Ett grundläggande exempel på distribution av 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    = ["*"]
}

Resursformat

Om du vill skapa en Microsoft.Synapse/workspaces/sqlPools-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

Microsoft.Synapse/workspaces/sqlPools

Namn Beskrivning Värde
plats Den geo-plats där resursen finns sträng (krävs)
Namn Resursnamnet sträng (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: arbetsytor
Egenskaper Egenskaper för SQL-pool SqlPoolResourceProperties
Sku SQL-pool-SKU Sku
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"

Sku

Namn Beskrivning Värde
kapacitet Om SKU:n stöder utskalning/in bör kapacitets heltal inkluderas. Om det inte går att skala ut/in för resursen kan detta utelämnas. Int
Namn SKU-namnet sträng
Nivå Tjänstnivån sträng

SqlPoolResourceProperties

Namn Beskrivning Värde
Sortering Sorteringsläge sträng
createMode Anger läget för skapande av SQL-pool.

Standard: vanlig skapande av sql-pool.

PointInTimeRestore: Skapar en SQL-pool genom att återställa en tidpunktssäkerhetskopia av en befintlig SQL-pool. sourceDatabaseId måste anges som resurs-ID för den befintliga sql-poolen och restorePointInTime måste anges.

Återställning: Skapar en SQL-pool med en geo-replikerad säkerhetskopia. sourceDatabaseId måste anges som återställningsbartDatabaseId för återställning.

Återställning: Skapar en SQL-pool genom att återställa en säkerhetskopia av en borttagen SQL-pool. SourceDatabaseId ska vara sql-poolens ursprungliga resurs-ID. SourceDatabaseId och sourceDatabaseDeletionDate måste anges.
"Standard"
"PointInTimeRestore"
"Återställning"
"Återställ"
maxSizeBytes Maximal storlek i byte Int
försörjningsstatus Resurstillstånd sträng
recoverableDatabaseId Säkerhetskopiera databas som ska återställas från sträng
restorePointInTime Tid för ögonblicksbild att återställa sträng
sourceDatabaseDeletionDate Anger den tid då SQL-poolen togs bort sträng
sourceDatabaseId Källdatabas att skapa från sträng
storageAccountType Lagringskontotypen som används för att lagra säkerhetskopior för den här SQL-poolen. "GRS"
"LRS"

TrackedResourceTags

Namn Beskrivning Värde