Azure Synapse Workspace Aad ADMin

This page shows how to write Terraform for Synapse Workspace Aad ADMin and write them securely.

azurerm_synapse_workspace_aad_admin (Terraform)

The Workspace Aad ADMin in Synapse can be configured in Terraform with the resource name azurerm_synapse_workspace_aad_admin. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • synapse_workspace_id - (Required) The ID of the Synapse Workspace where the Azure AD Administrator should be configured.

  • login - (Required) The login name of the Azure AD Administrator of this Synapse Workspace.

  • object_id - (Required) The object id of the Azure AD Administrator of this Synapse Workspace.

  • tenant_id - (Required) The tenant id of the Azure AD Administrator of this Synapse Workspace.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating the Synapse Workspace.
  • read - (Defaults to 5 minutes) Used when retrieving the Synapse Workspace.
  • update - (Defaults to 30 minutes) Used when updating the Synapse Workspace.
  • delete - (Defaults to 30 minutes) Used when deleting the Synapse Workspace.

Import

Synapse Workspace Azure AD Administrator can be imported using the resource id, e.g.

terraform import azurerm_synapse_workspace_aad_admin.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/administrators/activeDirectory

Explanation in Terraform Registry

Manages an Azure Active Directory Administrator setting for a Synapse Workspace

Tips: Best Practices for The Other Azure Synapse Resources

In addition to the azurerm_synapse_workspace, Azure Synapse has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.

risk-label

azurerm_synapse_workspace

Ensure to enable the managed virtual network

It is better to enable the managed virtual network, which is disabled as the default.

Review your Azure Synapse settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

Azure Resource Manager Example

Azure Resource Manager code does not have the related resource.

Frequently asked questions

What is Azure Synapse Workspace Aad ADMin?

Azure Synapse Workspace Aad ADMin is a resource for Synapse of Microsoft Azure. Settings can be wrote in Terraform.