Azure Classic v5.38.0, Mar 21 23

azure.mysql.ActiveDirectoryAdministrator

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

Example Usage

using System.Collections.Generic;
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 exampleServer = new Azure.MySql.Server("exampleServer", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        AdministratorLogin = "mysqladminun",
        AdministratorLoginPassword = "H@Sh1CoR3!",
        SslEnforcementEnabled = true,
        SkuName = "B_Gen5_2",
        StorageMb = 5120,
        Version = "5.7",
    });

    var exampleActiveDirectoryAdministrator = new Azure.MySql.ActiveDirectoryAdministrator("exampleActiveDirectoryAdministrator", new()
    {
        ServerName = exampleServer.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/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
		}
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleServer, err := mysql.NewServer(ctx, "exampleServer", &mysql.ServerArgs{
			Location:                   exampleResourceGroup.Location,
			ResourceGroupName:          exampleResourceGroup.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, "exampleActiveDirectoryAdministrator", &mysql.ActiveDirectoryAdministratorArgs{
			ServerName:        exampleServer.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.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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleServer = new Server("exampleServer", ServerArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.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(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_server = azure.mysql.Server("exampleServer",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.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("exampleActiveDirectoryAdministrator",
    server_name=example_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 exampleServer = new azure.mysql.Server("exampleServer", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    administratorLogin: "mysqladminun",
    administratorLoginPassword: "H@Sh1CoR3!",
    sslEnforcementEnabled: true,
    skuName: "B_Gen5_2",
    storageMb: 5120,
    version: "5.7",
});
const exampleActiveDirectoryAdministrator = new azure.mysql.ActiveDirectoryAdministrator("exampleActiveDirectoryAdministrator", {
    serverName: exampleServer.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
  exampleServer:
    type: azure:mysql:Server
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      administratorLogin: mysqladminun
      administratorLoginPassword: H@Sh1CoR3!
      sslEnforcementEnabled: true
      skuName: B_Gen5_2
      storageMb: 5120
      version: '5.7'
  exampleActiveDirectoryAdministrator:
    type: azure:mysql:ActiveDirectoryAdministrator
    properties:
      serverName: ${exampleServer.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,
                                 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:mysql: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. For a managed identity this should be the Client ID of the identity.
ResourceGroupName string: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
ServerName string: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
TenantId string: The Azure Tenant ID

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. For a managed identity this should be the Client ID of the identity.
ResourceGroupName string: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
ServerName string: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
TenantId string: The Azure Tenant ID

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. For a managed identity this should be the Client ID of the identity.
resourceGroupName String: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
serverName String: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId String: The Azure Tenant ID

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. For a managed identity this should be the Client ID of the identity.
resourceGroupName string: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
serverName string: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId string: The Azure Tenant ID

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. For a managed identity this should be the Client ID of the identity.
resource_group_name str: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
server_name str: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenant_id str: The Azure Tenant ID

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. For a managed identity this should be the Client ID of the identity.
resourceGroupName String: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
serverName String: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId String: The Azure Tenant ID

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,
        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:

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. For a managed identity this should be the Client ID of the identity.
ResourceGroupName string: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
ServerName string: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
TenantId string: The Azure Tenant ID

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. For a managed identity this should be the Client ID of the identity.
ResourceGroupName string: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
ServerName string: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
TenantId string: The Azure Tenant ID

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. For a managed identity this should be the Client ID of the identity.
resourceGroupName String: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
serverName String: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId String: The Azure Tenant ID

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. For a managed identity this should be the Client ID of the identity.
resourceGroupName string: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
serverName string: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId string: The Azure Tenant ID

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. For a managed identity this should be the Client ID of the identity.
resource_group_name str: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
server_name str: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenant_id str: The Azure Tenant ID

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. For a managed identity this should be the Client ID of the identity.
resourceGroupName String: The name of the resource group for the MySQL server. Changing this forces a new resource to be created.
serverName String: The name of the MySQL Server on which to set the administrator. Changing this forces a new resource to be created.
tenantId String: The Azure Tenant ID

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

Package Details

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