Skip to content

Data Source: azurermSynapseWorkspace

Use this data source to access information about an existing Synapse Workspace.

Example Usage

import * as cdktf from "cdktf";
/*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 dataAzurermSynapseWorkspaceExample =
  new azurerm.dataAzurermSynapseWorkspace.DataAzurermSynapseWorkspace(
    this,
    "example",
    {
      name: "existing",
      resource_group_name: "example-resource-group",
    }
  );
new cdktf.TerraformOutput(this, "id", {
  value: dataAzurermSynapseWorkspaceExample.id,
});

Arguments Reference

The following arguments are supported:

  • name - (Required) The name of this Synapse Workspace.

  • resourceGroupName - (Required) The name of the Resource Group where the Synapse Workspace exists.

Attributes Reference

the following Attributes are exported:

  • id - The ID of the synapse Workspace.

  • location - The Azure location where the Synapse Workspace exists.

  • connectivityEndpoints - A list of Connectivity endpoints for this Synapse Workspace.

  • tags - A mapping of tags assigned to the resource.

  • identity - An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.

The identity block exports the following:

  • type - The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

  • principalId - The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

  • tenantId - The Tenant ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

Timeouts

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

  • read - (Defaults to 5 minutes) Used when retrieving the Synapse Workspace.