All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.sql.kotlin.ActiveDirectoryAdministratorArgs.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 6.14.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.sql.kotlin

import com.pulumi.azure.sql.ActiveDirectoryAdministratorArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * 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
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const current = azure.core.getClientConfig({});
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "example-resources",
 *     location: "West Europe",
 * });
 * const exampleSqlServer = new azure.sql.SqlServer("example", {
 *     name: "mysqlserver",
 *     resourceGroupName: example.name,
 *     location: example.location,
 *     version: "12.0",
 *     administratorLogin: "4dm1n157r470r",
 *     administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
 * });
 * const exampleActiveDirectoryAdministrator = new azure.sql.ActiveDirectoryAdministrator("example", {
 *     serverName: exampleSqlServer.name,
 *     resourceGroupName: example.name,
 *     login: "sqladmin",
 *     tenantId: current.then(current => current.tenantId),
 *     objectId: current.then(current => current.objectId),
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * current = azure.core.get_client_config()
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_sql_server = azure.sql.SqlServer("example",
 *     name="mysqlserver",
 *     resource_group_name=example.name,
 *     location=example.location,
 *     version="12.0",
 *     administrator_login="4dm1n157r470r",
 *     administrator_login_password="4-v3ry-53cr37-p455w0rd")
 * example_active_directory_administrator = azure.sql.ActiveDirectoryAdministrator("example",
 *     server_name=example_sql_server.name,
 *     resource_group_name=example.name,
 *     login="sqladmin",
 *     tenant_id=current.tenant_id,
 *     object_id=current.object_id)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var current = Azure.Core.GetClientConfig.Invoke();
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "example-resources",
 *         Location = "West Europe",
 *     });
 *     var exampleSqlServer = new Azure.Sql.SqlServer("example", new()
 *     {
 *         Name = "mysqlserver",
 *         ResourceGroupName = example.Name,
 *         Location = example.Location,
 *         Version = "12.0",
 *         AdministratorLogin = "4dm1n157r470r",
 *         AdministratorLoginPassword = "4-v3ry-53cr37-p455w0rd",
 *     });
 *     var exampleActiveDirectoryAdministrator = new Azure.Sql.ActiveDirectoryAdministrator("example", new()
 *     {
 *         ServerName = exampleSqlServer.Name,
 *         ResourceGroupName = example.Name,
 *         Login = "sqladmin",
 *         TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
 *         ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
 *     });
 * });
 * ```
 * ```go
 * 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
 * 		}
 * 		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("example-resources"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleSqlServer, err := sql.NewSqlServer(ctx, "example", &sql.SqlServerArgs{
 * 			Name:                       pulumi.String("mysqlserver"),
 * 			ResourceGroupName:          example.Name,
 * 			Location:                   example.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, "example", &sql.ActiveDirectoryAdministratorArgs{
 * 			ServerName:        exampleSqlServer.Name,
 * 			ResourceGroupName: example.Name,
 * 			Login:             pulumi.String("sqladmin"),
 * 			TenantId:          pulumi.String(current.TenantId),
 * 			ObjectId:          pulumi.String(current.ObjectId),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("example-resources")
 *             .location("West Europe")
 *             .build());
 *         var exampleSqlServer = new SqlServer("exampleSqlServer", SqlServerArgs.builder()
 *             .name("mysqlserver")
 *             .resourceGroupName(example.name())
 *             .location(example.location())
 *             .version("12.0")
 *             .administratorLogin("4dm1n157r470r")
 *             .administratorLoginPassword("4-v3ry-53cr37-p455w0rd")
 *             .build());
 *         var exampleActiveDirectoryAdministrator = new ActiveDirectoryAdministrator("exampleActiveDirectoryAdministrator", ActiveDirectoryAdministratorArgs.builder()
 *             .serverName(exampleSqlServer.name())
 *             .resourceGroupName(example.name())
 *             .login("sqladmin")
 *             .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
 *             .objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleSqlServer:
 *     type: azure:sql:SqlServer
 *     name: example
 *     properties:
 *       name: mysqlserver
 *       resourceGroupName: ${example.name}
 *       location: ${example.location}
 *       version: '12.0'
 *       administratorLogin: 4dm1n157r470r
 *       administratorLoginPassword: 4-v3ry-53cr37-p455w0rd
 *   exampleActiveDirectoryAdministrator:
 *     type: azure:sql:ActiveDirectoryAdministrator
 *     name: example
 *     properties:
 *       serverName: ${exampleSqlServer.name}
 *       resourceGroupName: ${example.name}
 *       login: sqladmin
 *       tenantId: ${current.tenantId}
 *       objectId: ${current.objectId}
 * variables:
 *   current:
 *     fn::invoke:
 *       Function: azure:core:getClientConfig
 *       Arguments: {}
 * ```
 * 
 * ## Import
 * A SQL Active Directory Administrator can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:sql/activeDirectoryAdministrator:ActiveDirectoryAdministrator administrator /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Sql/servers/myserver/administrators/activeDirectory
 * ```
 * @property azureadAuthenticationOnly Specifies whether only AD Users and administrators can be used to login (`true`) or also local database users (`false`).
 * @property login The login name of the principal to set as the server administrator
 * @property objectId The ID of the principal to set as the server administrator
 * @property resourceGroupName The name of the resource group for the SQL server. Changing this forces a new resource to be created.
 * @property serverName The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
 * @property tenantId The Azure Tenant ID
 */
public data class ActiveDirectoryAdministratorArgs(
    public val azureadAuthenticationOnly: Output? = null,
    public val login: Output? = null,
    public val objectId: Output? = null,
    public val resourceGroupName: Output? = null,
    public val serverName: Output? = null,
    public val tenantId: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.sql.ActiveDirectoryAdministratorArgs =
        com.pulumi.azure.sql.ActiveDirectoryAdministratorArgs.builder()
            .azureadAuthenticationOnly(azureadAuthenticationOnly?.applyValue({ args0 -> args0 }))
            .login(login?.applyValue({ args0 -> args0 }))
            .objectId(objectId?.applyValue({ args0 -> args0 }))
            .resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
            .serverName(serverName?.applyValue({ args0 -> args0 }))
            .tenantId(tenantId?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [ActiveDirectoryAdministratorArgs].
 */
@PulumiTagMarker
public class ActiveDirectoryAdministratorArgsBuilder internal constructor() {
    private var azureadAuthenticationOnly: Output? = null

    private var login: Output? = null

    private var objectId: Output? = null

    private var resourceGroupName: Output? = null

    private var serverName: Output? = null

    private var tenantId: Output? = null

    /**
     * @param value Specifies whether only AD Users and administrators can be used to login (`true`) or also local database users (`false`).
     */
    @JvmName("wfpnbstprvlmsjtd")
    public suspend fun azureadAuthenticationOnly(`value`: Output) {
        this.azureadAuthenticationOnly = value
    }

    /**
     * @param value The login name of the principal to set as the server administrator
     */
    @JvmName("cqbleginhrimyaus")
    public suspend fun login(`value`: Output) {
        this.login = value
    }

    /**
     * @param value The ID of the principal to set as the server administrator
     */
    @JvmName("jcbverttwtktywdd")
    public suspend fun objectId(`value`: Output) {
        this.objectId = value
    }

    /**
     * @param value The name of the resource group for the SQL server. Changing this forces a new resource to be created.
     */
    @JvmName("oxtnslxvbbnreyop")
    public suspend fun resourceGroupName(`value`: Output) {
        this.resourceGroupName = value
    }

    /**
     * @param value The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
     */
    @JvmName("ptlramxpxwmtorav")
    public suspend fun serverName(`value`: Output) {
        this.serverName = value
    }

    /**
     * @param value The Azure Tenant ID
     */
    @JvmName("mpcnouwcyfdwxugd")
    public suspend fun tenantId(`value`: Output) {
        this.tenantId = value
    }

    /**
     * @param value Specifies whether only AD Users and administrators can be used to login (`true`) or also local database users (`false`).
     */
    @JvmName("mwleuawjqhdtblty")
    public suspend fun azureadAuthenticationOnly(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.azureadAuthenticationOnly = mapped
    }

    /**
     * @param value The login name of the principal to set as the server administrator
     */
    @JvmName("uwprkmpvjrhitlcv")
    public suspend fun login(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.login = mapped
    }

    /**
     * @param value The ID of the principal to set as the server administrator
     */
    @JvmName("umvxxgehqoxefhgh")
    public suspend fun objectId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.objectId = mapped
    }

    /**
     * @param value The name of the resource group for the SQL server. Changing this forces a new resource to be created.
     */
    @JvmName("kdrabyjajpitbmor")
    public suspend fun resourceGroupName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.resourceGroupName = mapped
    }

    /**
     * @param value The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.
     */
    @JvmName("wyvdqqoakvgcdtps")
    public suspend fun serverName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.serverName = mapped
    }

    /**
     * @param value The Azure Tenant ID
     */
    @JvmName("kragfdoxlarouwbu")
    public suspend fun tenantId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.tenantId = mapped
    }

    internal fun build(): ActiveDirectoryAdministratorArgs = ActiveDirectoryAdministratorArgs(
        azureadAuthenticationOnly = azureadAuthenticationOnly,
        login = login,
        objectId = objectId,
        resourceGroupName = resourceGroupName,
        serverName = serverName,
        tenantId = tenantId,
    )
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy