networking/network_security_perimeter¶
Overview¶
This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.
Dependency diagram (Mermaid)¶
graph TD
azapi_resource.accessRules["azapi_resource.accessRules"]
azapi_resource.links["azapi_resource.links"]
azapi_resource.loggingConfigurations["azapi_resource.loggingConfigurations"]
azapi_resource.networkSecurityPerimeter["azapi_resource.networkSecurityPerimeter"]
azapi_resource.profiles["azapi_resource.profiles"]
azapi_resource.resourceAssociations["azapi_resource.resourceAssociations"]
azurecaf_name.nsp["azurecaf_name.nsp"]
data.azapi_resource.linkReferences["data.azapi_resource.linkReferences"]
module.diagnostics["module.diagnostics"]
remote:cosmos_dbs["remote:cosmos_dbs"]
remote:diagnostics["remote:diagnostics"]
remote:event_hub_namespaces["remote:event_hub_namespaces"]
remote:event_hubs["remote:event_hubs"]
remote:keyvaults["remote:keyvaults"]
remote:mssql_servers["remote:mssql_servers"]
remote:storage_accounts["remote:storage_accounts"]
azapi_resource.accessRules --> azapi_resource.profiles
azapi_resource.links --> azapi_resource.networkSecurityPerimeter
azapi_resource.links --> azapi_resource.profiles
azapi_resource.loggingConfigurations --> azapi_resource.networkSecurityPerimeter
azapi_resource.networkSecurityPerimeter --> azurecaf_name.nsp
azapi_resource.profiles --> azapi_resource.networkSecurityPerimeter
azapi_resource.resourceAssociations --> azapi_resource.networkSecurityPerimeter
azapi_resource.resourceAssociations --> azapi_resource.profiles
azapi_resource.resourceAssociations --> remote:cosmos_dbs
azapi_resource.resourceAssociations --> remote:event_hub_namespaces
azapi_resource.resourceAssociations --> remote:event_hubs
azapi_resource.resourceAssociations --> remote:keyvaults
azapi_resource.resourceAssociations --> remote:mssql_servers
azapi_resource.resourceAssociations --> remote:storage_accounts
data.azapi_resource.linkReferences --> azapi_resource.links
data.azapi_resource.linkReferences --> azapi_resource.networkSecurityPerimeter
module.diagnostics --> azapi_resource.networkSecurityPerimeter
module.diagnostics --> remote:diagnostics
Module Reference¶
Category: networking
Path: modules/networking/network_security_perimeter
Azure Resources: azapi_resource, azurecaf_name
Inputs¶
| Name | Description | Type | Required | Default | Validation |
|---|---|---|---|---|---|
"global_settings" |
"Global settings object" | any |
yes | - |
- |
"client_config" |
"Client configuration object" | any |
yes | - |
- |
"location" |
"The location of the resource." | string |
yes | - |
- |
"base_tags" |
"Base tags for the resource to be inherited from the resource group." | bool |
yes | - |
- |
"resource_group" |
"Resource group object" | any |
yes | - |
- |
"remote_objects" |
"Remote objects to be passed to the module." | any |
yes | - |
- |
"settings" |
"<<DESCRIPTION Network security perimeter settings (AzAPI, Microsoft.Network API 2025-07-01). - name - Required perim... | object({name = string, location = opt... |
yes | - |
"Each access rule must specify direction as Inbound or Outbound."; "Each resource association must specify access_mode as Audit, Enforced or Learning."; "A perimeter link description must not exceed 140 characters." |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
"network_security_perimeter_id" |
"The ID of the network security perimeter." | - | azapi_resource.networkSecurityPerimeter.id |
"id" |
"The ID of the network security perimeter." | - | azapi_resource.networkSecurityPerimeter.id |
"profiles" |
"The profiles created in the perimeter, indexed by configuration key." | - | azapi_resource.profiles |
"access_rules" |
"The access rules created in the perimeter, indexed by configuration key." | - | azapi_resource.accessRules |
"resource_associations" |
"The PaaS resource associations, indexed by configuration key." | - | azapi_resource.resourceAssociations |
"links" |
"The perimeter links, indexed by configuration key." | - | azapi_resource.links |
"link_references" |
"Existing Azure-created link references, indexed by configuration key." | - | data.azapi_resource.linkReferences |
"logging_configurations" |
"The perimeter logging configurations, indexed by configuration key." | - | azapi_resource.loggingConfigurations |
Sources¶
modules/networking/network_security_perimeter/azurecaf_names.tfmodules/networking/network_security_perimeter/diagnostics.tfmodules/networking/network_security_perimeter/linkReferences.tfmodules/networking/network_security_perimeter/links.tfmodules/networking/network_security_perimeter/locals.tfmodules/networking/network_security_perimeter/loggingConfigurations.tfmodules/networking/network_security_perimeter/main.tfmodules/networking/network_security_perimeter/networkSecurityPerimeter.tfmodules/networking/network_security_perimeter/outputs.tfmodules/networking/network_security_perimeter/profiles.tfmodules/networking/network_security_perimeter/providers.tfmodules/networking/network_security_perimeter/resourceAssociations.tfmodules/networking/network_security_perimeter/variables.tf