Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. RedisCache

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.RedisCache

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Manages a API Management Redis Cache.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    name: example
    properties:
      name: example-apim
      location: ${example.location}
      resourceGroupName: ${example.name}
      publisherName: pub1
      publisherEmail: pub1@email.com
      skuName: Consumption_0
  exampleCache:
    type: azure:redis:Cache
    name: example
    properties:
      name: example-cache
      location: ${example.location}
      resourceGroupName: ${example.name}
      capacity: 1
      family: C
      skuName: Basic
      enableNonSslPort: false
      minimumTlsVersion: '1.2'
      redisConfiguration: {}
  exampleRedisCache:
    type: azure:apimanagement:RedisCache
    name: example
    properties:
      name: example-Redis-Cache
      apiManagementId: ${exampleService.id}
      connectionString: ${exampleCache.primaryConnectionString}
      description: Redis cache instances
      redisCacheId: ${exampleCache.id}
      cacheLocation: East Us

    Create RedisCache Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RedisCache(name: string, args: RedisCacheArgs, opts?: CustomResourceOptions);
    @overload
def RedisCache(resource_name: str,
               args: RedisCacheArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def RedisCache(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               api_management_id: Optional[str] = None,
               connection_string: Optional[str] = None,
               cache_location: Optional[str] = None,
               description: Optional[str] = None,
               name: Optional[str] = None,
               redis_cache_id: Optional[str] = None)
    func NewRedisCache(ctx *Context, name string, args RedisCacheArgs, opts ...ResourceOption) (*RedisCache, error)
    public RedisCache(string name, RedisCacheArgs args, CustomResourceOptions? opts = null)
    public RedisCache(String name, RedisCacheArgs args)
public RedisCache(String name, RedisCacheArgs args, CustomResourceOptions options)

    type: azure:apimanagement:RedisCache
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RedisCacheArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RedisCacheArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RedisCacheArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RedisCacheArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RedisCacheArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var redisCacheResource = new Azure.ApiManagement.RedisCache("redisCacheResource", new()
{
    ApiManagementId = "string",
    ConnectionString = "string",
    CacheLocation = "string",
    Description = "string",
    Name = "string",
    RedisCacheId = "string",
});

    example, err := apimanagement.NewRedisCache(ctx, "redisCacheResource", &apimanagement.RedisCacheArgs{
	ApiManagementId:  pulumi.String("string"),
	ConnectionString: pulumi.String("string"),
	CacheLocation:    pulumi.String("string"),
	Description:      pulumi.String("string"),
	Name:             pulumi.String("string"),
	RedisCacheId:     pulumi.String("string"),
})

    var redisCacheResource = new RedisCache("redisCacheResource", RedisCacheArgs.builder()
    .apiManagementId("string")
    .connectionString("string")
    .cacheLocation("string")
    .description("string")
    .name("string")
    .redisCacheId("string")
    .build());

    redis_cache_resource = azure.apimanagement.RedisCache("redisCacheResource",
    api_management_id="string",
    connection_string="string",
    cache_location="string",
    description="string",
    name="string",
    redis_cache_id="string")

    const redisCacheResource = new azure.apimanagement.RedisCache("redisCacheResource", {
    apiManagementId: "string",
    connectionString: "string",
    cacheLocation: "string",
    description: "string",
    name: "string",
    redisCacheId: "string",
});

    type: azure:apimanagement:RedisCache
properties:
    apiManagementId: string
    cacheLocation: string
    connectionString: string
    description: string
    name: string
    redisCacheId: string

    RedisCache Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RedisCache resource accepts the following input properties:

    ApiManagementId string
    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.
    ConnectionString string
    The connection string to the Cache for Redis.
    CacheLocation string
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    Description string
    The description of the API Management Redis Cache.
    Name string
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    RedisCacheId string
    The resource ID of the Cache for Redis.
    ApiManagementId string
    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.
    ConnectionString string
    The connection string to the Cache for Redis.
    CacheLocation string
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    Description string
    The description of the API Management Redis Cache.
    Name string
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    RedisCacheId string
    The resource ID of the Cache for Redis.
    apiManagementId String
    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.
    connectionString String
    The connection string to the Cache for Redis.
    cacheLocation String
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    description String
    The description of the API Management Redis Cache.
    name String
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    redisCacheId String
    The resource ID of the Cache for Redis.
    apiManagementId string
    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.
    connectionString string
    The connection string to the Cache for Redis.
    cacheLocation string
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    description string
    The description of the API Management Redis Cache.
    name string
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    redisCacheId string
    The resource ID of the Cache for Redis.
    api_management_id str
    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 str
    The connection string to the Cache for Redis.
    cache_location str
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    description str
    The description of the API Management Redis Cache.
    name str
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    redis_cache_id str
    The resource ID of the Cache for Redis.
    apiManagementId String
    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.
    connectionString String
    The connection string to the Cache for Redis.
    cacheLocation String
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    description String
    The description of the API Management Redis Cache.
    name String
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    redisCacheId String
    The resource ID of the Cache for Redis.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RedisCache resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RedisCache Resource

    Get an existing RedisCache resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RedisCacheState, opts?: CustomResourceOptions): RedisCache
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_id: Optional[str] = None,
        cache_location: Optional[str] = None,
        connection_string: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        redis_cache_id: Optional[str] = None) -> RedisCache
    func GetRedisCache(ctx *Context, name string, id IDInput, state *RedisCacheState, opts ...ResourceOption) (*RedisCache, error)
    public static RedisCache Get(string name, Input<string> id, RedisCacheState? state, CustomResourceOptions? opts = null)
    public static RedisCache get(String name, Output<String> id, RedisCacheState state, CustomResourceOptions options)
    resources:  _:    type: azure:apimanagement:RedisCache    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiManagementId string
    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.
    CacheLocation string
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    ConnectionString string
    The connection string to the Cache for Redis.
    Description string
    The description of the API Management Redis Cache.
    Name string
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    RedisCacheId string
    The resource ID of the Cache for Redis.
    ApiManagementId string
    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.
    CacheLocation string
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    ConnectionString string
    The connection string to the Cache for Redis.
    Description string
    The description of the API Management Redis Cache.
    Name string
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    RedisCacheId string
    The resource ID of the Cache for Redis.
    apiManagementId String
    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.
    cacheLocation String
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    connectionString String
    The connection string to the Cache for Redis.
    description String
    The description of the API Management Redis Cache.
    name String
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    redisCacheId String
    The resource ID of the Cache for Redis.
    apiManagementId string
    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.
    cacheLocation string
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    connectionString string
    The connection string to the Cache for Redis.
    description string
    The description of the API Management Redis Cache.
    name string
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    redisCacheId string
    The resource ID of the Cache for Redis.
    api_management_id str
    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.
    cache_location str
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    connection_string str
    The connection string to the Cache for Redis.
    description str
    The description of the API Management Redis Cache.
    name str
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    redis_cache_id str
    The resource ID of the Cache for Redis.
    apiManagementId String
    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.
    cacheLocation String
    The location where to use cache from. Possible values are default and valid Azure regions. Defaults to default.
    connectionString String
    The connection string to the Cache for Redis.
    description String
    The description of the API Management Redis Cache.
    name String
    The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.
    redisCacheId String
    The resource ID of the Cache for Redis.

    Import

    API Management Redis Caches can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/redisCache:RedisCache example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/caches/cache1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure