Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. WorkspaceSqlAadAdmin
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.20.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.WorkspaceSqlAadAdmin

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.20.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-azure-native

    Workspace active directory administrator Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2021-03-01.

    Other available API versions: 2021-06-01-preview.

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

    new WorkspaceSqlAadAdmin(name: string, args: WorkspaceSqlAadAdminArgs, opts?: CustomResourceOptions);
    @overload
def WorkspaceSqlAadAdmin(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         administrator_type: Optional[str] = None,
                         login: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         sid: Optional[str] = None,
                         tenant_id: Optional[str] = None,
                         workspace_name: Optional[str] = None)
@overload
def WorkspaceSqlAadAdmin(resource_name: str,
                         args: WorkspaceSqlAadAdminArgs,
                         opts: Optional[ResourceOptions] = 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.
    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.

    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

    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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlAdministrators/activeDirectory

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.20.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-azure-native