Bicep-resursdefinition
Resurstypen för arbetsytor kan distribueras med åtgärder som mål:
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Om du vill skapa en Microsoft.Synapse/workspaces-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.Synapse/workspaces@2021-05-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
connectivityEndpoints: {
{customized property}: 'string'
}
cspWorkspaceAdminProperties: {
initialWorkspaceAdminObjectId: 'string'
}
defaultDataLakeStorage: {
accountUrl: 'string'
filesystem: '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'
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'
}
}
Egenskapsvärden
CspWorkspaceAdminProperties
Namn |
Beskrivning |
Värde |
initialWorkspaceAdminObjectId |
AAD-objekt-ID för inledande arbetsyteadministratör |
sträng |
CustomerManagedKeyDetails
DataLakeStorageAccountDetails
Namn |
Beskrivning |
Värde |
accountUrl |
Konto-URL |
sträng |
filesystem |
Filsystemnamn |
sträng |
EncryptionDetails
KekIdentityProperties
Namn |
Beskrivning |
Värde |
userAssignedIdentity |
Resurs-ID för användartilldelad identitet |
sträng |
useSystemAssignedIdentity |
Booleskt värde som anger om systemtilldelad identitet ska användas eller inte |
någon |
Hanterad identitet
Namn |
Beskrivning |
Värde |
typ |
Typen av hanterad identitet för arbetsytan |
"Ingen" "SystemAssigned" "SystemAssigned,UserAssigned" |
userAssignedIdentities |
Användartilldelade hanterade identiteter. |
UserAssignedManagedIdentiteter |
ManagedVirtualNetworkSettings
Namn |
Beskrivning |
Värde |
allowedAadTenantIdsForLinking |
Tillåtna Aad-klient-ID:t för länkning |
string[] |
linkedAccessCheckOnTargetResource |
Länkad åtkomstkontroll på målresurs |
Bool |
preventDataExfiltration |
Förhindra dataexfiltrering |
Bool |
Microsoft.Synapse/workspaces
Namn |
Beskrivning |
Värde |
identitet |
Arbetsytans identitet |
ManagedIdentity |
plats |
Den geo-plats där resursen finns |
sträng (krävs) |
Namn |
Resursnamnet |
sträng (krävs) |
Egenskaper |
Resursegenskaper för arbetsyta |
WorkspaceEgenskaper |
Taggar |
Resurstaggar |
Ordlista med taggnamn och värden. Se taggar i mallar |
PrivateEndpoint
PrivateEndpointConnection
PrivateEndpointConnectionProperties
PrivateLinkServiceConnectionState
Namn |
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
Namn |
Beskrivning |
Värde |
purviewResourceId |
Purview-resurs-ID |
sträng |
UserAssignedManagedIdentiteter
UserAssignedManagedIdentity
VirtualNetworkProfile
Namn |
Beskrivning |
Värde |
computeSubnetId |
Undernäts-ID som används för beräkningar på arbetsytan |
sträng |
WorkspaceKeyDetails
Namn |
Beskrivning |
Värde |
keyVaultUrl |
Url för nyckel för arbetsytans nyckel under resurs |
sträng |
Namn |
Namn på underresurs för arbetsytans nyckel |
sträng |
Arbetsyteegenskaper
Namn |
Beskrivning |
Värde |
connectivityEndpoints |
Anslutningsslutpunkter |
WorkspacePropertiesConnectivityEndpoints |
cspWorkspaceAdminProperties |
AAD-administratörsegenskaper för den första arbetsytan för en CSP-prenumeration |
CspWorkspaceAdminProperties |
defaultDataLakeStorage |
Standardinformation om lagringskontot för arbetsytan |
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 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 hanterat virtuellt nätverk |
ManagedVirtualNetworkSettings |
privateEndpointConnections |
Privata slutpunktsanslutningar till arbetsytan |
PrivateEndpointConnection[] |
publicNetworkAccess |
Aktivera eller inaktivera offentlig nätverksåtkomst till arbetsytan |
"Inaktiverad" "Aktiverad" |
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 |
Profil för virtuellt nätverk |
VirtualNetworkProfile |
workspaceRepositoryConfiguration |
Inställningar för Git-integrering |
WorkspaceRepositoryConfiguration |
WorkspacePropertiesConnectivityEndpoints
WorkspaceRepositoryConfiguration
Namn |
Beskrivning |
Värde |
accountName |
Kontonamn |
sträng |
collaborationBranch |
Samarbetsgren |
sträng |
hostName |
GitHub Enterprise-värdnamn. Till exempel: https://github.mydomain.com |
sträng |
lastCommitId |
Det senaste inchecknings-ID:t |
sträng |
projectName |
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
Begränsningar: Min längd = 36 Maximal längd = 36 Mönster = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
typ |
Typ av konfiguration av lagringsplats-ID för arbetsytan. Exempel på WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration |
sträng |
Användningsexempel
Azure-verifierade moduler
Följande Azure-verifierade moduler kan användas för att distribuera den här resurstypen.
Resursdefinition för ARM-mall
Resurstypen för arbetsytor kan distribueras med åtgärder som mål:
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Om du vill skapa en Microsoft.Synapse/workspaces-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.Synapse/workspaces",
"apiVersion": "2021-05-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"connectivityEndpoints": {
"{customized property}": "string"
},
"cspWorkspaceAdminProperties": {
"initialWorkspaceAdminObjectId": "string"
},
"defaultDataLakeStorage": {
"accountUrl": "string",
"filesystem": "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",
"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"
}
}
Egenskapsvärden
CspWorkspaceAdminProperties
Namn |
Beskrivning |
Värde |
initialWorkspaceAdminObjectId |
AAD-objekt-ID för inledande arbetsyteadministratör |
sträng |
CustomerManagedKeyDetails
DataLakeStorageAccountDetails
Namn |
Beskrivning |
Värde |
accountUrl |
Konto-URL |
sträng |
filesystem |
Filsystemnamn |
sträng |
EncryptionDetails
KekIdentityProperties
Namn |
Beskrivning |
Värde |
userAssignedIdentity |
Resurs-ID för användartilldelad identitet |
sträng |
useSystemAssignedIdentity |
Booleskt värde som anger om systemtilldelad identitet ska användas eller inte |
någon |
Hanterad identitet
Namn |
Beskrivning |
Värde |
typ |
Typen av hanterad identitet för arbetsytan |
"Ingen" "SystemAssigned" "SystemAssigned,UserAssigned" |
userAssignedIdentities |
Användartilldelade hanterade identiteter. |
UserAssignedManagedIdentiteter |
ManagedVirtualNetworkSettings
Namn |
Beskrivning |
Värde |
allowedAadTenantIdsForLinking |
Tillåtna Aad-klient-ID:t för länkning |
string[] |
linkedAccessCheckOnTargetResource |
Länkad åtkomstkontroll på målresurs |
Bool |
preventDataExfiltration |
Förhindra dataexfiltrering |
Bool |
Microsoft.Synapse/workspaces
Namn |
Beskrivning |
Värde |
apiVersion |
API-versionen |
'2021-05-01' |
identitet |
Arbetsytans identitet |
ManagedIdentity |
plats |
Den geo-plats där resursen finns |
sträng (krävs) |
Namn |
Resursnamnet |
sträng (krävs) |
Egenskaper |
Resursegenskaper för arbetsyta |
WorkspaceEgenskaper |
Taggar |
Resurstaggar |
Ordlista med taggnamn och värden. Se taggar i mallar |
typ |
Resurstypen |
"Microsoft.Synapse/workspaces" |
PrivateEndpoint
PrivateEndpointConnection
PrivateEndpointConnectionProperties
PrivateLinkServiceConnectionState
Namn |
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
Namn |
Beskrivning |
Värde |
purviewResourceId |
Purview-resurs-ID |
sträng |
UserAssignedManagedIdentiteter
UserAssignedManagedIdentity
VirtualNetworkProfile
Namn |
Beskrivning |
Värde |
computeSubnetId |
Undernäts-ID som används för beräkningar på arbetsytan |
sträng |
WorkspaceKeyDetails
Namn |
Beskrivning |
Värde |
keyVaultUrl |
Url för nyckel för arbetsytans nyckel under resurs |
sträng |
Namn |
Namn på underresurs för arbetsytans nyckel |
sträng |
Arbetsyteegenskaper
Namn |
Beskrivning |
Värde |
connectivityEndpoints |
Anslutningsslutpunkter |
WorkspacePropertiesConnectivityEndpoints |
cspWorkspaceAdminProperties |
AAD-administratörsegenskaper för den första arbetsytan för en CSP-prenumeration |
CspWorkspaceAdminProperties |
defaultDataLakeStorage |
Standardinformation om lagringskontot för arbetsytan |
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 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 hanterat virtuellt nätverk |
ManagedVirtualNetworkSettings |
privateEndpointConnections |
Privata slutpunktsanslutningar till arbetsytan |
PrivateEndpointConnection[] |
publicNetworkAccess |
Aktivera eller inaktivera offentlig nätverksåtkomst till arbetsytan |
"Inaktiverad" "Aktiverad" |
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 |
Profil för virtuellt nätverk |
VirtualNetworkProfile |
workspaceRepositoryConfiguration |
Inställningar för Git-integrering |
WorkspaceRepositoryConfiguration |
WorkspacePropertiesConnectivityEndpoints
WorkspaceRepositoryConfiguration
Namn |
Beskrivning |
Värde |
accountName |
Kontonamn |
sträng |
collaborationBranch |
Samarbetsgren |
sträng |
hostName |
GitHub Enterprise-värdnamn. Till exempel: https://github.mydomain.com |
sträng |
lastCommitId |
Det senaste inchecknings-ID:t |
sträng |
projectName |
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
Begränsningar: Min längd = 36 Maximal längd = 36 Mönster = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
typ |
Typ av konfiguration av lagringsplats-ID för arbetsytan. Exempel på WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration |
sträng |
Användningsexempel
Azure-snabbstartsmallar
Följande Azure-snabbstartsmallar distribuera den här resurstypen.
Mall |
Beskrivning |
Azure Synapse Proof-of-Concept
|
Den här mallen skapar en konceptbevismiljö för Azure Synapse, inklusive SQL-pooler och valfria Apache Spark-pooler |
Resurstypen för arbetsytor kan distribueras med åtgärder som mål:
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
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@2021-05-01"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
connectivityEndpoints = {
{customized property} = "string"
}
cspWorkspaceAdminProperties = {
initialWorkspaceAdminObjectId = "string"
}
defaultDataLakeStorage = {
accountUrl = "string"
filesystem = "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"
virtualNetworkProfile = {
computeSubnetId = "string"
}
workspaceRepositoryConfiguration = {
accountName = "string"
collaborationBranch = "string"
hostName = "string"
lastCommitId = "string"
projectName = "string"
repositoryName = "string"
rootFolder = "string"
tenantId = "string"
type = "string"
}
}
}
}
Egenskapsvärden
CspWorkspaceAdminProperties
Namn |
Beskrivning |
Värde |
initialWorkspaceAdminObjectId |
AAD-objekt-ID för inledande arbetsyteadministratör |
sträng |
CustomerManagedKeyDetails
DataLakeStorageAccountDetails
Namn |
Beskrivning |
Värde |
accountUrl |
Konto-URL |
sträng |
filesystem |
Filsystemnamn |
sträng |
EncryptionDetails
KekIdentityProperties
Namn |
Beskrivning |
Värde |
userAssignedIdentity |
Resurs-ID för användartilldelad identitet |
sträng |
useSystemAssignedIdentity |
Booleskt värde som anger om systemtilldelad identitet ska användas eller inte |
någon |
Hanterad identitet
Namn |
Beskrivning |
Värde |
typ |
Typen av hanterad identitet för arbetsytan |
"Ingen" "SystemAssigned" "SystemAssigned,UserAssigned" |
userAssignedIdentities |
Användartilldelade hanterade identiteter. |
UserAssignedManagedIdentiteter |
ManagedVirtualNetworkSettings
Namn |
Beskrivning |
Värde |
allowedAadTenantIdsForLinking |
Tillåtna Aad-klient-ID:t för länkning |
string[] |
linkedAccessCheckOnTargetResource |
Länkad åtkomstkontroll på målresurs |
Bool |
preventDataExfiltration |
Förhindra dataexfiltrering |
Bool |
Microsoft.Synapse/workspaces
Namn |
Beskrivning |
Värde |
identitet |
Arbetsytans identitet |
ManagedIdentity |
plats |
Den geo-plats där resursen finns |
sträng (krävs) |
Namn |
Resursnamnet |
sträng (krävs) |
Egenskaper |
Resursegenskaper för arbetsyta |
WorkspaceEgenskaper |
Taggar |
Resurstaggar |
Ordlista med taggnamn och värden. |
typ |
Resurstypen |
"Microsoft.Synapse/workspaces@2021-05-01" |
PrivateEndpoint
PrivateEndpointConnection
PrivateEndpointConnectionProperties
PrivateLinkServiceConnectionState
Namn |
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
Namn |
Beskrivning |
Värde |
purviewResourceId |
Purview-resurs-ID |
sträng |
UserAssignedManagedIdentiteter
UserAssignedManagedIdentity
VirtualNetworkProfile
Namn |
Beskrivning |
Värde |
computeSubnetId |
Undernäts-ID som används för beräkningar på arbetsytan |
sträng |
WorkspaceKeyDetails
Namn |
Beskrivning |
Värde |
keyVaultUrl |
Url för nyckel för arbetsytans nyckel under resurs |
sträng |
Namn |
Namn på underresurs för arbetsytans nyckel |
sträng |
Arbetsyteegenskaper
Namn |
Beskrivning |
Värde |
connectivityEndpoints |
Anslutningsslutpunkter |
WorkspacePropertiesConnectivityEndpoints |
cspWorkspaceAdminProperties |
AAD-administratörsegenskaper för den första arbetsytan för en CSP-prenumeration |
CspWorkspaceAdminProperties |
defaultDataLakeStorage |
Standardinformation om lagringskontot för arbetsytan |
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 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 hanterat virtuellt nätverk |
ManagedVirtualNetworkSettings |
privateEndpointConnections |
Privata slutpunktsanslutningar till arbetsytan |
PrivateEndpointConnection[] |
publicNetworkAccess |
Aktivera eller inaktivera offentlig nätverksåtkomst till arbetsytan |
"Inaktiverad" "Aktiverad" |
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 |
Profil för virtuellt nätverk |
VirtualNetworkProfile |
workspaceRepositoryConfiguration |
Inställningar för Git-integrering |
WorkspaceRepositoryConfiguration |
WorkspacePropertiesConnectivityEndpoints
WorkspaceRepositoryConfiguration
Namn |
Beskrivning |
Värde |
accountName |
Kontonamn |
sträng |
collaborationBranch |
Samarbetsgren |
sträng |
hostName |
GitHub Enterprise-värdnamn. Till exempel: https://github.mydomain.com |
sträng |
lastCommitId |
Det senaste inchecknings-ID:t |
sträng |
projectName |
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
Begränsningar: Min längd = 36 Maximal längd = 36 Mönster = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
typ |
Typ av konfiguration av lagringsplats-ID för arbetsytan. Exempel på WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration |
sträng |