Espaces de travail Microsoft.Synapse/sqlPools

Définition de ressource Bicep

Le type de ressource workspaces/sqlPools peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Exemples d’utilisation

Exemples Bicep

Exemple de base de déploiement de 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: {}
}

Modules vérifiés Azure

Les modules vérifiés Azure suivants peuvent être utilisés pour déployer ce type de ressource.

Module Descriptif
Azure Synapse Analytics Workspace - SQL Pool AVM Child Module for Azure Synapse Analytics Workspace - SQL Pool

Format de ressource

Pour créer une ressource Microsoft.Synapse/workspaces/sqlPools, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

Microsoft.Synapse/workspaces/sqlPools

Nom Descriptif Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.
Nom symbolique de la ressource de type : espaces de travail
Propriétés Propriétés du pool SQL SqlPoolResourceProperties
Sku SQL pool SKU référence SKU
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

Sku

Nom Descriptif Valeur
capacité Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si le scale-out/in n’est pas possible pour la ressource, cela peut être omis. Int
nom Nom de la référence SKU corde
niveau Niveau de service corde

SqlPoolResourceProperties

Nom Descriptif Valeur
Classement Mode classement corde
createMode Spécifie le mode de création du pool sql.

Valeur par défaut : création régulière du pool SQL.

PointInTimeRestore : crée un pool sql en restaurant une sauvegarde à un point dans le temps d’un pool sql existant. sourceDatabaseId doit être spécifié comme ID de ressource du pool sql existant, et restorePointInTime doit être spécifié.

Récupération : crée un pool sql par une sauvegarde géorépliquée. sourceDatabaseId doit être spécifié en tant que récupérableDatabaseId à restaurer.

Restauration : crée un pool sql en restaurant une sauvegarde d’un pool sql supprimé. SourceDatabaseId doit être l’ID de ressource d’origine du pool sql. SourceDatabaseId et sourceDatabaseDeletionDate doivent être spécifiés.
Valeur par défaut
'PointInTimeRestore'
'Recovery'
'Restore'
maxSizeBytes Taille maximale en octets Int
provisioningState État de la ressource corde
recoverableDatabaseId Sauvegarder la base de données à partir de laquelle effectuer une restauration corde
restorePointInTime Heure de restauration d’instantané corde
sourceDatabaseDeletionDate Spécifie l’heure à laquelle le pool sql a été supprimé corde
sourceDatabaseId Base de données source à partir de laquelle créer corde
storageAccountType Type de compte de stockage utilisé pour stocker des sauvegardes pour ce pool sql. 'GRS'
'LRS'

TrackedResourceTags

Nom Descriptif Valeur

Définition de ressource de modèle ARM

Le type de ressource workspaces/sqlPools peut être déployé avec des opérations qui ciblent :

Exemples d’utilisation

Modèles de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.

Modèle Descriptif
preuve de concept Azure Synapse

Déployer sur Azure
Ce modèle crée un environnement de preuve de concept pour Azure Synapse, notamment des pools SQL et des pools Apache Spark facultatifs

Format de ressource

Pour créer une ressource Microsoft.Synapse/workspaces/sqlPools, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriété

Microsoft.Synapse/workspaces/sqlPools

Nom Descriptif Valeur
apiVersion Version de l’API '2021-06-01'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés du pool SQL SqlPoolResourceProperties
Sku SQL pool SKU référence SKU
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.Synapse/workspaces/sqlPools'

Sku

Nom Descriptif Valeur
capacité Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si le scale-out/in n’est pas possible pour la ressource, cela peut être omis. Int
nom Nom de la référence SKU corde
niveau Niveau de service corde

SqlPoolResourceProperties

Nom Descriptif Valeur
Classement Mode classement corde
createMode Spécifie le mode de création du pool sql.

Valeur par défaut : création régulière du pool SQL.

PointInTimeRestore : crée un pool sql en restaurant une sauvegarde à un point dans le temps d’un pool sql existant. sourceDatabaseId doit être spécifié comme ID de ressource du pool sql existant, et restorePointInTime doit être spécifié.

Récupération : crée un pool sql par une sauvegarde géorépliquée. sourceDatabaseId doit être spécifié en tant que récupérableDatabaseId à restaurer.

Restauration : crée un pool sql en restaurant une sauvegarde d’un pool sql supprimé. SourceDatabaseId doit être l’ID de ressource d’origine du pool sql. SourceDatabaseId et sourceDatabaseDeletionDate doivent être spécifiés.
Valeur par défaut
'PointInTimeRestore'
'Recovery'
'Restore'
maxSizeBytes Taille maximale en octets Int
provisioningState État de la ressource corde
recoverableDatabaseId Sauvegarder la base de données à partir de laquelle effectuer une restauration corde
restorePointInTime Heure de restauration d’instantané corde
sourceDatabaseDeletionDate Spécifie l’heure à laquelle le pool sql a été supprimé corde
sourceDatabaseId Base de données source à partir de laquelle créer corde
storageAccountType Type de compte de stockage utilisé pour stocker des sauvegardes pour ce pool sql. 'GRS'
'LRS'

TrackedResourceTags

Nom Descriptif Valeur

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource workspaces/sqlPools peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources Pour une liste des propriétés modifiées dans chaque version d’API, voir journal des modifications.

Exemples d’utilisation

Échantillons Terraform

Exemple de base de déploiement de 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    = ["*"]
}

Format de ressource

Pour créer une ressource Microsoft.Synapse/workspaces/sqlPools, ajoutez le terraform suivant à votre modèle.

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

Valeurs de propriété

Microsoft.Synapse/workspaces/sqlPools

Nom Descriptif Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : espaces de travail
Propriétés Propriétés du pool SQL SqlPoolResourceProperties
Sku SQL pool SKU référence SKU
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.Synapse/workspaces/sqlPools@2021-06-01 »

Sku

Nom Descriptif Valeur
capacité Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si le scale-out/in n’est pas possible pour la ressource, cela peut être omis. Int
nom Nom de la référence SKU corde
niveau Niveau de service corde

SqlPoolResourceProperties

Nom Descriptif Valeur
Classement Mode classement corde
createMode Spécifie le mode de création du pool sql.

Valeur par défaut : création régulière du pool SQL.

PointInTimeRestore : crée un pool sql en restaurant une sauvegarde à un point dans le temps d’un pool sql existant. sourceDatabaseId doit être spécifié comme ID de ressource du pool sql existant, et restorePointInTime doit être spécifié.

Récupération : crée un pool sql par une sauvegarde géorépliquée. sourceDatabaseId doit être spécifié en tant que récupérableDatabaseId à restaurer.

Restauration : crée un pool sql en restaurant une sauvegarde d’un pool sql supprimé. SourceDatabaseId doit être l’ID de ressource d’origine du pool sql. SourceDatabaseId et sourceDatabaseDeletionDate doivent être spécifiés.
Valeur par défaut
'PointInTimeRestore'
'Recovery'
'Restore'
maxSizeBytes Taille maximale en octets Int
provisioningState État de la ressource corde
recoverableDatabaseId Sauvegarder la base de données à partir de laquelle effectuer une restauration corde
restorePointInTime Heure de restauration d’instantané corde
sourceDatabaseDeletionDate Spécifie l’heure à laquelle le pool sql a été supprimé corde
sourceDatabaseId Base de données source à partir de laquelle créer corde
storageAccountType Type de compte de stockage utilisé pour stocker des sauvegardes pour ce pool sql. 'GRS'
'LRS'

TrackedResourceTags

Nom Descriptif Valeur