Espaces de travail Microsoft.Synapse
Article 12/20/2024
2 contributeurs
Commentaires
Dans cet article
Définition de ressource Bicep
Le type de ressource des espaces de travail peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications .
Pour créer une ressource Microsoft.Synapse/workspaces, ajoutez le bicep suivant à votre modèle.
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(Azure.Bicep.Types.Concrete.AnyType)
}
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'
}
}
Valeurs de propriété
CspWorkspaceAdminProperties
Nom
Description
Valeur
initialWorkspaceAdminObjectId
ID d’objet AAD de l’administrateur d’espace de travail initial
corde
CustomerManagedKeyDetails
DataLakeStorageAccountDetails
Nom
Description
Valeur
accountUrl
URL du compte
corde
createManagedPrivateEndpoint
Créer un point de terminaison privé managé sur ce compte de stockage ou non
Bool
système de fichiers
Nom du système de fichiers
corde
resourceId
ID de ressource ARM de ce compte de stockage
corde
EncryptionDetails
KekIdentityProperties
Nom
Description
Valeur
userAssignedIdentity
ID de ressource d’identité affectée par l’utilisateur
corde
useSystemAssignedIdentity
Boolean spécifiant s’il faut utiliser l’identité affectée par le système ou non
quelconque
ManagedIdentity
Nom
Description
Valeur
type
Type d’identité managée pour l’espace de travail
'None' 'SystemAssigned' 'SystemAssigned,UserAssigned'
userAssignedIdentities
Identités managées affectées par l’utilisateur.
UserAssignedManagedIdentities
ManagedVirtualNetworkSettings
Nom
Description
Valeur
allowedAadTenantIdsForLinking
ID de locataire Aad autorisés pour la liaison
string[]
linkedAccessCheckOnTargetResource
Vérification de l’accès lié sur la ressource cible
Bool
preventDataExfiltration
Empêcher l’exfiltration des données
Bool
Microsoft.Synapse/workspaces
Nom
Description
Valeur
identité
Identité de l’espace de travail
managedIdentity
emplacement
Emplacement géographique où réside la ressource
chaîne (obligatoire)
nom
Nom de la ressource
chaîne (obligatoire)
Propriétés
Propriétés des ressources d’espace de travail
WorkspaceProperties
étiquettes
Balises de ressource
Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
PrivateEndpoint
PrivateEndpointConnection
PrivateEndpointConnectionProperties
Nom
Description
Valeur
privateEndpoint
Point de terminaison privé auquel la connexion appartient.
PrivateEndpoint
privateLinkServiceConnectionState
État de connexion de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionState
PrivateLinkServiceConnectionState
Nom
Description
Valeur
description
Description de la connexion du service private link.
corde
statut
État de connexion du service de liaison privée.
corde
PurviewConfiguration
Nom
Description
Valeur
purviewResourceId
ID de ressource Purview
corde
UserAssignedManagedIdentities
UserAssignedManagedIdentity
VirtualNetworkProfile
Nom
Description
Valeur
computeSubnetId
ID de sous-réseau utilisé pour les calculs dans l’espace de travail
corde
WorkspaceKeyDetails
Nom
Description
Valeur
keyVaultUrl
URL du coffre de clés de sous-ressource de la clé d’espace de travail
corde
nom
Nom de la sous-ressource clé de l’espace de travail
corde
WorkspaceProperties
Nom
Description
Valeur
azureADOnlyAuthentication
Activer ou désactiver AzureADOnlyAuthentication sur toutes les sous-ressources de l’espace de travail
Bool
cspWorkspaceAdminProperties
Propriétés d’administration AAD de l’espace de travail initial pour un abonnement CSP
CspWorkspaceAdminProperties
defaultDataLakeStorage
Détails du compte de stockage data lake par défaut de l’espace de travail
DataLakeStorageAccountDetails
chiffrement
Détails du chiffrement de l’espace de travail
EncryptionDetails
managedResourceGroupName
Groupe de ressources géré par l’espace de travail. Le nom du groupe de ressources identifie de façon unique le groupe de ressources dans l’ID d’abonnement utilisateur. Le nom du groupe de ressources ne doit pas dépasser 90 caractères et doit être des caractères alphanumériques (Char.IsLetterOrDigit()) et '-', '_', '(', ')' et'.'. Notez que le nom ne peut pas se terminer par « . »
corde
managedVirtualNetwork
La définition de ce paramètre sur « par défaut » garantit que tout le calcul de cet espace de travail se trouve dans un réseau virtuel géré pour le compte de l’utilisateur.
corde
managedVirtualNetworkSettings
Paramètres de réseau virtuel managé
ManagedVirtualNetworkSettings
privateEndpointConnections
Connexions de point de terminaison privé à l’espace de travail
PrivateEndpointConnection []
publicNetworkAccess
Activer ou désactiver l’accès au réseau public à l’espace de travail
'Désactivé' 'Activé'
purviewConfiguration
Purview Configuration
PurviewConfiguration
sqlAdministratorLogin
Connexion pour l’administrateur SQL Active Directory de l’espace de travail
corde
sqlAdministratorLoginPassword
Mot de passe de connexion administrateur SQL
corde
trustedServiceBypassEnabled
Est trustedServiceBypassEnabled pour l’espace de travail
Bool
virtualNetworkProfile
Profil de réseau virtuel
virtualNetworkProfile
workspaceRepositoryConfiguration
Paramètres d’intégration Git
WorkspaceRepositoryConfiguration
WorkspaceRepositoryConfiguration
Nom
Description
Valeur
accountName
Nom du compte
corde
CollaborationBranch
Branche de collaboration
corde
hostName
Nom d’hôte GitHub Enterprise. Par exemple : https://github.mydomain.com
corde
lastCommitId
Dernier ID de validation
corde
projectName
Nom du projet VSTS
corde
repositoryName
Nom du référentiel
corde
rootFolder
Dossier racine à utiliser dans le référentiel
corde
tenantId
ID de locataire VSTS
corde Contraintes: Longueur minimale = 36 Longueur maximale = 36 Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
type
Type de configuration repositoryID de l’espace de travail. Exemple WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration
corde
Définition de ressource de modèle ARM
Le type de ressource des espaces de travail peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications .
Pour créer une ressource Microsoft.Synapse/workspaces, ajoutez le code JSON suivant à votre modèle.
{
"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"
}
}
Valeurs de propriété
CspWorkspaceAdminProperties
Nom
Description
Valeur
initialWorkspaceAdminObjectId
ID d’objet AAD de l’administrateur d’espace de travail initial
corde
CustomerManagedKeyDetails
DataLakeStorageAccountDetails
Nom
Description
Valeur
accountUrl
URL du compte
corde
createManagedPrivateEndpoint
Créer un point de terminaison privé managé sur ce compte de stockage ou non
Bool
système de fichiers
Nom du système de fichiers
corde
resourceId
ID de ressource ARM de ce compte de stockage
corde
EncryptionDetails
KekIdentityProperties
Nom
Description
Valeur
userAssignedIdentity
ID de ressource d’identité affectée par l’utilisateur
corde
useSystemAssignedIdentity
Boolean spécifiant s’il faut utiliser l’identité affectée par le système ou non
quelconque
ManagedIdentity
Nom
Description
Valeur
type
Type d’identité managée pour l’espace de travail
'None' 'SystemAssigned' 'SystemAssigned,UserAssigned'
userAssignedIdentities
Identités managées affectées par l’utilisateur.
UserAssignedManagedIdentities
ManagedVirtualNetworkSettings
Nom
Description
Valeur
allowedAadTenantIdsForLinking
ID de locataire Aad autorisés pour la liaison
string[]
linkedAccessCheckOnTargetResource
Vérification de l’accès lié sur la ressource cible
Bool
preventDataExfiltration
Empêcher l’exfiltration des données
Bool
Microsoft.Synapse/workspaces
Nom
Description
Valeur
apiVersion
Version de l’API
'2021-06-01'
identité
Identité de l’espace de travail
managedIdentity
emplacement
Emplacement géographique où réside la ressource
chaîne (obligatoire)
nom
Nom de la ressource
chaîne (obligatoire)
Propriétés
Propriétés des ressources d’espace de travail
WorkspaceProperties
étiquettes
Balises de ressource
Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type
Type de ressource
'Microsoft.Synapse/workspaces'
PrivateEndpoint
PrivateEndpointConnection
PrivateEndpointConnectionProperties
Nom
Description
Valeur
privateEndpoint
Point de terminaison privé auquel la connexion appartient.
PrivateEndpoint
privateLinkServiceConnectionState
État de connexion de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionState
PrivateLinkServiceConnectionState
Nom
Description
Valeur
description
Description de la connexion du service private link.
corde
statut
État de connexion du service de liaison privée.
corde
PurviewConfiguration
Nom
Description
Valeur
purviewResourceId
ID de ressource Purview
corde
UserAssignedManagedIdentities
UserAssignedManagedIdentity
VirtualNetworkProfile
Nom
Description
Valeur
computeSubnetId
ID de sous-réseau utilisé pour les calculs dans l’espace de travail
corde
WorkspaceKeyDetails
Nom
Description
Valeur
keyVaultUrl
URL du coffre de clés de sous-ressource de la clé d’espace de travail
corde
nom
Nom de la sous-ressource clé de l’espace de travail
corde
WorkspaceProperties
Nom
Description
Valeur
azureADOnlyAuthentication
Activer ou désactiver AzureADOnlyAuthentication sur toutes les sous-ressources de l’espace de travail
Bool
cspWorkspaceAdminProperties
Propriétés d’administration AAD de l’espace de travail initial pour un abonnement CSP
CspWorkspaceAdminProperties
defaultDataLakeStorage
Détails du compte de stockage data lake par défaut de l’espace de travail
DataLakeStorageAccountDetails
chiffrement
Détails du chiffrement de l’espace de travail
EncryptionDetails
managedResourceGroupName
Groupe de ressources géré par l’espace de travail. Le nom du groupe de ressources identifie de façon unique le groupe de ressources dans l’ID d’abonnement utilisateur. Le nom du groupe de ressources ne doit pas dépasser 90 caractères et doit être des caractères alphanumériques (Char.IsLetterOrDigit()) et '-', '_', '(', ')' et'.'. Notez que le nom ne peut pas se terminer par « . »
corde
managedVirtualNetwork
La définition de ce paramètre sur « par défaut » garantit que tout le calcul de cet espace de travail se trouve dans un réseau virtuel géré pour le compte de l’utilisateur.
corde
managedVirtualNetworkSettings
Paramètres de réseau virtuel managé
ManagedVirtualNetworkSettings
privateEndpointConnections
Connexions de point de terminaison privé à l’espace de travail
PrivateEndpointConnection []
publicNetworkAccess
Activer ou désactiver l’accès au réseau public à l’espace de travail
'Désactivé' 'Activé'
purviewConfiguration
Purview Configuration
PurviewConfiguration
sqlAdministratorLogin
Connexion pour l’administrateur SQL Active Directory de l’espace de travail
corde
sqlAdministratorLoginPassword
Mot de passe de connexion administrateur SQL
corde
trustedServiceBypassEnabled
Est trustedServiceBypassEnabled pour l’espace de travail
Bool
virtualNetworkProfile
Profil de réseau virtuel
virtualNetworkProfile
workspaceRepositoryConfiguration
Paramètres d’intégration Git
WorkspaceRepositoryConfiguration
WorkspaceRepositoryConfiguration
Nom
Description
Valeur
accountName
Nom du compte
corde
CollaborationBranch
Branche de collaboration
corde
hostName
Nom d’hôte GitHub Enterprise. Par exemple : https://github.mydomain.com
corde
lastCommitId
Dernier ID de validation
corde
projectName
Nom du projet VSTS
corde
repositoryName
Nom du référentiel
corde
rootFolder
Dossier racine à utiliser dans le référentiel
corde
tenantId
ID de locataire VSTS
corde Contraintes: Longueur minimale = 36 Longueur maximale = 36 Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
type
Type de configuration repositoryID de l’espace de travail. Exemple WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration
corde
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
Modèle
Description
preuve de concept Azure Synapse
Ce modèle crée un environnement de preuve de concept pour Azure Synapse, notamment des pools SQL et des pools Apache Spark facultatifs
Le type de ressource des espaces de travail peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications .
Pour créer une ressource Microsoft.Synapse/workspaces, ajoutez le terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Synapse/workspaces@2021-06-01"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
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"
}
}
})
}
Valeurs de propriété
CspWorkspaceAdminProperties
Nom
Description
Valeur
initialWorkspaceAdminObjectId
ID d’objet AAD de l’administrateur d’espace de travail initial
corde
CustomerManagedKeyDetails
DataLakeStorageAccountDetails
Nom
Description
Valeur
accountUrl
URL du compte
corde
createManagedPrivateEndpoint
Créer un point de terminaison privé managé sur ce compte de stockage ou non
Bool
système de fichiers
Nom du système de fichiers
corde
resourceId
ID de ressource ARM de ce compte de stockage
corde
EncryptionDetails
KekIdentityProperties
Nom
Description
Valeur
userAssignedIdentity
ID de ressource d’identité affectée par l’utilisateur
corde
useSystemAssignedIdentity
Boolean spécifiant s’il faut utiliser l’identité affectée par le système ou non
quelconque
ManagedIdentity
Nom
Description
Valeur
type
Type d’identité managée pour l’espace de travail
'None' 'SystemAssigned' 'SystemAssigned,UserAssigned'
userAssignedIdentities
Identités managées affectées par l’utilisateur.
UserAssignedManagedIdentities
ManagedVirtualNetworkSettings
Nom
Description
Valeur
allowedAadTenantIdsForLinking
ID de locataire Aad autorisés pour la liaison
string[]
linkedAccessCheckOnTargetResource
Vérification de l’accès lié sur la ressource cible
Bool
preventDataExfiltration
Empêcher l’exfiltration des données
Bool
Microsoft.Synapse/workspaces
Nom
Description
Valeur
identité
Identité de l’espace de travail
managedIdentity
emplacement
Emplacement géographique où réside la ressource
chaîne (obligatoire)
nom
Nom de la ressource
chaîne (obligatoire)
Propriétés
Propriétés des ressources d’espace de travail
WorkspaceProperties
étiquettes
Balises de ressource
Dictionnaire de noms et de valeurs d’étiquettes.
type
Type de ressource
« Microsoft.Synapse/workspaces@2021-06-01 »
PrivateEndpoint
PrivateEndpointConnection
PrivateEndpointConnectionProperties
Nom
Description
Valeur
privateEndpoint
Point de terminaison privé auquel la connexion appartient.
PrivateEndpoint
privateLinkServiceConnectionState
État de connexion de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionState
PrivateLinkServiceConnectionState
Nom
Description
Valeur
description
Description de la connexion du service private link.
corde
statut
État de connexion du service de liaison privée.
corde
PurviewConfiguration
Nom
Description
Valeur
purviewResourceId
ID de ressource Purview
corde
UserAssignedManagedIdentities
UserAssignedManagedIdentity
VirtualNetworkProfile
Nom
Description
Valeur
computeSubnetId
ID de sous-réseau utilisé pour les calculs dans l’espace de travail
corde
WorkspaceKeyDetails
Nom
Description
Valeur
keyVaultUrl
URL du coffre de clés de sous-ressource de la clé d’espace de travail
corde
nom
Nom de la sous-ressource clé de l’espace de travail
corde
WorkspaceProperties
Nom
Description
Valeur
azureADOnlyAuthentication
Activer ou désactiver AzureADOnlyAuthentication sur toutes les sous-ressources de l’espace de travail
Bool
cspWorkspaceAdminProperties
Propriétés d’administration AAD de l’espace de travail initial pour un abonnement CSP
CspWorkspaceAdminProperties
defaultDataLakeStorage
Détails du compte de stockage data lake par défaut de l’espace de travail
DataLakeStorageAccountDetails
chiffrement
Détails du chiffrement de l’espace de travail
EncryptionDetails
managedResourceGroupName
Groupe de ressources géré par l’espace de travail. Le nom du groupe de ressources identifie de façon unique le groupe de ressources dans l’ID d’abonnement utilisateur. Le nom du groupe de ressources ne doit pas dépasser 90 caractères et doit être des caractères alphanumériques (Char.IsLetterOrDigit()) et '-', '_', '(', ')' et'.'. Notez que le nom ne peut pas se terminer par « . »
corde
managedVirtualNetwork
La définition de ce paramètre sur « par défaut » garantit que tout le calcul de cet espace de travail se trouve dans un réseau virtuel géré pour le compte de l’utilisateur.
corde
managedVirtualNetworkSettings
Paramètres de réseau virtuel managé
ManagedVirtualNetworkSettings
privateEndpointConnections
Connexions de point de terminaison privé à l’espace de travail
PrivateEndpointConnection []
publicNetworkAccess
Activer ou désactiver l’accès au réseau public à l’espace de travail
'Désactivé' 'Activé'
purviewConfiguration
Purview Configuration
PurviewConfiguration
sqlAdministratorLogin
Connexion pour l’administrateur SQL Active Directory de l’espace de travail
corde
sqlAdministratorLoginPassword
Mot de passe de connexion administrateur SQL
corde
trustedServiceBypassEnabled
Est trustedServiceBypassEnabled pour l’espace de travail
Bool
virtualNetworkProfile
Profil de réseau virtuel
virtualNetworkProfile
workspaceRepositoryConfiguration
Paramètres d’intégration Git
WorkspaceRepositoryConfiguration
WorkspaceRepositoryConfiguration
Nom
Description
Valeur
accountName
Nom du compte
corde
CollaborationBranch
Branche de collaboration
corde
hostName
Nom d’hôte GitHub Enterprise. Par exemple : https://github.mydomain.com
corde
lastCommitId
Dernier ID de validation
corde
projectName
Nom du projet VSTS
corde
repositoryName
Nom du référentiel
corde
rootFolder
Dossier racine à utiliser dans le référentiel
corde
tenantId
ID de locataire VSTS
corde Contraintes: Longueur minimale = 36 Longueur maximale = 36 Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
type
Type de configuration repositoryID de l’espace de travail. Exemple WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration
corde