apim/api_management_api¶
Overview¶
This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.
Dependency diagram (Mermaid)¶
graph TD
azurecaf_name.apim["azurecaf_name.apim"]
azurerm_api_management_api.apim["azurerm_api_management_api.apim"]
azurerm_api_management_api.apim --> azurecaf_name.apim
Module Reference¶
Category: apim
Path: modules/apim/api_management_api
Azure Resources: azurecaf_name, azurerm_api_management_api
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" |
"<<DESCRIPTION Settings for an API Management API. Required provider settings: name and revision. Optional CAF refere... | object({name = string, revision = str... |
yes | - |
"api_type must be graphql, http, soap, or websocket."; "protocols may contain only http, https, ws, and wss."; "import.content_format must be a supported API definition format."; "openid_authentication.bearer_token_sending_methods may contain only authorizationHeader and query."; "version_set_id must be specified when version is set."; "oauth2_authorization and openid_authentication cannot be configured together."; "service_url must be specified when api_type is websocket."; "display_name and at least one protocol must be specified when source_api_id is not set."; "display_name must not be empty when specified."; "import.wsdl_selector can be configured only with wsdl or wsdl-link content_format." |
"remote_objects" |
"Remote objects used to resolve API Management dependencies." | any |
no | {} |
- |
"base_tags" |
"Base tags for the resource to be inherited from the resource group." | map(any) |
no | {} |
- |
"api_management_name" |
"Name of the API Management Service that owns this API." | string |
yes | - |
- |
"resource_group_name" |
"Name of the resource group containing the API Management Service." | string |
yes | - |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
"id" |
"The ID of the API Management API." | - | azurerm_api_management_api.apim.id |
"is_current" |
"Is this the current API Revision?" | - | azurerm_api_management_api.apim.is_current |
"is_online" |
"Is this API Revision online/accessible via the Gateway?" | - | azurerm_api_management_api.apim.is_online |
"version" |
"The Version number of this API, if this API is versioned." | - | azurerm_api_management_api.apim.version |
"version_set_id" |
"The ID of the Version Set which this API is associated with." | - | azurerm_api_management_api.apim.version_set_id |
"name" |
"The name of the API Management API." | - | azurerm_api_management_api.apim.name |
Sources¶
modules/apim/api_management_api/main.tfmodules/apim/api_management_api/module.tfmodules/apim/api_management_api/outputs.tfmodules/apim/api_management_api/variables.tf