com.pulumi.azure.synapse.kotlin.RoleAssignment.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.synapse.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [RoleAssignment].
*/
@PulumiTagMarker
public class RoleAssignmentResourceBuilder internal constructor() {
public var name: String? = null
public var args: RoleAssignmentArgs = RoleAssignmentArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend RoleAssignmentArgsBuilder.() -> Unit) {
val builder = RoleAssignmentArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): RoleAssignment {
val builtJavaResource = com.pulumi.azure.synapse.RoleAssignment(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return RoleAssignment(builtJavaResource)
}
}
/**
* Manages a Synapse Role Assignment.
* ## Example Usage
*
* ```typescript
* 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],
* });
* ```
* ```python
* 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]))
* ```
* ```csharp
* 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,
* },
* });
* });
* ```
* ```go
* 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 {
* 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, nil, 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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: {}
* ```
*
* ## Import
* Synapse Role Assignment can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:synapse/roleAssignment:RoleAssignment example "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Synapse/workspaces/workspace1|000000000000"
* ```
*/
public class RoleAssignment internal constructor(
override val javaResource: com.pulumi.azure.synapse.RoleAssignment,
) : KotlinCustomResource(javaResource, RoleAssignmentMapper) {
/**
* 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.
*/
public val principalId: Output
get() = javaResource.principalId().applyValue({ args0 -> args0 })
/**
* 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`.
*/
public val principalType: Output?
get() = javaResource.principalType().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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.
*/
public val roleName: Output
get() = javaResource.roleName().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val synapseSparkPoolId: Output?
get() = javaResource.synapseSparkPoolId().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
*/
public val synapseWorkspaceId: Output?
get() = javaResource.synapseWorkspaceId().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
}
public object RoleAssignmentMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.synapse.RoleAssignment::class == javaResource::class
override fun map(javaResource: Resource): RoleAssignment = RoleAssignment(
javaResource as
com.pulumi.azure.synapse.RoleAssignment,
)
}
/**
* @see [RoleAssignment].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [RoleAssignment].
*/
public suspend fun roleAssignment(
name: String,
block: suspend RoleAssignmentResourceBuilder.() -> Unit,
): RoleAssignment {
val builder = RoleAssignmentResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [RoleAssignment].
* @param name The _unique_ name of the resulting resource.
*/
public fun roleAssignment(name: String): RoleAssignment {
val builder = RoleAssignmentResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy