com.pulumi.azure.synapse.inputs.RoleAssignmentState Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.synapse.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class RoleAssignmentState extends com.pulumi.resources.ResourceArgs {
public static final RoleAssignmentState Empty = new RoleAssignmentState();
/**
* 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.
*
*/
@Import(name="principalId")
private @Nullable Output principalId;
/**
* @return 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 Optional> principalId() {
return Optional.ofNullable(this.principalId);
}
/**
* 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`.
*
*/
@Import(name="principalType")
private @Nullable Output principalType;
/**
* @return 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 Optional> principalType() {
return Optional.ofNullable(this.principalType);
}
/**
* 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.
*
*/
@Import(name="roleName")
private @Nullable Output roleName;
/**
* @return 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 Optional> roleName() {
return Optional.ofNullable(this.roleName);
}
/**
* 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.
*
*/
@Import(name="synapseSparkPoolId")
private @Nullable Output synapseSparkPoolId;
/**
* @return 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 Optional> synapseSparkPoolId() {
return Optional.ofNullable(this.synapseSparkPoolId);
}
/**
* The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
*
*/
@Import(name="synapseWorkspaceId")
private @Nullable Output synapseWorkspaceId;
/**
* @return The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
*
*/
public Optional> synapseWorkspaceId() {
return Optional.ofNullable(this.synapseWorkspaceId);
}
private RoleAssignmentState() {}
private RoleAssignmentState(RoleAssignmentState $) {
this.principalId = $.principalId;
this.principalType = $.principalType;
this.roleName = $.roleName;
this.synapseSparkPoolId = $.synapseSparkPoolId;
this.synapseWorkspaceId = $.synapseWorkspaceId;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(RoleAssignmentState defaults) {
return new Builder(defaults);
}
public static final class Builder {
private RoleAssignmentState $;
public Builder() {
$ = new RoleAssignmentState();
}
public Builder(RoleAssignmentState defaults) {
$ = new RoleAssignmentState(Objects.requireNonNull(defaults));
}
/**
* @param principalId 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.
*
* @return builder
*
*/
public Builder principalId(@Nullable Output principalId) {
$.principalId = principalId;
return this;
}
/**
* @param principalId 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.
*
* @return builder
*
*/
public Builder principalId(String principalId) {
return principalId(Output.of(principalId));
}
/**
* @param principalType 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`.
*
* @return builder
*
*/
public Builder principalType(@Nullable Output principalType) {
$.principalType = principalType;
return this;
}
/**
* @param principalType 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`.
*
* @return builder
*
*/
public Builder principalType(String principalType) {
return principalType(Output.of(principalType));
}
/**
* @param roleName 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.
*
* @return builder
*
*/
public Builder roleName(@Nullable Output roleName) {
$.roleName = roleName;
return this;
}
/**
* @param roleName 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.
*
* @return builder
*
*/
public Builder roleName(String roleName) {
return roleName(Output.of(roleName));
}
/**
* @param synapseSparkPoolId 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.
*
* @return builder
*
*/
public Builder synapseSparkPoolId(@Nullable Output synapseSparkPoolId) {
$.synapseSparkPoolId = synapseSparkPoolId;
return this;
}
/**
* @param synapseSparkPoolId 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.
*
* @return builder
*
*/
public Builder synapseSparkPoolId(String synapseSparkPoolId) {
return synapseSparkPoolId(Output.of(synapseSparkPoolId));
}
/**
* @param synapseWorkspaceId The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder synapseWorkspaceId(@Nullable Output synapseWorkspaceId) {
$.synapseWorkspaceId = synapseWorkspaceId;
return this;
}
/**
* @param synapseWorkspaceId The Synapse Workspace which the Synapse Role Assignment applies to. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder synapseWorkspaceId(String synapseWorkspaceId) {
return synapseWorkspaceId(Output.of(synapseWorkspaceId));
}
public RoleAssignmentState build() {
return $;
}
}
}