1. Packages
  2. Azure Classic
  3. API Docs
  4. sql
  5. ActiveDirectoryAdministrator

We recommend using Azure Native.

Azure Classic v5.66.1 published on Wednesday, Feb 14, 2024 by Pulumi

azure.sql.ActiveDirectoryAdministrator

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.66.1 published on Wednesday, Feb 14, 2024 by Pulumi

    Allows you to set a user or group as the AD administrator for an Azure SQL server.

    Note: The azure.sql.ActiveDirectoryAdministrator resource is deprecated in version 3.0 of the AzureRM provider and will be removed in version 4.0. Please use the azuread_administrator block of the azure.mssql.Server resource instead.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var current = Azure.Core.GetClientConfig.Invoke();
    
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var exampleSqlServer = new Azure.Sql.SqlServer("exampleSqlServer", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            Version = "12.0",
            AdministratorLogin = "4dm1n157r470r",
            AdministratorLoginPassword = "4-v3ry-53cr37-p455w0rd",
        });
    
        var exampleActiveDirectoryAdministrator = new Azure.Sql.ActiveDirectoryAdministrator("exampleActiveDirectoryAdministrator", new()
        {
            ServerName = exampleSqlServer.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            Login = "sqladmin",
            TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
            ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/sql"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		current, err := core.GetClientConfig(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleSqlServer, err := sql.NewSqlServer(ctx, "exampleSqlServer", &sql.SqlServerArgs{
    			ResourceGroupName:          exampleResourceGroup.Name,
    			Location:                   exampleResourceGroup.Location,
    			Version:                    pulumi.String("12.0"),
    			AdministratorLogin:         pulumi.String("4dm1n157r470r"),
    			AdministratorLoginPassword: pulumi.String("4-v3ry-53cr37-p455w0rd"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = sql.NewActiveDirectoryAdministrator(ctx, "exampleActiveDirectoryAdministrator", &sql.ActiveDirectoryAdministratorArgs{
    			ServerName:        exampleSqlServer.Name,
    			ResourceGroupName: exampleResourceGroup.Name,
    			Login:             pulumi.String("sqladmin"),
    			TenantId:          *pulumi.String(current.TenantId),
    			ObjectId:          *pulumi.String(current.ObjectId),
    		})
    		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.azure.core.CoreFunctions;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.sql.SqlServer;
    import com.pulumi.azure.sql.SqlServerArgs;
    import com.pulumi.azure.sql.ActiveDirectoryAdministrator;
    import com.pulumi.azure.sql.ActiveDirectoryAdministratorArgs;
    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) {
            final var current = CoreFunctions.getClientConfig();
    
            var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
                .location("West Europe")
                .build());
    
            var exampleSqlServer = new SqlServer("exampleSqlServer", SqlServerArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.location())
                .version("12.0")
                .administratorLogin("4dm1n157r470r")
                .administratorLoginPassword("4-v3ry-53cr37-p455w0rd")
                .build());
    
            var exampleActiveDirectoryAdministrator = new ActiveDirectoryAdministrator("exampleActiveDirectoryAdministrator", ActiveDirectoryAdministratorArgs.builder()        
                .serverName(exampleSqlServer.name())
                .resourceGroupName(exampleResourceGroup.name())
                .login("sqladmin")
                .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
                .objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    current = azure.core.get_client_config()
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_sql_server = azure.sql.SqlServer("exampleSqlServer",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        version="12.0",
        administrator_login="4dm1n157r470r",
        administrator_login_password="4-v3ry-53cr37-p455w0rd")
    example_active_directory_administrator = azure.sql.ActiveDirectoryAdministrator("exampleActiveDirectoryAdministrator",
        server_name=example_sql_server.name,
        resource_group_name=example_resource_group.name,
        login="sqladmin",
        tenant_id=current.tenant_id,
        object_id=current.object_id)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const current = azure.core.getClientConfig({});
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleSqlServer = new azure.sql.SqlServer("exampleSqlServer", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        version: "12.0",
        administratorLogin: "4dm1n157r470r",
        administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
    });
    const exampleActiveDirectoryAdministrator = new azure.sql.ActiveDirectoryAdministrator("exampleActiveDirectoryAdministrator", {
        serverName: exampleSqlServer.name,
        resourceGroupName: exampleResourceGroup.name,
        login: "sqladmin",
        tenantId: current.then(current => current.tenantId),
        objectId: current.then(current => current.objectId),
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleSqlServer:
        type: azure:sql:SqlServer
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.location}
          version: '12.0'
          administratorLogin: 4dm1n157r470r
          administratorLoginPassword: 4-v3ry-53cr37-p455w0rd
      exampleActiveDirectoryAdministrator:
        type: azure:sql:ActiveDirectoryAdministrator
        properties:
          serverName: ${exampleSqlServer.name}
          resourceGroupName: ${exampleResourceGroup.name}
          login: sqladmin
          tenantId: ${current.tenantId}
          objectId: ${current.objectId}
    variables:
      current:
        fn::invoke:
          Function: azure:core:getClientConfig
          Arguments: {}
    

    Create ActiveDirectoryAdministrator Resource

    new ActiveDirectoryAdministrator(name: string, args: ActiveDirectoryAdministratorArgs, opts?: CustomResourceOptions);
    @overload
    def ActiveDirectoryAdministrator(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     azuread_authentication_only: Optional[bool] = None,
                                     login: Optional[str] = None,
                                     object_id: Optional[str] = None,
                                     resource_group_name: Optional[str] = None,
                                     server_name: Optional[str] = None,
                                     tenant_id: Optional[str] = None)
    @overload
    def ActiveDirectoryAdministrator(resource_name: str,
                                     args: ActiveDirectoryAdministratorArgs,
                                     opts: Optional[ResourceOptions] = None)
    func NewActiveDirectoryAdministrator(ctx *Context, name string, args ActiveDirectoryAdministratorArgs, opts ...ResourceOption) (*ActiveDirectoryAdministrator, error)
    public ActiveDirectoryAdministrator(string name, ActiveDirectoryAdministratorArgs args, CustomResourceOptions? opts = null)
    public ActiveDirectoryAdministrator(String name, ActiveDirectoryAdministratorArgs args)
    public ActiveDirectoryAdministrator(String name, ActiveDirectoryAdministratorArgs args, CustomResourceOptions options)
    
    type: azure:sql:ActiveDirectoryAdministrator
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ActiveDirectoryAdministratorArgs
    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 ActiveDirectoryAdministratorArgs
    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 ActiveDirectoryAdministratorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ActiveDirectoryAdministratorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ActiveDirectoryAdministratorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Login string
    The login name of the principal to set as the server administrator
    ObjectId string
    The ID of the principal to set as the server administrator
    ResourceGroupName string
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    ServerName string
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    TenantId string
    The Azure Tenant ID
    AzureadAuthenticationOnly bool
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
    Login string
    The login name of the principal to set as the server administrator
    ObjectId string
    The ID of the principal to set as the server administrator
    ResourceGroupName string
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    ServerName string
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    TenantId string
    The Azure Tenant ID
    AzureadAuthenticationOnly bool
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
    login String
    The login name of the principal to set as the server administrator
    objectId String
    The ID of the principal to set as the server administrator
    resourceGroupName String
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    serverName String
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    tenantId String
    The Azure Tenant ID
    azureadAuthenticationOnly Boolean
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
    login string
    The login name of the principal to set as the server administrator
    objectId string
    The ID of the principal to set as the server administrator
    resourceGroupName string
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    serverName string
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    tenantId string
    The Azure Tenant ID
    azureadAuthenticationOnly boolean
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
    login str
    The login name of the principal to set as the server administrator
    object_id str
    The ID of the principal to set as the server administrator
    resource_group_name str
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    server_name str
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    tenant_id str
    The Azure Tenant ID
    azuread_authentication_only bool
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
    login String
    The login name of the principal to set as the server administrator
    objectId String
    The ID of the principal to set as the server administrator
    resourceGroupName String
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    serverName String
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    tenantId String
    The Azure Tenant ID
    azureadAuthenticationOnly Boolean
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ActiveDirectoryAdministrator Resource

    Get an existing ActiveDirectoryAdministrator resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ActiveDirectoryAdministratorState, opts?: CustomResourceOptions): ActiveDirectoryAdministrator
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            azuread_authentication_only: Optional[bool] = None,
            login: Optional[str] = None,
            object_id: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            server_name: Optional[str] = None,
            tenant_id: Optional[str] = None) -> ActiveDirectoryAdministrator
    func GetActiveDirectoryAdministrator(ctx *Context, name string, id IDInput, state *ActiveDirectoryAdministratorState, opts ...ResourceOption) (*ActiveDirectoryAdministrator, error)
    public static ActiveDirectoryAdministrator Get(string name, Input<string> id, ActiveDirectoryAdministratorState? state, CustomResourceOptions? opts = null)
    public static ActiveDirectoryAdministrator get(String name, Output<String> id, ActiveDirectoryAdministratorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AzureadAuthenticationOnly bool
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
    Login string
    The login name of the principal to set as the server administrator
    ObjectId string
    The ID of the principal to set as the server administrator
    ResourceGroupName string
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    ServerName string
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    TenantId string
    The Azure Tenant ID
    AzureadAuthenticationOnly bool
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
    Login string
    The login name of the principal to set as the server administrator
    ObjectId string
    The ID of the principal to set as the server administrator
    ResourceGroupName string
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    ServerName string
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    TenantId string
    The Azure Tenant ID
    azureadAuthenticationOnly Boolean
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
    login String
    The login name of the principal to set as the server administrator
    objectId String
    The ID of the principal to set as the server administrator
    resourceGroupName String
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    serverName String
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    tenantId String
    The Azure Tenant ID
    azureadAuthenticationOnly boolean
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
    login string
    The login name of the principal to set as the server administrator
    objectId string
    The ID of the principal to set as the server administrator
    resourceGroupName string
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    serverName string
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    tenantId string
    The Azure Tenant ID
    azuread_authentication_only bool
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
    login str
    The login name of the principal to set as the server administrator
    object_id str
    The ID of the principal to set as the server administrator
    resource_group_name str
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    server_name str
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    tenant_id str
    The Azure Tenant ID
    azureadAuthenticationOnly Boolean
    Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
    login String
    The login name of the principal to set as the server administrator
    objectId String
    The ID of the principal to set as the server administrator
    resourceGroupName String
    The name of the resource group for the SQL server. Changing this forces a new resource to be created.
    serverName String
    The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
    tenantId String
    The Azure Tenant ID

    Import

    A SQL Active Directory Administrator can be imported using the resource id, e.g.

    $ pulumi import azure:sql/activeDirectoryAdministrator:ActiveDirectoryAdministrator administrator /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Sql/servers/myserver/administrators/activeDirectory
    

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.66.1 published on Wednesday, Feb 14, 2024 by Pulumi