Share via


Microsoft.Synapse-werkruimten 01-03-2021

Bicep-resourcedefinitie

Het resourcetype werkruimten kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Synapse/workspaces-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.Synapse/workspaces@2021-03-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'
          }
        }
      }
    ]
    publicNetworkAccess: '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'
    }
  }
}

Eigenschapswaarden

workspaces

Naam Description Waarde
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-50

Geldige tekens:
Kleine letters, afbreekstreepjes en cijfers.

Begin en eindig met letter of cijfer.

Kan niet bevatten -ondemand

De resourcenaam moet uniek zijn in Azure.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
identity Identiteit van de werkruimte ManagedIdentity
properties Eigenschappen van werkruimteresources WerkruimteEigenschappen

ManagedIdentity

Naam Beschrijving Waarde
type Het type beheerde identiteit voor de werkruimte 'Geen'
'SystemAssigned'

WerkruimteEigenschappen

Naam Description Waarde
connectivityEndpoints Connectiviteitseindpunten object
defaultDataLakeStorage Details van standaard data lake storage-account voor werkruimte DataLakeStorageAccountDetails
versleuteling De versleutelingsdetails van de werkruimte EncryptionDetails
managedResourceGroupName Door werkruimte beheerde resourcegroep. De naam van de resourcegroep identificeert de resourcegroep in de subscriptionId van de gebruiker. De naam van de resourcegroep mag niet langer zijn dan 90 tekens en moet alfanumerieke tekens zijn (Char.IsLetterOrDigit()) en '-', '_', '(', ')' en '.'. Houd er rekening mee dat de naam niet mag eindigen op '.' tekenreeks
managedVirtualNetwork Als u dit instelt op 'standaard', zorgt u ervoor dat alle berekeningen voor deze werkruimte zich in een virtueel netwerk bevinden dat namens de gebruiker wordt beheerd. tekenreeks
managedVirtualNetworkSettings Instellingen voor beheerde Virtual Network ManagedVirtualNetworkSettings
privateEndpointConnections Privé-eindpuntverbindingen met de werkruimte PrivateEndpointConnection[]
publicNetworkAccess Openbare netwerktoegang tot werkruimte in- of uitschakelen 'Uitgeschakeld'
Ingeschakeld
purviewConfiguration Purview-configuratie PurviewConfiguration
sqlAdministratorLogin Aanmelden voor sql Active Directory-beheerder van werkruimte tekenreeks
sqlAdministratorLoginPassword Aanmeldingswachtwoord voor SQL-beheerder tekenreeks
virtualNetworkProfile Virtual Network profiel VirtualNetworkProfile
workspaceRepositoryConfiguration Instellingen voor Git-integratie WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Naam Description Waarde
accountUrl Account-URL tekenreeks
bestandssysteem Bestandssysteemnaam tekenreeks

EncryptionDetails

Naam Description Waarde
Cmk Details van door de klant beheerde sleutel CustomerManagedKeyDetails

CustomerManagedKeyDetails

Naam Description Waarde
sleutel Het belangrijkste object van de werkruimte WorkspaceKeyDetails

WorkspaceKeyDetails

Naam Description Waarde
keyVaultUrl Url van de sleutelkluis voor subresource van werkruimtesleutel tekenreeks
naam Naam van subresource van werkruimtesleutel tekenreeks

ManagedVirtualNetworkSettings

Naam Description Waarde
allowedAadTenantIdsForLinking Toegestane Aad-tenant-id's voor koppelen tekenreeks[]
linkedAccessCheckOnTargetResource Controle van gekoppelde toegang op doelresource booleaans
preventDataExfiltration Gegevensexfiltratie voorkomen booleaans

PrivateEndpointConnection

Naam Description Waarde
properties Eigenschappen van privé-eindpuntverbinding. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Naam Description Waarde
privateEndpoint Het privé-eindpunt waartoe de verbinding behoort. PrivateEndpoint
privateLinkServiceConnectionState Verbindingsstatus van de privé-eindpuntverbinding. PrivateLinkServiceConnectionState

PrivateEndpoint

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.

PrivateLinkServiceConnectionState

Naam Description Waarde
beschrijving De beschrijving van de private link-serviceverbinding. tekenreeks
status De verbindingsstatus van de Private Link-service. tekenreeks

PurviewConfiguration

Naam Description Waarde
purviewResourceId Purview-resource-id tekenreeks

VirtualNetworkProfile

Naam Description Waarde
computeSubnetId Subnet-id die wordt gebruikt voor berekeningen in de werkruimte tekenreeks

WorkspaceRepositoryConfiguration

Naam Description Waarde
accountName Accountnaam tekenreeks
collaborationBranch Samenwerkingsbranch tekenreeks
Hostname GitHub Enterprise-hostnaam. Bijvoorbeeld: https://github.mydomain.com tekenreeks
lastCommitId De id van de laatste doorvoering tekenreeks
projectNaam NAAM VSTS-project tekenreeks
repositoryName Naam van opslagplaats tekenreeks
rootFolder Hoofdmap voor gebruik in de opslagplaats tekenreeks
tenantId De VSTS-tenant-id tekenreeks
type Type configuratie van opslagplaats-id van werkruimte. Voorbeeld van WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration tekenreeks

Snelstartsjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Azure Synapse proof-of-concept

Implementeren op Azure
Met deze sjabloon maakt u een proof-of-conceptomgeving voor Azure Synapse, waaronder SQL-pools en optionele Apache Spark-pools

Resourcedefinitie van ARM-sjabloon

Het resourcetype werkruimten kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.Synapse/workspaces wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.Synapse/workspaces",
  "apiVersion": "2021-03-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"
          }
        }
      }
    ],
    "publicNetworkAccess": "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"
    }
  }
}

Eigenschapswaarden

workspaces

Naam Description Waarde
type Het resourcetype 'Microsoft.Synapse/workspaces'
apiVersion De resource-API-versie '2021-03-01'
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-50

Geldige tekens:
Kleine letters, afbreekstreepjes en cijfers.

Begin en eindig met een letter of cijfer.

Kan niet bevatten -ondemand

De resourcenaam moet uniek zijn in Azure.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
identity Identiteit van de werkruimte ManagedIdentity
properties Eigenschappen van werkruimteresources WerkruimteEigenschappen

ManagedIdentity

Naam Description Waarde
type Het type beheerde identiteit voor de werkruimte 'Geen'
'SystemAssigned'

WerkruimteEigenschappen

Naam Beschrijving Waarde
connectivityEndpoints Connectiviteitseindpunten object
defaultDataLakeStorage Standaardgegevens van data lake-opslagaccounts voor werkruimten DataLakeStorageAccountDetails
versleuteling De versleutelingsdetails van de werkruimte EncryptionDetails
managedResourceGroupName Door werkruimte beheerde resourcegroep. De naam van de resourcegroep identificeert de resourcegroep in de abonnements-id van de gebruiker. De naam van de resourcegroep mag niet langer zijn dan 90 tekens en moet alfanumerieke tekens (Char.IsLetterOrDigit()) en '-', '_', '(', ')' en '.' bestaan. Houd er rekening mee dat de naam niet mag eindigen op '.' tekenreeks
managedVirtualNetwork Als u dit instelt op 'standaard', zorgt u ervoor dat alle rekenkracht voor deze werkruimte zich in een virtueel netwerk bevindt dat namens de gebruiker wordt beheerd. tekenreeks
managedVirtualNetworkSettings Instellingen voor beheerde Virtual Network ManagedVirtualNetworkSettings
privateEndpointConnections Privé-eindpuntverbindingen met de werkruimte PrivateEndpointConnection[]
publicNetworkAccess Openbare netwerktoegang tot werkruimte in- of uitschakelen 'Uitgeschakeld'
Ingeschakeld
purviewConfiguration Purview-configuratie PurviewConfiguration
sqlAdministratorLogin Aanmelden voor sql Active Directory-beheerder van werkruimte tekenreeks
sqlAdministratorLoginPassword Aanmeldingswachtwoord voor SQL-beheerder tekenreeks
virtualNetworkProfile Virtual Network profiel VirtualNetworkProfile
workspaceRepositoryConfiguration Git-integratie-instellingen WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Naam Description Waarde
accountUrl Account-URL tekenreeks
bestandssysteem Bestandssysteemnaam tekenreeks

EncryptionDetails

Naam Description Waarde
Cmk Details van door de klant beheerde sleutel CustomerManagedKeyDetails

CustomerManagedKeyDetails

Naam Description Waarde
sleutel Het belangrijkste object van de werkruimte WorkspaceKeyDetails

WorkspaceKeyDetails

Naam Description Waarde
keyVaultUrl Url van de sleutelkluis voor subresource van werkruimtesleutel tekenreeks
naam Naam van subresource van werkruimtesleutel tekenreeks

ManagedVirtualNetworkSettings

Naam Description Waarde
allowedAadTenantIdsForLinking Toegestane Aad-tenant-id's voor koppelen tekenreeks[]
linkedAccessCheckOnTargetResource Controle van gekoppelde toegang op doelresource booleaans
preventDataExfiltration Gegevensexfiltratie voorkomen booleaans

PrivateEndpointConnection

Naam Description Waarde
properties Eigenschappen van privé-eindpuntverbinding. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Naam Description Waarde
privateEndpoint Het privé-eindpunt waartoe de verbinding behoort. PrivateEndpoint
privateLinkServiceConnectionState Verbindingsstatus van de privé-eindpuntverbinding. PrivateLinkServiceConnectionState

PrivateEndpoint

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.

PrivateLinkServiceConnectionState

Naam Description Waarde
beschrijving De beschrijving van de private link-serviceverbinding. tekenreeks
status De verbindingsstatus van de Private Link-service. tekenreeks

PurviewConfiguration

Naam Beschrijving Waarde
purviewResourceId Purview-resource-id tekenreeks

VirtualNetworkProfile

Naam Description Waarde
computeSubnetId Subnet-id die wordt gebruikt voor berekeningen in de werkruimte tekenreeks

WorkspaceRepositoryConfiguration

Naam Description Waarde
accountName Accountnaam tekenreeks
collaborationBranch Samenwerkingsbranch tekenreeks
Hostname GitHub Enterprise-hostnaam. Bijvoorbeeld: https://github.mydomain.com tekenreeks
lastCommitId De id van de laatste doorvoering tekenreeks
projectNaam VSTS-projectnaam tekenreeks
repositoryName Naam van opslagplaats tekenreeks
rootFolder Hoofdmap voor gebruik in de opslagplaats tekenreeks
tenantId De VSTS-tenant-id tekenreeks
type Type configuratie van opslagplaats-id van werkruimte. Voorbeeld van WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration tekenreeks

Snelstartsjablonen

Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Azure Synapse proof-of-concept

Implementeren op Azure
Met deze sjabloon maakt u een proof-of-conceptomgeving voor Azure Synapse, waaronder SQL-pools en optionele Apache Spark-pools

Terraform-resourcedefinitie (AzAPI-provider)

Het resourcetype werkruimten kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Synapse/workspaces-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces@2021-03-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"
            }
          }
        }
      ]
      publicNetworkAccess = "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"
      }
    }
  })
}

Eigenschapswaarden

workspaces

Naam Description Waarde
type Het resourcetype "Microsoft.Synapse/workspaces@2021-03-01"
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-50

Geldige tekens:
Kleine letters, afbreekstreepjes en cijfers.

Begin en eindig met letter of cijfer.

Kan niet bevatten -ondemand

De resourcenaam moet uniek zijn in Azure.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
parent_id Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden.
identity Identiteit van de werkruimte ManagedIdentity
properties Eigenschappen van werkruimteresources WerkruimteEigenschappen

ManagedIdentity

Naam Description Waarde
type Het type beheerde identiteit voor de werkruimte "SystemAssigned"

WerkruimteEigenschappen

Naam Description Waarde
connectivityEndpoints Connectiviteitseindpunten object
defaultDataLakeStorage Details van standaard data lake storage-account voor werkruimte DataLakeStorageAccountDetails
versleuteling De versleutelingsdetails van de werkruimte EncryptionDetails
managedResourceGroupName Door werkruimte beheerde resourcegroep. De naam van de resourcegroep identificeert de resourcegroep in de subscriptionId van de gebruiker. De naam van de resourcegroep mag niet langer zijn dan 90 tekens en moet alfanumerieke tekens zijn (Char.IsLetterOrDigit()) en '-', '_', '(', ')' en '.'. Houd er rekening mee dat de naam niet mag eindigen op '.' tekenreeks
managedVirtualNetwork Als u dit instelt op 'standaard', zorgt u ervoor dat alle berekeningen voor deze werkruimte zich in een virtueel netwerk bevinden dat namens de gebruiker wordt beheerd. tekenreeks
managedVirtualNetworkSettings Instellingen voor beheerde Virtual Network ManagedVirtualNetworkSettings
privateEndpointConnections Privé-eindpuntverbindingen met de werkruimte PrivateEndpointConnection[]
publicNetworkAccess Openbare netwerktoegang tot werkruimte in- of uitschakelen "Uitgeschakeld"
"Ingeschakeld"
purviewConfiguration Purview-configuratie PurviewConfiguration
sqlAdministratorLogin Aanmelden voor sql Active Directory-beheerder van werkruimte tekenreeks
sqlAdministratorLoginPassword Aanmeldingswachtwoord voor SQL-beheerder tekenreeks
virtualNetworkProfile Virtual Network profiel VirtualNetworkProfile
workspaceRepositoryConfiguration Instellingen voor Git-integratie WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Naam Description Waarde
accountUrl Account-URL tekenreeks
bestandssysteem Bestandssysteemnaam tekenreeks

EncryptionDetails

Naam Description Waarde
Cmk Door de klant beheerde sleuteldetails CustomerManagedKeyDetails

CustomerManagedKeyDetails

Naam Description Waarde
sleutel Het belangrijkste object van de werkruimte WorkspaceKeyDetails

WorkspaceKeyDetails

Naam Description Waarde
keyVaultUrl Url van sleutelkluis voor subresource van werkruimtesleutel tekenreeks
naam Naam van subresource van werkruimtesleutel tekenreeks

ManagedVirtualNetworkSettings

Naam Description Waarde
allowedAadTenantIdsForLinking Toegestane Aad-tenant-id's voor koppelen tekenreeks[]
linkedAccessCheckOnTargetResource Controle van gekoppelde toegang op doelresource booleaans
preventDataExfiltration Gegevensexfiltratie voorkomen booleaans

PrivateEndpointConnection

Naam Description Waarde
properties Eigenschappen van privé-eindpuntverbinding. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Naam Beschrijving Waarde
privateEndpoint Het privé-eindpunt waartoe de verbinding behoort. PrivateEndpoint
privateLinkServiceConnectionState Verbindingsstatus van de privé-eindpuntverbinding. PrivateLinkServiceConnectionState

PrivateEndpoint

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.

PrivateLinkServiceConnectionState

Naam Description Waarde
beschrijving De beschrijving van de private link-serviceverbinding. tekenreeks
status De verbindingsstatus van de Private Link-service. tekenreeks

PurviewConfiguration

Naam Beschrijving Waarde
purviewResourceId Purview-resource-id tekenreeks

VirtualNetworkProfile

Naam Beschrijving Waarde
computeSubnetId Subnet-id die wordt gebruikt voor berekeningen in de werkruimte tekenreeks

WorkspaceRepositoryConfiguration

Naam Beschrijving Waarde
accountName Accountnaam tekenreeks
collaborationBranch Samenwerkingsbranch tekenreeks
Hostname GitHub Enterprise-hostnaam. Bijvoorbeeld: https://github.mydomain.com tekenreeks
lastCommitId De id van de laatste doorvoering tekenreeks
projectNaam VSTS-projectnaam tekenreeks
repositoryName Naam van opslagplaats tekenreeks
rootFolder Hoofdmap voor gebruik in de opslagplaats tekenreeks
tenantId De VSTS-tenant-id tekenreeks
type Type configuratie van opslagplaats-id van werkruimte. Voorbeeld van WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration tekenreeks