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

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

azure.synapse.RoleAssignment

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

    Manages a Synapse Role Assignment.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
            AccountKind = "StorageV2",
            IsHnsEnabled = true,
        });
    
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new()
        {
            StorageAccountId = exampleAccount.Id,
        });
    
        var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
            SqlAdministratorLogin = "sqladminuser",
            SqlAdministratorLoginPassword = "H@Sh1CoR3!",
            Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
            {
                Type = "SystemAssigned",
            },
        });
    
        var exampleFirewallRule = new Azure.Synapse.FirewallRule("exampleFirewallRule", new()
        {
            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("exampleRoleAssignment", new()
        {
            SynapseWorkspaceId = exampleWorkspace.Id,
            RoleName = "Synapse SQL Administrator",
            PrincipalId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
        }, new CustomResourceOptions
        {
            DependsOn = new[]
            {
                exampleFirewallRule,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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!"),
    			Identity: &synapse.WorkspaceIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleFirewallRule, err := synapse.NewFirewallRule(ctx, "exampleFirewallRule", &synapse.FirewallRuleArgs{
    			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, 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
    	})
    }
    
    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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
                .location("West Europe")
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.location())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .accountKind("StorageV2")
                .isHnsEnabled("true")
                .build());
    
            var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()        
                .storageAccountId(exampleAccount.id())
                .build());
    
            var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.location())
                .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
                .sqlAdministratorLogin("sqladminuser")
                .sqlAdministratorLoginPassword("H@Sh1CoR3!")
                .identity(WorkspaceIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .build());
    
            var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()        
                .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());
    
        }
    }
    
    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!",
        identity=azure.synapse.WorkspaceIdentityArgs(
            type="SystemAssigned",
        ))
    example_firewall_rule = azure.synapse.FirewallRule("exampleFirewallRule",
        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("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]))
    
    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!",
        identity: {
            type: "SystemAssigned",
        },
    });
    const exampleFirewallRule = new azure.synapse.FirewallRule("exampleFirewallRule", {
        synapseWorkspaceId: exampleWorkspace.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],
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleAccount:
        type: azure:storage:Account
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.location}
          accountTier: Standard
          accountReplicationType: LRS
          accountKind: StorageV2
          isHnsEnabled: 'true'
      exampleDataLakeGen2Filesystem:
        type: azure:storage:DataLakeGen2Filesystem
        properties:
          storageAccountId: ${exampleAccount.id}
      exampleWorkspace:
        type: azure:synapse:Workspace
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.location}
          storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
          sqlAdministratorLogin: sqladminuser
          sqlAdministratorLoginPassword: H@Sh1CoR3!
          identity:
            type: SystemAssigned
      exampleFirewallRule:
        type: azure:synapse:FirewallRule
        properties:
          synapseWorkspaceId: ${exampleWorkspace.id}
          startIpAddress: 0.0.0.0
          endIpAddress: 255.255.255.255
      exampleRoleAssignment:
        type: azure:synapse:RoleAssignment
        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

    new RoleAssignment(name: string, args: RoleAssignmentArgs, opts?: CustomResourceOptions);
    @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)
    @overload
    def RoleAssignment(resource_name: str,
                       args: RoleAssignmentArgs,
                       opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    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.

    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.

    RoleName string

    The Role Name of the Synapse Built-In Role. 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.

    roleName String

    The Role Name of the Synapse Built-In Role. 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.

    roleName string

    The Role Name of the Synapse Built-In Role. 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.

    role_name str

    The Role Name of the Synapse Built-In Role. 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.

    roleName String

    The Role Name of the Synapse Built-In Role. 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.

    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)
    Resource lookup is not supported in YAML
    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.

    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.

    RoleName string

    The Role Name of the Synapse Built-In Role. 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.

    roleName String

    The Role Name of the Synapse Built-In Role. 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.

    roleName string

    The Role Name of the Synapse Built-In Role. 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.

    role_name str

    The Role Name of the Synapse Built-In Role. 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.

    roleName String

    The Role Name of the Synapse Built-In Role. 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"
    

    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.

    Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi