Aree di lavoro Microsoft.Synapse/sqlPools

Definizione di risorsa Bicep

Il tipo di risorsa workspaces/sqlPools può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Synapse/workspaces/sqlPools, aggiungere il bicep seguente al modello.

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

Valori delle proprietà

Microsoft.Synapse/workspaces/sqlPools

Nome Descrizione Valore
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa stringa (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.
Nome simbolico per la risorsa di tipo: aree di lavoro
proprietà Proprietà del pool SQL SqlPoolResourceProperties
Sku SQL pool SKU sku
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

Sku

Nome Descrizione Valore
capacità Se lo SKU supporta l'aumento o l'aumento del numero di istanze, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, potrebbe essere omesso. Int
nome Nome SKU corda
livello Livello di servizio corda

SqlPoolResourceProperties

Nome Descrizione Valore
collazione Modalità regole di confronto corda
createMode Specifica la modalità di creazione del pool SQL.

Impostazione predefinita: creazione regolare del pool SQL.

PointInTimeRestore: crea un pool SQL ripristinando un backup temporizzato di un pool SQL esistente. sourceDatabaseId deve essere specificato come ID risorsa del pool SQL esistente e deve essere specificato restorePointInTime.

Ripristino: crea un pool SQL da un backup con replica geografica. sourceDatabaseId deve essere specificato come recoverableDatabaseId da ripristinare.

Ripristino: crea un pool SQL ripristinando un backup di un pool SQL eliminato. SourceDatabaseId deve essere l'ID risorsa originale del pool SQL. È necessario specificare SourceDatabaseId e sourceDatabaseDeletionDate.
Impostazione predefinita
'PointInTimeRestore'
'Ripristino'
'Restore'
maxSizeBytes Dimensioni massime in byte Int
provisioningState Stato risorsa corda
recoverableDatabaseId Eseguire il backup del database da cui eseguire il ripristino corda
restorePointInTime Tempo di snapshot da ripristinare corda
sourceDatabaseDeletionDate Specifica l'ora in cui il pool SQL è stato eliminato corda
sourceDatabaseId Database di origine da cui creare corda
storageAccountType Tipo di account di archiviazione usato per archiviare i backup per questo pool SQL. 'GRS'
'LRS'

TrackedResourceTags

Nome Descrizione Valore

Esempi di utilizzo

Esempi bicep

Esempio di base di distribuzione del pool SQL di Synapse.

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

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa workspaces/sqlPools può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Synapse/workspaces/sqlPools, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

Microsoft.Synapse/workspaces/sqlPools

Nome Descrizione Valore
apiVersion Versione dell'API '2021-06-01'
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà del pool SQL SqlPoolResourceProperties
Sku SQL pool SKU sku
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.Synapse/workspaces/sqlPools'

Sku

Nome Descrizione Valore
capacità Se lo SKU supporta l'aumento o l'aumento del numero di istanze, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, potrebbe essere omesso. Int
nome Nome SKU corda
livello Livello di servizio corda

SqlPoolResourceProperties

Nome Descrizione Valore
collazione Modalità regole di confronto corda
createMode Specifica la modalità di creazione del pool SQL.

Impostazione predefinita: creazione regolare del pool SQL.

PointInTimeRestore: crea un pool SQL ripristinando un backup temporizzato di un pool SQL esistente. sourceDatabaseId deve essere specificato come ID risorsa del pool SQL esistente e deve essere specificato restorePointInTime.

Ripristino: crea un pool SQL da un backup con replica geografica. sourceDatabaseId deve essere specificato come recoverableDatabaseId da ripristinare.

Ripristino: crea un pool SQL ripristinando un backup di un pool SQL eliminato. SourceDatabaseId deve essere l'ID risorsa originale del pool SQL. È necessario specificare SourceDatabaseId e sourceDatabaseDeletionDate.
Impostazione predefinita
'PointInTimeRestore'
'Ripristino'
'Restore'
maxSizeBytes Dimensioni massime in byte Int
provisioningState Stato risorsa corda
recoverableDatabaseId Eseguire il backup del database da cui eseguire il ripristino corda
restorePointInTime Tempo di snapshot da ripristinare corda
sourceDatabaseDeletionDate Specifica l'ora in cui il pool SQL è stato eliminato corda
sourceDatabaseId Database di origine da cui creare corda
storageAccountType Tipo di account di archiviazione usato per archiviare i backup per questo pool SQL. 'GRS'
'LRS'

TrackedResourceTags

Nome Descrizione Valore

Esempi di utilizzo

Modelli di avvio rapido di Azure

I modelli di avvio rapido di Azure seguenti distribuire questo tipo di risorsa.

Sagoma Descrizione
proof-of-concept di Azure Synapse

Distribuire in Azure
Questo modello crea un ambiente di verifica per Azure Synapse, inclusi pool SQL e pool Apache Spark facoltativi

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa workspaces/sqlPools può essere distribuito con operazioni destinate a:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Synapse/workspaces/sqlPools, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

Microsoft.Synapse/workspaces/sqlPools

Nome Descrizione Valore
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: aree di lavoro
proprietà Proprietà del pool SQL SqlPoolResourceProperties
Sku SQL pool SKU sku
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"

Sku

Nome Descrizione Valore
capacità Se lo SKU supporta l'aumento o l'aumento del numero di istanze, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, potrebbe essere omesso. Int
nome Nome SKU corda
livello Livello di servizio corda

SqlPoolResourceProperties

Nome Descrizione Valore
collazione Modalità regole di confronto corda
createMode Specifica la modalità di creazione del pool SQL.

Impostazione predefinita: creazione regolare del pool SQL.

PointInTimeRestore: crea un pool SQL ripristinando un backup temporizzato di un pool SQL esistente. sourceDatabaseId deve essere specificato come ID risorsa del pool SQL esistente e deve essere specificato restorePointInTime.

Ripristino: crea un pool SQL da un backup con replica geografica. sourceDatabaseId deve essere specificato come recoverableDatabaseId da ripristinare.

Ripristino: crea un pool SQL ripristinando un backup di un pool SQL eliminato. SourceDatabaseId deve essere l'ID risorsa originale del pool SQL. È necessario specificare SourceDatabaseId e sourceDatabaseDeletionDate.
Impostazione predefinita
'PointInTimeRestore'
'Ripristino'
'Restore'
maxSizeBytes Dimensioni massime in byte Int
provisioningState Stato risorsa corda
recoverableDatabaseId Eseguire il backup del database da cui eseguire il ripristino corda
restorePointInTime Tempo di snapshot da ripristinare corda
sourceDatabaseDeletionDate Specifica l'ora in cui il pool SQL è stato eliminato corda
sourceDatabaseId Database di origine da cui creare corda
storageAccountType Tipo di account di archiviazione usato per archiviare i backup per questo pool SQL. 'GRS'
'LRS'

TrackedResourceTags

Nome Descrizione Valore

Esempi di utilizzo

Esempi di Terraform

Esempio di base di distribuzione del pool SQL di Synapse.

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    = ["*"]
}