azure-native.dbformysql.AzureADAdministrator
Represents a Administrator.
Uses Azure REST API version 2023-12-30. In version 2.x of the Azure Native provider, it used API version 2022-01-01.
Other available API versions: 2022-01-01, 2023-06-01-preview, 2023-06-30, 2024-12-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native dbformysql [ApiVersion]. See the version guide for details.
Example Usage
Create an azure ad administrator
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var azureADAdministrator = new AzureNative.DBforMySQL.AzureADAdministrator("azureADAdministrator", new()
    {
        AdministratorName = "ActiveDirectory",
        AdministratorType = AzureNative.DBforMySQL.AdministratorType.ActiveDirectory,
        IdentityResourceId = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi",
        Login = "bob@contoso.com",
        ResourceGroupName = "testrg",
        ServerName = "mysqltestsvc4",
        Sid = "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        TenantId = "c12b7025-bfe2-46c1-b463-993b5e4cd467",
    });
});
package main
import (
	dbformysql "github.com/pulumi/pulumi-azure-native-sdk/dbformysql/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dbformysql.NewAzureADAdministrator(ctx, "azureADAdministrator", &dbformysql.AzureADAdministratorArgs{
			AdministratorName:  pulumi.String("ActiveDirectory"),
			AdministratorType:  pulumi.String(dbformysql.AdministratorTypeActiveDirectory),
			IdentityResourceId: pulumi.String("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi"),
			Login:              pulumi.String("bob@contoso.com"),
			ResourceGroupName:  pulumi.String("testrg"),
			ServerName:         pulumi.String("mysqltestsvc4"),
			Sid:                pulumi.String("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
			TenantId:           pulumi.String("c12b7025-bfe2-46c1-b463-993b5e4cd467"),
		})
		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.dbformysql.AzureADAdministrator;
import com.pulumi.azurenative.dbformysql.AzureADAdministratorArgs;
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 azureADAdministrator = new AzureADAdministrator("azureADAdministrator", AzureADAdministratorArgs.builder()
            .administratorName("ActiveDirectory")
            .administratorType("ActiveDirectory")
            .identityResourceId("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi")
            .login("bob@contoso.com")
            .resourceGroupName("testrg")
            .serverName("mysqltestsvc4")
            .sid("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c")
            .tenantId("c12b7025-bfe2-46c1-b463-993b5e4cd467")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const azureADAdministrator = new azure_native.dbformysql.AzureADAdministrator("azureADAdministrator", {
    administratorName: "ActiveDirectory",
    administratorType: azure_native.dbformysql.AdministratorType.ActiveDirectory,
    identityResourceId: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi",
    login: "bob@contoso.com",
    resourceGroupName: "testrg",
    serverName: "mysqltestsvc4",
    sid: "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    tenantId: "c12b7025-bfe2-46c1-b463-993b5e4cd467",
});
import pulumi
import pulumi_azure_native as azure_native
azure_ad_administrator = azure_native.dbformysql.AzureADAdministrator("azureADAdministrator",
    administrator_name="ActiveDirectory",
    administrator_type=azure_native.dbformysql.AdministratorType.ACTIVE_DIRECTORY,
    identity_resource_id="/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi",
    login="bob@contoso.com",
    resource_group_name="testrg",
    server_name="mysqltestsvc4",
    sid="c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    tenant_id="c12b7025-bfe2-46c1-b463-993b5e4cd467")
resources:
  azureADAdministrator:
    type: azure-native:dbformysql:AzureADAdministrator
    properties:
      administratorName: ActiveDirectory
      administratorType: ActiveDirectory
      identityResourceId: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/test-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi
      login: bob@contoso.com
      resourceGroupName: testrg
      serverName: mysqltestsvc4
      sid: c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c
      tenantId: c12b7025-bfe2-46c1-b463-993b5e4cd467
Create AzureADAdministrator Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AzureADAdministrator(name: string, args: AzureADAdministratorArgs, opts?: CustomResourceOptions);@overload
def AzureADAdministrator(resource_name: str,
                         args: AzureADAdministratorArgs,
                         opts: Optional[ResourceOptions] = None)
@overload
def AzureADAdministrator(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         resource_group_name: Optional[str] = None,
                         server_name: Optional[str] = None,
                         administrator_name: Optional[str] = None,
                         administrator_type: Optional[Union[str, AdministratorType]] = None,
                         identity_resource_id: Optional[str] = None,
                         login: Optional[str] = None,
                         sid: Optional[str] = None,
                         tenant_id: Optional[str] = None)func NewAzureADAdministrator(ctx *Context, name string, args AzureADAdministratorArgs, opts ...ResourceOption) (*AzureADAdministrator, error)public AzureADAdministrator(string name, AzureADAdministratorArgs args, CustomResourceOptions? opts = null)
public AzureADAdministrator(String name, AzureADAdministratorArgs args)
public AzureADAdministrator(String name, AzureADAdministratorArgs args, CustomResourceOptions options)
type: azure-native:dbformysql:AzureADAdministrator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AzureADAdministratorArgs
- 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 AzureADAdministratorArgs
- 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 AzureADAdministratorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AzureADAdministratorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AzureADAdministratorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var azureADAdministratorResource = new AzureNative.DBforMySQL.AzureADAdministrator("azureADAdministratorResource", new()
{
    ResourceGroupName = "string",
    ServerName = "string",
    AdministratorName = "string",
    AdministratorType = "string",
    IdentityResourceId = "string",
    Login = "string",
    Sid = "string",
    TenantId = "string",
});
example, err := dbformysql.NewAzureADAdministrator(ctx, "azureADAdministratorResource", &dbformysql.AzureADAdministratorArgs{
	ResourceGroupName:  pulumi.String("string"),
	ServerName:         pulumi.String("string"),
	AdministratorName:  pulumi.String("string"),
	AdministratorType:  pulumi.String("string"),
	IdentityResourceId: pulumi.String("string"),
	Login:              pulumi.String("string"),
	Sid:                pulumi.String("string"),
	TenantId:           pulumi.String("string"),
})
var azureADAdministratorResource = new AzureADAdministrator("azureADAdministratorResource", AzureADAdministratorArgs.builder()
    .resourceGroupName("string")
    .serverName("string")
    .administratorName("string")
    .administratorType("string")
    .identityResourceId("string")
    .login("string")
    .sid("string")
    .tenantId("string")
    .build());
azure_ad_administrator_resource = azure_native.dbformysql.AzureADAdministrator("azureADAdministratorResource",
    resource_group_name="string",
    server_name="string",
    administrator_name="string",
    administrator_type="string",
    identity_resource_id="string",
    login="string",
    sid="string",
    tenant_id="string")
const azureADAdministratorResource = new azure_native.dbformysql.AzureADAdministrator("azureADAdministratorResource", {
    resourceGroupName: "string",
    serverName: "string",
    administratorName: "string",
    administratorType: "string",
    identityResourceId: "string",
    login: "string",
    sid: "string",
    tenantId: "string",
});
type: azure-native:dbformysql:AzureADAdministrator
properties:
    administratorName: string
    administratorType: string
    identityResourceId: string
    login: string
    resourceGroupName: string
    serverName: string
    sid: string
    tenantId: string
AzureADAdministrator Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AzureADAdministrator resource accepts the following input properties:
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ServerName string
- The name of the server.
- AdministratorName string
- The name of the Azure AD Administrator.
- AdministratorType string | Pulumi.Azure Native. DBfor My SQL. Administrator Type 
- Type of the sever administrator.
- IdentityResource stringId 
- The resource id of the identity used for AAD Authentication.
- Login string
- Login name of the server administrator.
- Sid string
- SID (object ID) of the server administrator.
- TenantId string
- Tenant ID of the administrator.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ServerName string
- The name of the server.
- AdministratorName string
- The name of the Azure AD Administrator.
- AdministratorType string | AdministratorType 
- Type of the sever administrator.
- IdentityResource stringId 
- The resource id of the identity used for AAD Authentication.
- Login string
- Login name of the server administrator.
- Sid string
- SID (object ID) of the server administrator.
- TenantId string
- Tenant ID of the administrator.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- serverName String
- The name of the server.
- administratorName String
- The name of the Azure AD Administrator.
- administratorType String | AdministratorType 
- Type of the sever administrator.
- identityResource StringId 
- The resource id of the identity used for AAD Authentication.
- login String
- Login name of the server administrator.
- sid String
- SID (object ID) of the server administrator.
- tenantId String
- Tenant ID of the administrator.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- serverName string
- The name of the server.
- administratorName string
- The name of the Azure AD Administrator.
- administratorType string | AdministratorType 
- Type of the sever administrator.
- identityResource stringId 
- The resource id of the identity used for AAD Authentication.
- login string
- Login name of the server administrator.
- sid string
- SID (object ID) of the server administrator.
- tenantId string
- Tenant ID of the administrator.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- server_name str
- The name of the server.
- administrator_name str
- The name of the Azure AD Administrator.
- administrator_type str | AdministratorType 
- Type of the sever administrator.
- identity_resource_ strid 
- The resource id of the identity used for AAD Authentication.
- login str
- Login name of the server administrator.
- sid str
- SID (object ID) of the server administrator.
- tenant_id str
- Tenant ID of the administrator.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- serverName String
- The name of the server.
- administratorName String
- The name of the Azure AD Administrator.
- administratorType String | "ActiveDirectory" 
- Type of the sever administrator.
- identityResource StringId 
- The resource id of the identity used for AAD Authentication.
- login String
- Login name of the server administrator.
- sid String
- SID (object ID) of the server administrator.
- tenantId String
- Tenant ID of the administrator.
Outputs
All input properties are implicitly available as output properties. Additionally, the AzureADAdministrator resource produces the following output properties:
- AzureApi stringVersion 
- The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- SystemData Pulumi.Azure Native. DBfor My SQL. Outputs. System Data Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- AzureApi stringVersion 
- The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- SystemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azureApi StringVersion 
- The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- systemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azureApi stringVersion 
- The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- systemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure_api_ strversion 
- The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_data SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azureApi StringVersion 
- The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- systemData Property Map
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
AdministratorType, AdministratorTypeArgs    
- ActiveDirectory 
- ActiveDirectory
- AdministratorType Active Directory 
- ActiveDirectory
- ActiveDirectory 
- ActiveDirectory
- ActiveDirectory 
- ActiveDirectory
- ACTIVE_DIRECTORY
- ActiveDirectory
- "ActiveDirectory" 
- ActiveDirectory
SystemDataResponse, SystemDataResponseArgs      
Metadata pertaining to creation and last modification of the resource.- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
- createdAt string
- The timestamp of resource creation (UTC).
- createdBy string
- The identity that created the resource.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- The type of identity that last modified the resource.
- created_at str
- The timestamp of resource creation (UTC).
- created_by str
- The identity that created the resource.
- created_by_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:dbformysql:AzureADAdministrator ActiveDirectory /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/administrators/{administratorName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
