Workspaces/sqlPools do Microsoft.Synapse

Definição de recurso do Bicep

O tipo de recurso workspaces/sqlPools pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Exemplos de uso

Exemplos do Bicep

Um exemplo básico de implantação do Pool de SQL do 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: {}
}

Formato de recurso

Para criar um recurso Microsoft.Synapse/workspaces/sqlPools, adicione o seguinte Bicep ao seu modelo.

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

Valores da propriedade

Microsoft.Synapse/workspaces/sqlPools

Nome Descrição Valor
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para o recurso do tipo: workspaces
Propriedades Propriedades do pool de SQL sqlPoolResourceProperties
Sku SQL pool SKU de SKU
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

Sku

Nome Descrição Valor
capacidade Se o SKU der suporte a expansão/entrada, o inteiro de capacidade deverá ser incluído. Se a escala horizontal/in não for possível para o recurso, isso poderá ser omitido. int
nome O nome do SKU cadeia
nível A camada de serviço cadeia

SqlPoolResourceProperties

Nome Descrição Valor
agrupamento Modo de ordenação cadeia
createMode Especifica o modo de criação do pool de sql.

Padrão: criação regular do pool de sql.

PointInTimeRestore: cria um pool de sql restaurando um backup pontual de um pool de sql existente. sourceDatabaseId deve ser especificado como a ID do recurso do pool de sql existente e restorePointInTime deve ser especificado.

Recuperação: cria um pool de sql por um backup replicado geograficamente. sourceDatabaseId deve ser especificado como o recoverableDatabaseId para restaurar.

Restauração: cria um pool de sql restaurando um backup de um pool de sql excluído. SourceDatabaseId deve ser a ID de recurso original do pool de sql. SourceDatabaseId e sourceDatabaseDeletionDeletionDate devem ser especificados.
'Padrão'
'PointInTimeRestore'
'Recuperação'
'Restaurar'
maxSizeBytes Tamanho máximo em bytes int
provisioningState Estado do recurso cadeia
recoverableDatabaseId Fazer backup do banco de dados para restaurar a partir do cadeia
restorePointInTime Tempo de instantâneo para restauração cadeia
sourceDatabaseDeletionDate Especifica a hora em que o pool de sql foi excluído cadeia
sourceDatabaseId Banco de dados de origem a ser criado com base em cadeia
storageAccountType O tipo de conta de armazenamento usado para armazenar backups para esse pool de sql. 'GRS'
'LRS'

TrackedResourceTags

Nome Descrição Valor

Definição de recurso de modelo do ARM

O tipo de recurso workspaces/sqlPools pode ser implantado com operações direcionadas:

Exemplos de uso

Modelos de início rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.

Modelo Descrição
de Prova de Conceito do Azure Synapse

Implantar no Azure
Este modelo cria uma prova de ambiente de conceito para o Azure Synapse, incluindo pools de SQL e pools opcionais do Apache Spark

Formato de recurso

Para criar um recurso Microsoft.Synapse/workspaces/sqlPools, adicione o JSON a seguir ao seu modelo.

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

Valores da propriedade

Microsoft.Synapse/workspaces/sqlPools

Nome Descrição Valor
apiVersion A versão da API '2021-06-01'
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades do pool de SQL sqlPoolResourceProperties
Sku SQL pool SKU de SKU
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.Synapse/workspaces/sqlPools'

Sku

Nome Descrição Valor
capacidade Se o SKU der suporte a expansão/entrada, o inteiro de capacidade deverá ser incluído. Se a escala horizontal/in não for possível para o recurso, isso poderá ser omitido. int
nome O nome do SKU cadeia
nível A camada de serviço cadeia

SqlPoolResourceProperties

Nome Descrição Valor
agrupamento Modo de ordenação cadeia
createMode Especifica o modo de criação do pool de sql.

Padrão: criação regular do pool de sql.

PointInTimeRestore: cria um pool de sql restaurando um backup pontual de um pool de sql existente. sourceDatabaseId deve ser especificado como a ID do recurso do pool de sql existente e restorePointInTime deve ser especificado.

Recuperação: cria um pool de sql por um backup replicado geograficamente. sourceDatabaseId deve ser especificado como o recoverableDatabaseId para restaurar.

Restauração: cria um pool de sql restaurando um backup de um pool de sql excluído. SourceDatabaseId deve ser a ID de recurso original do pool de sql. SourceDatabaseId e sourceDatabaseDeletionDeletionDate devem ser especificados.
'Padrão'
'PointInTimeRestore'
'Recuperação'
'Restaurar'
maxSizeBytes Tamanho máximo em bytes int
provisioningState Estado do recurso cadeia
recoverableDatabaseId Fazer backup do banco de dados para restaurar a partir do cadeia
restorePointInTime Tempo de instantâneo para restauração cadeia
sourceDatabaseDeletionDate Especifica a hora em que o pool de sql foi excluído cadeia
sourceDatabaseId Banco de dados de origem a ser criado com base em cadeia
storageAccountType O tipo de conta de armazenamento usado para armazenar backups para esse pool de sql. 'GRS'
'LRS'

TrackedResourceTags

Nome Descrição Valor

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso workspaces/sqlPools pode ser implantado com operações direcionadas:

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do Pool de SQL do 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    = ["*"]
}

Formato de recurso

Para criar um recurso Microsoft.Synapse/workspaces/sqlPools, adicione o Terraform a seguir ao seu modelo.

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

Valores da propriedade

Microsoft.Synapse/workspaces/sqlPools

Nome Descrição Valor
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: workspaces
Propriedades Propriedades do pool de SQL sqlPoolResourceProperties
Sku SQL pool SKU de SKU
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"

Sku

Nome Descrição Valor
capacidade Se o SKU der suporte a expansão/entrada, o inteiro de capacidade deverá ser incluído. Se a escala horizontal/in não for possível para o recurso, isso poderá ser omitido. int
nome O nome do SKU cadeia
nível A camada de serviço cadeia

SqlPoolResourceProperties

Nome Descrição Valor
agrupamento Modo de ordenação cadeia
createMode Especifica o modo de criação do pool de sql.

Padrão: criação regular do pool de sql.

PointInTimeRestore: cria um pool de sql restaurando um backup pontual de um pool de sql existente. sourceDatabaseId deve ser especificado como a ID do recurso do pool de sql existente e restorePointInTime deve ser especificado.

Recuperação: cria um pool de sql por um backup replicado geograficamente. sourceDatabaseId deve ser especificado como o recoverableDatabaseId para restaurar.

Restauração: cria um pool de sql restaurando um backup de um pool de sql excluído. SourceDatabaseId deve ser a ID de recurso original do pool de sql. SourceDatabaseId e sourceDatabaseDeletionDeletionDate devem ser especificados.
'Padrão'
'PointInTimeRestore'
'Recuperação'
'Restaurar'
maxSizeBytes Tamanho máximo em bytes int
provisioningState Estado do recurso cadeia
recoverableDatabaseId Fazer backup do banco de dados para restaurar a partir do cadeia
restorePointInTime Tempo de instantâneo para restauração cadeia
sourceDatabaseDeletionDate Especifica a hora em que o pool de sql foi excluído cadeia
sourceDatabaseId Banco de dados de origem a ser criado com base em cadeia
storageAccountType O tipo de conta de armazenamento usado para armazenar backups para esse pool de sql. 'GRS'
'LRS'

TrackedResourceTags

Nome Descrição Valor