Áreas de trabajo de Microsoft.Synapse/sqlPools 2020-04-01-preview

Definición de recursos de Bicep

El tipo de recurso workspaces/sqlPools se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Ejemplos de uso

Ejemplos de Bicep

Un ejemplo básico de implementación del grupo de SQL de 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: {}
}

Módulos comprobados de Azure

Los siguientes módulos comprobados de Azure se pueden usar para implementar este tipo de recurso.

Module Descripción
Azure Synapse Analytics Workspace - SQL Pool AVM Child Module for Azure Synapse Analytics Workspace - SQL Pool

Formato de recurso

Para crear un recurso Microsoft.Synapse/workspaces/sqlPools, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.Synapse/workspaces/sqlPools@2020-04-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    autoPauseTimer: int
    autoResume: bool
    maxServiceObjectiveName: 'string'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces/sqlPools

Nombre Descripción Valor
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso string (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.
Nombre simbólico para el recurso de tipo: espacios de trabajo
Propiedades Propiedades de recursos. SqlPoolProperties
Sku SKU del grupo de SQL. La lista de SKU puede variar según la región y la oferta de soporte técnico. SkuV3
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

SkuV3

Nombre Descripción Valor
nombre El nombre de la SKU, normalmente, una letra + código de número, por ejemplo, P3. string (obligatorio)
nivel Nivel o edición de la SKU concreta, por ejemplo, Básico, Premium. cuerda

SqlPoolProperties

Nombre Descripción Valor
autoPauseTimer Período de inactividad en minutos antes de pausar automáticamente el grupo de SQL. Int
autoResume Indica si el grupo de sql puede reanudarse automáticamente cuando se realizan intentos de conexión. Bool
maxServiceObjectiveName Nombre objetivo de nivel de servicio máximo del grupo de SQL. cuerda

TrackedResourceTags

Nombre Descripción Valor

Definición de recursos de plantilla de ARM

El tipo de recurso workspaces/sqlPools se puede implementar con operaciones que tienen como destino:

Ejemplos de uso

Plantillas de inicio rápido de Azure

Los siguientes plantillas de inicio rápido de Azure implementar este tipo de recurso.

Plantilla Descripción
de prueba de concepto de Azure Synapse

Implementación en Azure
Esta plantilla crea un entorno de prueba de concepto para Azure Synapse, incluidos los grupos de SQL y los grupos de Apache Spark opcionales.

Formato de recurso

Para crear un recurso Microsoft.Synapse/workspaces/sqlPools, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.Synapse/workspaces/sqlPools",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "autoPauseTimer": "int",
    "autoResume": "bool",
    "maxServiceObjectiveName": "string"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces/sqlPools

Nombre Descripción Valor
apiVersion La versión de api '2020-04-01-preview'
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades de recursos. SqlPoolProperties
Sku SKU del grupo de SQL. La lista de SKU puede variar según la región y la oferta de soporte técnico. SkuV3
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo El tipo de recurso 'Microsoft.Synapse/workspaces/sqlPools'

SkuV3

Nombre Descripción Valor
nombre El nombre de la SKU, normalmente, una letra + código de número, por ejemplo, P3. string (obligatorio)
nivel Nivel o edición de la SKU concreta, por ejemplo, Básico, Premium. cuerda

SqlPoolProperties

Nombre Descripción Valor
autoPauseTimer Período de inactividad en minutos antes de pausar automáticamente el grupo de SQL. Int
autoResume Indica si el grupo de sql puede reanudarse automáticamente cuando se realizan intentos de conexión. Bool
maxServiceObjectiveName Nombre objetivo de nivel de servicio máximo del grupo de SQL. cuerda

TrackedResourceTags

Nombre Descripción Valor

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso workspaces/sqlPools se puede implementar con operaciones que tienen como destino:

  • Grupos de recursos Para una lista de propiedades modificadas en cada versión de la API, consulte registro de cambios.

Ejemplos de uso

Ejemplos de Terraform

Un ejemplo básico de implementación del grupo de SQL de 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 crear un recurso Microsoft.Synapse/workspaces/sqlPools, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/sqlPools@2020-04-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      autoPauseTimer = int
      autoResume = bool
      maxServiceObjectiveName = "string"
    }
    sku = {
      name = "string"
      tier = "string"
    }
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces/sqlPools

Nombre Descripción Valor
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. ID para recurso de tipo: espacios de trabajo
Propiedades Propiedades de recursos. SqlPoolProperties
Sku SKU del grupo de SQL. La lista de SKU puede variar según la región y la oferta de soporte técnico. SkuV3
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta.
tipo El tipo de recurso "Microsoft.Synapse/workspaces/sqlPools@2020-04-01-preview"

SkuV3

Nombre Descripción Valor
nombre El nombre de la SKU, normalmente, una letra + código de número, por ejemplo, P3. string (obligatorio)
nivel Nivel o edición de la SKU concreta, por ejemplo, Básico, Premium. cuerda

SqlPoolProperties

Nombre Descripción Valor
autoPauseTimer Período de inactividad en minutos antes de pausar automáticamente el grupo de SQL. Int
autoResume Indica si el grupo de sql puede reanudarse automáticamente cuando se realizan intentos de conexión. Bool
maxServiceObjectiveName Nombre objetivo de nivel de servicio máximo del grupo de SQL. cuerda

TrackedResourceTags

Nombre Descripción Valor