Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. WorkspaceAadAdmin
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.WorkspaceAadAdmin

Explore with Pulumi AI

azure-native logo
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.1.0 published on Tuesday, Apr 8, 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.

    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 workspaceAadAdmin = new AzureNative.Synapse.WorkspaceAadAdmin("workspaceAadAdmin", new()
    {
        AdministratorType = "ActiveDirectory",
        Login = "bob@contoso.com",
        ResourceGroupName = "resourceGroup1",
        Sid = "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        TenantId = "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        WorkspaceName = "workspace1",
    });

});

    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.NewWorkspaceAadAdmin(ctx, "workspaceAadAdmin", &synapse.WorkspaceAadAdminArgs{
			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
	})
}

    package generated_program;

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

    }
}

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

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

    import pulumi
import pulumi_azure_native as azure_native

workspace_aad_admin = azure_native.synapse.WorkspaceAadAdmin("workspaceAadAdmin",
    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")

    resources:
  workspaceAadAdmin:
    type: azure-native:synapse:WorkspaceAadAdmin
    properties:
      administratorType: ActiveDirectory
      login: bob@contoso.com
      resourceGroupName: resourceGroup1
      sid: c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c
      tenantId: c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c
      workspaceName: workspace1

    Create WorkspaceAadAdmin Resource

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

    Constructor syntax

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

@overload
def WorkspaceAadAdmin(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 NewWorkspaceAadAdmin(ctx *Context, name string, args WorkspaceAadAdminArgs, opts ...ResourceOption) (*WorkspaceAadAdmin, error)
    public WorkspaceAadAdmin(string name, WorkspaceAadAdminArgs args, CustomResourceOptions? opts = null)
    public WorkspaceAadAdmin(String name, WorkspaceAadAdminArgs args)
public WorkspaceAadAdmin(String name, WorkspaceAadAdminArgs args, CustomResourceOptions options)

    type: azure-native:synapse:WorkspaceAadAdmin
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 WorkspaceAadAdminArgs
    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 WorkspaceAadAdminArgs
    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 WorkspaceAadAdminArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceAadAdminArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceAadAdminArgs
    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 workspaceAadAdminResource = new AzureNative.Synapse.WorkspaceAadAdmin("workspaceAadAdminResource", new()
{
    ResourceGroupName = "string",
    WorkspaceName = "string",
    AdministratorType = "string",
    Login = "string",
    Sid = "string",
    TenantId = "string",
});

    example, err := synapse.NewWorkspaceAadAdmin(ctx, "workspaceAadAdminResource", &synapse.WorkspaceAadAdminArgs{
	ResourceGroupName: pulumi.String("string"),
	WorkspaceName:     pulumi.String("string"),
	AdministratorType: pulumi.String("string"),
	Login:             pulumi.String("string"),
	Sid:               pulumi.String("string"),
	TenantId:          pulumi.String("string"),
})

    var workspaceAadAdminResource = new WorkspaceAadAdmin("workspaceAadAdminResource", WorkspaceAadAdminArgs.builder()
    .resourceGroupName("string")
    .workspaceName("string")
    .administratorType("string")
    .login("string")
    .sid("string")
    .tenantId("string")
    .build());

    workspace_aad_admin_resource = azure_native.synapse.WorkspaceAadAdmin("workspaceAadAdminResource",
    resource_group_name="string",
    workspace_name="string",
    administrator_type="string",
    login="string",
    sid="string",
    tenant_id="string")

    const workspaceAadAdminResource = new azure_native.synapse.WorkspaceAadAdmin("workspaceAadAdminResource", {
    resourceGroupName: "string",
    workspaceName: "string",
    administratorType: "string",
    login: "string",
    sid: "string",
    tenantId: "string",
});

    type: azure-native:synapse:WorkspaceAadAdmin
properties:
    administratorType: string
    login: string
    resourceGroupName: string
    sid: string
    tenantId: string
    workspaceName: string

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

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkspaceAadAdmin 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:WorkspaceAadAdmin activeDirectory /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/administrators/activeDirectory

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
    pulumi/pulumi-azure-native