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

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.synapse.Workspace

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a Synapse Workspace.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
            AccountKind = "StorageV2",
            IsHnsEnabled = true,
        });
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new Azure.Storage.DataLakeGen2FilesystemArgs
        {
            StorageAccountId = exampleAccount.Id,
        });
        var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new Azure.Synapse.WorkspaceArgs
        {
            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",
            },
            Tags = 
            {
                { "Env", "production" },
            },
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
	"github.com/pulumi/pulumi-azure/sdk/v4/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.WorkspaceAadAdminArgs{
				Login:    pulumi.String("AzureAD Admin"),
				ObjectId: pulumi.String("00000000-0000-0000-0000-000000000000"),
				TenantId: pulumi.String("00000000-0000-0000-0000-000000000000"),
			},
			Tags: pulumi.StringMap{
				"Env": pulumi.String("production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    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",
    },
    tags: {
        Env: "production",
    },
});

    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",
    ),
    tags={
        "Env": "production",
    })

    Example coming soon!

    Creating A Workspace With Customer Managed Key And Azure AD Admin

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var current = Output.Create(Azure.Core.GetClientConfig.InvokeAsync());
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
            AccountKind = "StorageV2",
            IsHnsEnabled = true,
        });
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new Azure.Storage.DataLakeGen2FilesystemArgs
        {
            StorageAccountId = exampleAccount.Id,
        });
        var exampleKeyVault = new Azure.KeyVault.KeyVault("exampleKeyVault", new Azure.KeyVault.KeyVaultArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            TenantId = current.Apply(current => current.TenantId),
            SkuName = "standard",
            PurgeProtectionEnabled = true,
        });
        var deployer = new Azure.KeyVault.AccessPolicy("deployer", new Azure.KeyVault.AccessPolicyArgs
        {
            KeyVaultId = exampleKeyVault.Id,
            TenantId = current.Apply(current => current.TenantId),
            ObjectId = current.Apply(current => current.ObjectId),
            KeyPermissions = 
            {
                "create",
                "get",
                "delete",
                "purge",
            },
        });
        var exampleKey = new Azure.KeyVault.Key("exampleKey", new Azure.KeyVault.KeyArgs
        {
            KeyVaultId = exampleKeyVault.Id,
            KeyType = "RSA",
            KeySize = 2048,
            KeyOpts = 
            {
                "unwrapKey",
                "wrapKey",
            },
        }, new CustomResourceOptions
        {
            DependsOn = 
            {
                deployer,
            },
        });
        var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new Azure.Synapse.WorkspaceArgs
        {
            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",
            },
            Tags = 
            {
                { "Env", "production" },
            },
        });
        var workspacePolicy = new Azure.KeyVault.AccessPolicy("workspacePolicy", new Azure.KeyVault.AccessPolicyArgs
        {
            KeyVaultId = exampleKeyVault.Id,
            TenantId = exampleWorkspace.Identities.Apply(identities => identities[0].TenantId),
            ObjectId = exampleWorkspace.Identities.Apply(identities => identities[0].PrincipalId),
            KeyPermissions = 
            {
                "Get",
                "WrapKey",
                "UnwrapKey",
            },
        });
        var exampleWorkspaceKey = new Azure.Synapse.WorkspaceKey("exampleWorkspaceKey", new Azure.Synapse.WorkspaceKeyArgs
        {
            CustomerManagedKeyVersionlessId = exampleKey.VersionlessId,
            SynapseWorkspaceId = exampleWorkspace.Id,
            Active = true,
            CustomerManagedKeyName = "enckey",
        }, new CustomResourceOptions
        {
            DependsOn = 
            {
                workspacePolicy,
            },
        });
        var exampleWorkspaceAadAdmin = new Azure.Synapse.WorkspaceAadAdmin("exampleWorkspaceAadAdmin", new Azure.Synapse.WorkspaceAadAdminArgs
        {
            SynapseWorkspaceId = exampleWorkspace.Id,
            Login = "AzureAD Admin",
            ObjectId = "00000000-0000-0000-0000-000000000000",
            TenantId = "00000000-0000-0000-0000-000000000000",
        }, new CustomResourceOptions
        {
            DependsOn = 
            {
                exampleWorkspaceKey,
            },
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/keyvault"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
	"github.com/pulumi/pulumi-azure/sdk/v4/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"),
			},
		})
		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"),
			},
			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.Identities.ApplyT(func(identities []synapse.WorkspaceIdentity) (string, error) {
				return identities[0].TenantId, nil
			}).(pulumi.StringOutput),
			ObjectId: exampleWorkspace.Identities.ApplyT(func(identities []synapse.WorkspaceIdentity) (string, error) {
				return identities[0].PrincipalId, nil
			}).(pulumi.StringOutput),
			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
	})
}

    Example coming soon!

    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",
    ],
});
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",
    },
    tags: {
        Env: "production",
    },
});
const workspacePolicy = new azure.keyvault.AccessPolicy("workspacePolicy", {
    keyVaultId: exampleKeyVault.id,
    tenantId: exampleWorkspace.identities.apply(identities => identities[0].tenantId),
    objectId: exampleWorkspace.identities.apply(identities => identities[0].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],
});

    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",
    ])
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",
    ),
    tags={
        "Env": "production",
    })
workspace_policy = azure.keyvault.AccessPolicy("workspacePolicy",
    key_vault_id=example_key_vault.id,
    tenant_id=example_workspace.identities[0].tenant_id,
    object_id=example_workspace.identities[0].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]))

    Example coming soon!

    Create Workspace Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);
    @overload
def Workspace(resource_name: str,
              args: WorkspaceArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Workspace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              resource_group_name: Optional[str] = None,
              storage_data_lake_gen2_filesystem_id: Optional[str] = None,
              sql_administrator_login_password: Optional[str] = None,
              sql_administrator_login: Optional[str] = None,
              github_repo: Optional[WorkspaceGithubRepoArgs] = None,
              public_network_access_enabled: Optional[bool] = 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,
              aad_admin: Optional[WorkspaceAadAdminArgs] = None,
              purview_id: Optional[str] = None,
              data_exfiltration_protection_enabled: Optional[bool] = None,
              sql_aad_admin: Optional[WorkspaceSqlAadAdminArgs] = None,
              customer_managed_key: Optional[WorkspaceCustomerManagedKeyArgs] = None,
              compute_subnet_id: Optional[str] = None,
              sql_identity_control_enabled: Optional[bool] = None,
              azure_devops_repo: Optional[WorkspaceAzureDevopsRepoArgs] = None,
              tags: Optional[Mapping[str, str]] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleworkspaceResourceResourceFromSynapseworkspace = new Azure.Synapse.Workspace("exampleworkspaceResourceResourceFromSynapseworkspace", new()
{
    ResourceGroupName = "string",
    StorageDataLakeGen2FilesystemId = "string",
    SqlAdministratorLoginPassword = "string",
    SqlAdministratorLogin = "string",
    GithubRepo = new Azure.Synapse.Inputs.WorkspaceGithubRepoArgs
    {
        AccountName = "string",
        BranchName = "string",
        RepositoryName = "string",
        RootFolder = "string",
        GitUrl = "string",
        LastCommitId = "string",
    },
    PublicNetworkAccessEnabled = false,
    LinkingAllowedForAadTenantIds = new[]
    {
        "string",
    },
    Location = "string",
    ManagedResourceGroupName = "string",
    ManagedVirtualNetworkEnabled = false,
    Name = "string",
    AadAdmin = new Azure.Synapse.Inputs.WorkspaceAadAdminArgs
    {
        Login = "string",
        ObjectId = "string",
        TenantId = "string",
    },
    PurviewId = "string",
    DataExfiltrationProtectionEnabled = false,
    SqlAadAdmin = new Azure.Synapse.Inputs.WorkspaceSqlAadAdminArgs
    {
        Login = "string",
        ObjectId = "string",
        TenantId = "string",
    },
    CustomerManagedKey = new Azure.Synapse.Inputs.WorkspaceCustomerManagedKeyArgs
    {
        KeyVersionlessId = "string",
        KeyName = "string",
    },
    ComputeSubnetId = "string",
    SqlIdentityControlEnabled = false,
    AzureDevopsRepo = new Azure.Synapse.Inputs.WorkspaceAzureDevopsRepoArgs
    {
        AccountName = "string",
        BranchName = "string",
        ProjectName = "string",
        RepositoryName = "string",
        RootFolder = "string",
        LastCommitId = "string",
        TenantId = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := synapse.NewWorkspace(ctx, "exampleworkspaceResourceResourceFromSynapseworkspace", &synapse.WorkspaceArgs{
	ResourceGroupName:               pulumi.String("string"),
	StorageDataLakeGen2FilesystemId: pulumi.String("string"),
	SqlAdministratorLoginPassword:   pulumi.String("string"),
	SqlAdministratorLogin:           pulumi.String("string"),
	GithubRepo: &synapse.WorkspaceGithubRepoArgs{
		AccountName:    pulumi.String("string"),
		BranchName:     pulumi.String("string"),
		RepositoryName: pulumi.String("string"),
		RootFolder:     pulumi.String("string"),
		GitUrl:         pulumi.String("string"),
		LastCommitId:   pulumi.String("string"),
	},
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	LinkingAllowedForAadTenantIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Location:                     pulumi.String("string"),
	ManagedResourceGroupName:     pulumi.String("string"),
	ManagedVirtualNetworkEnabled: pulumi.Bool(false),
	Name:                         pulumi.String("string"),
	AadAdmin: &synapse.WorkspaceAadAdminTypeArgs{
		Login:    pulumi.String("string"),
		ObjectId: pulumi.String("string"),
		TenantId: pulumi.String("string"),
	},
	PurviewId:                         pulumi.String("string"),
	DataExfiltrationProtectionEnabled: pulumi.Bool(false),
	SqlAadAdmin: &synapse.WorkspaceSqlAadAdminTypeArgs{
		Login:    pulumi.String("string"),
		ObjectId: pulumi.String("string"),
		TenantId: pulumi.String("string"),
	},
	CustomerManagedKey: &synapse.WorkspaceCustomerManagedKeyArgs{
		KeyVersionlessId: pulumi.String("string"),
		KeyName:          pulumi.String("string"),
	},
	ComputeSubnetId:           pulumi.String("string"),
	SqlIdentityControlEnabled: pulumi.Bool(false),
	AzureDevopsRepo: &synapse.WorkspaceAzureDevopsRepoArgs{
		AccountName:    pulumi.String("string"),
		BranchName:     pulumi.String("string"),
		ProjectName:    pulumi.String("string"),
		RepositoryName: pulumi.String("string"),
		RootFolder:     pulumi.String("string"),
		LastCommitId:   pulumi.String("string"),
		TenantId:       pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var exampleworkspaceResourceResourceFromSynapseworkspace = new com.pulumi.azure.synapse.Workspace("exampleworkspaceResourceResourceFromSynapseworkspace", com.pulumi.azure.synapse.WorkspaceArgs.builder()
    .resourceGroupName("string")
    .storageDataLakeGen2FilesystemId("string")
    .sqlAdministratorLoginPassword("string")
    .sqlAdministratorLogin("string")
    .githubRepo(WorkspaceGithubRepoArgs.builder()
        .accountName("string")
        .branchName("string")
        .repositoryName("string")
        .rootFolder("string")
        .gitUrl("string")
        .lastCommitId("string")
        .build())
    .publicNetworkAccessEnabled(false)
    .linkingAllowedForAadTenantIds("string")
    .location("string")
    .managedResourceGroupName("string")
    .managedVirtualNetworkEnabled(false)
    .name("string")
    .aadAdmin(WorkspaceAadAdminArgs.builder()
        .login("string")
        .objectId("string")
        .tenantId("string")
        .build())
    .purviewId("string")
    .dataExfiltrationProtectionEnabled(false)
    .sqlAadAdmin(WorkspaceSqlAadAdminArgs.builder()
        .login("string")
        .objectId("string")
        .tenantId("string")
        .build())
    .customerManagedKey(WorkspaceCustomerManagedKeyArgs.builder()
        .keyVersionlessId("string")
        .keyName("string")
        .build())
    .computeSubnetId("string")
    .sqlIdentityControlEnabled(false)
    .azureDevopsRepo(WorkspaceAzureDevopsRepoArgs.builder()
        .accountName("string")
        .branchName("string")
        .projectName("string")
        .repositoryName("string")
        .rootFolder("string")
        .lastCommitId("string")
        .tenantId("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    exampleworkspace_resource_resource_from_synapseworkspace = azure.synapse.Workspace("exampleworkspaceResourceResourceFromSynapseworkspace",
    resource_group_name="string",
    storage_data_lake_gen2_filesystem_id="string",
    sql_administrator_login_password="string",
    sql_administrator_login="string",
    github_repo={
        "account_name": "string",
        "branch_name": "string",
        "repository_name": "string",
        "root_folder": "string",
        "git_url": "string",
        "last_commit_id": "string",
    },
    public_network_access_enabled=False,
    linking_allowed_for_aad_tenant_ids=["string"],
    location="string",
    managed_resource_group_name="string",
    managed_virtual_network_enabled=False,
    name="string",
    aad_admin={
        "login": "string",
        "object_id": "string",
        "tenant_id": "string",
    },
    purview_id="string",
    data_exfiltration_protection_enabled=False,
    sql_aad_admin={
        "login": "string",
        "object_id": "string",
        "tenant_id": "string",
    },
    customer_managed_key={
        "key_versionless_id": "string",
        "key_name": "string",
    },
    compute_subnet_id="string",
    sql_identity_control_enabled=False,
    azure_devops_repo={
        "account_name": "string",
        "branch_name": "string",
        "project_name": "string",
        "repository_name": "string",
        "root_folder": "string",
        "last_commit_id": "string",
        "tenant_id": "string",
    },
    tags={
        "string": "string",
    })

    const exampleworkspaceResourceResourceFromSynapseworkspace = new azure.synapse.Workspace("exampleworkspaceResourceResourceFromSynapseworkspace", {
    resourceGroupName: "string",
    storageDataLakeGen2FilesystemId: "string",
    sqlAdministratorLoginPassword: "string",
    sqlAdministratorLogin: "string",
    githubRepo: {
        accountName: "string",
        branchName: "string",
        repositoryName: "string",
        rootFolder: "string",
        gitUrl: "string",
        lastCommitId: "string",
    },
    publicNetworkAccessEnabled: false,
    linkingAllowedForAadTenantIds: ["string"],
    location: "string",
    managedResourceGroupName: "string",
    managedVirtualNetworkEnabled: false,
    name: "string",
    aadAdmin: {
        login: "string",
        objectId: "string",
        tenantId: "string",
    },
    purviewId: "string",
    dataExfiltrationProtectionEnabled: false,
    sqlAadAdmin: {
        login: "string",
        objectId: "string",
        tenantId: "string",
    },
    customerManagedKey: {
        keyVersionlessId: "string",
        keyName: "string",
    },
    computeSubnetId: "string",
    sqlIdentityControlEnabled: false,
    azureDevopsRepo: {
        accountName: "string",
        branchName: "string",
        projectName: "string",
        repositoryName: "string",
        rootFolder: "string",
        lastCommitId: "string",
        tenantId: "string",
    },
    tags: {
        string: "string",
    },
});

    type: azure:synapse:Workspace
properties:
    aadAdmin:
        login: string
        objectId: string
        tenantId: string
    azureDevopsRepo:
        accountName: string
        branchName: string
        lastCommitId: string
        projectName: string
        repositoryName: string
        rootFolder: string
        tenantId: string
    computeSubnetId: string
    customerManagedKey:
        keyName: string
        keyVersionlessId: string
    dataExfiltrationProtectionEnabled: false
    githubRepo:
        accountName: string
        branchName: string
        gitUrl: string
        lastCommitId: string
        repositoryName: string
        rootFolder: string
    linkingAllowedForAadTenantIds:
        - string
    location: string
    managedResourceGroupName: string
    managedVirtualNetworkEnabled: false
    name: string
    publicNetworkAccessEnabled: false
    purviewId: string
    resourceGroupName: string
    sqlAadAdmin:
        login: string
        objectId: string
        tenantId: string
    sqlAdministratorLogin: string
    sqlAdministratorLoginPassword: string
    sqlIdentityControlEnabled: false
    storageDataLakeGen2FilesystemId: string
    tags:
        string: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.
    SqlAdministratorLogin string
    Specifies The Login Name of the SQL administrator. Changing this forces a new resource to be created.
    SqlAdministratorLoginPassword string
    The Password associated with the sql_administrator_login for the SQL administrator.
    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
    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.
    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.
    ManagedVirtualNetworkEnabled bool
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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.
    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.
    SqlAdministratorLogin string
    Specifies The Login Name of the SQL administrator. Changing this forces a new resource to be created.
    SqlAdministratorLoginPassword string
    The Password associated with the sql_administrator_login for the SQL administrator.
    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
    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.
    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.
    ManagedVirtualNetworkEnabled bool
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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.
    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.
    sqlAdministratorLogin String
    Specifies The Login Name of the SQL administrator. Changing this forces a new resource to be created.
    sqlAdministratorLoginPassword String
    The Password associated with the sql_administrator_login for the SQL administrator.
    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
    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.
    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.
    managedVirtualNetworkEnabled Boolean
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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.
    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.
    sqlAdministratorLogin string
    Specifies The Login Name of the SQL administrator. Changing this forces a new resource to be created.
    sqlAdministratorLoginPassword string
    The Password associated with the sql_administrator_login for the SQL administrator.
    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
    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.
    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.
    managedVirtualNetworkEnabled boolean
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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.
    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.
    sql_administrator_login str
    Specifies The Login Name of the SQL administrator. Changing this forces a new resource to be created.
    sql_administrator_login_password str
    The Password associated with the sql_administrator_login for the SQL administrator.
    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
    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.
    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.
    managed_virtual_network_enabled bool
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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_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.
    sqlAdministratorLogin String
    Specifies The Login Name of the SQL administrator. Changing this forces a new resource to be created.
    sqlAdministratorLoginPassword String
    The Password associated with the sql_administrator_login for the SQL administrator.
    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
    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.
    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.
    managedVirtualNetworkEnabled Boolean
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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.
    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.
    Identities List<WorkspaceIdentity>
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
    ConnectivityEndpoints map[string]string
    A list of Connectivity endpoints for this Synapse Workspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identities []WorkspaceIdentity
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
    connectivityEndpoints Map<String,String>
    A list of Connectivity endpoints for this Synapse Workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    identities List<WorkspaceIdentity>
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
    connectivityEndpoints {[key: string]: string}
    A list of Connectivity endpoints for this Synapse Workspace.
    id string
    The provider-assigned unique ID for this managed resource.
    identities WorkspaceIdentity[]
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
    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.
    identities Sequence[WorkspaceIdentity]
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
    connectivityEndpoints Map<String>
    A list of Connectivity endpoints for this Synapse Workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    identities List<Property Map>
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.

    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,
        identities: Optional[Sequence[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)
    resources:  _:    type: azure:synapse:Workspace    get:      id: ${id}
    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
    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.
    Identities List<WorkspaceIdentity>
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
    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.
    ManagedVirtualNetworkEnabled bool
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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.
    SqlAdministratorLoginPassword string
    The Password associated with the sql_administrator_login for the SQL administrator.
    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
    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.
    Identities []WorkspaceIdentityArgs
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
    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.
    ManagedVirtualNetworkEnabled bool
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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.
    SqlAdministratorLoginPassword string
    The Password associated with the sql_administrator_login for the SQL administrator.
    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
    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.
    identities List<WorkspaceIdentity>
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
    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.
    managedVirtualNetworkEnabled Boolean
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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.
    sqlAdministratorLoginPassword String
    The Password associated with the sql_administrator_login for the SQL administrator.
    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
    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.
    identities WorkspaceIdentity[]
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
    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.
    managedVirtualNetworkEnabled boolean
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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.
    sqlAdministratorLoginPassword string
    The Password associated with the sql_administrator_login for the SQL administrator.
    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
    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.
    identities Sequence[WorkspaceIdentityArgs]
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
    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.
    managed_virtual_network_enabled bool
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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.
    sql_administrator_login_password str
    The Password associated with the sql_administrator_login for the SQL administrator.
    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
    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.
    identities List<Property Map>
    An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
    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.
    managedVirtualNetworkEnabled Boolean
    Is Virtual Network enabled for all computes in this workspace? Defaults to false. 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.
    sqlAdministratorLoginPassword String
    The Password associated with the sql_administrator_login for the SQL administrator.
    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.
    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.
    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.
    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.
    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.
    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.
    lastCommitId String
    The last commit ID.

    WorkspaceIdentity, WorkspaceIdentityArgs

    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
    The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
    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
    The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
    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
    The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
    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
    The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
    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 str
    The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
    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
    The Identity Type for the Service Principal associated with the Managed Service Identity 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

    To learn more about importing existing cloud resources, see Importing resources.

    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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.