Condividi tramite

Aree di lavoro Microsoft.Synapse 2021-04-01-preview

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa delle aree di lavoro può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.Synapse/workspaces, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.Synapse/workspaces@2021-04-01-preview' = {
  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'
    }
  }
}

Valori delle proprietà

aree di lavoro

Nome Descrizione valore
name Nome della risorsa stringa (obbligatorio)

Limite di caratteri: 1-50

Caratteri validi:
Lettere minuscole, trattini e numeri.

Deve iniziare e terminare con una lettera o un numero.

Non può contenere -ondemand

Il nome della risorsa deve essere univoco in Azure.
posizione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
tags Tag delle risorse. Dizionario di nomi e valori di tag. Vedere Tag nei modelli
identity Identità dell'area di lavoro ManagedIdentity
properties Proprietà delle risorse dell'area di lavoro WorkspaceProperties

ManagedIdentity

Nome Descrizione Valore
tipo Tipo di identità gestita per l'area di lavoro 'Nessuno'
'SystemAssigned'

WorkspaceProperties

Nome Descrizione Valore
connectivityEndpoints Endpoint di connettività object
defaultDataLakeStorage Dettagli dell'account di archiviazione data lake predefinito dell'area di lavoro DataLakeStorageAccountDetails
Crittografia Dettagli della crittografia dell'area di lavoro EncryptionDetails
managedResourceGroupName Gruppo di risorse gestite dell'area di lavoro. Il nome del gruppo di risorse identifica in modo univoco il gruppo di risorse all'interno dell'id sottoscrizione utente. Il nome del gruppo di risorse non deve superare i 90 caratteri e deve contenere caratteri alfanumerici (Char.IsLetterOrDigit()) e '-', '_', '(', ')' e'.'. Si noti che il nome non può terminare con '.' string
managedVirtualNetwork L'impostazione di questa opzione su "default" garantisce che tutte le risorse di calcolo per questa area di lavoro si trovano in una rete virtuale gestita per conto dell'utente. string
managedVirtualNetworkSettings Impostazioni di Rete virtuale gestite ManagedVirtualNetworkSettings
privateEndpointConnections Connessioni endpoint privato all'area di lavoro PrivateEndpointConnection[]
publicNetworkAccess Abilitare o disabilitare l'accesso alla rete pubblica all'area di lavoro 'Disabilitato'
'Enabled'
purviewConfiguration Configurazione di Purview PurviewConfiguration
sqlAdministratorLogin Account di accesso per l'amministratore di ACTIVE Directory SQL dell'area di lavoro string
sqlAdministratorLoginPassword Password di accesso amministratore SQL string
virtualNetworkProfile profilo Rete virtuale VirtualNetworkProfile
workspaceRepositoryConfiguration Impostazioni di integrazione Git WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Nome Descrizione Valore
accountUrl URL dell'account string
file system Nome filesystem string

EncryptionDetails

Nome Descrizione Valore
cmk Dettagli chiave gestita dal cliente CustomerManagedKeyDetails

CustomerManagedKeyDetails

Nome Descrizione Valore
chiave Oggetto chiave dell'area di lavoro WorkspaceKeyDetails

WorkspaceKeyDetails

Nome Descrizione Valore
keyVaultUrl URL dell'insieme di credenziali delle chiavi della chiave secondaria dell'area di lavoro string
name Nome della risorsa secondaria della chiave dell'area di lavoro string

ManagedVirtualNetworkSettings

Nome Descrizione Valore
allowedAadTenantIdsForLinking ID tenant Aad consentiti per il collegamento string[]
linkedAccessCheckOnTargetResource Controllo accesso collegato nella risorsa di destinazione bool
preventDataExfiltration Impedire l'esfiltrazione dei dati bool

PrivateEndpointConnection

Nome Descrizione Valore
properties Proprietà di connessione dell'endpoint privato. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nome Descrizione Valore
privateEndpoint Endpoint privato a cui appartiene la connessione. PrivateEndpoint
privateLinkServiceConnectionState Stato della connessione dell'endpoint privato. PrivateLinkServiceConnectionState

PrivateEndpoint

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrizione Valore
description Descrizione della connessione al servizio collegamento privato. string
status Stato di connessione del servizio di collegamento privato. string

PurviewConfiguration

Nome Descrizione Valore
purviewResourceId ID risorsa Purview string

VirtualNetworkProfile

Nome Descrizione Valore
computeSubnetId ID subnet usato per i calcoli nell'area di lavoro string

WorkspaceRepositoryConfiguration

Nome Descrizione Valore
accountName Nome account string
collaborationBranch Ramo di collaborazione string
hostName Nome host GitHub Enterprise. ad esempio https://github.mydomain.com string
lastCommitId Ultimo ID commit string
projectName Nome del progetto VSTS string
repositoryName Nome del repository string
rootFolder Cartella radice da usare nel repository string
TenantId The VSTS tenant ID string
type Tipo di configurazione repositoryID dell'area di lavoro. Esempio di WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration string

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
Azure Synapse proof-of-concept

Distribuisci in Azure 		Questo modello crea un ambiente di prova del concetto per Azure Synapse, inclusi pool SQL e pool apache Spark facoltativi

Definizione della risorsa modello di Resource Manager

Il tipo di risorsa delle aree di lavoro può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.Synapse/workspaces, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.Synapse/workspaces",
  "apiVersion": "2021-04-01-preview",
  "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"
    }
  }
}

Valori delle proprietà

aree di lavoro

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.Synapse/workspaces'
apiVersion Versione dell'API risorsa '2021-04-01-preview'
name Nome della risorsa stringa (obbligatoria)

Limite di caratteri: 1-50

Caratteri validi:
Lettere minuscole, trattini e numeri.

Deve iniziare e terminare con una lettera o un numero.

Non può contenere -ondemand

Il nome della risorsa deve essere univoco in Azure.
posizione Posizione geografica in cui vive la risorsa stringa (obbligatoria)
tags Tag di risorse. Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli
identity Identità dell'area di lavoro ManagedIdentity
properties Proprietà delle risorse dell'area di lavoro Proprietà dell'area di lavoro

ManagedIdentity

Nome Descrizione Valore
tipo Tipo di identità gestita per l'area di lavoro 'Nessuno'
'SystemAssigned'

Proprietà dell'area di lavoro

Nome Descrizione Valore
connectivityEndpoints Endpoint di connettività object
defaultDataLakeStorage Dettagli dell'account di archiviazione data lake predefinito dell'area di lavoro DataLakeStorageAccountDetails
Crittografia Dettagli della crittografia dell'area di lavoro EncryptionDetails
managedResourceGroupName Gruppo di risorse gestite dall'area di lavoro. Il nome del gruppo di risorse identifica in modo univoco il gruppo di risorse all'interno dell'id sottoscrizione utente. Il nome del gruppo di risorse non deve essere più di 90 caratteri lunghi e deve essere caratteri alfanumerici (Char.IsLetterOrDigit()) e '-', '_', '(', '', ')' e'.'. Si noti che il nome non può terminare con '.' string
managedVirtualNetwork L'impostazione di questa opzione su "impostazione predefinita" garantisce che tutto il calcolo per questa area di lavoro si trova in una rete virtuale gestita per conto dell'utente. string
managedVirtualNetworkSettings Impostazioni di Rete virtuale gestite ManagedVirtualNetworkSettings
privateEndpointConnections Connessioni endpoint privato all'area di lavoro PrivateEndpointConnection[]
publicNetworkAccess Abilitare o disabilitare l'accesso alla rete pubblica all'area di lavoro 'Disabilitato'
'Enabled'
purviewConfiguration Configurazione di Purview PurviewConfiguration
sqlAdministratorLogin Account di accesso per l'amministratore di ACTIVE Directory SQL dell'area di lavoro string
sqlAdministratorLoginPassword Password di accesso amministratore SQL string
virtualNetworkProfile profilo Rete virtuale VirtualNetworkProfile
workspaceRepositoryConfiguration Impostazioni di integrazione Git WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Nome Descrizione Valore
accountUrl URL dell'account string
file system Nome file system string

EncryptionDetails

Nome Descrizione Valore
cmk Dettagli chiave gestita dal cliente CustomerManagedKeyDetails

CustomerManagedKeyDetails

Nome Descrizione Valore
chiave Oggetto chiave dell'area di lavoro WorkspaceKeyDetails

WorkspaceKeyDetails

Nome Descrizione Valore
keyVaultUrl URL dell'insieme di credenziali delle chiavi della chiave dell'area di lavoro string
name Nome della sotto-risorsa chiave dell'area di lavoro string

ManagedVirtualNetworkSettings

Nome Descrizione Valore
allowedAadTenantIdsForLinking ID tenant Aad consentiti per il collegamento string[]
linkedAccessCheckOnTargetResource Controllo di accesso collegato nella risorsa di destinazione bool
preventDataExfiltration Impedire l'esfiltrazione dei dati bool

PrivateEndpointConnection

Nome Descrizione Valore
properties Proprietà di connessione dell'endpoint privato. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nome Descrizione Valore
privateEndpoint Endpoint privato a cui appartiene la connessione. PrivateEndpoint
privateLinkServiceConnectionState Stato di connessione della connessione dell'endpoint privato. PrivateLinkServiceConnectionState

PrivateEndpoint

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrizione Valore
description Descrizione della connessione al servizio di collegamento privato. string
status Stato della connessione al servizio di collegamento privato. string

PurviewConfiguration

Nome Descrizione Valore
purviewResourceId ID risorsa Purview string

VirtualNetworkProfile

Nome Descrizione Valore
computeSubnetId ID subnet usato per le risorse di calcolo nell'area di lavoro string

WorkspaceRepositoryConfiguration

Nome Descrizione Valore
accountName Nome account string
collaborationBranch Ramo di collaborazione string
hostName Nome host GitHub Enterprise. ad esempio https://github.mydomain.com string
lastCommitId Ultimo ID commit string
projectName Nome del progetto VSTS string
repositoryName Nome del repository string
rootFolder Cartella radice da usare nel repository string
TenantId The VSTS tenant ID string
type Tipo di configurazione repositoryID dell'area di lavoro. Esempio di WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration string

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
Azure Synapse modello di verifica

Distribuisci in Azure 		Questo modello crea un ambiente di verifica per Azure Synapse, inclusi pool SQL e pool Apache Spark facoltativi

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa delle aree di lavoro può essere distribuito con operazioni destinate a:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.Synapse/workspaces, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

aree di lavoro

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.Synapse/workspaces@2021-04-01-preview"
name Nome della risorsa stringa (obbligatorio)

Limite di caratteri: 1-50

Caratteri validi:
Lettere minuscole, trattini e numeri.

Deve iniziare e terminare con una lettera o un numero.

Non può contenere -ondemand

Il nome della risorsa deve essere univoco in Azure.
posizione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
parent_id Per eseguire la distribuzione in un gruppo di risorse, usare l'ID del gruppo di risorse. stringa (obbligatorio)
tags Tag delle risorse. Dizionario di nomi e valori di tag.
identity Identità dell'area di lavoro ManagedIdentity
properties Proprietà delle risorse dell'area di lavoro WorkspaceProperties

ManagedIdentity

Nome Descrizione Valore
tipo Tipo di identità gestita per l'area di lavoro "SystemAssigned"

Proprietà dell'area di lavoro

Nome Descrizione Valore
connectivityEndpoints Endpoint di connettività object
defaultDataLakeStorage Dettagli dell'account di archiviazione data lake predefinito dell'area di lavoro DataLakeStorageAccountDetails
Crittografia Dettagli della crittografia dell'area di lavoro EncryptionDetails
managedResourceGroupName Gruppo di risorse gestite dall'area di lavoro. Il nome del gruppo di risorse identifica in modo univoco il gruppo di risorse all'interno dell'id sottoscrizione utente. Il nome del gruppo di risorse non deve essere più di 90 caratteri lunghi e deve essere caratteri alfanumerici (Char.IsLetterOrDigit()) e '-', '_', '(', '', ')' e'.'. Si noti che il nome non può terminare con '.' string
managedVirtualNetwork L'impostazione di questa opzione su "impostazione predefinita" garantisce che tutto il calcolo per questa area di lavoro si trova in una rete virtuale gestita per conto dell'utente. string
managedVirtualNetworkSettings Impostazioni di Rete virtuale gestite ManagedVirtualNetworkSettings
privateEndpointConnections Connessioni endpoint private all'area di lavoro PrivateEndpointConnection[]
publicNetworkAccess Abilitare o disabilitare l'accesso di rete pubblica all'area di lavoro "Disabilitato"
"Abilitato"
purviewConfiguration Configurazione di Purview PurviewConfiguration
sqlAdministratorLogin Account di accesso per l'amministratore di SQL active directory dell'area di lavoro string
sqlAdministratorLoginPassword Password di accesso dell'amministratore SQL string
virtualNetworkProfile profilo Rete virtuale VirtualNetworkProfile
workspaceRepositoryConfiguration Impostazioni di integrazione Git WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Nome Descrizione Valore
accountUrl URL dell'account string
file system Nome filesystem string

EncryptionDetails

Nome Descrizione Valore
cmk Dettagli chiave gestita dal cliente CustomerManagedKeyDetails

CustomerManagedKeyDetails

Nome Descrizione Valore
chiave Oggetto chiave dell'area di lavoro WorkspaceKeyDetails

WorkspaceKeyDetails

Nome Descrizione Valore
keyVaultUrl URL dell'insieme di credenziali delle chiavi della chiave secondaria dell'area di lavoro string
name Nome della risorsa secondaria della chiave dell'area di lavoro string

ManagedVirtualNetworkSettings

Nome Descrizione Valore
allowedAadTenantIdsForLinking ID tenant Aad consentiti per il collegamento string[]
linkedAccessCheckOnTargetResource Controllo accesso collegato nella risorsa di destinazione bool
preventDataExfiltration Impedire l'esfiltrazione dei dati bool

PrivateEndpointConnection

Nome Descrizione Valore
properties Proprietà di connessione dell'endpoint privato. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nome Descrizione Valore
privateEndpoint Endpoint privato a cui appartiene la connessione. PrivateEndpoint
privateLinkServiceConnectionState Stato di connessione della connessione dell'endpoint privato. PrivateLinkServiceConnectionState

PrivateEndpoint

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrizione Valore
description Descrizione della connessione al servizio di collegamento privato. string
status Stato della connessione al servizio di collegamento privato. string

PurviewConfiguration

Nome Descrizione Valore
purviewResourceId ID risorsa Purview string

VirtualNetworkProfile

Nome Descrizione Valore
computeSubnetId ID subnet usato per le risorse di calcolo nell'area di lavoro string

WorkspaceRepositoryConfiguration

Nome Descrizione Valore
accountName Nome account string
collaborationBranch Ramo di collaborazione string
hostName Nome host GitHub Enterprise. ad esempio https://github.mydomain.com string
lastCommitId Ultimo ID commit string
projectName Nome del progetto VSTS string
repositoryName Nome del repository string
rootFolder Cartella radice da usare nel repository string
TenantId The VSTS tenant ID string
type Tipo di configurazione repositoryID dell'area di lavoro. Esempio di WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration string