Microsoft. Przestrzenie robocze Synapse/sqlPools

Definicja zasobu Bicep

Typ zasobu workspaces/sqlPools można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Przykłady użycia

Przykłady Bicep

Podstawowy przykład wdrażania puli SQL usługi 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: {}
}

Format zasobu

Aby utworzyć zasób Microsoft.Synapse/workspaces/sqlPools, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

Microsoft.Synapse/workspaces/sqlPools

Nazwa Opis Wartość
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
nadrzędny W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.
Nazwa symboliczna zasobu typu: obszarów roboczych
Właściwości Właściwości puli SQL SqlPoolResourceProperties
Numer jednostki magazynowej Jednostka SKU puli SQL sku
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Numer jednostki magazynowej

Nazwa Opis Wartość
dyspozycyjność Jeśli jednostka SKU obsługuje skalowanie w poziomie/w, należy uwzględnić liczbę całkowitą pojemności. Jeśli skalowanie w poziomie/w nie jest możliwe dla zasobu, może to zostać pominięte. Int
nazwa Nazwa jednostki SKU ciąg
warstwa Warstwa usługi ciąg

Właściwości sqlPoolResourceProperties

Nazwa Opis Wartość
sortowanie Tryb sortowania ciąg
createMode Określa tryb tworzenia puli SQL.

Ustawienie domyślne: regularne tworzenie puli SQL.

PointInTimeRestore: tworzy pulę SQL, przywracając kopię zapasową punktu w czasie istniejącej puli SQL. sourceDatabaseId musi być określony jako identyfikator zasobu istniejącej puli SQL, a parametr restorePointInTime należy określić.

Odzyskiwanie: tworzy pulę SQL za pomocą kopii zapasowej replikowanej geograficznie. sourceDatabaseId musi być określony jako recoverableDatabaseId, aby przywrócić.

Przywracanie: tworzy pulę SQL, przywracając kopię zapasową usuniętej puli SQL. SourceDatabaseId powinien być oryginalnym identyfikatorem zasobu puli SQL. Należy określić parametr SourceDatabaseId i sourceDatabaseDeletionDate.
"Wartość domyślna"
"PointInTimeRestore"
"Odzyskiwanie"
"Przywracanie"
maxSizeBytes Maksymalny rozmiar w bajtach Int
stan provisioningu Stan zasobu ciąg
recoverableDatabaseId Tworzenie kopii zapasowej bazy danych do przywrócenia z ciąg
restorePointInTime Czas migawki do przywrócenia ciąg
sourceDatabaseDeletionDate Określa czas usunięcia puli SQL ciąg
sourceDatabaseId Źródłowa baza danych do utworzenia na podstawie ciąg
storageAccountType Typ konta magazynu używany do przechowywania kopii zapasowych dla tej puli SQL. "GRS"
"LRS"

TrackedResourceTags

Nazwa Opis Wartość

Definicja zasobu szablonu usługi ARM

Typ zasobu workspaces/sqlPools można wdrożyć przy użyciu operacji docelowych:

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon Opis
weryfikacji koncepcji usługi Azure Synapse

wdrażanie w usłudze Azure
Ten szablon tworzy środowisko weryfikacji koncepcji dla usługi Azure Synapse, w tym pule SQL i opcjonalne pule platformy Apache Spark

Format zasobu

Aby utworzyć zasób Microsoft.Synapse/workspaces/sqlPools, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

Microsoft.Synapse/workspaces/sqlPools

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2021-06-01'
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości puli SQL SqlPoolResourceProperties
Numer jednostki magazynowej Jednostka SKU puli SQL sku
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.Synapse/workspaces/sqlPools"

Numer jednostki magazynowej

Nazwa Opis Wartość
dyspozycyjność Jeśli jednostka SKU obsługuje skalowanie w poziomie/w, należy uwzględnić liczbę całkowitą pojemności. Jeśli skalowanie w poziomie/w nie jest możliwe dla zasobu, może to zostać pominięte. Int
nazwa Nazwa jednostki SKU ciąg
warstwa Warstwa usługi ciąg

Właściwości sqlPoolResourceProperties

Nazwa Opis Wartość
sortowanie Tryb sortowania ciąg
createMode Określa tryb tworzenia puli SQL.

Ustawienie domyślne: regularne tworzenie puli SQL.

PointInTimeRestore: tworzy pulę SQL, przywracając kopię zapasową punktu w czasie istniejącej puli SQL. sourceDatabaseId musi być określony jako identyfikator zasobu istniejącej puli SQL, a parametr restorePointInTime należy określić.

Odzyskiwanie: tworzy pulę SQL za pomocą kopii zapasowej replikowanej geograficznie. sourceDatabaseId musi być określony jako recoverableDatabaseId, aby przywrócić.

Przywracanie: tworzy pulę SQL, przywracając kopię zapasową usuniętej puli SQL. SourceDatabaseId powinien być oryginalnym identyfikatorem zasobu puli SQL. Należy określić parametr SourceDatabaseId i sourceDatabaseDeletionDate.
"Wartość domyślna"
"PointInTimeRestore"
"Odzyskiwanie"
"Przywracanie"
maxSizeBytes Maksymalny rozmiar w bajtach Int
stan provisioningu Stan zasobu ciąg
recoverableDatabaseId Tworzenie kopii zapasowej bazy danych do przywrócenia z ciąg
restorePointInTime Czas migawki do przywrócenia ciąg
sourceDatabaseDeletionDate Określa czas usunięcia puli SQL ciąg
sourceDatabaseId Źródłowa baza danych do utworzenia na podstawie ciąg
storageAccountType Typ konta magazynu używany do przechowywania kopii zapasowych dla tej puli SQL. "GRS"
"LRS"

TrackedResourceTags

Nazwa Opis Wartość

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu workspaces/sqlPools można wdrożyć przy użyciu operacji docelowych:

  • Grupy zasobów Listę zmienionych właściwości w każdej wersji API można znaleźć w dzienniku zmian.

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania puli SQL usługi 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    = ["*"]
}

Format zasobu

Aby utworzyć zasób Microsoft.Synapse/workspaces/sqlPools, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

Microsoft.Synapse/workspaces/sqlPools

Nazwa Opis Wartość
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: obszarów roboczych
Właściwości Właściwości puli SQL SqlPoolResourceProperties
Numer jednostki magazynowej Jednostka SKU puli SQL sku
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"

Numer jednostki magazynowej

Nazwa Opis Wartość
dyspozycyjność Jeśli jednostka SKU obsługuje skalowanie w poziomie/w, należy uwzględnić liczbę całkowitą pojemności. Jeśli skalowanie w poziomie/w nie jest możliwe dla zasobu, może to zostać pominięte. Int
nazwa Nazwa jednostki SKU ciąg
warstwa Warstwa usługi ciąg

Właściwości sqlPoolResourceProperties

Nazwa Opis Wartość
sortowanie Tryb sortowania ciąg
createMode Określa tryb tworzenia puli SQL.

Ustawienie domyślne: regularne tworzenie puli SQL.

PointInTimeRestore: tworzy pulę SQL, przywracając kopię zapasową punktu w czasie istniejącej puli SQL. sourceDatabaseId musi być określony jako identyfikator zasobu istniejącej puli SQL, a parametr restorePointInTime należy określić.

Odzyskiwanie: tworzy pulę SQL za pomocą kopii zapasowej replikowanej geograficznie. sourceDatabaseId musi być określony jako recoverableDatabaseId, aby przywrócić.

Przywracanie: tworzy pulę SQL, przywracając kopię zapasową usuniętej puli SQL. SourceDatabaseId powinien być oryginalnym identyfikatorem zasobu puli SQL. Należy określić parametr SourceDatabaseId i sourceDatabaseDeletionDate.
"Wartość domyślna"
"PointInTimeRestore"
"Odzyskiwanie"
"Przywracanie"
maxSizeBytes Maksymalny rozmiar w bajtach Int
stan provisioningu Stan zasobu ciąg
recoverableDatabaseId Tworzenie kopii zapasowej bazy danych do przywrócenia z ciąg
restorePointInTime Czas migawki do przywrócenia ciąg
sourceDatabaseDeletionDate Określa czas usunięcia puli SQL ciąg
sourceDatabaseId Źródłowa baza danych do utworzenia na podstawie ciąg
storageAccountType Typ konta magazynu używany do przechowywania kopii zapasowych dla tej puli SQL. "GRS"
"LRS"

TrackedResourceTags

Nazwa Opis Wartość