pulumi-azure-kotlin/com.pulumi.azure.mysql.kotlin/ActiveDirectoryAdministratorArgs

ActiveDirectoryAdministratorArgs

data class ActiveDirectoryAdministratorArgs(val login: Output<String>? = null, val objectId: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serverName: Output<String>? = null, val tenantId: Output<String>? = null) : ConvertibleToJava<ActiveDirectoryAdministratorArgs>

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

Note: Azure Database for MySQL Single Server and its sub resources are scheduled for retirement by 2024-09-16 and will migrate to using Azure Database for MySQL Flexible Server: https://go.microsoft.com/fwlink/?linkid=2216041. The azure.mysql.ActiveDirectoryAdministrator resource is deprecated and will be removed in v4.0 of the AzureRM Provider. Please use the azure.mysql.FlexibleServerActiveDirectoryAdministratory resource instead.

Example Usage

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 exampleServer = new azure.mysql.Server("example", {
    name: "example-mysqlserver",
    location: example.location,
    resourceGroupName: example.name,
    administratorLogin: "mysqladminun",
    administratorLoginPassword: "H@Sh1CoR3!",
    sslEnforcementEnabled: true,
    skuName: "B_Gen5_2",
    storageMb: 5120,
    version: "5.7",
});
const exampleActiveDirectoryAdministrator = new azure.mysql.ActiveDirectoryAdministrator("example", {
    serverName: exampleServer.name,
    resourceGroupName: example.name,
    login: "sqladmin",
    tenantId: current.then(current => current.tenantId),
    objectId: current.then(current => current.objectId),
});
Content copied to clipboard
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_server = azure.mysql.Server("example",
    name="example-mysqlserver",
    location=example.location,
    resource_group_name=example.name,
    administrator_login="mysqladminun",
    administrator_login_password="H@Sh1CoR3!",
    ssl_enforcement_enabled=True,
    sku_name="B_Gen5_2",
    storage_mb=5120,
    version="5.7")
example_active_directory_administrator = azure.mysql.ActiveDirectoryAdministrator("example",
    server_name=example_server.name,
    resource_group_name=example.name,
    login="sqladmin",
    tenant_id=current.tenant_id,
    object_id=current.object_id)
Content copied to clipboard
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 exampleServer = new Azure.MySql.Server("example", new()
    {
        Name = "example-mysqlserver",
        Location = example.Location,
        ResourceGroupName = example.Name,
        AdministratorLogin = "mysqladminun",
        AdministratorLoginPassword = "H@Sh1CoR3!",
        SslEnforcementEnabled = true,
        SkuName = "B_Gen5_2",
        StorageMb = 5120,
        Version = "5.7",
    });
    var exampleActiveDirectoryAdministrator = new Azure.MySql.ActiveDirectoryAdministrator("example", new()
    {
        ServerName = exampleServer.Name,
        ResourceGroupName = example.Name,
        Login = "sqladmin",
        TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
        ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mysql"
	"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
		}
		exampleServer, err := mysql.NewServer(ctx, "example", &mysql.ServerArgs{
			Name:                       pulumi.String("example-mysqlserver"),
			Location:                   example.Location,
			ResourceGroupName:          example.Name,
			AdministratorLogin:         pulumi.String("mysqladminun"),
			AdministratorLoginPassword: pulumi.String("H@Sh1CoR3!"),
			SslEnforcementEnabled:      pulumi.Bool(true),
			SkuName:                    pulumi.String("B_Gen5_2"),
			StorageMb:                  pulumi.Int(5120),
			Version:                    pulumi.String("5.7"),
		})
		if err != nil {
			return err
		}
		_, err = mysql.NewActiveDirectoryAdministrator(ctx, "example", &mysql.ActiveDirectoryAdministratorArgs{
			ServerName:        exampleServer.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
	})
}
Content copied to clipboard
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.mysql.Server;
import com.pulumi.azure.mysql.ServerArgs;
import com.pulumi.azure.mysql.ActiveDirectoryAdministrator;
import com.pulumi.azure.mysql.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 exampleServer = new Server("exampleServer", ServerArgs.builder()
            .name("example-mysqlserver")
            .location(example.location())
            .resourceGroupName(example.name())
            .administratorLogin("mysqladminun")
            .administratorLoginPassword("H@Sh1CoR3!")
            .sslEnforcementEnabled(true)
            .skuName("B_Gen5_2")
            .storageMb(5120)
            .version("5.7")
            .build());
        var exampleActiveDirectoryAdministrator = new ActiveDirectoryAdministrator("exampleActiveDirectoryAdministrator", ActiveDirectoryAdministratorArgs.builder()
            .serverName(exampleServer.name())
            .resourceGroupName(example.name())
            .login("sqladmin")
            .tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
            .objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleServer:
    type: azure:mysql:Server
    name: example
    properties:
      name: example-mysqlserver
      location: ${example.location}
      resourceGroupName: ${example.name}
      administratorLogin: mysqladminun
      administratorLoginPassword: H@Sh1CoR3!
      sslEnforcementEnabled: true
      skuName: B_Gen5_2
      storageMb: 5120
      version: '5.7'
  exampleActiveDirectoryAdministrator:
    type: azure:mysql:ActiveDirectoryAdministrator
    name: example
    properties:
      serverName: ${exampleServer.name}
      resourceGroupName: ${example.name}
      login: sqladmin
      tenantId: ${current.tenantId}
      objectId: ${current.objectId}
variables:
  current:
    fn::invoke:
      Function: azure:core:getClientConfig
      Arguments: {}
Content copied to clipboard

Import

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

$ pulumi import azure:mysql/activeDirectoryAdministrator:ActiveDirectoryAdministrator administrator /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.DBforMySQL/servers/myserver/administrators/activeDirectory
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(login: Output<String>? = null, objectId: Output<String>? = null, resourceGroupName: Output<String>? = null, serverName: Output<String>? = null, tenantId: Output<String>? = null)

Properties

Link copied to clipboard
val login: Output<String>? = null

The login name of the principal to set as the server administrator

Link copied to clipboard
val objectId: Output<String>? = null

The ID of the principal to set as the server administrator. For a managed identity this should be the Client ID of the identity.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group for the MySQL server. Changing this forces a new resource to be created.

Link copied to clipboard
val serverName: Output<String>? = null

The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.

Link copied to clipboard
val tenantId: Output<String>? = null

The Azure Tenant ID

Functions

Link copied to clipboard
open override fun toJava(): ActiveDirectoryAdministratorArgs