Azure API Management Redis Cache

This page shows how to write Terraform and Azure Resource Manager for API Management Redis Cache and write them securely.

azurerm_api_management_redis_cache (Terraform)

The Redis Cache in API Management can be configured in Terraform with the resource name azurerm_api_management_redis_cache. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • name - (Required) The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.

  • api_management_id - (Required) The resource ID of the Api Management Service from which to create this external cache. Changing this forces a new API Management Redis Cache to be created.

  • connection_string - (Required) The connection string to the Cache for Redis.


  • description - (Optional) The description of the API Management Redis Cache.

  • redis_cache_id - (Optional) The resource ID of the Cache for Redis.

  • cache_location - (Optional) The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the API Management Redis Cache.

Explanation in Terraform Registry

Manages a API Management Redis Cache.

Microsoft.ApiManagement/service/caches (Azure Resource Manager)

The service/caches in Microsoft.ApiManagement can be configured in Azure Resource Manager with the resource name Microsoft.ApiManagement/service/caches. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • name required - string

    Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).

  • properties required
      • connectionString required - string

        Runtime connection string to cache

      • description optional - string

        Cache description

      • resourceId optional - string

        Original uri of entity in external system cache points to

      • useFromLocation required - string

        Location identifier to use cache from (should be either 'default' or valid Azure region identifier)

  • type required - string

Frequently asked questions

What is Azure API Management Redis Cache?

Azure API Management Redis Cache is a resource for API Management of Microsoft Azure. Settings can be wrote in Terraform.