Áreas de trabajo de Microsoft.Synapse/sqlPools

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.

Formato de recurso

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

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 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 del recurso de tipo: áreas de trabajo
Propiedades Propiedades del grupo de SQL SqlPoolResourceProperties
Sku SKU del grupo de SQL Sku de
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

SKU

Nombre Descripción Valor
capacidad Si la SKU admite el escalado horizontal o horizontal, se debe incluir el entero de capacidad. Si no es posible escalar horizontalmente o reducir horizontalmente el recurso, se puede omitir. Int
nombre Nombre de la SKU cuerda
nivel El nivel de servicio cuerda

SqlPoolResourceProperties

Nombre Descripción Valor
colación Modo de intercalación cuerda
createMode Especifica el modo de creación del grupo de SQL.

Valor predeterminado: creación normal del grupo de SQL.

PointInTimeRestore: crea un grupo de SQL restaurando una copia de seguridad a un momento dado de un grupo de SQL existente. sourceDatabaseId debe especificarse como identificador de recurso del grupo de SQL existente y se debe especificar restorePointInTime.

Recuperación: crea un grupo de SQL mediante una copia de seguridad con replicación geográfica. sourceDatabaseId debe especificarse como recoverableDatabaseId para restaurar.

Restaurar: crea un grupo de SQL restaurando una copia de seguridad de un grupo de SQL eliminado. SourceDatabaseId debe ser el identificador de recurso original del grupo de SQL. SourceDatabaseId y sourceDatabaseDeletionDate deben especificarse.
'Valor predeterminado'
'PointInTimeRestore'
"Recuperación"
'Restaurar'
maxSizeBytes Tamaño máximo en bytes Int
provisioningState Estado del recurso cuerda
recoverableDatabaseId Copia de seguridad de la base de datos desde la que se va a restaurar cuerda
restorePointInTime Tiempo de instantánea que se va a restaurar cuerda
sourceDatabaseDeletionDate Especifica la hora en que se eliminó el grupo de SQL. cuerda
sourceDatabaseId Base de datos de origen a partir de la que se va a crear cuerda
storageAccountType Tipo de cuenta de almacenamiento que se usa para almacenar copias de seguridad de este grupo de SQL. 'GRS'
'LRS'

TrackedResourceTags

Nombre Descripción Valor

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

Definición de recursos de plantilla de ARM

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.

Formato de recurso

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

{
  "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 de propiedad

Microsoft.Synapse/workspaces/sqlPools

Nombre Descripción Valor
apiVersion La versión de api '2021-06-01'
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades del grupo de SQL SqlPoolResourceProperties
Sku SKU del grupo de SQL Sku de
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'

SKU

Nombre Descripción Valor
capacidad Si la SKU admite el escalado horizontal o horizontal, se debe incluir el entero de capacidad. Si no es posible escalar horizontalmente o reducir horizontalmente el recurso, se puede omitir. Int
nombre Nombre de la SKU cuerda
nivel El nivel de servicio cuerda

SqlPoolResourceProperties

Nombre Descripción Valor
colación Modo de intercalación cuerda
createMode Especifica el modo de creación del grupo de SQL.

Valor predeterminado: creación normal del grupo de SQL.

PointInTimeRestore: crea un grupo de SQL restaurando una copia de seguridad a un momento dado de un grupo de SQL existente. sourceDatabaseId debe especificarse como identificador de recurso del grupo de SQL existente y se debe especificar restorePointInTime.

Recuperación: crea un grupo de SQL mediante una copia de seguridad con replicación geográfica. sourceDatabaseId debe especificarse como recoverableDatabaseId para restaurar.

Restaurar: crea un grupo de SQL restaurando una copia de seguridad de un grupo de SQL eliminado. SourceDatabaseId debe ser el identificador de recurso original del grupo de SQL. SourceDatabaseId y sourceDatabaseDeletionDate deben especificarse.
'Valor predeterminado'
'PointInTimeRestore'
"Recuperación"
'Restaurar'
maxSizeBytes Tamaño máximo en bytes Int
provisioningState Estado del recurso cuerda
recoverableDatabaseId Copia de seguridad de la base de datos desde la que se va a restaurar cuerda
restorePointInTime Tiempo de instantánea que se va a restaurar cuerda
sourceDatabaseDeletionDate Especifica la hora en que se eliminó el grupo de SQL. cuerda
sourceDatabaseId Base de datos de origen a partir de la que se va a crear cuerda
storageAccountType Tipo de cuenta de almacenamiento que se usa para almacenar copias de seguridad de este grupo de SQL. 'GRS'
'LRS'

TrackedResourceTags

Nombre Descripción Valor

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.

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 obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

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@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 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. Identificador del recurso de tipo: áreas de trabajo
Propiedades Propiedades del grupo de SQL SqlPoolResourceProperties
Sku SKU del grupo de SQL Sku de
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta.
tipo El tipo de recurso "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"

SKU

Nombre Descripción Valor
capacidad Si la SKU admite el escalado horizontal o horizontal, se debe incluir el entero de capacidad. Si no es posible escalar horizontalmente o reducir horizontalmente el recurso, se puede omitir. Int
nombre Nombre de la SKU cuerda
nivel El nivel de servicio cuerda

SqlPoolResourceProperties

Nombre Descripción Valor
colación Modo de intercalación cuerda
createMode Especifica el modo de creación del grupo de SQL.

Valor predeterminado: creación normal del grupo de SQL.

PointInTimeRestore: crea un grupo de SQL restaurando una copia de seguridad a un momento dado de un grupo de SQL existente. sourceDatabaseId debe especificarse como identificador de recurso del grupo de SQL existente y se debe especificar restorePointInTime.

Recuperación: crea un grupo de SQL mediante una copia de seguridad con replicación geográfica. sourceDatabaseId debe especificarse como recoverableDatabaseId para restaurar.

Restaurar: crea un grupo de SQL restaurando una copia de seguridad de un grupo de SQL eliminado. SourceDatabaseId debe ser el identificador de recurso original del grupo de SQL. SourceDatabaseId y sourceDatabaseDeletionDate deben especificarse.
'Valor predeterminado'
'PointInTimeRestore'
"Recuperación"
'Restaurar'
maxSizeBytes Tamaño máximo en bytes Int
provisioningState Estado del recurso cuerda
recoverableDatabaseId Copia de seguridad de la base de datos desde la que se va a restaurar cuerda
restorePointInTime Tiempo de instantánea que se va a restaurar cuerda
sourceDatabaseDeletionDate Especifica la hora en que se eliminó el grupo de SQL. cuerda
sourceDatabaseId Base de datos de origen a partir de la que se va a crear cuerda
storageAccountType Tipo de cuenta de almacenamiento que se usa para almacenar copias de seguridad de este grupo de SQL. 'GRS'
'LRS'

TrackedResourceTags

Nombre Descripción Valor

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