Microsoft.Synapse workspaces (Obszary robocze usługi Microsoft.Synapse)

Definicja zasobu Bicep

Typ zasobu obszarów roboczych można wdrożyć przy użyciu operacji docelowych:

grupy zasobów — zobacz polecenia wdrażania grupy zasobów

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 obszaru roboczego 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 storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
  properties: {}
}

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 container 'Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01' = {
  name: resourceName
  parent: blobService
  properties: {
    metadata: {
      key: 'value'
    }
  }
}

Moduły zweryfikowane na platformie Azure

Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.

Moduł	Opis
Obszar roboczy usługi Azure Synapse Analytics	Moduł zasobów AVM dla obszaru roboczego usługi Azure Synapse Analytics

Format zasobu

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

resource symbolicname 'Microsoft.Synapse/workspaces@2021-06-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    azureADOnlyAuthentication: bool
    cspWorkspaceAdminProperties: {
      initialWorkspaceAdminObjectId: 'string'
    }
    defaultDataLakeStorage: {
      accountUrl: 'string'
      createManagedPrivateEndpoint: bool
      filesystem: 'string'
      resourceId: 'string'
    }
    encryption: {
      cmk: {
        kekIdentity: {
          userAssignedIdentity: 'string'
          useSystemAssignedIdentity: any(...)
        }
        key: {
          keyVaultUrl: 'string'
          name: 'string'
        }
      }
    }
    managedResourceGroupName: 'string'
    managedVirtualNetwork: 'string'
    managedVirtualNetworkSettings: {
      allowedAadTenantIdsForLinking: [
        'string'
      ]
      linkedAccessCheckOnTargetResource: bool
      preventDataExfiltration: bool
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    purviewConfiguration: {
      purviewResourceId: 'string'
    }
    sqlAdministratorLogin: 'string'
    sqlAdministratorLoginPassword: 'string'
    trustedServiceBypassEnabled: bool
    virtualNetworkProfile: {
      computeSubnetId: 'string'
    }
    workspaceRepositoryConfiguration: {
      accountName: 'string'
      collaborationBranch: 'string'
      hostName: 'string'
      lastCommitId: 'string'
      projectName: 'string'
      repositoryName: 'string'
      rootFolder: 'string'
      tenantId: 'string'
      type: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

Microsoft.Synapse/workspaces

Nazwa	Opis	Wartość
tożsamość	Tożsamość obszaru roboczego	Identyfikator zarządzany
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 zasobu obszaru roboczego	WorkspaceWłaściwości
Tagi	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz tagi w szablonach

CspWorkspaceAdminProperties

Nazwa	Opis	Wartość
initialWorkspaceAdminObjectId	Identyfikator obiektu usługi AAD początkowego administratora obszaru roboczego	ciąg

CustomerManagedKeyDetails

Nazwa	Opis	Wartość
kekIdentity (tożsamość kek)	Klucz szyfrowania klucza	KekIdentityProperties
klucz	Obiekt klucza obszaru roboczego	WorkspaceKeyDetails (Szczegóły obszaru roboczego)

DataLakeStorageAccountDetails

Nazwa	Opis	Wartość
accountUrl (Adres URL konta)	Adres URL konta	ciąg
createManagedPrivateEndpoint	Utwórz zarządzany prywatny punkt końcowy na tym koncie magazynu lub nie	Bool
system plików	Nazwa systemu plików	ciąg
identyfikator zasobu	Identyfikator zasobu usługi ARM dla tego konta magazynu	ciąg

SzyfrowanieSzczegóły

Nazwa	Opis	Wartość
CMK (Kodeks Zarządzania	Szczegóły klucza zarządzanego przez klienta	CustomerManagedKeyDetails

KekIdentityProperties

Nazwa	Opis	Wartość
tożsamość przypisana przez użytkownika	Identyfikator zasobu tożsamości przypisanej przez użytkownika	ciąg
useSystemAssignedIdentity (tożsamość użytkownika)	Wartość logiczna określająca, czy używać tożsamości przypisanej przez system, czy nie	jakikolwiek

Identyfikator zarządzany

Nazwa	Opis	Wartość
typ	Typ tożsamości zarządzanej dla obszaru roboczego	"Brak" "SystemAssigned" "SystemAssigned,UserAssigned"
tożsamości przypisane użytkownikom	Tożsamości zarządzane przypisane przez użytkownika.	UserAssignedManagedIdentities

ManagedVirtualNetworkSettings (Ustawienia sieci zarządzanejVirtualNetwork)

Nazwa	Opis	Wartość
allowedAadTenantIdsForLinking	Dozwolone identyfikatory dzierżawy usługi Aad na potrzeby łączenia	ciąg znakowy[]
linkedAccessCheckOnTargetResource	Sprawdzanie dostępu połączonego w zasobie docelowym	Bool
preventDataExfiltracja	Zapobieganie eksfiltracji danych	Bool

Prywatny punkt końcowy

Nazwa	Opis	Wartość

PrivateEndpointConnection (Połączenie PrivateEndpointConnection)

Nazwa	Opis	Wartość
Właściwości	Właściwości połączenia prywatnego punktu końcowego.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa	Opis	Wartość
privateEndpoint (punkt końcowy prywatny)	Prywatny punkt końcowy, do którego należy połączenie.	PrivateEndpoint
privateLinkServiceConnectionState	Stan połączenia prywatnego punktu końcowego.	PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Nazwa	Opis	Wartość
opis	Opis połączenia usługi private link.	ciąg
stan	Stan połączenia usługi private link.	ciąg

Konfiguracja programu PurviewConfiguration

Nazwa	Opis	Wartość
purviewResourceId (identyfikator zasobu)	Identyfikator zasobu usługi Purview	ciąg

Śledzone tagi zasobów

Nazwa	Opis	Wartość

UserAssignedManagedIdentities

Nazwa	Opis	Wartość

UserAssignedManagedIdentity

Nazwa	Opis	Wartość

Profil sieci wirtualnej

Nazwa	Opis	Wartość
computeSubnetId	Identyfikator podsieci używany do obliczeń w obszarze roboczym	ciąg

WorkspaceKeyDetails (Szczegóły obszaru roboczego)

Nazwa	Opis	Wartość
keyVaultUrl (adres URL klucza)	Adres URL magazynu kluczy podrzędnych klucza obszaru roboczego	ciąg
nazwa	Nazwa podsób klucza obszaru roboczego	ciąg

Właściwości obszaru roboczego

Nazwa	Opis	Wartość
azureADOnlyAuthentication	Włączanie lub wyłączanie usługi AzureADOnlyAuthentication we wszystkich podźródle obszaru roboczego	Bool
cspWorkspaceAdminProperties	Początkowe właściwości administratora usługi AAD obszaru roboczego dla subskrypcji CSP	CspWorkspaceAdminProperties
defaultDataLakeStorage	Szczegóły domyślnego konta usługi Data Lake Storage obszaru roboczego	DataLakeStorageAccountDetails
szyfrowanie	Szczegóły szyfrowania obszaru roboczego	SzyfrowanieSzczegóły
managedResourceGroupName (nazwa_grupy_zasobów)	Zarządzana grupa zasobów obszaru roboczego. Nazwa grupy zasobów jednoznacznie identyfikuje grupę zasobów w ramach identyfikatora subskrypcji użytkownika. Nazwa grupy zasobów nie może być dłuższa niż 90 znaków i musi być znakiem alfanumerycznym (Char.IsLetterOrDigit()) i "-", "_", "(", ")" i". Należy pamiętać, że nazwa nie może kończyć się ciągiem "".	ciąg
zarządzana sieć wirtualna	Ustawienie tej wartości na wartość "default" zapewni, że wszystkie obliczenia dla tego obszaru roboczego są w sieci wirtualnej zarządzanej w imieniu użytkownika.	ciąg
managedVirtualNetworkSettings (Ustawienia sieci wirtualnej)	Ustawienia zarządzanej sieci wirtualnej	ManagedVirtualNetworkSettings (Ustawienia sieci zarządzanejVirtualNetwork)
privateEndpointConnections (połączenia prywatnegopunktu końcowego)	Połączenia prywatnego punktu końcowego z obszarem roboczym	PrivateEndpointConnection[]
dostęp do sieci publicznej	Włączanie lub wyłączanie dostępu do sieci publicznej do obszaru roboczego	"Wyłączone" "Włączone"
purviewConfiguration (konfiguracja parametru)	Konfiguracja usługi Purview	Konfiguracja programu PurviewConfiguration
sqlAdministratorLogin	Logowanie do obszaru roboczego administrator usługi SQL Active Directory	ciąg
sqlAdministratorLoginPassword	Hasło logowania administratora SQL	ciąg
trustedServiceBypassEnabled	Czy element trustedServiceBypassEnabled dla obszaru roboczego	Bool
virtualNetworkProfile (profil sieci wirtualnej)	Profil sieci wirtualnej	VirtualNetworkProfile
workspaceRepositoryConfiguration (konfiguracja repozytorium obszarów roboczych)	Ustawienia integracji z usługą Git	Konfiguracja repozytorium obszaru roboczego

Konfiguracja repozytorium obszaru roboczego

Nazwa	Opis	Wartość
nazwa konta	Nazwa konta	ciąg
współpracaGałąź	Gałąź współpracy	ciąg
nazwa hosta	Nazwa hosta usługi GitHub Enterprise. Na przykład: `https://github.mydomain.com`	ciąg
lastCommitId (Identyfikator ostatniego zatwierdzenia)	Ostatni identyfikator zatwierdzenia	ciąg
nazwa projektu	Nazwa projektu usługi VSTS	ciąg
nazwaRepozytorium	Nazwa repozytorium	ciąg
folder główny	Folder główny do użycia w repozytorium	ciąg
Identyfikator najemcy	Identyfikator dzierżawy usługi VSTS	struna Ograniczenia: Minimalna długość = 36 Maksymalna długość = 36 Wzorzec = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
typ	Typ konfiguracji identyfikatora repozytorium obszaru roboczego. Przykładowy obszar roboczyVSTSConfiguration, workspaceGitHubConfiguration	ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu obszarów roboczych można wdrożyć przy użyciu operacji docelowych:

Grupy zasobów – Zobacz polecenia wdrożenia grup zasobów Aby uzyskać listę zmienionych właściwości w każdej wersji API, zobacz log zmian.

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	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, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Synapse/workspaces",
  "apiVersion": "2021-06-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "azureADOnlyAuthentication": "bool",
    "cspWorkspaceAdminProperties": {
      "initialWorkspaceAdminObjectId": "string"
    },
    "defaultDataLakeStorage": {
      "accountUrl": "string",
      "createManagedPrivateEndpoint": "bool",
      "filesystem": "string",
      "resourceId": "string"
    },
    "encryption": {
      "cmk": {
        "kekIdentity": {
          "userAssignedIdentity": "string",
          "useSystemAssignedIdentity": {}
        },
        "key": {
          "keyVaultUrl": "string",
          "name": "string"
        }
      }
    },
    "managedResourceGroupName": "string",
    "managedVirtualNetwork": "string",
    "managedVirtualNetworkSettings": {
      "allowedAadTenantIdsForLinking": [ "string" ],
      "linkedAccessCheckOnTargetResource": "bool",
      "preventDataExfiltration": "bool"
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "purviewConfiguration": {
      "purviewResourceId": "string"
    },
    "sqlAdministratorLogin": "string",
    "sqlAdministratorLoginPassword": "string",
    "trustedServiceBypassEnabled": "bool",
    "virtualNetworkProfile": {
      "computeSubnetId": "string"
    },
    "workspaceRepositoryConfiguration": {
      "accountName": "string",
      "collaborationBranch": "string",
      "hostName": "string",
      "lastCommitId": "string",
      "projectName": "string",
      "repositoryName": "string",
      "rootFolder": "string",
      "tenantId": "string",
      "type": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

Microsoft.Synapse/workspaces

Nazwa	Opis	Wartość
apiVersion (wersja interfejsu api)	Wersja interfejsu API	'2021-06-01'
tożsamość	Tożsamość obszaru roboczego	Identyfikator zarządzany
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 zasobu obszaru roboczego	WorkspaceWłaściwości
Tagi	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ	Typ zasobu	"Microsoft.Synapse/workspaces"

CspWorkspaceAdminProperties

Nazwa	Opis	Wartość
initialWorkspaceAdminObjectId	Identyfikator obiektu usługi AAD początkowego administratora obszaru roboczego	ciąg

CustomerManagedKeyDetails

Nazwa	Opis	Wartość
kekIdentity (tożsamość kek)	Klucz szyfrowania klucza	KekIdentityProperties
klucz	Obiekt klucza obszaru roboczego	WorkspaceKeyDetails (Szczegóły obszaru roboczego)

DataLakeStorageAccountDetails

Nazwa	Opis	Wartość
accountUrl (Adres URL konta)	Adres URL konta	ciąg
createManagedPrivateEndpoint	Utwórz zarządzany prywatny punkt końcowy na tym koncie magazynu lub nie	Bool
system plików	Nazwa systemu plików	ciąg
identyfikator zasobu	Identyfikator zasobu usługi ARM dla tego konta magazynu	ciąg

SzyfrowanieSzczegóły

Nazwa	Opis	Wartość
CMK (Kodeks Zarządzania	Szczegóły klucza zarządzanego przez klienta	CustomerManagedKeyDetails

KekIdentityProperties

Nazwa	Opis	Wartość
tożsamość przypisana przez użytkownika	Identyfikator zasobu tożsamości przypisanej przez użytkownika	ciąg
useSystemAssignedIdentity (tożsamość użytkownika)	Wartość logiczna określająca, czy używać tożsamości przypisanej przez system, czy nie	jakikolwiek

Identyfikator zarządzany

Nazwa	Opis	Wartość
typ	Typ tożsamości zarządzanej dla obszaru roboczego	"Brak" "SystemAssigned" "SystemAssigned,UserAssigned"
tożsamości przypisane użytkownikom	Tożsamości zarządzane przypisane przez użytkownika.	UserAssignedManagedIdentities

ManagedVirtualNetworkSettings (Ustawienia sieci zarządzanejVirtualNetwork)

Nazwa	Opis	Wartość
allowedAadTenantIdsForLinking	Dozwolone identyfikatory dzierżawy usługi Aad na potrzeby łączenia	ciąg znakowy[]
linkedAccessCheckOnTargetResource	Sprawdzanie dostępu połączonego w zasobie docelowym	Bool
preventDataExfiltracja	Zapobieganie eksfiltracji danych	Bool

Prywatny punkt końcowy

Nazwa	Opis	Wartość

PrivateEndpointConnection (Połączenie PrivateEndpointConnection)

Nazwa	Opis	Wartość
Właściwości	Właściwości połączenia prywatnego punktu końcowego.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa	Opis	Wartość
privateEndpoint (punkt końcowy prywatny)	Prywatny punkt końcowy, do którego należy połączenie.	PrivateEndpoint
privateLinkServiceConnectionState	Stan połączenia prywatnego punktu końcowego.	PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Nazwa	Opis	Wartość
opis	Opis połączenia usługi private link.	ciąg
stan	Stan połączenia usługi private link.	ciąg

Konfiguracja programu PurviewConfiguration

Nazwa	Opis	Wartość
purviewResourceId (identyfikator zasobu)	Identyfikator zasobu usługi Purview	ciąg

Śledzone tagi zasobów

Nazwa	Opis	Wartość

UserAssignedManagedIdentities

Nazwa	Opis	Wartość

UserAssignedManagedIdentity

Nazwa	Opis	Wartość

Profil sieci wirtualnej

Nazwa	Opis	Wartość
computeSubnetId	Identyfikator podsieci używany do obliczeń w obszarze roboczym	ciąg

WorkspaceKeyDetails (Szczegóły obszaru roboczego)

Nazwa	Opis	Wartość
keyVaultUrl (adres URL klucza)	Adres URL magazynu kluczy podrzędnych klucza obszaru roboczego	ciąg
nazwa	Nazwa podsób klucza obszaru roboczego	ciąg

Właściwości obszaru roboczego

Nazwa	Opis	Wartość
azureADOnlyAuthentication	Włączanie lub wyłączanie usługi AzureADOnlyAuthentication we wszystkich podźródle obszaru roboczego	Bool
cspWorkspaceAdminProperties	Początkowe właściwości administratora usługi AAD obszaru roboczego dla subskrypcji CSP	CspWorkspaceAdminProperties
defaultDataLakeStorage	Szczegóły domyślnego konta usługi Data Lake Storage obszaru roboczego	DataLakeStorageAccountDetails
szyfrowanie	Szczegóły szyfrowania obszaru roboczego	SzyfrowanieSzczegóły
managedResourceGroupName (nazwa_grupy_zasobów)	Zarządzana grupa zasobów obszaru roboczego. Nazwa grupy zasobów jednoznacznie identyfikuje grupę zasobów w ramach identyfikatora subskrypcji użytkownika. Nazwa grupy zasobów nie może być dłuższa niż 90 znaków i musi być znakiem alfanumerycznym (Char.IsLetterOrDigit()) i "-", "_", "(", ")" i". Należy pamiętać, że nazwa nie może kończyć się ciągiem "".	ciąg
zarządzana sieć wirtualna	Ustawienie tej wartości na wartość "default" zapewni, że wszystkie obliczenia dla tego obszaru roboczego są w sieci wirtualnej zarządzanej w imieniu użytkownika.	ciąg
managedVirtualNetworkSettings (Ustawienia sieci wirtualnej)	Ustawienia zarządzanej sieci wirtualnej	ManagedVirtualNetworkSettings (Ustawienia sieci zarządzanejVirtualNetwork)
privateEndpointConnections (połączenia prywatnegopunktu końcowego)	Połączenia prywatnego punktu końcowego z obszarem roboczym	PrivateEndpointConnection[]
dostęp do sieci publicznej	Włączanie lub wyłączanie dostępu do sieci publicznej do obszaru roboczego	"Wyłączone" "Włączone"
purviewConfiguration (konfiguracja parametru)	Konfiguracja usługi Purview	Konfiguracja programu PurviewConfiguration
sqlAdministratorLogin	Logowanie do obszaru roboczego administrator usługi SQL Active Directory	ciąg
sqlAdministratorLoginPassword	Hasło logowania administratora SQL	ciąg
trustedServiceBypassEnabled	Czy element trustedServiceBypassEnabled dla obszaru roboczego	Bool
virtualNetworkProfile (profil sieci wirtualnej)	Profil sieci wirtualnej	VirtualNetworkProfile
workspaceRepositoryConfiguration (konfiguracja repozytorium obszarów roboczych)	Ustawienia integracji z usługą Git	Konfiguracja repozytorium obszaru roboczego

Konfiguracja repozytorium obszaru roboczego

Nazwa	Opis	Wartość
nazwa konta	Nazwa konta	ciąg
współpracaGałąź	Gałąź współpracy	ciąg
nazwa hosta	Nazwa hosta usługi GitHub Enterprise. Na przykład: `https://github.mydomain.com`	ciąg
lastCommitId (Identyfikator ostatniego zatwierdzenia)	Ostatni identyfikator zatwierdzenia	ciąg
nazwa projektu	Nazwa projektu usługi VSTS	ciąg
nazwaRepozytorium	Nazwa repozytorium	ciąg
folder główny	Folder główny do użycia w repozytorium	ciąg
Identyfikator najemcy	Identyfikator dzierżawy usługi VSTS	struna Ograniczenia: Minimalna długość = 36 Maksymalna długość = 36 Wzorzec = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
typ	Typ konfiguracji identyfikatora repozytorium obszaru roboczego. Przykładowy obszar roboczyVSTSConfiguration, workspaceGitHubConfiguration	ciąg

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu obszarów roboczych 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 obszaru roboczego 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    = ["*"]
}

Format zasobu

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces@2021-06-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      azureADOnlyAuthentication = bool
      cspWorkspaceAdminProperties = {
        initialWorkspaceAdminObjectId = "string"
      }
      defaultDataLakeStorage = {
        accountUrl = "string"
        createManagedPrivateEndpoint = bool
        filesystem = "string"
        resourceId = "string"
      }
      encryption = {
        cmk = {
          kekIdentity = {
            userAssignedIdentity = "string"
            useSystemAssignedIdentity = ?
          }
          key = {
            keyVaultUrl = "string"
            name = "string"
          }
        }
      }
      managedResourceGroupName = "string"
      managedVirtualNetwork = "string"
      managedVirtualNetworkSettings = {
        allowedAadTenantIdsForLinking = [
          "string"
        ]
        linkedAccessCheckOnTargetResource = bool
        preventDataExfiltration = bool
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      purviewConfiguration = {
        purviewResourceId = "string"
      }
      sqlAdministratorLogin = "string"
      sqlAdministratorLoginPassword = "string"
      trustedServiceBypassEnabled = bool
      virtualNetworkProfile = {
        computeSubnetId = "string"
      }
      workspaceRepositoryConfiguration = {
        accountName = "string"
        collaborationBranch = "string"
        hostName = "string"
        lastCommitId = "string"
        projectName = "string"
        repositoryName = "string"
        rootFolder = "string"
        tenantId = "string"
        type = "string"
      }
    }
  }
}

Wartości właściwości

Microsoft.Synapse/workspaces

Nazwa	Opis	Wartość
tożsamość	Tożsamość obszaru roboczego	Identyfikator zarządzany
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 zasobu obszaru roboczego	WorkspaceWłaściwości
Tagi	Tagi zasobów	Słownik nazw tagów i wartości.
typ	Typ zasobu	"Microsoft.Synapse/workspaces@2021-06-01"

CspWorkspaceAdminProperties

Nazwa	Opis	Wartość
initialWorkspaceAdminObjectId	Identyfikator obiektu usługi AAD początkowego administratora obszaru roboczego	ciąg

CustomerManagedKeyDetails

Nazwa	Opis	Wartość
kekIdentity (tożsamość kek)	Klucz szyfrowania klucza	KekIdentityProperties
klucz	Obiekt klucza obszaru roboczego	WorkspaceKeyDetails (Szczegóły obszaru roboczego)

DataLakeStorageAccountDetails

Nazwa	Opis	Wartość
accountUrl (Adres URL konta)	Adres URL konta	ciąg
createManagedPrivateEndpoint	Utwórz zarządzany prywatny punkt końcowy na tym koncie magazynu lub nie	Bool
system plików	Nazwa systemu plików	ciąg
identyfikator zasobu	Identyfikator zasobu usługi ARM dla tego konta magazynu	ciąg

SzyfrowanieSzczegóły

Nazwa	Opis	Wartość
CMK (Kodeks Zarządzania	Szczegóły klucza zarządzanego przez klienta	CustomerManagedKeyDetails

KekIdentityProperties

Nazwa	Opis	Wartość
tożsamość przypisana przez użytkownika	Identyfikator zasobu tożsamości przypisanej przez użytkownika	ciąg
useSystemAssignedIdentity (tożsamość użytkownika)	Wartość logiczna określająca, czy używać tożsamości przypisanej przez system, czy nie	jakikolwiek

Identyfikator zarządzany

Nazwa	Opis	Wartość
typ	Typ tożsamości zarządzanej dla obszaru roboczego	"Brak" "SystemAssigned" "SystemAssigned,UserAssigned"
tożsamości przypisane użytkownikom	Tożsamości zarządzane przypisane przez użytkownika.	UserAssignedManagedIdentities

ManagedVirtualNetworkSettings (Ustawienia sieci zarządzanejVirtualNetwork)

Nazwa	Opis	Wartość
allowedAadTenantIdsForLinking	Dozwolone identyfikatory dzierżawy usługi Aad na potrzeby łączenia	ciąg znakowy[]
linkedAccessCheckOnTargetResource	Sprawdzanie dostępu połączonego w zasobie docelowym	Bool
preventDataExfiltracja	Zapobieganie eksfiltracji danych	Bool

Prywatny punkt końcowy

Nazwa	Opis	Wartość

PrivateEndpointConnection (Połączenie PrivateEndpointConnection)

Nazwa	Opis	Wartość
Właściwości	Właściwości połączenia prywatnego punktu końcowego.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa	Opis	Wartość
privateEndpoint (punkt końcowy prywatny)	Prywatny punkt końcowy, do którego należy połączenie.	PrivateEndpoint
privateLinkServiceConnectionState	Stan połączenia prywatnego punktu końcowego.	PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Nazwa	Opis	Wartość
opis	Opis połączenia usługi private link.	ciąg
stan	Stan połączenia usługi private link.	ciąg

Konfiguracja programu PurviewConfiguration

Nazwa	Opis	Wartość
purviewResourceId (identyfikator zasobu)	Identyfikator zasobu usługi Purview	ciąg

Śledzone tagi zasobów

Nazwa	Opis	Wartość

UserAssignedManagedIdentities

Nazwa	Opis	Wartość

UserAssignedManagedIdentity

Nazwa	Opis	Wartość

Profil sieci wirtualnej

Nazwa	Opis	Wartość
computeSubnetId	Identyfikator podsieci używany do obliczeń w obszarze roboczym	ciąg

WorkspaceKeyDetails (Szczegóły obszaru roboczego)

Nazwa	Opis	Wartość
keyVaultUrl (adres URL klucza)	Adres URL magazynu kluczy podrzędnych klucza obszaru roboczego	ciąg
nazwa	Nazwa podsób klucza obszaru roboczego	ciąg

Właściwości obszaru roboczego

Nazwa	Opis	Wartość
azureADOnlyAuthentication	Włączanie lub wyłączanie usługi AzureADOnlyAuthentication we wszystkich podźródle obszaru roboczego	Bool
cspWorkspaceAdminProperties	Początkowe właściwości administratora usługi AAD obszaru roboczego dla subskrypcji CSP	CspWorkspaceAdminProperties
defaultDataLakeStorage	Szczegóły domyślnego konta usługi Data Lake Storage obszaru roboczego	DataLakeStorageAccountDetails
szyfrowanie	Szczegóły szyfrowania obszaru roboczego	SzyfrowanieSzczegóły
managedResourceGroupName (nazwa_grupy_zasobów)	Zarządzana grupa zasobów obszaru roboczego. Nazwa grupy zasobów jednoznacznie identyfikuje grupę zasobów w ramach identyfikatora subskrypcji użytkownika. Nazwa grupy zasobów nie może być dłuższa niż 90 znaków i musi być znakiem alfanumerycznym (Char.IsLetterOrDigit()) i "-", "_", "(", ")" i". Należy pamiętać, że nazwa nie może kończyć się ciągiem "".	ciąg
zarządzana sieć wirtualna	Ustawienie tej wartości na wartość "default" zapewni, że wszystkie obliczenia dla tego obszaru roboczego są w sieci wirtualnej zarządzanej w imieniu użytkownika.	ciąg
managedVirtualNetworkSettings (Ustawienia sieci wirtualnej)	Ustawienia zarządzanej sieci wirtualnej	ManagedVirtualNetworkSettings (Ustawienia sieci zarządzanejVirtualNetwork)
privateEndpointConnections (połączenia prywatnegopunktu końcowego)	Połączenia prywatnego punktu końcowego z obszarem roboczym	PrivateEndpointConnection[]
dostęp do sieci publicznej	Włączanie lub wyłączanie dostępu do sieci publicznej do obszaru roboczego	"Wyłączone" "Włączone"
purviewConfiguration (konfiguracja parametru)	Konfiguracja usługi Purview	Konfiguracja programu PurviewConfiguration
sqlAdministratorLogin	Logowanie do obszaru roboczego administrator usługi SQL Active Directory	ciąg
sqlAdministratorLoginPassword	Hasło logowania administratora SQL	ciąg
trustedServiceBypassEnabled	Czy element trustedServiceBypassEnabled dla obszaru roboczego	Bool
virtualNetworkProfile (profil sieci wirtualnej)	Profil sieci wirtualnej	VirtualNetworkProfile
workspaceRepositoryConfiguration (konfiguracja repozytorium obszarów roboczych)	Ustawienia integracji z usługą Git	Konfiguracja repozytorium obszaru roboczego

Konfiguracja repozytorium obszaru roboczego

Nazwa	Opis	Wartość
nazwa konta	Nazwa konta	ciąg
współpracaGałąź	Gałąź współpracy	ciąg
nazwa hosta	Nazwa hosta usługi GitHub Enterprise. Na przykład: `https://github.mydomain.com`	ciąg
lastCommitId (Identyfikator ostatniego zatwierdzenia)	Ostatni identyfikator zatwierdzenia	ciąg
nazwa projektu	Nazwa projektu usługi VSTS	ciąg
nazwaRepozytorium	Nazwa repozytorium	ciąg
folder główny	Folder główny do użycia w repozytorium	ciąg
Identyfikator najemcy	Identyfikator dzierżawy usługi VSTS	struna Ograniczenia: Minimalna długość = 36 Maksymalna długość = 36 Wzorzec = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
typ	Typ konfiguracji identyfikatora repozytorium obszaru roboczego. Przykładowy obszar roboczyVSTSConfiguration, workspaceGitHubConfiguration	ciąg

Opinia

Czy ta strona była pomocna?

Last updated on 2025-09-17

Microsoft.Synapse workspaces (Obszary robocze usługi Microsoft.Synapse)

Definicja zasobu Bicep

Przykłady użycia

Przykłady Bicep

Moduły zweryfikowane na platformie Azure

Format zasobu

Wartości właściwości

Microsoft.Synapse/workspaces

CspWorkspaceAdminProperties

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

SzyfrowanieSzczegóły

KekIdentityProperties

Identyfikator zarządzany

ManagedVirtualNetworkSettings (Ustawienia sieci zarządzanejVirtualNetwork)

Prywatny punkt końcowy

PrivateEndpointConnection (Połączenie PrivateEndpointConnection)

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

Konfiguracja programu PurviewConfiguration

Śledzone tagi zasobów

UserAssignedManagedIdentities

UserAssignedManagedIdentity

Profil sieci wirtualnej

WorkspaceKeyDetails (Szczegóły obszaru roboczego)

Właściwości obszaru roboczego

Konfiguracja repozytorium obszaru roboczego

Definicja zasobu szablonu usługi ARM

Przykłady użycia

Szablony szybkiego startu platformy Azure

Format zasobu

Wartości właściwości

Microsoft.Synapse/workspaces

CspWorkspaceAdminProperties

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

SzyfrowanieSzczegóły

KekIdentityProperties

Identyfikator zarządzany

ManagedVirtualNetworkSettings (Ustawienia sieci zarządzanejVirtualNetwork)

Prywatny punkt końcowy

PrivateEndpointConnection (Połączenie PrivateEndpointConnection)

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

Konfiguracja programu PurviewConfiguration

Śledzone tagi zasobów

UserAssignedManagedIdentities

UserAssignedManagedIdentity

Profil sieci wirtualnej

WorkspaceKeyDetails (Szczegóły obszaru roboczego)

Właściwości obszaru roboczego

Konfiguracja repozytorium obszaru roboczego

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Przykłady użycia

Przykłady programu Terraform

Format zasobu

Wartości właściwości

Microsoft.Synapse/workspaces

CspWorkspaceAdminProperties

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

SzyfrowanieSzczegóły

KekIdentityProperties

Identyfikator zarządzany

ManagedVirtualNetworkSettings (Ustawienia sieci zarządzanejVirtualNetwork)

Prywatny punkt końcowy

PrivateEndpointConnection (Połączenie PrivateEndpointConnection)

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

Konfiguracja programu PurviewConfiguration

Śledzone tagi zasobów

UserAssignedManagedIdentities

UserAssignedManagedIdentity

Profil sieci wirtualnej

WorkspaceKeyDetails (Szczegóły obszaru roboczego)

Właściwości obszaru roboczego

Konfiguracja repozytorium obszaru roboczego

Opinia

Dodatkowe zasoby