Azure v6.22.0, Apr 1 25

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.synapse.RoleAssignment

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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 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",
    },
});
const exampleFirewallRule = new azure.synapse.FirewallRule("example", {
    name: "AllowAll",
    synapseWorkspaceId: exampleWorkspace.id,
    startIpAddress: "0.0.0.0",
    endIpAddress: "255.255.255.255",
});
const current = azure.core.getClientConfig({});
const exampleRoleAssignment = new azure.synapse.RoleAssignment("example", {
    synapseWorkspaceId: exampleWorkspace.id,
    roleName: "Synapse SQL Administrator",
    principalId: current.then(current => current.objectId),
}, {
    dependsOn: [exampleFirewallRule],
});

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)
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",
    })
example_firewall_rule = azure.synapse.FirewallRule("example",
    name="AllowAll",
    synapse_workspace_id=example_workspace.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("example",
    synapse_workspace_id=example_workspace.id,
    role_name="Synapse SQL Administrator",
    principal_id=current.object_id,
    opts = pulumi.ResourceOptions(depends_on=[example_firewall_rule]))

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"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
		}
		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"),
			},
		})
		if err != nil {
			return err
		}
		exampleFirewallRule, err := synapse.NewFirewallRule(ctx, "example", &synapse.FirewallRuleArgs{
			Name:               pulumi.String("AllowAll"),
			SynapseWorkspaceId: exampleWorkspace.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, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		_, err = synapse.NewRoleAssignment(ctx, "example", &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
	})
}

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 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",
        },
    });

    var exampleFirewallRule = new Azure.Synapse.FirewallRule("example", new()
    {
        Name = "AllowAll",
        SynapseWorkspaceId = exampleWorkspace.Id,
        StartIpAddress = "0.0.0.0",
        EndIpAddress = "255.255.255.255",
    });

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

    var exampleRoleAssignment = new Azure.Synapse.RoleAssignment("example", new()
    {
        SynapseWorkspaceId = exampleWorkspace.Id,
        RoleName = "Synapse SQL Administrator",
        PrincipalId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleFirewallRule,
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.DataLakeGen2Filesystem;
import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
import com.pulumi.azure.synapse.Workspace;
import com.pulumi.azure.synapse.WorkspaceArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
import com.pulumi.azure.synapse.FirewallRule;
import com.pulumi.azure.synapse.FirewallRuleArgs;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.synapse.RoleAssignment;
import com.pulumi.azure.synapse.RoleAssignmentArgs;
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());

        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())
            .build());

        var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()
            .name("AllowAll")
            .synapseWorkspaceId(exampleWorkspace.id())
            .startIpAddress("0.0.0.0")
            .endIpAddress("255.255.255.255")
            .build());

        final var current = CoreFunctions.getClientConfig();

        var exampleRoleAssignment = new RoleAssignment("exampleRoleAssignment", RoleAssignmentArgs.builder()
            .synapseWorkspaceId(exampleWorkspace.id())
            .roleName("Synapse SQL Administrator")
            .principalId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleFirewallRule)
                .build());

    }
}

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}
  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
  exampleFirewallRule:
    type: azure:synapse:FirewallRule
    name: example
    properties:
      name: AllowAll
      synapseWorkspaceId: ${exampleWorkspace.id}
      startIpAddress: 0.0.0.0
      endIpAddress: 255.255.255.255
  exampleRoleAssignment:
    type: azure:synapse:RoleAssignment
    name: example
    properties:
      synapseWorkspaceId: ${exampleWorkspace.id}
      roleName: Synapse SQL Administrator
      principalId: ${current.objectId}
    options:
      dependsOn:
        - ${exampleFirewallRule}
variables:
  current:
    fn::invoke:
      function: azure:core:getClientConfig
      arguments: {}

Create RoleAssignment Resource

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

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,
                   principal_type: 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.

TypeScript
Python
Go
C#
Java
YAML

var azureRoleAssignmentResource = new Azure.Synapse.RoleAssignment("azureRoleAssignmentResource", new()
{
    PrincipalId = "string",
    RoleName = "string",
    PrincipalType = "string",
    SynapseSparkPoolId = "string",
    SynapseWorkspaceId = "string",
});

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

var azureRoleAssignmentResource = new com.pulumi.azure.synapse.RoleAssignment("azureRoleAssignmentResource", com.pulumi.azure.synapse.RoleAssignmentArgs.builder()
    .principalId("string")
    .roleName("string")
    .principalType("string")
    .synapseSparkPoolId("string")
    .synapseWorkspaceId("string")
    .build());

azure_role_assignment_resource = azure.synapse.RoleAssignment("azureRoleAssignmentResource",
    principal_id="string",
    role_name="string",
    principal_type="string",
    synapse_spark_pool_id="string",
    synapse_workspace_id="string")

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

type: azure:synapse:RoleAssignment
properties:
    principalId: string
    principalType: 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. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
PrincipalType string: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
SynapseSparkPoolId string: The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
PrincipalType string: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
SynapseSparkPoolId string: The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
principalType String: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
synapseSparkPoolId String: The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
principalType string: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
synapseSparkPoolId string: The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
principal_type str: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
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.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
principalType String: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
synapseSparkPoolId String: The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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.

TypeScript
Python
Go
C#
Java
YAML

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,
        principal_type: 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.
PrincipalType string: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
RoleName string: The Role Name of the Synapse Built-In Role. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
SynapseSparkPoolId string: The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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.
PrincipalType string: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
RoleName string: The Role Name of the Synapse Built-In Role. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
SynapseSparkPoolId string: The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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.
principalType String: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
roleName String: The Role Name of the Synapse Built-In Role. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
synapseSparkPoolId String: The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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.
principalType string: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
roleName string: The Role Name of the Synapse Built-In Role. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
synapseSparkPoolId string: The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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.
principal_type str: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
role_name str: The Role Name of the Synapse Built-In Role. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
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.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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.
principalType String: The Type of the Principal. One of User, Group or ServicePrincipal. Changing this forces a new resource to be created.
NOTE: While principal_type is optional, it's still recommended to set this value, as some Synapse use-cases may not work correctly if this is not specified. Service Principals for example can't run SQL statements using Entra ID authentication if principal_type is not set to ServicePrincipal.
roleName String: The Role Name of the Synapse Built-In Role. Possible values are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User. Changing this forces a new resource to be created.
NOTE: Currently, the Synapse built-in roles are Apache Spark Administrator, Synapse Administrator, Synapse Artifact Publisher, Synapse Artifact User, Synapse Compute Operator, Synapse Contributor, Synapse Credential User, Synapse Linked Data Manager, Synapse Monitoring Operator, Synapse SQL Administrator and Synapse User.
NOTE: Old roles are still supported: Workspace Admin, Apache Spark Admin, Sql Admin. These values will be removed in the next Major Version 3.0.
synapseSparkPoolId String: The Synapse Spark Pool which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
NOTE: A Synapse firewall rule including local IP is needed to allow access. Only one of synapse_workspace_id, synapse_spark_pool_id must be set.
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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

azure.synapse.RoleAssignment

On this page

On this page

Example Usage

Create RoleAssignment Resource

Constructor syntax

Parameters

Constructor example

RoleAssignment Resource Properties

Inputs

Outputs

Look up Existing RoleAssignment Resource

Import

Package Details

On this page

On this page