Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. synapse
  5. WorkspaceSqlAadAdmin

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.synapse.WorkspaceSqlAadAdmin

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an Azure Active Directory SQL Administrator setting for a Synapse Workspace

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleAccount = new azure.storage.Account("example", {
    name: "examplestorageacc",
    resourceGroupName: example.name,
    location: example.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
    accountKind: "StorageV2",
    isHnsEnabled: true,
});
const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("example", {
    name: "example",
    storageAccountId: exampleAccount.id,
});
const current = azure.core.getClientConfig({});
const exampleKeyVault = new azure.keyvault.KeyVault("example", {
    name: "example",
    location: example.location,
    resourceGroupName: example.name,
    tenantId: current.then(current => current.tenantId),
    skuName: "standard",
    purgeProtectionEnabled: true,
});
const deployer = new azure.keyvault.AccessPolicy("deployer", {
    keyVaultId: exampleKeyVault.id,
    tenantId: current.then(current => current.tenantId),
    objectId: current.then(current => current.objectId),
    keyPermissions: [
        "Create",
        "Get",
        "Delete",
        "Purge",
        "GetRotationPolicy",
    ],
});
const exampleKey = new azure.keyvault.Key("example", {
    name: "workspace-encryption-key",
    keyVaultId: exampleKeyVault.id,
    keyType: "RSA",
    keySize: 2048,
    keyOpts: [
        "unwrapKey",
        "wrapKey",
    ],
}, {
    dependsOn: [deployer],
});
const exampleWorkspace = new azure.synapse.Workspace("example", {
    name: "example",
    resourceGroupName: example.name,
    location: example.location,
    storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
    sqlAdministratorLogin: "sqladminuser",
    sqlAdministratorLoginPassword: "H@Sh1CoR3!",
    identity: {
        type: "SystemAssigned",
    },
    tags: {
        Env: "production",
    },
});
const exampleWorkspaceSqlAadAdmin = new azure.synapse.WorkspaceSqlAadAdmin("example", {
    synapseWorkspaceId: exampleWorkspace.id,
    login: "AzureAD Admin",
    objectId: current.then(current => current.objectId),
    tenantId: current.then(current => current.tenantId),
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_account = azure.storage.Account("example",
    name="examplestorageacc",
    resource_group_name=example.name,
    location=example.location,
    account_tier="Standard",
    account_replication_type="LRS",
    account_kind="StorageV2",
    is_hns_enabled=True)
example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("example",
    name="example",
    storage_account_id=example_account.id)
current = azure.core.get_client_config()
example_key_vault = azure.keyvault.KeyVault("example",
    name="example",
    location=example.location,
    resource_group_name=example.name,
    tenant_id=current.tenant_id,
    sku_name="standard",
    purge_protection_enabled=True)
deployer = azure.keyvault.AccessPolicy("deployer",
    key_vault_id=example_key_vault.id,
    tenant_id=current.tenant_id,
    object_id=current.object_id,
    key_permissions=[
        "Create",
        "Get",
        "Delete",
        "Purge",
        "GetRotationPolicy",
    ])
example_key = azure.keyvault.Key("example",
    name="workspace-encryption-key",
    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("example",
    name="example",
    resource_group_name=example.name,
    location=example.location,
    storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
    sql_administrator_login="sqladminuser",
    sql_administrator_login_password="H@Sh1CoR3!",
    identity={
        "type": "SystemAssigned",
    },
    tags={
        "Env": "production",
    })
example_workspace_sql_aad_admin = azure.synapse.WorkspaceSqlAadAdmin("example",
    synapse_workspace_id=example_workspace.id,
    login="AzureAD Admin",
    object_id=current.object_id,
    tenant_id=current.tenant_id)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/keyvault"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/synapse"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
			Name:                   pulumi.String("examplestorageacc"),
			ResourceGroupName:      example.Name,
			Location:               example.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, "example", &storage.DataLakeGen2FilesystemArgs{
			Name:             pulumi.String("example"),
			StorageAccountId: exampleAccount.ID(),
		})
		if err != nil {
			return err
		}
		current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		exampleKeyVault, err := keyvault.NewKeyVault(ctx, "example", &keyvault.KeyVaultArgs{
			Name:                   pulumi.String("example"),
			Location:               example.Location,
			ResourceGroupName:      example.Name,
			TenantId:               pulumi.String(current.TenantId),
			SkuName:                pulumi.String("standard"),
			PurgeProtectionEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		deployer, err := keyvault.NewAccessPolicy(ctx, "deployer", &keyvault.AccessPolicyArgs{
			KeyVaultId: exampleKeyVault.ID(),
			TenantId:   pulumi.String(current.TenantId),
			ObjectId:   pulumi.String(current.ObjectId),
			KeyPermissions: pulumi.StringArray{
				pulumi.String("Create"),
				pulumi.String("Get"),
				pulumi.String("Delete"),
				pulumi.String("Purge"),
				pulumi.String("GetRotationPolicy"),
			},
		})
		if err != nil {
			return err
		}
		_, err = keyvault.NewKey(ctx, "example", &keyvault.KeyArgs{
			Name:       pulumi.String("workspace-encryption-key"),
			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, "example", &synapse.WorkspaceArgs{
			Name:                            pulumi.String("example"),
			ResourceGroupName:               example.Name,
			Location:                        example.Location,
			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
			Identity: &synapse.WorkspaceIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
			Tags: pulumi.StringMap{
				"Env": pulumi.String("production"),
			},
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewWorkspaceSqlAadAdmin(ctx, "example", &synapse.WorkspaceSqlAadAdminArgs{
			SynapseWorkspaceId: exampleWorkspace.ID(),
			Login:              pulumi.String("AzureAD Admin"),
			ObjectId:           pulumi.String(current.ObjectId),
			TenantId:           pulumi.String(current.TenantId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleAccount = new Azure.Storage.Account("example", new()
    {
        Name = "examplestorageacc",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
        AccountKind = "StorageV2",
        IsHnsEnabled = true,
    });

    var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("example", new()
    {
        Name = "example",
        StorageAccountId = exampleAccount.Id,
    });

    var current = Azure.Core.GetClientConfig.Invoke();

    var exampleKeyVault = new Azure.KeyVault.KeyVault("example", new()
    {
        Name = "example",
        Location = example.Location,
        ResourceGroupName = example.Name,
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        SkuName = "standard",
        PurgeProtectionEnabled = true,
    });

    var deployer = new Azure.KeyVault.AccessPolicy("deployer", new()
    {
        KeyVaultId = exampleKeyVault.Id,
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
        KeyPermissions = new[]
        {
            "Create",
            "Get",
            "Delete",
            "Purge",
            "GetRotationPolicy",
        },
    });

    var exampleKey = new Azure.KeyVault.Key("example", new()
    {
        Name = "workspace-encryption-key",
        KeyVaultId = exampleKeyVault.Id,
        KeyType = "RSA",
        KeySize = 2048,
        KeyOpts = new[]
        {
            "unwrapKey",
            "wrapKey",
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            deployer,
        },
    });

    var exampleWorkspace = new Azure.Synapse.Workspace("example", new()
    {
        Name = "example",
        ResourceGroupName = example.Name,
        Location = example.Location,
        StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
        SqlAdministratorLogin = "sqladminuser",
        SqlAdministratorLoginPassword = "H@Sh1CoR3!",
        Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
        {
            Type = "SystemAssigned",
        },
        Tags = 
        {
            { "Env", "production" },
        },
    });

    var exampleWorkspaceSqlAadAdmin = new Azure.Synapse.WorkspaceSqlAadAdmin("example", new()
    {
        SynapseWorkspaceId = exampleWorkspace.Id,
        Login = "AzureAD Admin",
        ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.DataLakeGen2Filesystem;
import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.keyvault.KeyVault;
import com.pulumi.azure.keyvault.KeyVaultArgs;
import com.pulumi.azure.keyvault.AccessPolicy;
import com.pulumi.azure.keyvault.AccessPolicyArgs;
import com.pulumi.azure.keyvault.Key;
import com.pulumi.azure.keyvault.KeyArgs;
import com.pulumi.azure.synapse.Workspace;
import com.pulumi.azure.synapse.WorkspaceArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
import com.pulumi.azure.synapse.WorkspaceSqlAadAdmin;
import com.pulumi.azure.synapse.WorkspaceSqlAadAdminArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("examplestorageacc")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .accountKind("StorageV2")
            .isHnsEnabled("true")
            .build());

        var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()
            .name("example")
            .storageAccountId(exampleAccount.id())
            .build());

        final var current = CoreFunctions.getClientConfig();

        var exampleKeyVault = new KeyVault("exampleKeyVault", KeyVaultArgs.builder()
            .name("example")
            .location(example.location())
            .resourceGroupName(example.name())
            .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
            .skuName("standard")
            .purgeProtectionEnabled(true)
            .build());

        var deployer = new AccessPolicy("deployer", AccessPolicyArgs.builder()
            .keyVaultId(exampleKeyVault.id())
            .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
            .objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
            .keyPermissions(            
                "Create",
                "Get",
                "Delete",
                "Purge",
                "GetRotationPolicy")
            .build());

        var exampleKey = new Key("exampleKey", KeyArgs.builder()
            .name("workspace-encryption-key")
            .keyVaultId(exampleKeyVault.id())
            .keyType("RSA")
            .keySize(2048)
            .keyOpts(            
                "unwrapKey",
                "wrapKey")
            .build(), CustomResourceOptions.builder()
                .dependsOn(deployer)
                .build());

        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .location(example.location())
            .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
            .sqlAdministratorLogin("sqladminuser")
            .sqlAdministratorLoginPassword("H@Sh1CoR3!")
            .identity(WorkspaceIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .tags(Map.of("Env", "production"))
            .build());

        var exampleWorkspaceSqlAadAdmin = new WorkspaceSqlAadAdmin("exampleWorkspaceSqlAadAdmin", WorkspaceSqlAadAdminArgs.builder()
            .synapseWorkspaceId(exampleWorkspace.id())
            .login("AzureAD Admin")
            .objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
            .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: examplestorageacc
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
      accountKind: StorageV2
      isHnsEnabled: 'true'
  exampleDataLakeGen2Filesystem:
    type: azure:storage:DataLakeGen2Filesystem
    name: example
    properties:
      name: example
      storageAccountId: ${exampleAccount.id}
  exampleKeyVault:
    type: azure:keyvault:KeyVault
    name: example
    properties:
      name: example
      location: ${example.location}
      resourceGroupName: ${example.name}
      tenantId: ${current.tenantId}
      skuName: standard
      purgeProtectionEnabled: true
  deployer:
    type: azure:keyvault:AccessPolicy
    properties:
      keyVaultId: ${exampleKeyVault.id}
      tenantId: ${current.tenantId}
      objectId: ${current.objectId}
      keyPermissions:
        - Create
        - Get
        - Delete
        - Purge
        - GetRotationPolicy
  exampleKey:
    type: azure:keyvault:Key
    name: example
    properties:
      name: workspace-encryption-key
      keyVaultId: ${exampleKeyVault.id}
      keyType: RSA
      keySize: 2048
      keyOpts:
        - unwrapKey
        - wrapKey
    options:
      dependsOn:
        - ${deployer}
  exampleWorkspace:
    type: azure:synapse:Workspace
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      location: ${example.location}
      storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
      sqlAdministratorLogin: sqladminuser
      sqlAdministratorLoginPassword: H@Sh1CoR3!
      identity:
        type: SystemAssigned
      tags:
        Env: production
  exampleWorkspaceSqlAadAdmin:
    type: azure:synapse:WorkspaceSqlAadAdmin
    name: example
    properties:
      synapseWorkspaceId: ${exampleWorkspace.id}
      login: AzureAD Admin
      objectId: ${current.objectId}
      tenantId: ${current.tenantId}
variables:
  current:
    fn::invoke:
      function: azure:core:getClientConfig
      arguments: {}
Copy

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: WorkspaceSqlAadAdminArgs,
                         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 This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSqlAadAdminArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkspaceSqlAadAdminArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSqlAadAdminArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSqlAadAdminArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
example, err := synapse.NewWorkspaceSqlAadAdmin(ctx, "workspaceSqlAadAdminResource", &synapse.WorkspaceSqlAadAdminArgs{
	Login:              pulumi.String("string"),
	ObjectId:           pulumi.String("string"),
	SynapseWorkspaceId: pulumi.String("string"),
	TenantId:           pulumi.String("string"),
})
Copy
var workspaceSqlAadAdminResource = new WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource", WorkspaceSqlAadAdminArgs.builder()
    .login("string")
    .objectId("string")
    .synapseWorkspaceId("string")
    .tenantId("string")
    .build());
Copy
workspace_sql_aad_admin_resource = azure.synapse.WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource",
    login="string",
    object_id="string",
    synapse_workspace_id="string",
    tenant_id="string")
Copy
const workspaceSqlAadAdminResource = new azure.synapse.WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource", {
    login: "string",
    objectId: "string",
    synapseWorkspaceId: "string",
    tenantId: "string",
});
Copy
type: azure:synapse:WorkspaceSqlAadAdmin
properties:
    login: string
    objectId: string
    synapseWorkspaceId: string
    tenantId: string
Copy

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 This property is required. string
The login name of the Azure AD Administrator of this Synapse Workspace.
ObjectId This property is required. string
The object id of the Azure AD Administrator of this Synapse Workspace.
SynapseWorkspaceId This property is required. string
The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
TenantId This property is required. string
The tenant id of the Azure AD Administrator of this Synapse Workspace.
Login This property is required. string
The login name of the Azure AD Administrator of this Synapse Workspace.
ObjectId This property is required. string
The object id of the Azure AD Administrator of this Synapse Workspace.
SynapseWorkspaceId This property is required. string
The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
TenantId This property is required. string
The tenant id of the Azure AD Administrator of this Synapse Workspace.
login This property is required. String
The login name of the Azure AD Administrator of this Synapse Workspace.
objectId This property is required. String
The object id of the Azure AD Administrator of this Synapse Workspace.
synapseWorkspaceId This property is required. String
The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
tenantId This property is required. String
The tenant id of the Azure AD Administrator of this Synapse Workspace.
login This property is required. string
The login name of the Azure AD Administrator of this Synapse Workspace.
objectId This property is required. string
The object id of the Azure AD Administrator of this Synapse Workspace.
synapseWorkspaceId This property is required. string
The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
tenantId This property is required. string
The tenant id of the Azure AD Administrator of this Synapse Workspace.
login This property is required. str
The login name of the Azure AD Administrator of this Synapse Workspace.
object_id This property is required. str
The object id of the Azure AD Administrator of this Synapse Workspace.
synapse_workspace_id This property is required. str
The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
tenant_id This property is required. str
The tenant id of the Azure AD Administrator of this Synapse Workspace.
login This property is required. String
The login name of the Azure AD Administrator of this Synapse Workspace.
objectId This property is required. String
The object id of the Azure AD Administrator of this Synapse Workspace.
synapseWorkspaceId This property is required. String
The ID of the Synapse Workspace where the Azure AD Administrator should be configured.
tenantId This property is required. 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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
Copy

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure