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

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.WorkspaceSqlAadAdmin

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 an Azure Active Directory Sql Administrator setting for 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 current = Output.Create(Azure.Core.GetClientConfig.InvokeAsync());
        var exampleKeyVault = new Azure.KeyVault.KeyVault("exampleKeyVault", new Azure.KeyVault.KeyVaultArgs
        {
            Location = azurerm_resource_group.Exampl.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!",
            Tags = 
            {
                { "Env", "production" },
            },
        });
        var test = new Azure.Synapse.WorkspaceSqlAadAdmin("test", new Azure.Synapse.WorkspaceSqlAadAdminArgs
        {
            SynapseWorkspaceId = azurerm_synapse_workspace.Test.Id,
            Login = "AzureAD Admin",
            ObjectId = current.Apply(current => current.ObjectId),
            TenantId = current.Apply(current => current.TenantId),
        });
    }

}

    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 {
		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
		}
		current, err := core.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		exampleKeyVault, err := keyvault.NewKeyVault(ctx, "exampleKeyVault", &keyvault.KeyVaultArgs{
			Location:               pulumi.Any(azurerm_resource_group.Exampl.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
		}
		_, 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
		}
		_, 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!"),
			Tags: pulumi.StringMap{
				"Env": pulumi.String("production"),
			},
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewWorkspaceSqlAadAdmin(ctx, "test", &synapse.WorkspaceSqlAadAdminArgs{
			SynapseWorkspaceId: pulumi.Any(azurerm_synapse_workspace.Test.Id),
			Login:              pulumi.String("AzureAD Admin"),
			ObjectId:           pulumi.String(current.ObjectId),
			TenantId:           pulumi.String(current.TenantId),
		})
		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 current = azure.core.getClientConfig({});
const exampleKeyVault = new azure.keyvault.KeyVault("exampleKeyVault", {
    location: azurerm_resource_group.exampl.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!",
    tags: {
        Env: "production",
    },
});
const test = new azure.synapse.WorkspaceSqlAadAdmin("test", {
    synapseWorkspaceId: azurerm_synapse_workspace.test.id,
    login: "AzureAD Admin",
    objectId: current.then(current => current.objectId),
    tenantId: current.then(current => current.tenantId),
});

    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)
current = azure.core.get_client_config()
example_key_vault = azure.keyvault.KeyVault("exampleKeyVault",
    location=azurerm_resource_group["exampl"]["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!",
    tags={
        "Env": "production",
    })
test = azure.synapse.WorkspaceSqlAadAdmin("test",
    synapse_workspace_id=azurerm_synapse_workspace["test"]["id"],
    login="AzureAD Admin",
    object_id=current.object_id,
    tenant_id=current.tenant_id)

    Example coming soon!

    Create WorkspaceSqlAadAdmin Resource

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

    Constructor syntax

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

@overload
def WorkspaceSqlAadAdmin(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         login: Optional[str] = None,
                         object_id: Optional[str] = None,
                         synapse_workspace_id: Optional[str] = None,
                         tenant_id: Optional[str] = None)
    func NewWorkspaceSqlAadAdmin(ctx *Context, name string, args WorkspaceSqlAadAdminArgs, opts ...ResourceOption) (*WorkspaceSqlAadAdmin, error)
    public WorkspaceSqlAadAdmin(string name, WorkspaceSqlAadAdminArgs args, CustomResourceOptions? opts = null)
    public WorkspaceSqlAadAdmin(String name, WorkspaceSqlAadAdminArgs args)
public WorkspaceSqlAadAdmin(String name, WorkspaceSqlAadAdminArgs args, CustomResourceOptions options)

    type: azure:synapse:WorkspaceSqlAadAdmin
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 WorkspaceSqlAadAdminArgs
    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 WorkspaceSqlAadAdminInitArgs
    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 WorkspaceSqlAadAdminArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceSqlAadAdminArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceSqlAadAdminArgs
    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 workspaceSqlAadAdminResource = new Azure.Synapse.WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource", new()
{
    Login = "string",
    ObjectId = "string",
    SynapseWorkspaceId = "string",
    TenantId = "string",
});

    example, err := synapse.NewWorkspaceSqlAadAdmin(ctx, "workspaceSqlAadAdminResource", &synapse.WorkspaceSqlAadAdminArgs{
	Login:              pulumi.String("string"),
	ObjectId:           pulumi.String("string"),
	SynapseWorkspaceId: pulumi.String("string"),
	TenantId:           pulumi.String("string"),
})

    var workspaceSqlAadAdminResource = new WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource", WorkspaceSqlAadAdminArgs.builder()
    .login("string")
    .objectId("string")
    .synapseWorkspaceId("string")
    .tenantId("string")
    .build());

    workspace_sql_aad_admin_resource = azure.synapse.WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource",
    login="string",
    object_id="string",
    synapse_workspace_id="string",
    tenant_id="string")

    const workspaceSqlAadAdminResource = new azure.synapse.WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource", {
    login: "string",
    objectId: "string",
    synapseWorkspaceId: "string",
    tenantId: "string",
});

    type: azure:synapse:WorkspaceSqlAadAdmin
properties:
    login: string
    objectId: string
    synapseWorkspaceId: string
    tenantId: string

    WorkspaceSqlAadAdmin 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 WorkspaceSqlAadAdmin resource accepts the following input properties:

    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.
    SynapseWorkspaceId string
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    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.
    SynapseWorkspaceId string
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    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.
    synapseWorkspaceId String
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    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.
    synapseWorkspaceId string
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    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.
    synapse_workspace_id str
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    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.
    synapseWorkspaceId String
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    tenantId String
    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing WorkspaceSqlAadAdmin Resource

    Get an existing WorkspaceSqlAadAdmin 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?: WorkspaceSqlAadAdminState, opts?: CustomResourceOptions): WorkspaceSqlAadAdmin
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        login: Optional[str] = None,
        object_id: Optional[str] = None,
        synapse_workspace_id: Optional[str] = None,
        tenant_id: Optional[str] = None) -> WorkspaceSqlAadAdmin
    func GetWorkspaceSqlAadAdmin(ctx *Context, name string, id IDInput, state *WorkspaceSqlAadAdminState, opts ...ResourceOption) (*WorkspaceSqlAadAdmin, error)
    public static WorkspaceSqlAadAdmin Get(string name, Input<string> id, WorkspaceSqlAadAdminState? state, CustomResourceOptions? opts = null)
    public static WorkspaceSqlAadAdmin get(String name, Output<String> id, WorkspaceSqlAadAdminState state, CustomResourceOptions options)
    resources:  _:    type: azure:synapse:WorkspaceSqlAadAdmin    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:
    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.
    SynapseWorkspaceId string
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    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.
    SynapseWorkspaceId string
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    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.
    synapseWorkspaceId String
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    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.
    synapseWorkspaceId string
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    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.
    synapse_workspace_id str
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    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.
    synapseWorkspaceId String
    The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
    tenantId String
    The tenant id of the Azure AD Administrator of this Synapse Workspace.

    Import

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

     $ pulumi import azure:synapse/workspaceSqlAadAdmin:WorkspaceSqlAadAdmin example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/sqlAdministrators/activeDirectory

    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.