avm-res-apimanagement-service
Azure/avm-res-apimanagement-service/azurerm
Terraform Module
HCL
AZURERM
✓ Verified
Terraform Azure Verified Resource Module for API Management Service
Install
module "avm-res-apimanagement-service" {
source = "Azure/avm-res-apimanagement-service/azurerm"
version = "0.0.7"
}
README
terraform-azurerm-avm-res-apimanagement-service This repo deploys the base Azure API management service. > [!IMPORTANT] > As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not fully functional and implemented across all supported languages yet - breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated. Hence, modules MUST NOT be published at version 1.0.0 or higher at this time. > > All module MUST be published as a pre-release version (e.g., 0.1.0, 0.1.1, 0.2.0, etc.) until the AVM framework becomes GA. > > However, it is important to note that this DOES NOT mean that the modules cannot be consumed and utilized. They CAN be leveraged in all types of environments (dev, test, prod etc.). C
Inputs (38)
| Name | Type | Description | Default |
|---|---|---|---|
| resource_group_name | string | The resource group where the resources will be deployed. | |
| location | string | Azure region where the resource should be deployed. | |
| publisher_email | string | The email of the API Management service publisher. | |
| name | string | The name of the this resource. | |
| apis | map(object({ # Basic API p | APIs for the API Management service. APIs define the operations available to API | {} |
| client_certificate_enabled | bool | Enforce a client certificate to be presented on each request to the gateway. Thi | false |
| diagnostic_settings | map(object({ name | A map of diagnostic settings to create on the Key Vault. The map key is delibera | {} |
| notification_sender_email | string | Email address from which the notification will be sent. | null |
| protocols | object({ enable_http2 = op | Protocol settings for the API Management service. | null |
| security | object({ enable_backend_ss | Security settings for the API Management service. | null |
| lock | object({ kind = string | Controls the Resource Lock configuration for this resource. The following proper | null |
| public_ip_address_id | string | ID of a standard SKU IPv4 Public IP. Only supported on Premium and Developer tie | null |
| sku_name | string | The SKU name of the API Management service. | "Developer_1" |
| managed_identities | object({ system_assigned | Controls the Managed Identity configuration on this resource. The following prop | {} |
| min_api_version | string | The version which the control plane API calls to API Management service are limi | null |
| private_endpoints_manage_dns_zone_group | bool | Whether to manage private DNS zone groups with this module. If set to false, you | true |
| products | map(object({ display_name | Products for the API Management service. The map key is the product identifier. | {} |
| sign_in | object({ enabled = bool | Sign-in settings for the API Management service. When enabled, anonymous users w | null |
| zones | list(string) | Specifies a list of Availability Zones in which this API Management service shou | null |
| additional_location | list(object({ location | Additional datacenter locations where the API Management service should be provi | [] |
| delegation | object({ subscriptions_ena | Delegation settings for the API Management service. | null |
| policy | object({ xml_content = str | Service-level (global) policy for the API Management service. This policy applie | null |
| private_endpoints | map(object({ name = option | A map of private endpoints to create on this resource. The map key is deliberate | {} |
| certificate | list(object({ encoded_cert | Certificate configurations for the API Management service. | [] |
Outputs (31)
certificates — Certificate information for the API Management Service.policy — Service-level policy details.products — A map of products created in the API Management service.api_version_set_ids — A map of API version set names to their resource IDs.apis — A map of APIs created in the API Management service.named_value_ids — A map of named value keys to their resource IDs.public_ip_addresses — The Public IP addresses of the API Management Service.apim_management_url — The management URL of the API Management service.named_values — A map of named values created in the API Management service.resource — The API Management service resource.scm_url — The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.workspace_identity — The identity for the created workspace.api_operations — A map of API operations created in the API Management service.api_version_sets — A map of API version sets created in the API Management service.developer_portal_url — The publisher URL of the API Management service.private_endpoints — A map of the private endpoints created.subscription_ids — A map of subscription keys to their resource IDs.subscriptions — A map of subscriptions created in the API Management service.hostname_configuration — The hostname configuration for the API Management Service.private_ip_addresses — The private IP addresses of the private endpoints created by this moduleproduct_ids — A map of product keys to their resource IDs.resource_id — The ID of the API Management service.name — The name of the API Management service.portal_url — The URL for the Publisher Portal associated with this API Management service.subscription_keys — A map of subscription keys to their primary and secondary keys.tenant_access — The tenant access information for the API Management Service.additional_locations — Information about additional locations for the API Management Service.apim_gateway_url — The gateway URL of the API Management service.api_ids — A map of API names to their resource IDs.gateway_regional_url — The Region URL for the Gateway of the API Management Service.… and 1 more outputs
Resources (19)
azurerm_api_managementazurerm_api_management_apiazurerm_api_management_api_operationazurerm_api_management_api_operation_policyazurerm_api_management_api_policyazurerm_api_management_api_version_setazurerm_api_management_named_valueazurerm_api_management_policyazurerm_api_management_productazurerm_api_management_product_apiazurerm_api_management_product_groupazurerm_api_management_subscriptionazurerm_management_lockazurerm_monitor_diagnostic_settingazurerm_private_endpointazurerm_private_endpoint_application_security_group_associationazurerm_role_assignmentmodtm_telemetryrandom_uuid
Details
FrameworkTerraform Module
LanguageHCL
Version0.0.7
Cloud AZURERM
★ Stars3
Forks10
Total downloads40.2k
Inputs38
Outputs31
Resources19
Examples8
LicenseMIT
NamespaceAzure
Updated