azurermSynapseManagedPrivateEndpoint
Manages a Synapse Managed Private Endpoint.
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 azurermStorageAccountExample = new azurerm.storageAccount.StorageAccount(
this,
"example_1",
{
account_kind: "StorageV2",
account_replication_type: "LRS",
account_tier: "Standard",
is_hns_enabled: "true",
location: azurermResourceGroupExample.location,
name: "examplestorageacc",
resource_group_name: azurermResourceGroupExample.name,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermStorageAccountExample.overrideLogicalId("example");
const azurermStorageAccountExampleConnect =
new azurerm.storageAccount.StorageAccount(this, "example_connect", {
account_kind: "BlobStorage",
account_replication_type: "LRS",
account_tier: "Standard",
location: azurermResourceGroupExample.location,
name: "examplestorage2",
resource_group_name: azurermResourceGroupExample.name,
});
const azurermStorageDataLakeGen2FilesystemExample =
new azurerm.storageDataLakeGen2Filesystem.StorageDataLakeGen2Filesystem(
this,
"example_3",
{
name: "example",
storage_account_id: azurermStorageAccountExample.id,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermStorageDataLakeGen2FilesystemExample.overrideLogicalId("example");
const azurermSynapseWorkspaceExample =
new azurerm.synapseWorkspace.SynapseWorkspace(this, "example_4", {
identity: [
{
type: "SystemAssigned",
},
],
location: azurermResourceGroupExample.location,
managed_virtual_network_enabled: true,
name: "example",
resource_group_name: azurermResourceGroupExample.name,
sql_administrator_login: "sqladminuser",
sql_administrator_login_password: "H@Sh1CoR3!",
storage_data_lake_gen2_filesystem_id:
azurermStorageDataLakeGen2FilesystemExample.id,
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSynapseWorkspaceExample.overrideLogicalId("example");
const azurermSynapseFirewallRuleExample =
new azurerm.synapseFirewallRule.SynapseFirewallRule(this, "example_5", {
end_ip_address: "255.255.255.255",
name: "AllowAll",
start_ip_address: "0.0.0.0",
synapse_workspace_id: azurermSynapseWorkspaceExample.id,
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSynapseFirewallRuleExample.overrideLogicalId("example");
const azurermSynapseManagedPrivateEndpointExample =
new azurerm.synapseManagedPrivateEndpoint.SynapseManagedPrivateEndpoint(
this,
"example_6",
{
depends_on: [`\${${azurermSynapseFirewallRuleExample.fqn}}`],
name: "example-endpoint",
subresource_name: "blob",
synapse_workspace_id: azurermSynapseWorkspaceExample.id,
target_resource_id: azurermStorageAccountExampleConnect.id,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSynapseManagedPrivateEndpointExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
-
name- (Required) Specifies the name which should be used for this Managed Private Endpoint. Changing this forces a new resource to be created. -
synapseWorkspaceId- (Required) The ID of the Synapse Workspace on which to create the Managed Private Endpoint. Changing this forces a new resource to be created.
-> NOTE: A Synapse firewall rule including local IP is needed for managing current resource.
-
targetResourceId- (Required) The ID of the Private Link Enabled Remote Resource which this Synapse Private Endpoint should be connected to. Changing this forces a new resource to be created. -
subresourceName- (Required) Specifies the sub resource name which the Synapse Private Endpoint is able to connect to. Changing this forces a new resource to be created.
-> NOTE: Possible values are listed in documentation.
Attributes Reference
The following attributes are exported:
id- The Synapse Managed Private Endpoint ID.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 30 minutes) Used when creating the Synapse Managed Private Endpoint.read- (Defaults to 5 minutes) Used when retrieving the Synapse Managed Private Endpoint.delete- (Defaults to 30 minutes) Used when deleting the Synapse Managed Private Endpoint.
Import
Synapse Managed Private Endpoint can be imported using the resourceId, e.g.