apim/api_management_user¶
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_user.apim["azurerm_api_management_user.apim"]
Module Reference¶
Category: apim
Path: modules/apim/api_management_user
Azure Resources: azurerm_api_management_user
Inputs¶
| Name | Description | Type | Required | Default | Validation |
|---|---|---|---|---|---|
"global_settings" |
"<<DESCRIPTION Global CAF settings, as produced by the root module. Supported attributes: - default_region, environme... | object({default_region = optional(str... |
yes | - |
- |
"client_config" |
"<<DESCRIPTION Client configuration, as produced by the root module. landingzone_key is required; client_id, object_i... | object({client_id = optional(string),... |
yes | - |
- |
"settings" |
"<<DESCRIPTION Settings for an API Management user. user_id, email, first_name, and last_name are required. Optional ... | object({user_id = string, email = str... |
yes | - |
"confirmation must be invite or signup."; "state must be active, blocked, or pending." |
"remote_objects" |
"Remote objects used by the root module to resolve API Management and resource-group references." | any |
no | {} |
- |
"base_tags" |
"Base tags inherited from the resource group." | map(any) |
no | {} |
- |
"api_management_name" |
"The name of the API Management service." | string |
yes | - |
- |
"resource_group_name" |
"The name of the resource group containing the API Management service." | string |
yes | - |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
"id" |
"The ID of the API Management User." | - | azurerm_api_management_user.apim.id |
Sources¶
modules/apim/api_management_user/main.tfmodules/apim/api_management_user/module.tfmodules/apim/api_management_user/outputs.tfmodules/apim/api_management_user/variables.tf