Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. WorkspaceSqlAadAdmin
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.WorkspaceSqlAadAdmin

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Workspace active directory administrator

Uses Azure REST API version 2021-06-01. In version 2.x of the Azure Native provider, it used API version 2021-06-01.

Other available API versions: 2021-04-01-preview, 2021-05-01, 2021-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native synapse [ApiVersion]. See the version guide for details.

Note: SQL AAD Admin is configured automatically during workspace creation and assigned to the current user. One can’t add more admins with this resource unless you manually delete the current SQL AAD Admin.

Example Usage

Create or update workspace active directory admin

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var workspaceSqlAadAdmin = new AzureNative.Synapse.WorkspaceSqlAadAdmin("workspaceSqlAadAdmin", new()
    {
        AdministratorType = "ActiveDirectory",
        Login = "bob@contoso.com",
        ResourceGroupName = "resourceGroup1",
        Sid = "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        TenantId = "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        WorkspaceName = "workspace1",
    });

});
Copy
package main

import (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewWorkspaceSqlAadAdmin(ctx, "workspaceSqlAadAdmin", &synapse.WorkspaceSqlAadAdminArgs{
			AdministratorType: pulumi.String("ActiveDirectory"),
			Login:             pulumi.String("bob@contoso.com"),
			ResourceGroupName: pulumi.String("resourceGroup1"),
			Sid:               pulumi.String("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
			TenantId:          pulumi.String("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
			WorkspaceName:     pulumi.String("workspace1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.synapse.WorkspaceSqlAadAdmin;
import com.pulumi.azurenative.synapse.WorkspaceSqlAadAdminArgs;
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 workspaceSqlAadAdmin = new WorkspaceSqlAadAdmin("workspaceSqlAadAdmin", WorkspaceSqlAadAdminArgs.builder()
            .administratorType("ActiveDirectory")
            .login("bob@contoso.com")
            .resourceGroupName("resourceGroup1")
            .sid("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c")
            .tenantId("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c")
            .workspaceName("workspace1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const workspaceSqlAadAdmin = new azure_native.synapse.WorkspaceSqlAadAdmin("workspaceSqlAadAdmin", {
    administratorType: "ActiveDirectory",
    login: "bob@contoso.com",
    resourceGroupName: "resourceGroup1",
    sid: "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    tenantId: "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    workspaceName: "workspace1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workspace_sql_aad_admin = azure_native.synapse.WorkspaceSqlAadAdmin("workspaceSqlAadAdmin",
    administrator_type="ActiveDirectory",
    login="bob@contoso.com",
    resource_group_name="resourceGroup1",
    sid="c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    tenant_id="c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    workspace_name="workspace1")
Copy
resources:
  workspaceSqlAadAdmin:
    type: azure-native:synapse:WorkspaceSqlAadAdmin
    properties:
      administratorType: ActiveDirectory
      login: bob@contoso.com
      resourceGroupName: resourceGroup1
      sid: c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c
      tenantId: c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c
      workspaceName: workspace1
Copy

Create WorkspaceSqlAadAdmin Resource

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

Constructor syntax

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

@overload
def WorkspaceSqlAadAdmin(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         resource_group_name: Optional[str] = None,
                         workspace_name: Optional[str] = None,
                         administrator_type: Optional[str] = None,
                         login: Optional[str] = None,
                         sid: Optional[str] = None,
                         tenant_id: Optional[str] = None)
func NewWorkspaceSqlAadAdmin(ctx *Context, name string, args WorkspaceSqlAadAdminArgs, opts ...ResourceOption) (*WorkspaceSqlAadAdmin, error)
public WorkspaceSqlAadAdmin(string name, WorkspaceSqlAadAdminArgs args, CustomResourceOptions? opts = null)
public WorkspaceSqlAadAdmin(String name, WorkspaceSqlAadAdminArgs args)
public WorkspaceSqlAadAdmin(String name, WorkspaceSqlAadAdminArgs args, CustomResourceOptions options)

type: azure-native:synapse:WorkspaceSqlAadAdmin
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSqlAadAdminArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkspaceSqlAadAdminArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSqlAadAdminArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceSqlAadAdminArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkspaceSqlAadAdminArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var workspaceSqlAadAdminResource = new AzureNative.Synapse.WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource", new()
{
    ResourceGroupName = "string",
    WorkspaceName = "string",
    AdministratorType = "string",
    Login = "string",
    Sid = "string",
    TenantId = "string",
});
Copy
example, err := synapse.NewWorkspaceSqlAadAdmin(ctx, "workspaceSqlAadAdminResource", &synapse.WorkspaceSqlAadAdminArgs{
	ResourceGroupName: pulumi.String("string"),
	WorkspaceName:     pulumi.String("string"),
	AdministratorType: pulumi.String("string"),
	Login:             pulumi.String("string"),
	Sid:               pulumi.String("string"),
	TenantId:          pulumi.String("string"),
})
Copy
var workspaceSqlAadAdminResource = new WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource", WorkspaceSqlAadAdminArgs.builder()
    .resourceGroupName("string")
    .workspaceName("string")
    .administratorType("string")
    .login("string")
    .sid("string")
    .tenantId("string")
    .build());
Copy
workspace_sql_aad_admin_resource = azure_native.synapse.WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource",
    resource_group_name="string",
    workspace_name="string",
    administrator_type="string",
    login="string",
    sid="string",
    tenant_id="string")
Copy
const workspaceSqlAadAdminResource = new azure_native.synapse.WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource", {
    resourceGroupName: "string",
    workspaceName: "string",
    administratorType: "string",
    login: "string",
    sid: "string",
    tenantId: "string",
});
Copy
type: azure-native:synapse:WorkspaceSqlAadAdmin
properties:
    administratorType: string
    login: string
    resourceGroupName: string
    sid: string
    tenantId: string
    workspaceName: string
Copy

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

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
AdministratorType Changes to this property will trigger replacement. string
Workspace active directory administrator type
Login string
Login of the workspace active directory administrator
Sid Changes to this property will trigger replacement. string
Object ID of the workspace active directory administrator
TenantId Changes to this property will trigger replacement. string
Tenant ID of the workspace active directory administrator
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
AdministratorType Changes to this property will trigger replacement. string
Workspace active directory administrator type
Login string
Login of the workspace active directory administrator
Sid Changes to this property will trigger replacement. string
Object ID of the workspace active directory administrator
TenantId Changes to this property will trigger replacement. string
Tenant ID of the workspace active directory administrator
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
administratorType Changes to this property will trigger replacement. String
Workspace active directory administrator type
login String
Login of the workspace active directory administrator
sid Changes to this property will trigger replacement. String
Object ID of the workspace active directory administrator
tenantId Changes to this property will trigger replacement. String
Tenant ID of the workspace active directory administrator
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
administratorType Changes to this property will trigger replacement. string
Workspace active directory administrator type
login string
Login of the workspace active directory administrator
sid Changes to this property will trigger replacement. string
Object ID of the workspace active directory administrator
tenantId Changes to this property will trigger replacement. string
Tenant ID of the workspace active directory administrator
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
administrator_type Changes to this property will trigger replacement. str
Workspace active directory administrator type
login str
Login of the workspace active directory administrator
sid Changes to this property will trigger replacement. str
Object ID of the workspace active directory administrator
tenant_id Changes to this property will trigger replacement. str
Tenant ID of the workspace active directory administrator
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
administratorType Changes to this property will trigger replacement. String
Workspace active directory administrator type
login String
Login of the workspace active directory administrator
sid Changes to this property will trigger replacement. String
Object ID of the workspace active directory administrator
tenantId Changes to this property will trigger replacement. String
Tenant ID of the workspace active directory administrator

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkspaceSqlAadAdmin resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:synapse:WorkspaceSqlAadAdmin activeDirectory /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlAdministrators/activeDirectory
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native