apim/api_management_api_policy¶
Overview¶
This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.
Dependency diagram (Mermaid)¶
graph TD
azurerm_api_management_api_policy.apim["azurerm_api_management_api_policy.apim"]
Module Reference¶
Category: apim
Path: modules/apim/api_management_api_policy
Azure Resources: azurerm_api_management_api_policy
Inputs¶
| Name | Description | Type | Required | Default | Validation |
|---|---|---|---|---|---|
global_settings |
Global settings object (see module README.md) | any |
yes | - |
- |
client_config |
Client configuration object (see module README.md). | any |
yes | - |
- |
settings |
(Required) Used to handle passthrough paramenters. | any |
yes | - |
- |
remote_objects |
Remote objects configuration. | any |
no | {} |
- |
base_tags |
Base tags for the resource to be inherited from the resource group. | map(any) |
no | {} |
- |
api_name |
The name of the API | any |
yes | - |
- |
api_management_name |
The name of the API Management Service. Changing this forces a new resource to be created. | any |
yes | - |
- |
resource_group_name |
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be ... | any |
yes | - |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
id |
The ID of the API Management API Policy. | - | azurerm_api_management_api_policy.apim.id |
Sources¶
modules/apim/api_management_api_policy/main.tfmodules/apim/api_management_api_policy/module.tfmodules/apim/api_management_api_policy/outputs.tfmodules/apim/api_management_api_policy/variables.tf