azurermSqlActiveDirectoryAdministrator
Allows you to set a user or group as the AD administrator for an Azure SQL server.
-> Note: The azurermSqlActiveDirectoryAdministrator resource is deprecated in version 3.0 of the AzureRM provider and will be removed in version 4.0. Please use the azureadAdministrator block of the azurermMssqlServer resource instead.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "example-resources",
}
);
const azurermSqlServerExample = new azurerm.sqlServer.SqlServer(
this,
"example_1",
{
administrator_login: "4dm1n157r470r",
administrator_login_password: "4-v3ry-53cr37-p455w0rd",
location: azurermResourceGroupExample.location,
name: "mysqlserver",
resource_group_name: azurermResourceGroupExample.name,
version: "12.0",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSqlServerExample.overrideLogicalId("example");
const dataAzurermClientConfigCurrent =
new azurerm.dataAzurermClientConfig.DataAzurermClientConfig(
this,
"current",
{}
);
const azurermSqlActiveDirectoryAdministratorExample =
new azurerm.sqlActiveDirectoryAdministrator.SqlActiveDirectoryAdministrator(
this,
"example_3",
{
login: "sqladmin",
object_id: dataAzurermClientConfigCurrent.objectId,
resource_group_name: azurermResourceGroupExample.name,
server_name: azurermSqlServerExample.name,
tenant_id: dataAzurermClientConfigCurrent.tenantId,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSqlActiveDirectoryAdministratorExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
-
serverName- (Required) The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created. -
resourceGroupName- (Required) The name of the resource group for the SQL server. Changing this forces a new resource to be created. -
login- (Required) The login name of the principal to set as the server administrator -
objectId- (Required) The ID of the principal to set as the server administrator -
tenantId- (Required) The Azure Tenant ID -
azureadAuthenticationOnly- (Optional) Specifies whether only AD Users and administrators can be used to login (true) or also local database users (false).
Attributes Reference
The following attributes are exported:
id- The ID of the SQL Active Directory Administrator.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 30 minutes) Used when creating the SQL Active Directory Administrator.update- (Defaults to 30 minutes) Used when updating the SQL Active Directory Administrator.read- (Defaults to 5 minutes) Used when retrieving the SQL Active Directory Administrator.delete- (Defaults to 30 minutes) Used when deleting the SQL Active Directory Administrator.
Import
A SQL Active Directory Administrator can be imported using the resourceId, e.g.