Microsoft.ApiManagement service/caches
Bicep resource definition
The service/caches resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/caches resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/caches@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
connectionString: 'string'
description: 'string'
resourceId: 'string'
useFromLocation: 'string'
}
}
Property values
service/caches
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: service |
| properties | Cache properties details. | CacheContractProperties |
CacheContractProperties
| Name | Description | Value |
|---|---|---|
| connectionString | Runtime connection string to cache | string (required) Constraints: Max length = 300 |
| description | Cache description | string Constraints: Max length = 2000 |
| resourceId | Original uri of entity in external system cache points to | string Constraints: Max length = 2000 |
| useFromLocation | Location identifier to use cache from (should be either 'default' or valid Azure region identifier) | string (required) Constraints: Max length = 256 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Deploy API Management with an external Azure Cache for Redis |
This template demonstrates how to create an instance of Azure API Management in the Consumption tier with an external Azure Cache for Redis instance as the API Management external cache. |
ARM template resource definition
The service/caches resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/caches resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/caches",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"connectionString": "string",
"description": "string",
"resourceId": "string",
"useFromLocation": "string"
}
}
Property values
service/caches
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ApiManagement/service/caches' |
| apiVersion | The resource api version | '2023-09-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | Cache properties details. | CacheContractProperties |
CacheContractProperties
| Name | Description | Value |
|---|---|---|
| connectionString | Runtime connection string to cache | string (required) Constraints: Max length = 300 |
| description | Cache description | string Constraints: Max length = 2000 |
| resourceId | Original uri of entity in external system cache points to | string Constraints: Max length = 2000 |
| useFromLocation | Location identifier to use cache from (should be either 'default' or valid Azure region identifier) | string (required) Constraints: Max length = 256 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Deploy API Management with an external Azure Cache for Redis |
This template demonstrates how to create an instance of Azure API Management in the Consumption tier with an external Azure Cache for Redis instance as the API Management external cache. |
Terraform (AzAPI provider) resource definition
The service/caches resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/caches resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/caches@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
connectionString = "string"
description = "string"
resourceId = "string"
useFromLocation = "string"
}
})
}
Property values
service/caches
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/service/caches@2023-09-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service |
| properties | Cache properties details. | CacheContractProperties |
CacheContractProperties
| Name | Description | Value |
|---|---|---|
| connectionString | Runtime connection string to cache | string (required) Constraints: Max length = 300 |
| description | Cache description | string Constraints: Max length = 2000 |
| resourceId | Original uri of entity in external system cache points to | string Constraints: Max length = 2000 |
| useFromLocation | Location identifier to use cache from (should be either 'default' or valid Azure region identifier) | string (required) Constraints: Max length = 256 |