Share via

Microsoft.Synapse-arbetsytor 2020-12-01

  • Artikel

Bicep-resursdefinition

Resurstypen för arbetsytor kan distribueras med åtgärder som är mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Synapse/workspaces-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.Synapse/workspaces@2020-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
  }
  properties: {
    connectivityEndpoints: {}
    defaultDataLakeStorage: {
      accountUrl: 'string'
      filesystem: 'string'
    }
    encryption: {
      cmk: {
        key: {
          keyVaultUrl: 'string'
          name: 'string'
        }
      }
    }
    managedResourceGroupName: 'string'
    managedVirtualNetwork: 'string'
    managedVirtualNetworkSettings: {
      allowedAadTenantIdsForLinking: [
        'string'
      ]
      linkedAccessCheckOnTargetResource: bool
      preventDataExfiltration: bool
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    purviewConfiguration: {
      purviewResourceId: 'string'
    }
    sqlAdministratorLogin: 'string'
    sqlAdministratorLoginPassword: 'string'
    virtualNetworkProfile: {
      computeSubnetId: 'string'
    }
    workspaceRepositoryConfiguration: {
      accountName: 'string'
      collaborationBranch: 'string'
      hostName: 'string'
      lastCommitId: 'string'
      projectName: 'string'
      repositoryName: 'string'
      rootFolder: 'string'
      tenantId: 'string'
      type: 'string'
    }
  }
}

Egenskapsvärden

arbetsytor

Name Beskrivning Värde
name Resursnamnet sträng (krävs)

Teckengräns: 1–50

Giltiga tecken:
Gemener, bindestreck och siffror.

Börja och sluta med bokstav eller nummer.

Det går inte att innehålla -ondemand

Resursnamnet måste vara unikt i Hela Azure.
location Den geo-plats där resursen finns sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden. Se Taggar i mallar
identity Arbetsytans identitet ManagedIdentity
properties Egenskaper för arbetsytans resurs Egenskaper för arbetsyta

ManagedIdentity

Name Beskrivning Värde
typ Typ av hanterad identitet för arbetsytan "Ingen"
"SystemAssigned"

Egenskaper för arbetsyta

Name Beskrivning Värde
connectivityEndpoints Anslutningsslutpunkter objekt
defaultDataLakeStorage Information om arbetsytans standardkonto för Data Lake Storage DataLakeStorageAccountDetails
kryptering Krypteringsinformationen för arbetsytan EncryptionDetails
managedResourceGroupName Arbetsytans hanterade resursgrupp. Resursgruppens namn identifierar resursgruppen unikt i användarens subscriptionId. Resursgruppens namn får inte vara längre än 90 tecken långt och måste vara alfanumeriska tecken (Char.IsLetterOrDigit()) och "-", "_", "(", ")" och". Observera att namnet inte kan sluta med ".". sträng
managedVirtualNetwork Om du anger "standard" ser du till att all beräkning för den här arbetsytan finns i ett virtuellt nätverk som hanteras för användarens räkning. sträng
managedVirtualNetworkSettings Inställningar för hanterad Virtual Network ManagedVirtualNetworkSettings
privateEndpointConnections Privata slutpunktsanslutningar till arbetsytan PrivateEndpointConnection[]
purviewConfiguration Purview-konfiguration PurviewConfiguration
sqlAdministratorLogin Logga in för sql active directory-administratör för arbetsytan sträng
sqlAdministratorLoginPassword Inloggningslösenord för SQL-administratör sträng
virtualNetworkProfile Virtual Network profil VirtualNetworkProfile
workspaceRepositoryConfiguration Inställningar för Git-integrering WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Name Beskrivning Värde
accountUrl Konto-URL sträng
Filesystem Filsystemnamn sträng

EncryptionDetails

Name Beskrivning Värde
Cmk Information om kundhanterad nyckel CustomerManagedKeyDetails

CustomerManagedKeyDetails

Name Beskrivning Värde
nyckel Arbetsytans nyckelobjekt WorkspaceKeyDetails

WorkspaceKeyDetails

Name Beskrivning Värde
keyVaultUrl Url för nyckel för underresursnyckel för arbetsyta sträng
name Namn på underresurs för arbetsytenyckel sträng

ManagedVirtualNetworkSettings

Name Beskrivning Värde
allowedAadTenantIdsForLinking Tillåtna Aad-klientorganisations-ID:t för länkning string[]
linkedAccessCheckOnTargetResource Länkad åtkomstkontroll på målresurs boolesk
preventDataExfiltration Förhindra dataexfiltrering boolesk

PrivateEndpointConnection

Name Beskrivning Värde
properties Anslutningsegenskaper för privat slutpunkt. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Beskrivning Värde
privateEndpoint Den privata slutpunkt som anslutningen tillhör. PrivateEndpoint
privateLinkServiceConnectionState Anslutningstillstånd för den privata slutpunktsanslutningen. PrivateLinkServiceConnectionState

PrivateEndpoint

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

PrivateLinkServiceConnectionState

Name Beskrivning Värde
beskrivning Beskrivning av tjänstanslutningen för privat länk. sträng
status Anslutningsstatus för tjänsten Private Link. sträng

PurviewConfiguration

Name Beskrivning Värde
purviewResourceId Purview-resurs-ID sträng

VirtualNetworkProfile

Name Beskrivning Värde
computeSubnetId Undernäts-ID som används för beräkningar på arbetsytan sträng

WorkspaceRepositoryConfiguration

Name Beskrivning Värde
accountName Kontonamn sträng
collaborationBranch Samarbetsgren sträng
Värdnamn GitHub Enterprise-värdnamn. Exempelvis: https://github.mydomain.com sträng
lastCommitId Senaste inchecknings-ID sträng
projektnamn VSTS-projektnamn sträng
repositoryName Namn på lagringsplats sträng
rootFolder Rotmapp som ska användas i lagringsplatsen sträng
tenantId VSTS-klientorganisations-ID sträng
typ Typ av konfiguration av lagringsplats-ID för arbetsytan. Exempel på WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Azure Synapse proof-of-concept

Distribuera till Azure		 Den här mallen skapar en miljö för konceptbevis för Azure Synapse, inklusive SQL-pooler och valfria Apache Spark-pooler

Resursdefinition för ARM-mall

Resurstypen för arbetsytor kan distribueras med åtgärder som är mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Synapse/workspaces-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.Synapse/workspaces",
  "apiVersion": "2020-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "connectivityEndpoints": {},
    "defaultDataLakeStorage": {
      "accountUrl": "string",
      "filesystem": "string"
    },
    "encryption": {
      "cmk": {
        "key": {
          "keyVaultUrl": "string",
          "name": "string"
        }
      }
    },
    "managedResourceGroupName": "string",
    "managedVirtualNetwork": "string",
    "managedVirtualNetworkSettings": {
      "allowedAadTenantIdsForLinking": [ "string" ],
      "linkedAccessCheckOnTargetResource": "bool",
      "preventDataExfiltration": "bool"
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "purviewConfiguration": {
      "purviewResourceId": "string"
    },
    "sqlAdministratorLogin": "string",
    "sqlAdministratorLoginPassword": "string",
    "virtualNetworkProfile": {
      "computeSubnetId": "string"
    },
    "workspaceRepositoryConfiguration": {
      "accountName": "string",
      "collaborationBranch": "string",
      "hostName": "string",
      "lastCommitId": "string",
      "projectName": "string",
      "repositoryName": "string",
      "rootFolder": "string",
      "tenantId": "string",
      "type": "string"
    }
  }
}

Egenskapsvärden

arbetsytor

Name Beskrivning Värde
typ Resurstypen "Microsoft.Synapse/workspaces"
apiVersion Resurs-API-versionen '2020-12-01'
name Resursnamnet sträng (krävs)

Teckengräns: 1–50

Giltiga tecken:
Gemener, bindestreck och siffror.

Börja och sluta med bokstav eller nummer.

Det går inte att innehålla -ondemand

Resursnamnet måste vara unikt i Hela Azure.
location Den geo-plats där resursen finns sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden. Se Taggar i mallar
identity Arbetsytans identitet ManagedIdentity
properties Egenskaper för arbetsytans resurs Egenskaper för arbetsyta

ManagedIdentity

Name Beskrivning Värde
typ Typ av hanterad identitet för arbetsytan "Ingen"
"SystemAssigned"

Egenskaper för arbetsyta

Name Beskrivning Värde
connectivityEndpoints Anslutningsslutpunkter objekt
defaultDataLakeStorage Information om arbetsytans standardkonto för Data Lake Storage DataLakeStorageAccountDetails
kryptering Krypteringsinformationen för arbetsytan EncryptionDetails
managedResourceGroupName Arbetsytans hanterade resursgrupp. Resursgruppens namn identifierar resursgruppen unikt i användarens subscriptionId. Resursgruppens namn får inte vara längre än 90 tecken långt och måste vara alfanumeriska tecken (Char.IsLetterOrDigit()) och "-", "_", "(", ")" och". Observera att namnet inte kan sluta med ".". sträng
managedVirtualNetwork Om du anger "standard" ser du till att all beräkning för den här arbetsytan finns i ett virtuellt nätverk som hanteras för användarens räkning. sträng
managedVirtualNetworkSettings Inställningar för hanterad Virtual Network ManagedVirtualNetworkSettings
privateEndpointConnections Privata slutpunktsanslutningar till arbetsytan PrivateEndpointConnection[]
purviewConfiguration Purview-konfiguration PurviewConfiguration
sqlAdministratorLogin Logga in för sql active directory-administratör för arbetsytan sträng
sqlAdministratorLoginPassword Inloggningslösenord för SQL-administratör sträng
virtualNetworkProfile Virtual Network profil VirtualNetworkProfile
workspaceRepositoryConfiguration Inställningar för Git-integrering WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Name Beskrivning Värde
accountUrl Konto-URL sträng
Filesystem Filsystemnamn sträng

EncryptionDetails

Name Beskrivning Värde
Cmk Information om kundhanterad nyckel CustomerManagedKeyDetails

CustomerManagedKeyDetails

Name Beskrivning Värde
nyckel Arbetsytans nyckelobjekt WorkspaceKeyDetails

WorkspaceKeyDetails

Name Beskrivning Värde
keyVaultUrl Url för nyckel för underresursnyckel för arbetsyta sträng
name Namn på underresurs för arbetsytenyckel sträng

ManagedVirtualNetworkSettings

Name Beskrivning Värde
allowedAadTenantIdsForLinking Tillåtna Aad-klientorganisations-ID:t för länkning string[]
linkedAccessCheckOnTargetResource Länkad åtkomstkontroll på målresurs boolesk
preventDataExfiltration Förhindra dataexfiltrering boolesk

PrivateEndpointConnection

Name Beskrivning Värde
properties Anslutningsegenskaper för privat slutpunkt. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Beskrivning Värde
privateEndpoint Den privata slutpunkt som anslutningen tillhör. PrivateEndpoint
privateLinkServiceConnectionState Anslutningstillstånd för den privata slutpunktsanslutningen. PrivateLinkServiceConnectionState

PrivateEndpoint

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

PrivateLinkServiceConnectionState

Name Beskrivning Värde
beskrivning Beskrivning av tjänstanslutningen för privat länk. sträng
status Anslutningsstatus för tjänsten Private Link. sträng

PurviewConfiguration

Name Beskrivning Värde
purviewResourceId Purview-resurs-ID sträng

VirtualNetworkProfile

Name Beskrivning Värde
computeSubnetId Undernäts-ID som används för beräkningar på arbetsytan sträng

WorkspaceRepositoryConfiguration

Name Beskrivning Värde
accountName Kontonamn sträng
collaborationBranch Samarbetsgren sträng
Värdnamn GitHub Enterprise-värdnamn. Exempelvis: https://github.mydomain.com sträng
lastCommitId Senaste inchecknings-ID sträng
projektnamn VSTS-projektnamn sträng
repositoryName Namn på lagringsplats sträng
rootFolder Rotmapp som ska användas på lagringsplatsen sträng
tenantId VSTS-klientorganisations-ID:t sträng
typ Typ av konfiguration av lagringsplats-ID för arbetsytan. Exempel på WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Azure Synapse Proof-of-Concept

Distribuera till Azure		 Den här mallen skapar en konceptbevismiljö för Azure Synapse, inklusive SQL-pooler och valfria Apache Spark-pooler

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen arbetsytor kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Synapse/workspaces-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces@2020-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      connectivityEndpoints = {}
      defaultDataLakeStorage = {
        accountUrl = "string"
        filesystem = "string"
      }
      encryption = {
        cmk = {
          key = {
            keyVaultUrl = "string"
            name = "string"
          }
        }
      }
      managedResourceGroupName = "string"
      managedVirtualNetwork = "string"
      managedVirtualNetworkSettings = {
        allowedAadTenantIdsForLinking = [
          "string"
        ]
        linkedAccessCheckOnTargetResource = bool
        preventDataExfiltration = bool
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              description = "string"
              status = "string"
            }
          }
        }
      ]
      purviewConfiguration = {
        purviewResourceId = "string"
      }
      sqlAdministratorLogin = "string"
      sqlAdministratorLoginPassword = "string"
      virtualNetworkProfile = {
        computeSubnetId = "string"
      }
      workspaceRepositoryConfiguration = {
        accountName = "string"
        collaborationBranch = "string"
        hostName = "string"
        lastCommitId = "string"
        projectName = "string"
        repositoryName = "string"
        rootFolder = "string"
        tenantId = "string"
        type = "string"
      }
    }
  })
}

Egenskapsvärden

arbetsytor

Name Beskrivning Värde
typ Resurstypen "Microsoft.Synapse/workspaces@2020-12-01"
name Resursnamnet sträng (krävs)

Teckengräns: 1–50

Giltiga tecken:
Gemener, bindestreck och siffror.

Börja och sluta med bokstav eller nummer.

Det går inte att innehålla -ondemand

Resursnamnet måste vara unikt i Hela Azure.
location Den geo-plats där resursen finns sträng (krävs)
parent_id Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden.
identity Arbetsytans identitet ManagedIdentity
properties Resursegenskaper för arbetsyta WorkspaceEgenskaper

ManagedIdentity

Name Beskrivning Värde
typ Typen av hanterad identitet för arbetsytan "SystemTilldelade"

WorkspaceEgenskaper

Name Beskrivning Värde
connectivityEndpoints Anslutningsslutpunkter objekt
defaultDataLakeStorage Standardinformation för data lake storage-konto för arbetsyta DataLakeStorageAccountDetails
kryptering Krypteringsinformationen för arbetsytan EncryptionDetails
managedResourceGroupName Arbetsytans hanterade resursgrupp. Resursgruppens namn identifierar resursgruppen unikt i användarprenumerations-ID:et. Resursgruppens namn får inte vara längre än 90 tecken långt och måste vara alfanumeriska tecken (Char.IsLetterOrDigit()) och "-", '_', '(', ')' och'.'. Observera att namnet inte kan sluta med .' sträng
managedVirtualNetwork Om du ställer in detta på "standard" ser du till att all beräkning för den här arbetsytan finns i ett virtuellt nätverk som hanteras för användarens räkning. sträng
managedVirtualNetworkSettings Inställningar för hanterade Virtual Network ManagedVirtualNetworkSettings
privateEndpointConnections Privata slutpunktsanslutningar till arbetsytan PrivateEndpointConnection[]
purviewConfiguration Purview-konfiguration PurviewConfiguration
sqlAdministratorLogin Logga in för sql active directory-administratör för arbetsytan sträng
sqlAdministratorLoginPassword Inloggningslösenord för SQL-administratör sträng
virtualNetworkProfile Virtual Network profil VirtualNetworkProfile
workspaceRepositoryConfiguration Git-integreringsinställningar WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Name Beskrivning Värde
accountUrl Konto-URL sträng
Filesystem Filsystemnamn sträng

EncryptionDetails

Name Beskrivning Värde
Cmk Kundhanterad nyckelinformation CustomerManagedKeyDetails

CustomerManagedKeyDetails

Name Beskrivning Värde
nyckel Arbetsytans nyckelobjekt WorkspaceKeyDetails

WorkspaceKeyDetails

Name Beskrivning Värde
keyVaultUrl Url för nyckel för arbetsytans nyckel underresurs sträng
name Underresursnamn för arbetsytans nyckel sträng

ManagedVirtualNetworkSettings

Name Beskrivning Värde
allowedAadTenantIdsForLinking Tillåtna Aad-klient-ID:t för länkning string[]
linkedAccessCheckOnTargetResource Länkad åtkomstkontroll på målresurs boolesk
preventDataExfiltration Förhindra dataexfiltrering boolesk

PrivateEndpointConnection

Name Beskrivning Värde
properties Anslutningsegenskaper för privat slutpunkt. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Beskrivning Värde
privateEndpoint Den privata slutpunkt som anslutningen tillhör. PrivateEndpoint
privateLinkServiceConnectionState Anslutningstillstånd för den privata slutpunktsanslutningen. PrivateLinkServiceConnectionState

PrivateEndpoint

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

PrivateLinkServiceConnectionState

Name Beskrivning Värde
beskrivning Beskrivning av tjänstanslutningen för privat länk. sträng
status Anslutningsstatus för tjänsten private link. sträng

PurviewConfiguration

Name Beskrivning Värde
purviewResourceId Purview-resurs-ID sträng

VirtualNetworkProfile

Name Beskrivning Värde
computeSubnetId Undernäts-ID som används för beräkningar på arbetsytan sträng

WorkspaceRepositoryConfiguration

Name Beskrivning Värde
accountName Kontonamn sträng
collaborationBranch Samarbetsgren sträng
Värdnamn GitHub Enterprise-värdnamn. Exempelvis: https://github.mydomain.com sträng
lastCommitId Senaste inchecknings-ID sträng
projektnamn VSTS-projektnamn sträng
repositoryName Namn på lagringsplats sträng
rootFolder Rotmapp som ska användas på lagringsplatsen sträng
tenantId VSTS-klientorganisations-ID:t sträng
typ Typ av konfiguration av lagringsplats-ID för arbetsytan. Exempel på WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration sträng