1. Packages
  2. Azure Classic
  3. API Docs
  4. synapse
  5. Workspace

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

azure.synapse.Workspace

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

    Manages a Synapse Workspace.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
            AccountKind = "StorageV2",
            IsHnsEnabled = true,
        });
    
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new()
        {
            StorageAccountId = exampleAccount.Id,
        });
    
        var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
            SqlAdministratorLogin = "sqladminuser",
            SqlAdministratorLoginPassword = "H@Sh1CoR3!",
            AadAdmin = new Azure.Synapse.Inputs.WorkspaceAadAdminArgs
            {
                Login = "AzureAD Admin",
                ObjectId = "00000000-0000-0000-0000-000000000000",
                TenantId = "00000000-0000-0000-0000-000000000000",
            },
            Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
            {
                Type = "SystemAssigned",
            },
            Tags = 
            {
                { "Env", "production" },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/synapse"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
    			ResourceGroupName:      exampleResourceGroup.Name,
    			Location:               exampleResourceGroup.Location,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    			AccountKind:            pulumi.String("StorageV2"),
    			IsHnsEnabled:           pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "exampleDataLakeGen2Filesystem", &storage.DataLakeGen2FilesystemArgs{
    			StorageAccountId: exampleAccount.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = synapse.NewWorkspace(ctx, "exampleWorkspace", &synapse.WorkspaceArgs{
    			ResourceGroupName:               exampleResourceGroup.Name,
    			Location:                        exampleResourceGroup.Location,
    			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
    			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
    			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
    			AadAdmin: &synapse.WorkspaceAadAdminTypeArgs{
    				Login:    pulumi.String("AzureAD Admin"),
    				ObjectId: pulumi.String("00000000-0000-0000-0000-000000000000"),
    				TenantId: pulumi.String("00000000-0000-0000-0000-000000000000"),
    			},
    			Identity: &synapse.WorkspaceIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    			Tags: pulumi.StringMap{
    				"Env": pulumi.String("production"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.storage.Account;
    import com.pulumi.azure.storage.AccountArgs;
    import com.pulumi.azure.storage.DataLakeGen2Filesystem;
    import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
    import com.pulumi.azure.synapse.Workspace;
    import com.pulumi.azure.synapse.WorkspaceArgs;
    import com.pulumi.azure.synapse.inputs.WorkspaceAadAdminArgs;
    import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
                .location("West Europe")
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.location())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .accountKind("StorageV2")
                .isHnsEnabled("true")
                .build());
    
            var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()        
                .storageAccountId(exampleAccount.id())
                .build());
    
            var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.location())
                .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
                .sqlAdministratorLogin("sqladminuser")
                .sqlAdministratorLoginPassword("H@Sh1CoR3!")
                .aadAdmin(WorkspaceAadAdminArgs.builder()
                    .login("AzureAD Admin")
                    .objectId("00000000-0000-0000-0000-000000000000")
                    .tenantId("00000000-0000-0000-0000-000000000000")
                    .build())
                .identity(WorkspaceIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .tags(Map.of("Env", "production"))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_account = azure.storage.Account("exampleAccount",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        account_tier="Standard",
        account_replication_type="LRS",
        account_kind="StorageV2",
        is_hns_enabled=True)
    example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", storage_account_id=example_account.id)
    example_workspace = azure.synapse.Workspace("exampleWorkspace",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
        sql_administrator_login="sqladminuser",
        sql_administrator_login_password="H@Sh1CoR3!",
        aad_admin=azure.synapse.WorkspaceAadAdminArgs(
            login="AzureAD Admin",
            object_id="00000000-0000-0000-0000-000000000000",
            tenant_id="00000000-0000-0000-0000-000000000000",
        ),
        identity=azure.synapse.WorkspaceIdentityArgs(
            type="SystemAssigned",
        ),
        tags={
            "Env": "production",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleAccount = new azure.storage.Account("exampleAccount", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
        accountKind: "StorageV2",
        isHnsEnabled: true,
    });
    const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", {storageAccountId: exampleAccount.id});
    const exampleWorkspace = new azure.synapse.Workspace("exampleWorkspace", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
        sqlAdministratorLogin: "sqladminuser",
        sqlAdministratorLoginPassword: "H@Sh1CoR3!",
        aadAdmin: {
            login: "AzureAD Admin",
            objectId: "00000000-0000-0000-0000-000000000000",
            tenantId: "00000000-0000-0000-0000-000000000000",
        },
        identity: {
            type: "SystemAssigned",
        },
        tags: {
            Env: "production",
        },
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleAccount:
        type: azure:storage:Account
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.location}
          accountTier: Standard
          accountReplicationType: LRS
          accountKind: StorageV2
          isHnsEnabled: 'true'
      exampleDataLakeGen2Filesystem:
        type: azure:storage:DataLakeGen2Filesystem
        properties:
          storageAccountId: ${exampleAccount.id}
      exampleWorkspace:
        type: azure:synapse:Workspace
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.location}
          storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
          sqlAdministratorLogin: sqladminuser
          sqlAdministratorLoginPassword: H@Sh1CoR3!
          aadAdmin:
            login: AzureAD Admin
            objectId: 00000000-0000-0000-0000-000000000000
            tenantId: 00000000-0000-0000-0000-000000000000
          identity:
            type: SystemAssigned
          tags:
            Env: production
    

    Creating A Workspace With Customer Managed Key And Azure AD Admin

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var current = Azure.Core.GetClientConfig.Invoke();
    
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
            AccountKind = "StorageV2",
            IsHnsEnabled = true,
        });
    
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new()
        {
            StorageAccountId = exampleAccount.Id,
        });
    
        var exampleKeyVault = new Azure.KeyVault.KeyVault("exampleKeyVault", new()
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
            SkuName = "standard",
            PurgeProtectionEnabled = true,
        });
    
        var deployer = new Azure.KeyVault.AccessPolicy("deployer", new()
        {
            KeyVaultId = exampleKeyVault.Id,
            TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
            ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
            KeyPermissions = new[]
            {
                "Create",
                "Get",
                "Delete",
                "Purge",
                "GetRotationPolicy",
            },
        });
    
        var exampleKey = new Azure.KeyVault.Key("exampleKey", new()
        {
            KeyVaultId = exampleKeyVault.Id,
            KeyType = "RSA",
            KeySize = 2048,
            KeyOpts = new[]
            {
                "unwrapKey",
                "wrapKey",
            },
        }, new CustomResourceOptions
        {
            DependsOn = new[]
            {
                deployer,
            },
        });
    
        var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
            SqlAdministratorLogin = "sqladminuser",
            SqlAdministratorLoginPassword = "H@Sh1CoR3!",
            CustomerManagedKey = new Azure.Synapse.Inputs.WorkspaceCustomerManagedKeyArgs
            {
                KeyVersionlessId = exampleKey.VersionlessId,
                KeyName = "enckey",
            },
            Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
            {
                Type = "SystemAssigned",
            },
            Tags = 
            {
                { "Env", "production" },
            },
        });
    
        var workspacePolicy = new Azure.KeyVault.AccessPolicy("workspacePolicy", new()
        {
            KeyVaultId = exampleKeyVault.Id,
            TenantId = exampleWorkspace.Identity.Apply(identity => identity?.TenantId),
            ObjectId = exampleWorkspace.Identity.Apply(identity => identity?.PrincipalId),
            KeyPermissions = new[]
            {
                "Get",
                "WrapKey",
                "UnwrapKey",
            },
        });
    
        var exampleWorkspaceKey = new Azure.Synapse.WorkspaceKey("exampleWorkspaceKey", new()
        {
            CustomerManagedKeyVersionlessId = exampleKey.VersionlessId,
            SynapseWorkspaceId = exampleWorkspace.Id,
            Active = true,
            CustomerManagedKeyName = "enckey",
        }, new CustomResourceOptions
        {
            DependsOn = new[]
            {
                workspacePolicy,
            },
        });
    
        var exampleWorkspaceAadAdmin = new Azure.Synapse.WorkspaceAadAdmin("exampleWorkspaceAadAdmin", new()
        {
            SynapseWorkspaceId = exampleWorkspace.Id,
            Login = "AzureAD Admin",
            ObjectId = "00000000-0000-0000-0000-000000000000",
            TenantId = "00000000-0000-0000-0000-000000000000",
        }, new CustomResourceOptions
        {
            DependsOn = new[]
            {
                exampleWorkspaceKey,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/keyvault"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/synapse"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		current, err := core.GetClientConfig(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
    			ResourceGroupName:      exampleResourceGroup.Name,
    			Location:               exampleResourceGroup.Location,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    			AccountKind:            pulumi.String("StorageV2"),
    			IsHnsEnabled:           pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "exampleDataLakeGen2Filesystem", &storage.DataLakeGen2FilesystemArgs{
    			StorageAccountId: exampleAccount.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		exampleKeyVault, err := keyvault.NewKeyVault(ctx, "exampleKeyVault", &keyvault.KeyVaultArgs{
    			Location:               exampleResourceGroup.Location,
    			ResourceGroupName:      exampleResourceGroup.Name,
    			TenantId:               *pulumi.String(current.TenantId),
    			SkuName:                pulumi.String("standard"),
    			PurgeProtectionEnabled: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		deployer, err := keyvault.NewAccessPolicy(ctx, "deployer", &keyvault.AccessPolicyArgs{
    			KeyVaultId: exampleKeyVault.ID(),
    			TenantId:   *pulumi.String(current.TenantId),
    			ObjectId:   *pulumi.String(current.ObjectId),
    			KeyPermissions: pulumi.StringArray{
    				pulumi.String("Create"),
    				pulumi.String("Get"),
    				pulumi.String("Delete"),
    				pulumi.String("Purge"),
    				pulumi.String("GetRotationPolicy"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleKey, err := keyvault.NewKey(ctx, "exampleKey", &keyvault.KeyArgs{
    			KeyVaultId: exampleKeyVault.ID(),
    			KeyType:    pulumi.String("RSA"),
    			KeySize:    pulumi.Int(2048),
    			KeyOpts: pulumi.StringArray{
    				pulumi.String("unwrapKey"),
    				pulumi.String("wrapKey"),
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			deployer,
    		}))
    		if err != nil {
    			return err
    		}
    		exampleWorkspace, err := synapse.NewWorkspace(ctx, "exampleWorkspace", &synapse.WorkspaceArgs{
    			ResourceGroupName:               exampleResourceGroup.Name,
    			Location:                        exampleResourceGroup.Location,
    			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
    			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
    			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
    			CustomerManagedKey: &synapse.WorkspaceCustomerManagedKeyArgs{
    				KeyVersionlessId: exampleKey.VersionlessId,
    				KeyName:          pulumi.String("enckey"),
    			},
    			Identity: &synapse.WorkspaceIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    			Tags: pulumi.StringMap{
    				"Env": pulumi.String("production"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		workspacePolicy, err := keyvault.NewAccessPolicy(ctx, "workspacePolicy", &keyvault.AccessPolicyArgs{
    			KeyVaultId: exampleKeyVault.ID(),
    			TenantId: exampleWorkspace.Identity.ApplyT(func(identity synapse.WorkspaceIdentity) (*string, error) {
    				return &identity.TenantId, nil
    			}).(pulumi.StringPtrOutput),
    			ObjectId: exampleWorkspace.Identity.ApplyT(func(identity synapse.WorkspaceIdentity) (*string, error) {
    				return &identity.PrincipalId, nil
    			}).(pulumi.StringPtrOutput),
    			KeyPermissions: pulumi.StringArray{
    				pulumi.String("Get"),
    				pulumi.String("WrapKey"),
    				pulumi.String("UnwrapKey"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleWorkspaceKey, err := synapse.NewWorkspaceKey(ctx, "exampleWorkspaceKey", &synapse.WorkspaceKeyArgs{
    			CustomerManagedKeyVersionlessId: exampleKey.VersionlessId,
    			SynapseWorkspaceId:              exampleWorkspace.ID(),
    			Active:                          pulumi.Bool(true),
    			CustomerManagedKeyName:          pulumi.String("enckey"),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			workspacePolicy,
    		}))
    		if err != nil {
    			return err
    		}
    		_, err = synapse.NewWorkspaceAadAdmin(ctx, "exampleWorkspaceAadAdmin", &synapse.WorkspaceAadAdminArgs{
    			SynapseWorkspaceId: exampleWorkspace.ID(),
    			Login:              pulumi.String("AzureAD Admin"),
    			ObjectId:           pulumi.String("00000000-0000-0000-0000-000000000000"),
    			TenantId:           pulumi.String("00000000-0000-0000-0000-000000000000"),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			exampleWorkspaceKey,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.CoreFunctions;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.storage.Account;
    import com.pulumi.azure.storage.AccountArgs;
    import com.pulumi.azure.storage.DataLakeGen2Filesystem;
    import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
    import com.pulumi.azure.keyvault.KeyVault;
    import com.pulumi.azure.keyvault.KeyVaultArgs;
    import com.pulumi.azure.keyvault.AccessPolicy;
    import com.pulumi.azure.keyvault.AccessPolicyArgs;
    import com.pulumi.azure.keyvault.Key;
    import com.pulumi.azure.keyvault.KeyArgs;
    import com.pulumi.azure.synapse.Workspace;
    import com.pulumi.azure.synapse.WorkspaceArgs;
    import com.pulumi.azure.synapse.inputs.WorkspaceCustomerManagedKeyArgs;
    import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
    import com.pulumi.azure.synapse.WorkspaceKey;
    import com.pulumi.azure.synapse.WorkspaceKeyArgs;
    import com.pulumi.azure.synapse.WorkspaceAadAdmin;
    import com.pulumi.azure.synapse.WorkspaceAadAdminArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var current = CoreFunctions.getClientConfig();
    
            var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
                .location("West Europe")
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.location())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .accountKind("StorageV2")
                .isHnsEnabled("true")
                .build());
    
            var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()        
                .storageAccountId(exampleAccount.id())
                .build());
    
            var exampleKeyVault = new KeyVault("exampleKeyVault", KeyVaultArgs.builder()        
                .location(exampleResourceGroup.location())
                .resourceGroupName(exampleResourceGroup.name())
                .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
                .skuName("standard")
                .purgeProtectionEnabled(true)
                .build());
    
            var deployer = new AccessPolicy("deployer", AccessPolicyArgs.builder()        
                .keyVaultId(exampleKeyVault.id())
                .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
                .objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
                .keyPermissions(            
                    "Create",
                    "Get",
                    "Delete",
                    "Purge",
                    "GetRotationPolicy")
                .build());
    
            var exampleKey = new Key("exampleKey", KeyArgs.builder()        
                .keyVaultId(exampleKeyVault.id())
                .keyType("RSA")
                .keySize(2048)
                .keyOpts(            
                    "unwrapKey",
                    "wrapKey")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(deployer)
                    .build());
    
            var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.location())
                .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
                .sqlAdministratorLogin("sqladminuser")
                .sqlAdministratorLoginPassword("H@Sh1CoR3!")
                .customerManagedKey(WorkspaceCustomerManagedKeyArgs.builder()
                    .keyVersionlessId(exampleKey.versionlessId())
                    .keyName("enckey")
                    .build())
                .identity(WorkspaceIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .tags(Map.of("Env", "production"))
                .build());
    
            var workspacePolicy = new AccessPolicy("workspacePolicy", AccessPolicyArgs.builder()        
                .keyVaultId(exampleKeyVault.id())
                .tenantId(exampleWorkspace.identity().applyValue(identity -> identity.tenantId()))
                .objectId(exampleWorkspace.identity().applyValue(identity -> identity.principalId()))
                .keyPermissions(            
                    "Get",
                    "WrapKey",
                    "UnwrapKey")
                .build());
    
            var exampleWorkspaceKey = new WorkspaceKey("exampleWorkspaceKey", WorkspaceKeyArgs.builder()        
                .customerManagedKeyVersionlessId(exampleKey.versionlessId())
                .synapseWorkspaceId(exampleWorkspace.id())
                .active(true)
                .customerManagedKeyName("enckey")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(workspacePolicy)
                    .build());
    
            var exampleWorkspaceAadAdmin = new WorkspaceAadAdmin("exampleWorkspaceAadAdmin", WorkspaceAadAdminArgs.builder()        
                .synapseWorkspaceId(exampleWorkspace.id())
                .login("AzureAD Admin")
                .objectId("00000000-0000-0000-0000-000000000000")
                .tenantId("00000000-0000-0000-0000-000000000000")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(exampleWorkspaceKey)
                    .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    current = azure.core.get_client_config()
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_account = azure.storage.Account("exampleAccount",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        account_tier="Standard",
        account_replication_type="LRS",
        account_kind="StorageV2",
        is_hns_enabled=True)
    example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", storage_account_id=example_account.id)
    example_key_vault = azure.keyvault.KeyVault("exampleKeyVault",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        tenant_id=current.tenant_id,
        sku_name="standard",
        purge_protection_enabled=True)
    deployer = azure.keyvault.AccessPolicy("deployer",
        key_vault_id=example_key_vault.id,
        tenant_id=current.tenant_id,
        object_id=current.object_id,
        key_permissions=[
            "Create",
            "Get",
            "Delete",
            "Purge",
            "GetRotationPolicy",
        ])
    example_key = azure.keyvault.Key("exampleKey",
        key_vault_id=example_key_vault.id,
        key_type="RSA",
        key_size=2048,
        key_opts=[
            "unwrapKey",
            "wrapKey",
        ],
        opts=pulumi.ResourceOptions(depends_on=[deployer]))
    example_workspace = azure.synapse.Workspace("exampleWorkspace",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
        sql_administrator_login="sqladminuser",
        sql_administrator_login_password="H@Sh1CoR3!",
        customer_managed_key=azure.synapse.WorkspaceCustomerManagedKeyArgs(
            key_versionless_id=example_key.versionless_id,
            key_name="enckey",
        ),
        identity=azure.synapse.WorkspaceIdentityArgs(
            type="SystemAssigned",
        ),
        tags={
            "Env": "production",
        })
    workspace_policy = azure.keyvault.AccessPolicy("workspacePolicy",
        key_vault_id=example_key_vault.id,
        tenant_id=example_workspace.identity.tenant_id,
        object_id=example_workspace.identity.principal_id,
        key_permissions=[
            "Get",
            "WrapKey",
            "UnwrapKey",
        ])
    example_workspace_key = azure.synapse.WorkspaceKey("exampleWorkspaceKey",
        customer_managed_key_versionless_id=example_key.versionless_id,
        synapse_workspace_id=example_workspace.id,
        active=True,
        customer_managed_key_name="enckey",
        opts=pulumi.ResourceOptions(depends_on=[workspace_policy]))
    example_workspace_aad_admin = azure.synapse.WorkspaceAadAdmin("exampleWorkspaceAadAdmin",
        synapse_workspace_id=example_workspace.id,
        login="AzureAD Admin",
        object_id="00000000-0000-0000-0000-000000000000",
        tenant_id="00000000-0000-0000-0000-000000000000",
        opts=pulumi.ResourceOptions(depends_on=[example_workspace_key]))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const current = azure.core.getClientConfig({});
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleAccount = new azure.storage.Account("exampleAccount", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
        accountKind: "StorageV2",
        isHnsEnabled: true,
    });
    const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", {storageAccountId: exampleAccount.id});
    const exampleKeyVault = new azure.keyvault.KeyVault("exampleKeyVault", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        tenantId: current.then(current => current.tenantId),
        skuName: "standard",
        purgeProtectionEnabled: true,
    });
    const deployer = new azure.keyvault.AccessPolicy("deployer", {
        keyVaultId: exampleKeyVault.id,
        tenantId: current.then(current => current.tenantId),
        objectId: current.then(current => current.objectId),
        keyPermissions: [
            "Create",
            "Get",
            "Delete",
            "Purge",
            "GetRotationPolicy",
        ],
    });
    const exampleKey = new azure.keyvault.Key("exampleKey", {
        keyVaultId: exampleKeyVault.id,
        keyType: "RSA",
        keySize: 2048,
        keyOpts: [
            "unwrapKey",
            "wrapKey",
        ],
    }, {
        dependsOn: [deployer],
    });
    const exampleWorkspace = new azure.synapse.Workspace("exampleWorkspace", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
        sqlAdministratorLogin: "sqladminuser",
        sqlAdministratorLoginPassword: "H@Sh1CoR3!",
        customerManagedKey: {
            keyVersionlessId: exampleKey.versionlessId,
            keyName: "enckey",
        },
        identity: {
            type: "SystemAssigned",
        },
        tags: {
            Env: "production",
        },
    });
    const workspacePolicy = new azure.keyvault.AccessPolicy("workspacePolicy", {
        keyVaultId: exampleKeyVault.id,
        tenantId: exampleWorkspace.identity.apply(identity => identity?.tenantId),
        objectId: exampleWorkspace.identity.apply(identity => identity?.principalId),
        keyPermissions: [
            "Get",
            "WrapKey",
            "UnwrapKey",
        ],
    });
    const exampleWorkspaceKey = new azure.synapse.WorkspaceKey("exampleWorkspaceKey", {
        customerManagedKeyVersionlessId: exampleKey.versionlessId,
        synapseWorkspaceId: exampleWorkspace.id,
        active: true,
        customerManagedKeyName: "enckey",
    }, {
        dependsOn: [workspacePolicy],
    });
    const exampleWorkspaceAadAdmin = new azure.synapse.WorkspaceAadAdmin("exampleWorkspaceAadAdmin", {
        synapseWorkspaceId: exampleWorkspace.id,
        login: "AzureAD Admin",
        objectId: "00000000-0000-0000-0000-000000000000",
        tenantId: "00000000-0000-0000-0000-000000000000",
    }, {
        dependsOn: [exampleWorkspaceKey],
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleAccount:
        type: azure:storage:Account
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.location}
          accountTier: Standard
          accountReplicationType: LRS
          accountKind: StorageV2
          isHnsEnabled: 'true'
      exampleDataLakeGen2Filesystem:
        type: azure:storage:DataLakeGen2Filesystem
        properties:
          storageAccountId: ${exampleAccount.id}
      exampleKeyVault:
        type: azure:keyvault:KeyVault
        properties:
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
          tenantId: ${current.tenantId}
          skuName: standard
          purgeProtectionEnabled: true
      deployer:
        type: azure:keyvault:AccessPolicy
        properties:
          keyVaultId: ${exampleKeyVault.id}
          tenantId: ${current.tenantId}
          objectId: ${current.objectId}
          keyPermissions:
            - Create
            - Get
            - Delete
            - Purge
            - GetRotationPolicy
      exampleKey:
        type: azure:keyvault:Key
        properties:
          keyVaultId: ${exampleKeyVault.id}
          keyType: RSA
          keySize: 2048
          keyOpts:
            - unwrapKey
            - wrapKey
        options:
          dependson:
            - ${deployer}
      exampleWorkspace:
        type: azure:synapse:Workspace
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.location}
          storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
          sqlAdministratorLogin: sqladminuser
          sqlAdministratorLoginPassword: H@Sh1CoR3!
          customerManagedKey:
            keyVersionlessId: ${exampleKey.versionlessId}
            keyName: enckey
          identity:
            type: SystemAssigned
          tags:
            Env: production
      workspacePolicy:
        type: azure:keyvault:AccessPolicy
        properties:
          keyVaultId: ${exampleKeyVault.id}
          tenantId: ${exampleWorkspace.identity.tenantId}
          objectId: ${exampleWorkspace.identity.principalId}
          keyPermissions:
            - Get
            - WrapKey
            - UnwrapKey
      exampleWorkspaceKey:
        type: azure:synapse:WorkspaceKey
        properties:
          customerManagedKeyVersionlessId: ${exampleKey.versionlessId}
          synapseWorkspaceId: ${exampleWorkspace.id}
          active: true
          customerManagedKeyName: enckey
        options:
          dependson:
            - ${workspacePolicy}
      exampleWorkspaceAadAdmin:
        type: azure:synapse:WorkspaceAadAdmin
        properties:
          synapseWorkspaceId: ${exampleWorkspace.id}
          login: AzureAD Admin
          objectId: 00000000-0000-0000-0000-000000000000
          tenantId: 00000000-0000-0000-0000-000000000000
        options:
          dependson:
            - ${exampleWorkspaceKey}
    variables:
      current:
        fn::invoke:
          Function: azure:core:getClientConfig
          Arguments: {}
    

    Create Workspace Resource

    new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);
    @overload
    def Workspace(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  aad_admin: Optional[WorkspaceAadAdminArgs] = None,
                  azure_devops_repo: Optional[WorkspaceAzureDevopsRepoArgs] = None,
                  compute_subnet_id: Optional[str] = None,
                  customer_managed_key: Optional[WorkspaceCustomerManagedKeyArgs] = None,
                  data_exfiltration_protection_enabled: Optional[bool] = None,
                  github_repo: Optional[WorkspaceGithubRepoArgs] = None,
                  identity: Optional[WorkspaceIdentityArgs] = None,
                  linking_allowed_for_aad_tenant_ids: Optional[Sequence[str]] = None,
                  location: Optional[str] = None,
                  managed_resource_group_name: Optional[str] = None,
                  managed_virtual_network_enabled: Optional[bool] = None,
                  name: Optional[str] = None,
                  public_network_access_enabled: Optional[bool] = None,
                  purview_id: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  sql_aad_admin: Optional[WorkspaceSqlAadAdminArgs] = None,
                  sql_administrator_login: Optional[str] = None,
                  sql_administrator_login_password: Optional[str] = None,
                  sql_identity_control_enabled: Optional[bool] = None,
                  storage_data_lake_gen2_filesystem_id: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
    @overload
    def Workspace(resource_name: str,
                  args: WorkspaceArgs,
                  opts: Optional[ResourceOptions] = None)
    func NewWorkspace(ctx *Context, name string, args WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)
    public Workspace(string name, WorkspaceArgs args, CustomResourceOptions? opts = null)
    public Workspace(String name, WorkspaceArgs args)
    public Workspace(String name, WorkspaceArgs args, CustomResourceOptions options)
    
    type: azure:synapse:Workspace
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Workspace Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Workspace resource accepts the following input properties:

    ResourceGroupName string

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    StorageDataLakeGen2FilesystemId string

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    AadAdmin WorkspaceAadAdmin

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    AzureDevopsRepo WorkspaceAzureDevopsRepo

    An azure_devops_repo block as defined below.

    ComputeSubnetId string

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    CustomerManagedKey WorkspaceCustomerManagedKey

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    DataExfiltrationProtectionEnabled bool

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    GithubRepo WorkspaceGithubRepo

    A github_repo block as defined below.

    Identity WorkspaceIdentity

    An identity block as defined below.

    LinkingAllowedForAadTenantIds List<string>

    Allowed AAD Tenant Ids For Linking.

    Location string

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    ManagedResourceGroupName string

    Workspace managed resource group. Changing this forces a new resource to be created.

    ManagedVirtualNetworkEnabled bool

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    Name string

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    PublicNetworkAccessEnabled bool

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    PurviewId string

    The ID of purview account.

    SqlAadAdmin WorkspaceSqlAadAdmin

    An sql_aad_admin block as defined below.

    SqlAdministratorLogin string

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    SqlAdministratorLoginPassword string

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    SqlIdentityControlEnabled bool

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    Tags Dictionary<string, string>

    A mapping of tags which should be assigned to the Synapse Workspace.

    ResourceGroupName string

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    StorageDataLakeGen2FilesystemId string

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    AadAdmin WorkspaceAadAdminTypeArgs

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    AzureDevopsRepo WorkspaceAzureDevopsRepoArgs

    An azure_devops_repo block as defined below.

    ComputeSubnetId string

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    CustomerManagedKey WorkspaceCustomerManagedKeyArgs

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    DataExfiltrationProtectionEnabled bool

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    GithubRepo WorkspaceGithubRepoArgs

    A github_repo block as defined below.

    Identity WorkspaceIdentityArgs

    An identity block as defined below.

    LinkingAllowedForAadTenantIds []string

    Allowed AAD Tenant Ids For Linking.

    Location string

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    ManagedResourceGroupName string

    Workspace managed resource group. Changing this forces a new resource to be created.

    ManagedVirtualNetworkEnabled bool

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    Name string

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    PublicNetworkAccessEnabled bool

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    PurviewId string

    The ID of purview account.

    SqlAadAdmin WorkspaceSqlAadAdminTypeArgs

    An sql_aad_admin block as defined below.

    SqlAdministratorLogin string

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    SqlAdministratorLoginPassword string

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    SqlIdentityControlEnabled bool

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    Tags map[string]string

    A mapping of tags which should be assigned to the Synapse Workspace.

    resourceGroupName String

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    storageDataLakeGen2FilesystemId String

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    aadAdmin WorkspaceAadAdmin

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    azureDevopsRepo WorkspaceAzureDevopsRepo

    An azure_devops_repo block as defined below.

    computeSubnetId String

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    customerManagedKey WorkspaceCustomerManagedKey

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    dataExfiltrationProtectionEnabled Boolean

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    githubRepo WorkspaceGithubRepo

    A github_repo block as defined below.

    identity WorkspaceIdentity

    An identity block as defined below.

    linkingAllowedForAadTenantIds List<String>

    Allowed AAD Tenant Ids For Linking.

    location String

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    managedResourceGroupName String

    Workspace managed resource group. Changing this forces a new resource to be created.

    managedVirtualNetworkEnabled Boolean

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    name String

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    publicNetworkAccessEnabled Boolean

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    purviewId String

    The ID of purview account.

    sqlAadAdmin WorkspaceSqlAadAdmin

    An sql_aad_admin block as defined below.

    sqlAdministratorLogin String

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlAdministratorLoginPassword String

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlIdentityControlEnabled Boolean

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    tags Map<String,String>

    A mapping of tags which should be assigned to the Synapse Workspace.

    resourceGroupName string

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    storageDataLakeGen2FilesystemId string

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    aadAdmin WorkspaceAadAdmin

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    azureDevopsRepo WorkspaceAzureDevopsRepo

    An azure_devops_repo block as defined below.

    computeSubnetId string

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    customerManagedKey WorkspaceCustomerManagedKey

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    dataExfiltrationProtectionEnabled boolean

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    githubRepo WorkspaceGithubRepo

    A github_repo block as defined below.

    identity WorkspaceIdentity

    An identity block as defined below.

    linkingAllowedForAadTenantIds string[]

    Allowed AAD Tenant Ids For Linking.

    location string

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    managedResourceGroupName string

    Workspace managed resource group. Changing this forces a new resource to be created.

    managedVirtualNetworkEnabled boolean

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    name string

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    publicNetworkAccessEnabled boolean

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    purviewId string

    The ID of purview account.

    sqlAadAdmin WorkspaceSqlAadAdmin

    An sql_aad_admin block as defined below.

    sqlAdministratorLogin string

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlAdministratorLoginPassword string

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlIdentityControlEnabled boolean

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    tags {[key: string]: string}

    A mapping of tags which should be assigned to the Synapse Workspace.

    resource_group_name str

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    storage_data_lake_gen2_filesystem_id str

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    aad_admin WorkspaceAadAdminArgs

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    azure_devops_repo WorkspaceAzureDevopsRepoArgs

    An azure_devops_repo block as defined below.

    compute_subnet_id str

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    customer_managed_key WorkspaceCustomerManagedKeyArgs

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    data_exfiltration_protection_enabled bool

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    github_repo WorkspaceGithubRepoArgs

    A github_repo block as defined below.

    identity WorkspaceIdentityArgs

    An identity block as defined below.

    linking_allowed_for_aad_tenant_ids Sequence[str]

    Allowed AAD Tenant Ids For Linking.

    location str

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    managed_resource_group_name str

    Workspace managed resource group. Changing this forces a new resource to be created.

    managed_virtual_network_enabled bool

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    name str

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    public_network_access_enabled bool

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    purview_id str

    The ID of purview account.

    sql_aad_admin WorkspaceSqlAadAdminArgs

    An sql_aad_admin block as defined below.

    sql_administrator_login str

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    sql_administrator_login_password str

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    sql_identity_control_enabled bool

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    tags Mapping[str, str]

    A mapping of tags which should be assigned to the Synapse Workspace.

    resourceGroupName String

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    storageDataLakeGen2FilesystemId String

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    aadAdmin Property Map

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    azureDevopsRepo Property Map

    An azure_devops_repo block as defined below.

    computeSubnetId String

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    customerManagedKey Property Map

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    dataExfiltrationProtectionEnabled Boolean

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    githubRepo Property Map

    A github_repo block as defined below.

    identity Property Map

    An identity block as defined below.

    linkingAllowedForAadTenantIds List<String>

    Allowed AAD Tenant Ids For Linking.

    location String

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    managedResourceGroupName String

    Workspace managed resource group. Changing this forces a new resource to be created.

    managedVirtualNetworkEnabled Boolean

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    name String

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    publicNetworkAccessEnabled Boolean

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    purviewId String

    The ID of purview account.

    sqlAadAdmin Property Map

    An sql_aad_admin block as defined below.

    sqlAdministratorLogin String

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlAdministratorLoginPassword String

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlIdentityControlEnabled Boolean

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    tags Map<String>

    A mapping of tags which should be assigned to the Synapse Workspace.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Workspace resource produces the following output properties:

    ConnectivityEndpoints Dictionary<string, string>

    A list of Connectivity endpoints for this Synapse Workspace.

    Id string

    The provider-assigned unique ID for this managed resource.

    ConnectivityEndpoints map[string]string

    A list of Connectivity endpoints for this Synapse Workspace.

    Id string

    The provider-assigned unique ID for this managed resource.

    connectivityEndpoints Map<String,String>

    A list of Connectivity endpoints for this Synapse Workspace.

    id String

    The provider-assigned unique ID for this managed resource.

    connectivityEndpoints {[key: string]: string}

    A list of Connectivity endpoints for this Synapse Workspace.

    id string

    The provider-assigned unique ID for this managed resource.

    connectivity_endpoints Mapping[str, str]

    A list of Connectivity endpoints for this Synapse Workspace.

    id str

    The provider-assigned unique ID for this managed resource.

    connectivityEndpoints Map<String>

    A list of Connectivity endpoints for this Synapse Workspace.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing Workspace Resource

    Get an existing Workspace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkspaceState, opts?: CustomResourceOptions): Workspace
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            aad_admin: Optional[WorkspaceAadAdminArgs] = None,
            azure_devops_repo: Optional[WorkspaceAzureDevopsRepoArgs] = None,
            compute_subnet_id: Optional[str] = None,
            connectivity_endpoints: Optional[Mapping[str, str]] = None,
            customer_managed_key: Optional[WorkspaceCustomerManagedKeyArgs] = None,
            data_exfiltration_protection_enabled: Optional[bool] = None,
            github_repo: Optional[WorkspaceGithubRepoArgs] = None,
            identity: Optional[WorkspaceIdentityArgs] = None,
            linking_allowed_for_aad_tenant_ids: Optional[Sequence[str]] = None,
            location: Optional[str] = None,
            managed_resource_group_name: Optional[str] = None,
            managed_virtual_network_enabled: Optional[bool] = None,
            name: Optional[str] = None,
            public_network_access_enabled: Optional[bool] = None,
            purview_id: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            sql_aad_admin: Optional[WorkspaceSqlAadAdminArgs] = None,
            sql_administrator_login: Optional[str] = None,
            sql_administrator_login_password: Optional[str] = None,
            sql_identity_control_enabled: Optional[bool] = None,
            storage_data_lake_gen2_filesystem_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> Workspace
    func GetWorkspace(ctx *Context, name string, id IDInput, state *WorkspaceState, opts ...ResourceOption) (*Workspace, error)
    public static Workspace Get(string name, Input<string> id, WorkspaceState? state, CustomResourceOptions? opts = null)
    public static Workspace get(String name, Output<String> id, WorkspaceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AadAdmin WorkspaceAadAdmin

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    AzureDevopsRepo WorkspaceAzureDevopsRepo

    An azure_devops_repo block as defined below.

    ComputeSubnetId string

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    ConnectivityEndpoints Dictionary<string, string>

    A list of Connectivity endpoints for this Synapse Workspace.

    CustomerManagedKey WorkspaceCustomerManagedKey

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    DataExfiltrationProtectionEnabled bool

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    GithubRepo WorkspaceGithubRepo

    A github_repo block as defined below.

    Identity WorkspaceIdentity

    An identity block as defined below.

    LinkingAllowedForAadTenantIds List<string>

    Allowed AAD Tenant Ids For Linking.

    Location string

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    ManagedResourceGroupName string

    Workspace managed resource group. Changing this forces a new resource to be created.

    ManagedVirtualNetworkEnabled bool

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    Name string

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    PublicNetworkAccessEnabled bool

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    PurviewId string

    The ID of purview account.

    ResourceGroupName string

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    SqlAadAdmin WorkspaceSqlAadAdmin

    An sql_aad_admin block as defined below.

    SqlAdministratorLogin string

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    SqlAdministratorLoginPassword string

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    SqlIdentityControlEnabled bool

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    StorageDataLakeGen2FilesystemId string

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    Tags Dictionary<string, string>

    A mapping of tags which should be assigned to the Synapse Workspace.

    AadAdmin WorkspaceAadAdminTypeArgs

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    AzureDevopsRepo WorkspaceAzureDevopsRepoArgs

    An azure_devops_repo block as defined below.

    ComputeSubnetId string

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    ConnectivityEndpoints map[string]string

    A list of Connectivity endpoints for this Synapse Workspace.

    CustomerManagedKey WorkspaceCustomerManagedKeyArgs

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    DataExfiltrationProtectionEnabled bool

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    GithubRepo WorkspaceGithubRepoArgs

    A github_repo block as defined below.

    Identity WorkspaceIdentityArgs

    An identity block as defined below.

    LinkingAllowedForAadTenantIds []string

    Allowed AAD Tenant Ids For Linking.

    Location string

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    ManagedResourceGroupName string

    Workspace managed resource group. Changing this forces a new resource to be created.

    ManagedVirtualNetworkEnabled bool

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    Name string

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    PublicNetworkAccessEnabled bool

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    PurviewId string

    The ID of purview account.

    ResourceGroupName string

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    SqlAadAdmin WorkspaceSqlAadAdminTypeArgs

    An sql_aad_admin block as defined below.

    SqlAdministratorLogin string

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    SqlAdministratorLoginPassword string

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    SqlIdentityControlEnabled bool

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    StorageDataLakeGen2FilesystemId string

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    Tags map[string]string

    A mapping of tags which should be assigned to the Synapse Workspace.

    aadAdmin WorkspaceAadAdmin

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    azureDevopsRepo WorkspaceAzureDevopsRepo

    An azure_devops_repo block as defined below.

    computeSubnetId String

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    connectivityEndpoints Map<String,String>

    A list of Connectivity endpoints for this Synapse Workspace.

    customerManagedKey WorkspaceCustomerManagedKey

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    dataExfiltrationProtectionEnabled Boolean

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    githubRepo WorkspaceGithubRepo

    A github_repo block as defined below.

    identity WorkspaceIdentity

    An identity block as defined below.

    linkingAllowedForAadTenantIds List<String>

    Allowed AAD Tenant Ids For Linking.

    location String

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    managedResourceGroupName String

    Workspace managed resource group. Changing this forces a new resource to be created.

    managedVirtualNetworkEnabled Boolean

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    name String

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    publicNetworkAccessEnabled Boolean

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    purviewId String

    The ID of purview account.

    resourceGroupName String

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    sqlAadAdmin WorkspaceSqlAadAdmin

    An sql_aad_admin block as defined below.

    sqlAdministratorLogin String

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlAdministratorLoginPassword String

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlIdentityControlEnabled Boolean

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    storageDataLakeGen2FilesystemId String

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    tags Map<String,String>

    A mapping of tags which should be assigned to the Synapse Workspace.

    aadAdmin WorkspaceAadAdmin

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    azureDevopsRepo WorkspaceAzureDevopsRepo

    An azure_devops_repo block as defined below.

    computeSubnetId string

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    connectivityEndpoints {[key: string]: string}

    A list of Connectivity endpoints for this Synapse Workspace.

    customerManagedKey WorkspaceCustomerManagedKey

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    dataExfiltrationProtectionEnabled boolean

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    githubRepo WorkspaceGithubRepo

    A github_repo block as defined below.

    identity WorkspaceIdentity

    An identity block as defined below.

    linkingAllowedForAadTenantIds string[]

    Allowed AAD Tenant Ids For Linking.

    location string

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    managedResourceGroupName string

    Workspace managed resource group. Changing this forces a new resource to be created.

    managedVirtualNetworkEnabled boolean

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    name string

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    publicNetworkAccessEnabled boolean

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    purviewId string

    The ID of purview account.

    resourceGroupName string

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    sqlAadAdmin WorkspaceSqlAadAdmin

    An sql_aad_admin block as defined below.

    sqlAdministratorLogin string

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlAdministratorLoginPassword string

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlIdentityControlEnabled boolean

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    storageDataLakeGen2FilesystemId string

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    tags {[key: string]: string}

    A mapping of tags which should be assigned to the Synapse Workspace.

    aad_admin WorkspaceAadAdminArgs

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    azure_devops_repo WorkspaceAzureDevopsRepoArgs

    An azure_devops_repo block as defined below.

    compute_subnet_id str

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    connectivity_endpoints Mapping[str, str]

    A list of Connectivity endpoints for this Synapse Workspace.

    customer_managed_key WorkspaceCustomerManagedKeyArgs

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    data_exfiltration_protection_enabled bool

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    github_repo WorkspaceGithubRepoArgs

    A github_repo block as defined below.

    identity WorkspaceIdentityArgs

    An identity block as defined below.

    linking_allowed_for_aad_tenant_ids Sequence[str]

    Allowed AAD Tenant Ids For Linking.

    location str

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    managed_resource_group_name str

    Workspace managed resource group. Changing this forces a new resource to be created.

    managed_virtual_network_enabled bool

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    name str

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    public_network_access_enabled bool

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    purview_id str

    The ID of purview account.

    resource_group_name str

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    sql_aad_admin WorkspaceSqlAadAdminArgs

    An sql_aad_admin block as defined below.

    sql_administrator_login str

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    sql_administrator_login_password str

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    sql_identity_control_enabled bool

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    storage_data_lake_gen2_filesystem_id str

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    tags Mapping[str, str]

    A mapping of tags which should be assigned to the Synapse Workspace.

    aadAdmin Property Map

    An aad_admin block as defined below. Conflicts with customer_managed_key.

    azureDevopsRepo Property Map

    An azure_devops_repo block as defined below.

    computeSubnetId String

    Subnet ID used for computes in workspace Changing this forces a new resource to be created.

    connectivityEndpoints Map<String>

    A list of Connectivity endpoints for this Synapse Workspace.

    customerManagedKey Property Map

    A customer_managed_key block as defined below. Conflicts with aad_admin.

    dataExfiltrationProtectionEnabled Boolean

    Is data exfiltration protection enabled in this workspace? If set to true, managed_virtual_network_enabled must also be set to true. Changing this forces a new resource to be created.

    githubRepo Property Map

    A github_repo block as defined below.

    identity Property Map

    An identity block as defined below.

    linkingAllowedForAadTenantIds List<String>

    Allowed AAD Tenant Ids For Linking.

    location String

    Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.

    managedResourceGroupName String

    Workspace managed resource group. Changing this forces a new resource to be created.

    managedVirtualNetworkEnabled Boolean

    Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.

    name String

    Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.

    publicNetworkAccessEnabled Boolean

    Whether public network access is allowed for the Cognitive Account. Defaults to true.

    purviewId String

    The ID of purview account.

    resourceGroupName String

    Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.

    sqlAadAdmin Property Map

    An sql_aad_admin block as defined below.

    sqlAdministratorLogin String

    Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlAdministratorLoginPassword String

    The Password associated with the sql_administrator_login for the SQL administrator. If this is not provided aad_admin or customer_managed_key must be provided.

    sqlIdentityControlEnabled Boolean

    Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?

    storageDataLakeGen2FilesystemId String

    Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.

    tags Map<String>

    A mapping of tags which should be assigned to the Synapse Workspace.

    Supporting Types

    WorkspaceAadAdmin, WorkspaceAadAdminArgs

    Login string

    The login name of the Azure AD Administrator of this Synapse Workspace.

    ObjectId string

    The object id of the Azure AD Administrator of this Synapse Workspace.

    TenantId string

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    Login string

    The login name of the Azure AD Administrator of this Synapse Workspace.

    ObjectId string

    The object id of the Azure AD Administrator of this Synapse Workspace.

    TenantId string

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    login String

    The login name of the Azure AD Administrator of this Synapse Workspace.

    objectId String

    The object id of the Azure AD Administrator of this Synapse Workspace.

    tenantId String

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    login string

    The login name of the Azure AD Administrator of this Synapse Workspace.

    objectId string

    The object id of the Azure AD Administrator of this Synapse Workspace.

    tenantId string

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    login str

    The login name of the Azure AD Administrator of this Synapse Workspace.

    object_id str

    The object id of the Azure AD Administrator of this Synapse Workspace.

    tenant_id str

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    login String

    The login name of the Azure AD Administrator of this Synapse Workspace.

    objectId String

    The object id of the Azure AD Administrator of this Synapse Workspace.

    tenantId String

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    WorkspaceAzureDevopsRepo, WorkspaceAzureDevopsRepoArgs

    AccountName string

    Specifies the Azure DevOps account name.

    BranchName string

    Specifies the collaboration branch of the repository to get code from.

    ProjectName string

    Specifies the name of the Azure DevOps project.

    RepositoryName string

    Specifies the name of the git repository.

    RootFolder string

    Specifies the root folder within the repository. Set to / for the top level.

    LastCommitId string

    The last commit ID.

    TenantId string

    the ID of the tenant for the Azure DevOps account.

    AccountName string

    Specifies the Azure DevOps account name.

    BranchName string

    Specifies the collaboration branch of the repository to get code from.

    ProjectName string

    Specifies the name of the Azure DevOps project.

    RepositoryName string

    Specifies the name of the git repository.

    RootFolder string

    Specifies the root folder within the repository. Set to / for the top level.

    LastCommitId string

    The last commit ID.

    TenantId string

    the ID of the tenant for the Azure DevOps account.

    accountName String

    Specifies the Azure DevOps account name.

    branchName String

    Specifies the collaboration branch of the repository to get code from.

    projectName String

    Specifies the name of the Azure DevOps project.

    repositoryName String

    Specifies the name of the git repository.

    rootFolder String

    Specifies the root folder within the repository. Set to / for the top level.

    lastCommitId String

    The last commit ID.

    tenantId String

    the ID of the tenant for the Azure DevOps account.

    accountName string

    Specifies the Azure DevOps account name.

    branchName string

    Specifies the collaboration branch of the repository to get code from.

    projectName string

    Specifies the name of the Azure DevOps project.

    repositoryName string

    Specifies the name of the git repository.

    rootFolder string

    Specifies the root folder within the repository. Set to / for the top level.

    lastCommitId string

    The last commit ID.

    tenantId string

    the ID of the tenant for the Azure DevOps account.

    account_name str

    Specifies the Azure DevOps account name.

    branch_name str

    Specifies the collaboration branch of the repository to get code from.

    project_name str

    Specifies the name of the Azure DevOps project.

    repository_name str

    Specifies the name of the git repository.

    root_folder str

    Specifies the root folder within the repository. Set to / for the top level.

    last_commit_id str

    The last commit ID.

    tenant_id str

    the ID of the tenant for the Azure DevOps account.

    accountName String

    Specifies the Azure DevOps account name.

    branchName String

    Specifies the collaboration branch of the repository to get code from.

    projectName String

    Specifies the name of the Azure DevOps project.

    repositoryName String

    Specifies the name of the git repository.

    rootFolder String

    Specifies the root folder within the repository. Set to / for the top level.

    lastCommitId String

    The last commit ID.

    tenantId String

    the ID of the tenant for the Azure DevOps account.

    WorkspaceCustomerManagedKey, WorkspaceCustomerManagedKeyArgs

    KeyVersionlessId string

    The Azure Key Vault Key Versionless ID to be used as the Customer Managed Key (CMK) for double encryption (e.g. https://example-keyvault.vault.azure.net/type/cmk/).

    KeyName string

    An identifier for the key. Name needs to match the name of the key used with the azure.synapse.WorkspaceKey resource. Defaults to "cmk" if not specified.

    KeyVersionlessId string

    The Azure Key Vault Key Versionless ID to be used as the Customer Managed Key (CMK) for double encryption (e.g. https://example-keyvault.vault.azure.net/type/cmk/).

    KeyName string

    An identifier for the key. Name needs to match the name of the key used with the azure.synapse.WorkspaceKey resource. Defaults to "cmk" if not specified.

    keyVersionlessId String

    The Azure Key Vault Key Versionless ID to be used as the Customer Managed Key (CMK) for double encryption (e.g. https://example-keyvault.vault.azure.net/type/cmk/).

    keyName String

    An identifier for the key. Name needs to match the name of the key used with the azure.synapse.WorkspaceKey resource. Defaults to "cmk" if not specified.

    keyVersionlessId string

    The Azure Key Vault Key Versionless ID to be used as the Customer Managed Key (CMK) for double encryption (e.g. https://example-keyvault.vault.azure.net/type/cmk/).

    keyName string

    An identifier for the key. Name needs to match the name of the key used with the azure.synapse.WorkspaceKey resource. Defaults to "cmk" if not specified.

    key_versionless_id str

    The Azure Key Vault Key Versionless ID to be used as the Customer Managed Key (CMK) for double encryption (e.g. https://example-keyvault.vault.azure.net/type/cmk/).

    key_name str

    An identifier for the key. Name needs to match the name of the key used with the azure.synapse.WorkspaceKey resource. Defaults to "cmk" if not specified.

    keyVersionlessId String

    The Azure Key Vault Key Versionless ID to be used as the Customer Managed Key (CMK) for double encryption (e.g. https://example-keyvault.vault.azure.net/type/cmk/).

    keyName String

    An identifier for the key. Name needs to match the name of the key used with the azure.synapse.WorkspaceKey resource. Defaults to "cmk" if not specified.

    WorkspaceGithubRepo, WorkspaceGithubRepoArgs

    AccountName string

    Specifies the GitHub account name.

    BranchName string

    Specifies the collaboration branch of the repository to get code from.

    RepositoryName string

    Specifies the name of the git repository.

    RootFolder string

    Specifies the root folder within the repository. Set to / for the top level.

    GitUrl string

    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com.

    Note: You must log in to the Synapse UI to complete the authentication to the GitHub repository.

    LastCommitId string

    The last commit ID.

    AccountName string

    Specifies the GitHub account name.

    BranchName string

    Specifies the collaboration branch of the repository to get code from.

    RepositoryName string

    Specifies the name of the git repository.

    RootFolder string

    Specifies the root folder within the repository. Set to / for the top level.

    GitUrl string

    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com.

    Note: You must log in to the Synapse UI to complete the authentication to the GitHub repository.

    LastCommitId string

    The last commit ID.

    accountName String

    Specifies the GitHub account name.

    branchName String

    Specifies the collaboration branch of the repository to get code from.

    repositoryName String

    Specifies the name of the git repository.

    rootFolder String

    Specifies the root folder within the repository. Set to / for the top level.

    gitUrl String

    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com.

    Note: You must log in to the Synapse UI to complete the authentication to the GitHub repository.

    lastCommitId String

    The last commit ID.

    accountName string

    Specifies the GitHub account name.

    branchName string

    Specifies the collaboration branch of the repository to get code from.

    repositoryName string

    Specifies the name of the git repository.

    rootFolder string

    Specifies the root folder within the repository. Set to / for the top level.

    gitUrl string

    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com.

    Note: You must log in to the Synapse UI to complete the authentication to the GitHub repository.

    lastCommitId string

    The last commit ID.

    account_name str

    Specifies the GitHub account name.

    branch_name str

    Specifies the collaboration branch of the repository to get code from.

    repository_name str

    Specifies the name of the git repository.

    root_folder str

    Specifies the root folder within the repository. Set to / for the top level.

    git_url str

    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com.

    Note: You must log in to the Synapse UI to complete the authentication to the GitHub repository.

    last_commit_id str

    The last commit ID.

    accountName String

    Specifies the GitHub account name.

    branchName String

    Specifies the collaboration branch of the repository to get code from.

    repositoryName String

    Specifies the name of the git repository.

    rootFolder String

    Specifies the root folder within the repository. Set to / for the top level.

    gitUrl String

    Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com.

    Note: You must log in to the Synapse UI to complete the authentication to the GitHub repository.

    lastCommitId String

    The last commit ID.

    WorkspaceIdentity, WorkspaceIdentityArgs

    Type string

    Specifies the type of Managed Service Identity that should be associated with this Synapse Workspace. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned (to enable both).

    IdentityIds List<string>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Synapse Workspace.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string

    The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

    TenantId string

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    Type string

    Specifies the type of Managed Service Identity that should be associated with this Synapse Workspace. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned (to enable both).

    IdentityIds []string

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Synapse Workspace.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string

    The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

    TenantId string

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    type String

    Specifies the type of Managed Service Identity that should be associated with this Synapse Workspace. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned (to enable both).

    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Synapse Workspace.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String

    The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

    tenantId String

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    type string

    Specifies the type of Managed Service Identity that should be associated with this Synapse Workspace. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned (to enable both).

    identityIds string[]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Synapse Workspace.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId string

    The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

    tenantId string

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    type str

    Specifies the type of Managed Service Identity that should be associated with this Synapse Workspace. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned (to enable both).

    identity_ids Sequence[str]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Synapse Workspace.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principal_id str

    The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

    tenant_id str

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    type String

    Specifies the type of Managed Service Identity that should be associated with this Synapse Workspace. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned (to enable both).

    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Synapse Workspace.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String

    The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

    tenantId String

    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    WorkspaceSqlAadAdmin, WorkspaceSqlAadAdminArgs

    Login string

    The login name of the Azure AD Administrator of this Synapse Workspace SQL.

    ObjectId string

    The object id of the Azure AD Administrator of this Synapse Workspace SQL.

    TenantId string

    The tenant id of the Azure AD Administrator of this Synapse Workspace SQL.

    Login string

    The login name of the Azure AD Administrator of this Synapse Workspace SQL.

    ObjectId string

    The object id of the Azure AD Administrator of this Synapse Workspace SQL.

    TenantId string

    The tenant id of the Azure AD Administrator of this Synapse Workspace SQL.

    login String

    The login name of the Azure AD Administrator of this Synapse Workspace SQL.

    objectId String

    The object id of the Azure AD Administrator of this Synapse Workspace SQL.

    tenantId String

    The tenant id of the Azure AD Administrator of this Synapse Workspace SQL.

    login string

    The login name of the Azure AD Administrator of this Synapse Workspace SQL.

    objectId string

    The object id of the Azure AD Administrator of this Synapse Workspace SQL.

    tenantId string

    The tenant id of the Azure AD Administrator of this Synapse Workspace SQL.

    login str

    The login name of the Azure AD Administrator of this Synapse Workspace SQL.

    object_id str

    The object id of the Azure AD Administrator of this Synapse Workspace SQL.

    tenant_id str

    The tenant id of the Azure AD Administrator of this Synapse Workspace SQL.

    login String

    The login name of the Azure AD Administrator of this Synapse Workspace SQL.

    objectId String

    The object id of the Azure AD Administrator of this Synapse Workspace SQL.

    tenantId String

    The tenant id of the Azure AD Administrator of this Synapse Workspace SQL.

    Import

    Synapse Workspace can be imported using the resource id, e.g.

     $ pulumi import azure:synapse/workspace:Workspace example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Synapse/workspaces/workspace1
    

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi