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

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

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 Role Assignment.

    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!",
        });
        var exampleFirewallRule = new Azure.Synapse.FirewallRule("exampleFirewallRule", new Azure.Synapse.FirewallRuleArgs
        {
            SynapseWorkspaceId = azurerm_synapse_workspace.Test.Id,
            StartIpAddress = "0.0.0.0",
            EndIpAddress = "255.255.255.255",
        });
        var current = Output.Create(Azure.Core.GetClientConfig.InvokeAsync());
        var exampleRoleAssignment = new Azure.Synapse.RoleAssignment("exampleRoleAssignment", new Azure.Synapse.RoleAssignmentArgs
        {
            SynapseWorkspaceId = exampleWorkspace.Id,
            RoleName = "Synapse SQL Administrator",
            PrincipalId = current.Apply(current => current.ObjectId),
        }, new CustomResourceOptions
        {
            DependsOn = 
            {
                exampleFirewallRule,
            },
        });
    }

}

    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
		}
		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!"),
		})
		if err != nil {
			return err
		}
		exampleFirewallRule, err := synapse.NewFirewallRule(ctx, "exampleFirewallRule", &synapse.FirewallRuleArgs{
			SynapseWorkspaceId: pulumi.Any(azurerm_synapse_workspace.Test.Id),
			StartIpAddress:     pulumi.String("0.0.0.0"),
			EndIpAddress:       pulumi.String("255.255.255.255"),
		})
		if err != nil {
			return err
		}
		current, err := core.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = synapse.NewRoleAssignment(ctx, "exampleRoleAssignment", &synapse.RoleAssignmentArgs{
			SynapseWorkspaceId: exampleWorkspace.ID(),
			RoleName:           pulumi.String("Synapse SQL Administrator"),
			PrincipalId:        pulumi.String(current.ObjectId),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleFirewallRule,
		}))
		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!",
});
const exampleFirewallRule = new azure.synapse.FirewallRule("exampleFirewallRule", {
    synapseWorkspaceId: azurerm_synapse_workspace.test.id,
    startIpAddress: "0.0.0.0",
    endIpAddress: "255.255.255.255",
});
const current = azure.core.getClientConfig({});
const exampleRoleAssignment = new azure.synapse.RoleAssignment("exampleRoleAssignment", {
    synapseWorkspaceId: exampleWorkspace.id,
    roleName: "Synapse SQL Administrator",
    principalId: current.then(current => current.objectId),
}, {
    dependsOn: [exampleFirewallRule],
});

    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!")
example_firewall_rule = azure.synapse.FirewallRule("exampleFirewallRule",
    synapse_workspace_id=azurerm_synapse_workspace["test"]["id"],
    start_ip_address="0.0.0.0",
    end_ip_address="255.255.255.255")
current = azure.core.get_client_config()
example_role_assignment = azure.synapse.RoleAssignment("exampleRoleAssignment",
    synapse_workspace_id=example_workspace.id,
    role_name="Synapse SQL Administrator",
    principal_id=current.object_id,
    opts=pulumi.ResourceOptions(depends_on=[example_firewall_rule]))

    Example coming soon!

    Create RoleAssignment Resource

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

    Constructor syntax

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

@overload
def RoleAssignment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   principal_id: Optional[str] = None,
                   role_name: Optional[str] = None,
                   synapse_spark_pool_id: Optional[str] = None,
                   synapse_workspace_id: Optional[str] = None)
    func NewRoleAssignment(ctx *Context, name string, args RoleAssignmentArgs, opts ...ResourceOption) (*RoleAssignment, error)
    public RoleAssignment(string name, RoleAssignmentArgs args, CustomResourceOptions? opts = null)
    public RoleAssignment(String name, RoleAssignmentArgs args)
public RoleAssignment(String name, RoleAssignmentArgs args, CustomResourceOptions options)

    type: azure:synapse:RoleAssignment
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 RoleAssignmentArgs
    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 RoleAssignmentArgs
    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 RoleAssignmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoleAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoleAssignmentArgs
    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 roleAssignmentResource = new Azure.Synapse.RoleAssignment("roleAssignmentResource", new()
{
    PrincipalId = "string",
    RoleName = "string",
    SynapseSparkPoolId = "string",
    SynapseWorkspaceId = "string",
});

    example, err := synapse.NewRoleAssignment(ctx, "roleAssignmentResource", &synapse.RoleAssignmentArgs{
	PrincipalId:        pulumi.String("string"),
	RoleName:           pulumi.String("string"),
	SynapseSparkPoolId: pulumi.String("string"),
	SynapseWorkspaceId: pulumi.String("string"),
})

    var roleAssignmentResource = new RoleAssignment("roleAssignmentResource", RoleAssignmentArgs.builder()
    .principalId("string")
    .roleName("string")
    .synapseSparkPoolId("string")
    .synapseWorkspaceId("string")
    .build());

    role_assignment_resource = azure.synapse.RoleAssignment("roleAssignmentResource",
    principal_id="string",
    role_name="string",
    synapse_spark_pool_id="string",
    synapse_workspace_id="string")

    const roleAssignmentResource = new azure.synapse.RoleAssignment("roleAssignmentResource", {
    principalId: "string",
    roleName: "string",
    synapseSparkPoolId: "string",
    synapseWorkspaceId: "string",
});

    type: azure:synapse:RoleAssignment
properties:
    principalId: string
    roleName: string
    synapseSparkPoolId: string
    synapseWorkspaceId: string

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

    PrincipalId string
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    RoleName string
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    SynapseSparkPoolId string
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    SynapseWorkspaceId string
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    PrincipalId string
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    RoleName string
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    SynapseSparkPoolId string
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    SynapseWorkspaceId string
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    principalId String
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    roleName String
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    synapseSparkPoolId String
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    synapseWorkspaceId String
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    principalId string
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    roleName string
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    synapseSparkPoolId string
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    synapseWorkspaceId string
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    principal_id str
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    role_name str
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    synapse_spark_pool_id str
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    synapse_workspace_id str
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    principalId String
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    roleName String
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    synapseSparkPoolId String
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    synapseWorkspaceId String
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RoleAssignment 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 RoleAssignment Resource

    Get an existing RoleAssignment 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?: RoleAssignmentState, opts?: CustomResourceOptions): RoleAssignment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        principal_id: Optional[str] = None,
        role_name: Optional[str] = None,
        synapse_spark_pool_id: Optional[str] = None,
        synapse_workspace_id: Optional[str] = None) -> RoleAssignment
    func GetRoleAssignment(ctx *Context, name string, id IDInput, state *RoleAssignmentState, opts ...ResourceOption) (*RoleAssignment, error)
    public static RoleAssignment Get(string name, Input<string> id, RoleAssignmentState? state, CustomResourceOptions? opts = null)
    public static RoleAssignment get(String name, Output<String> id, RoleAssignmentState state, CustomResourceOptions options)
    resources:  _:    type: azure:synapse:RoleAssignment    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:
    PrincipalId string
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    RoleName string
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    SynapseSparkPoolId string
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    SynapseWorkspaceId string
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    PrincipalId string
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    RoleName string
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    SynapseSparkPoolId string
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    SynapseWorkspaceId string
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    principalId String
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    roleName String
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    synapseSparkPoolId String
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    synapseWorkspaceId String
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    principalId string
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    roleName string
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    synapseSparkPoolId string
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    synapseWorkspaceId string
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    principal_id str
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    role_name str
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    synapse_spark_pool_id str
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    synapse_workspace_id str
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    principalId String
    The ID of the Principal (User, Group or Service Principal) to assign the Synapse Role Definition to. Changing this forces a new resource to be created.
    roleName String
    The Role Name of the Synapse Built-In Role. Changing this forces a new resource to be created.
    synapseSparkPoolId String
    The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
    synapseWorkspaceId String
    The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.

    Import

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

     $ pulumi import azure:synapse/roleAssignment:RoleAssignment example "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Synapse/workspaces/workspace1|000000000000"

    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.