https://github.com/libre-devops/terraform-azurerm-private-endpoint
A module used to deploy an Azure private endpoint
https://github.com/libre-devops/terraform-azurerm-private-endpoint
Last synced: 20 days ago
JSON representation
A module used to deploy an Azure private endpoint
- Host: GitHub
- URL: https://github.com/libre-devops/terraform-azurerm-private-endpoint
- Owner: libre-devops
- License: mit
- Created: 2023-04-07T13:01:32.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-02T16:54:57.000Z (8 months ago)
- Last Synced: 2025-03-30T15:44:37.159Z (25 days ago)
- Language: HCL
- Size: 36.1 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## Requirements
No requirements.
## Providers
| Name | Version |
|------|---------|
| [azurerm](#provider\_azurerm) | n/a |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [azurerm_private_endpoint.endpoint](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/private_endpoint) | resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [custom\_network\_interface\_name](#input\_custom\_network\_interface\_name) | The name of your private endpoint NIC | `string` | `null` | no |
| [ip\_configuration](#input\_ip\_configuration) | The ip configuration block | `any` | `null` | no |
| [location](#input\_location) | The location for this resource to be put in | `string` | n/a | yes |
| [private\_dns\_zone\_group](#input\_private\_dns\_zone\_group) | The private\_dns\_zone\_group block | `any` | `null` | no |
| [private\_endpoint\_name](#input\_private\_endpoint\_name) | The name of the private endpoint | `string` | n/a | yes |
| [private\_service\_connection](#input\_private\_service\_connection) | The private\_service\_connection block | `any` | `{}` | no |
| [rg\_name](#input\_rg\_name) | The name of the resource group, this module does not create a resource group, it is expecting the value of a resource group already exists | `string` | n/a | yes |
| [sub\_resource\_names](#input\_sub\_resource\_names) | The sub resource names of private endpoints found at https://learn.microsoft.com/en-gb/azure/private-link/private-endpoint-overview#private-link-resource, not used, but provided for lookup option | `map(string)` |
{
"Microsoft.Appconfiguration/configurationStores": "configurationStores",
"Microsoft.Authorization/resourceManagementPrivateLinks": "ResourceManagement",
"Microsoft.Automation/automationAccounts": "Webhook, DSCAndHybridWorker",
"Microsoft.AzureCosmosDB/databaseAccounts": "SQL, MongoDB, Cassandra, Gremlin, Table",
"Microsoft.Batch/batchAccounts": "batchAccount, nodeManagement",
"Microsoft.Cache/Redis": "redisCache",
"Microsoft.Cache/redisEnterprise": "redisEnterprise",
"Microsoft.CognitiveServices/accounts": "account",
"Microsoft.Compute/diskAccesses": "managed disk",
"Microsoft.ContainerRegistry/registries": "registry",
"Microsoft.ContainerService/managedClusters": "management",
"Microsoft.DBforMariaDB/servers": "mariadbServer",
"Microsoft.DBforMySQL/servers": "mysqlServer",
"Microsoft.DBforPostgreSQL/servers": "postgresqlServer",
"Microsoft.DataFactory/factories": "dataFactory",
"Microsoft.Databricks/workspaces": "databricks_ui_api, browser_authentication",
"Microsoft.Devices/IotHubs": "iotHub",
"Microsoft.Devices/provisioningServices": "iotDps",
"Microsoft.DigitalTwins/digitalTwinsInstances": "API",
"Microsoft.EventGrid/domains": "domain",
"Microsoft.EventGrid/topics": "topic",
"Microsoft.EventHub/namespaces": "namespace",
"Microsoft.HDInsight/clusters": "cluster",
"Microsoft.HealthcareApis/services": "fhir",
"Microsoft.Insights/privatelinkscopes": "azuremonitor",
"Microsoft.IoTCentral/IoTApps": "IoTApps",
"Microsoft.KeyVault/vaults": "vault",
"Microsoft.Keyvault/managedHSMs": "HSM",
"Microsoft.Kusto/clusters": "cluster",
"Microsoft.MachineLearningServices/workspaces": "amlworkspace",
"Microsoft.Media/mediaservices": "keydelivery, liveevent, streamingendpoint",
"Microsoft.Migrate/assessmentProjects": "project",
"Microsoft.Network/applicationgateways": "application gateway",
"Microsoft.Network/privateLinkServices": "empty",
"Microsoft.PowerBI/privateLinkServicesForPowerBI": "Power BI",
"Microsoft.Purview/accounts": "account, portal",
"Microsoft.RecoveryServices/vaults": "AzureBackup, AzureSiteRecovery",
"Microsoft.Relay/namespaces": "namespace",
"Microsoft.Search/searchServices": "searchService",
"Microsoft.ServiceBus/namespaces": "namespace",
"Microsoft.SignalRService/SignalR": "signalr",
"Microsoft.SignalRService/webPubSub": "webpubsub",
"Microsoft.Sql/servers": "sqlServer",
"Microsoft.Storage/storageAccounts": "blob, blob_secondary, table, table_secondary, queue, queue_secondary, file, file_secondary, web, web_secondary, dfs, dfs_secondary",
"Microsoft.StorageSync/storageSyncServices": "File Sync Service",
"Microsoft.Synapse/privateLinkHubs": "web",
"Microsoft.Synapse/workspaces": "Sql, SqlOnDemand, Dev",
"Microsoft.Web/hostingEnvironments": "hosting environment",
"Microsoft.Web/sites": "sites",
"Microsoft.Web/staticSites": "staticSites"
} | no |
| [subnet\_id](#input\_subnet\_id) | The ID of the subnet the private endpoint needs to connect | `string` | n/a | yes |
| [tags](#input\_tags) | A map of the tags to use on the resources that are deployed with this module. | `map(string)` | {
"source": "terraform"
} | no |
## Outputs
| Name | Description |
|------|-------------|
| [endpoint\_custom\_dns\_configs](#output\_endpoint\_custom\_dns\_configs) | The custom dns configs block |
| [endpoint\_id](#output\_endpoint\_id) | The ID of the private endpoint |
| [endpoint\_ip\_configuration](#output\_endpoint\_ip\_configuration) | The ip configuration block |
| [endpoint\_name](#output\_endpoint\_name) | The name of the storage account |
| [endpoint\_network\_interface](#output\_endpoint\_network\_interface) | The network interface block |
| [endpoint\_private\_dns\_zone\_configs](#output\_endpoint\_private\_dns\_zone\_configs) | The private dns zone configs |
## Requirements
No requirements.
## Providers
| Name | Version |
|------|---------|
| [azurerm](#provider\_azurerm) | n/a |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [azurerm_private_endpoint.endpoint](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/private_endpoint) | resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [custom\_network\_interface\_name](#input\_custom\_network\_interface\_name) | The name of your private endpoint NIC | `string` | `null` | no |
| [ip\_configuration](#input\_ip\_configuration) | The ip configuration block | `any` | `null` | no |
| [location](#input\_location) | The location for this resource to be put in | `string` | n/a | yes |
| [private\_dns\_zone\_group](#input\_private\_dns\_zone\_group) | The private\_dns\_zone\_group block | `any` | `null` | no |
| [private\_endpoint\_name](#input\_private\_endpoint\_name) | The name of the private endpoint | `string` | n/a | yes |
| [private\_service\_connection](#input\_private\_service\_connection) | The private\_service\_connection block | `any` | `{}` | no |
| [rg\_name](#input\_rg\_name) | The name of the resource group, this module does not create a resource group, it is expecting the value of a resource group already exists | `string` | n/a | yes |
| [sub\_resource\_names](#input\_sub\_resource\_names) | The sub resource names of private endpoints found at https://learn.microsoft.com/en-gb/azure/private-link/private-endpoint-overview#private-link-resource, not used, but provided for lookup option | `map(string)` |
{
"Microsoft.Appconfiguration/configurationStores": "configurationStores",
"Microsoft.Authorization/resourceManagementPrivateLinks": "ResourceManagement",
"Microsoft.Automation/automationAccounts": "Webhook, DSCAndHybridWorker",
"Microsoft.AzureCosmosDB/databaseAccounts": "SQL, MongoDB, Cassandra, Gremlin, Table",
"Microsoft.Batch/batchAccounts": "batchAccount, nodeManagement",
"Microsoft.Cache/Redis": "redisCache",
"Microsoft.Cache/redisEnterprise": "redisEnterprise",
"Microsoft.CognitiveServices/accounts": "account",
"Microsoft.Compute/diskAccesses": "managed disk",
"Microsoft.ContainerRegistry/registries": "registry",
"Microsoft.ContainerService/managedClusters": "management",
"Microsoft.DBforMariaDB/servers": "mariadbServer",
"Microsoft.DBforMySQL/servers": "mysqlServer",
"Microsoft.DBforPostgreSQL/servers": "postgresqlServer",
"Microsoft.DataFactory/factories": "dataFactory",
"Microsoft.Databricks/workspaces": "databricks_ui_api, browser_authentication",
"Microsoft.Devices/IotHubs": "iotHub",
"Microsoft.Devices/provisioningServices": "iotDps",
"Microsoft.DigitalTwins/digitalTwinsInstances": "API",
"Microsoft.EventGrid/domains": "domain",
"Microsoft.EventGrid/topics": "topic",
"Microsoft.EventHub/namespaces": "namespace",
"Microsoft.HDInsight/clusters": "cluster",
"Microsoft.HealthcareApis/services": "fhir",
"Microsoft.Insights/privatelinkscopes": "azuremonitor",
"Microsoft.IoTCentral/IoTApps": "IoTApps",
"Microsoft.KeyVault/vaults": "vault",
"Microsoft.Keyvault/managedHSMs": "HSM",
"Microsoft.Kusto/clusters": "cluster",
"Microsoft.MachineLearningServices/workspaces": "amlworkspace",
"Microsoft.Media/mediaservices": "keydelivery, liveevent, streamingendpoint",
"Microsoft.Migrate/assessmentProjects": "project",
"Microsoft.Network/applicationgateways": "application gateway",
"Microsoft.Network/privateLinkServices": "empty",
"Microsoft.PowerBI/privateLinkServicesForPowerBI": "Power BI",
"Microsoft.Purview/accounts": "account, portal",
"Microsoft.RecoveryServices/vaults": "AzureBackup, AzureSiteRecovery",
"Microsoft.Relay/namespaces": "namespace",
"Microsoft.Search/searchServices": "searchService",
"Microsoft.ServiceBus/namespaces": "namespace",
"Microsoft.SignalRService/SignalR": "signalr",
"Microsoft.SignalRService/webPubSub": "webpubsub",
"Microsoft.Sql/servers": "sqlServer",
"Microsoft.Storage/storageAccounts": "blob, blob_secondary, table, table_secondary, queue, queue_secondary, file, file_secondary, web, web_secondary, dfs, dfs_secondary",
"Microsoft.StorageSync/storageSyncServices": "File Sync Service",
"Microsoft.Synapse/privateLinkHubs": "web",
"Microsoft.Synapse/workspaces": "Sql, SqlOnDemand, Dev",
"Microsoft.Web/hostingEnvironments": "hosting environment",
"Microsoft.Web/sites": "sites",
"Microsoft.Web/staticSites": "staticSites"
} | no |
| [subnet\_id](#input\_subnet\_id) | The ID of the subnet the private endpoint needs to connect | `string` | n/a | yes |
| [tags](#input\_tags) | A map of the tags to use on the resources that are deployed with this module. | `map(string)` | {
"source": "terraform"
} | no |
## Outputs
| Name | Description |
|------|-------------|
| [endpoint\_custom\_dns\_configs](#output\_endpoint\_custom\_dns\_configs) | The custom dns configs block |
| [endpoint\_id](#output\_endpoint\_id) | The ID of the private endpoint |
| [endpoint\_ip\_configuration](#output\_endpoint\_ip\_configuration) | The ip configuration block |
| [endpoint\_name](#output\_endpoint\_name) | The name of the storage account |
| [endpoint\_network\_interface](#output\_endpoint\_network\_interface) | The network interface block |
| [endpoint\_private\_dns\_zone\_configs](#output\_endpoint\_private\_dns\_zone\_configs) | The private dns zone configs |