Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. synapse
  5. WorkspaceSqlAadAdmin
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.WorkspaceSqlAadAdmin

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Workspace active directory administrator API Version: 2021-03-01.

    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",
    });

});

    package main

import (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse"
	"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
	})
}

    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());

    }
}

    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")

    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",
});

    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

    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 string
    The unique name of the resource.
    args WorkspaceSqlAadAdminArgs
    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 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 string
    The unique name of the resource.
    args WorkspaceSqlAadAdminArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceSqlAadAdminArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
});

    example, err := synapse.NewWorkspaceSqlAadAdmin(ctx, "workspaceSqlAadAdminResource", &synapse.WorkspaceSqlAadAdminArgs{
	ResourceGroupName: "string",
	WorkspaceName:     "string",
	AdministratorType: "string",
	Login:             "string",
	Sid:               "string",
	TenantId:          "string",
})

    var workspaceSqlAadAdminResource = new WorkspaceSqlAadAdmin("workspaceSqlAadAdminResource", WorkspaceSqlAadAdminArgs.builder()
    .resourceGroupName("string")
    .workspaceName("string")
    .administratorType("string")
    .login("string")
    .sid("string")
    .tenantId("string")
    .build());

    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)

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

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

    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 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 WorkspaceSqlAadAdmin resource produces the following output properties:

    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"
    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"
    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"
    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"
    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"
    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/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/administrators/activeDirectory

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native