Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. appplatform
  5. SpringCloudAppRedisAssociation

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.appplatform.SpringCloudAppRedisAssociation

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Associates a Spring Cloud Application with a 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
  exampleSpringCloudService:
    type: azure:appplatform:SpringCloudService
    name: example
    properties:
      name: example-springcloud
      resourceGroupName: ${example.name}
      location: ${example.location}
  exampleSpringCloudApp:
    type: azure:appplatform:SpringCloudApp
    name: example
    properties:
      name: example-springcloudapp
      resourceGroupName: ${example.name}
      serviceName: ${exampleSpringCloudService.name}
  exampleCache:
    type: azure:redis:Cache
    name: example
    properties:
      name: example-cache
      location: ${example.location}
      resourceGroupName: ${example.name}
      capacity: 0
      family: C
      skuName: Basic
      enableNonSslPort: true
  exampleSpringCloudAppRedisAssociation:
    type: azure:appplatform:SpringCloudAppRedisAssociation
    name: example
    properties:
      name: example-bind
      springCloudAppId: ${exampleSpringCloudApp.id}
      redisCacheId: ${exampleCache.id}
      redisAccessKey: ${exampleCache.primaryAccessKey}
      sslEnabled: true
Copy

Create SpringCloudAppRedisAssociation Resource

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

Constructor syntax

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

@overload
def SpringCloudAppRedisAssociation(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   redis_access_key: Optional[str] = None,
                                   redis_cache_id: Optional[str] = None,
                                   spring_cloud_app_id: Optional[str] = None,
                                   name: Optional[str] = None,
                                   ssl_enabled: Optional[bool] = None)
func NewSpringCloudAppRedisAssociation(ctx *Context, name string, args SpringCloudAppRedisAssociationArgs, opts ...ResourceOption) (*SpringCloudAppRedisAssociation, error)
public SpringCloudAppRedisAssociation(string name, SpringCloudAppRedisAssociationArgs args, CustomResourceOptions? opts = null)
public SpringCloudAppRedisAssociation(String name, SpringCloudAppRedisAssociationArgs args)
public SpringCloudAppRedisAssociation(String name, SpringCloudAppRedisAssociationArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SpringCloudAppRedisAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SpringCloudAppRedisAssociationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SpringCloudAppRedisAssociationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SpringCloudAppRedisAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SpringCloudAppRedisAssociationArgs
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 springCloudAppRedisAssociationResource = new Azure.AppPlatform.SpringCloudAppRedisAssociation("springCloudAppRedisAssociationResource", new()
{
    RedisAccessKey = "string",
    RedisCacheId = "string",
    SpringCloudAppId = "string",
    Name = "string",
    SslEnabled = false,
});
Copy
example, err := appplatform.NewSpringCloudAppRedisAssociation(ctx, "springCloudAppRedisAssociationResource", &appplatform.SpringCloudAppRedisAssociationArgs{
	RedisAccessKey:   pulumi.String("string"),
	RedisCacheId:     pulumi.String("string"),
	SpringCloudAppId: pulumi.String("string"),
	Name:             pulumi.String("string"),
	SslEnabled:       pulumi.Bool(false),
})
Copy
var springCloudAppRedisAssociationResource = new SpringCloudAppRedisAssociation("springCloudAppRedisAssociationResource", SpringCloudAppRedisAssociationArgs.builder()
    .redisAccessKey("string")
    .redisCacheId("string")
    .springCloudAppId("string")
    .name("string")
    .sslEnabled(false)
    .build());
Copy
spring_cloud_app_redis_association_resource = azure.appplatform.SpringCloudAppRedisAssociation("springCloudAppRedisAssociationResource",
    redis_access_key="string",
    redis_cache_id="string",
    spring_cloud_app_id="string",
    name="string",
    ssl_enabled=False)
Copy
const springCloudAppRedisAssociationResource = new azure.appplatform.SpringCloudAppRedisAssociation("springCloudAppRedisAssociationResource", {
    redisAccessKey: "string",
    redisCacheId: "string",
    springCloudAppId: "string",
    name: "string",
    sslEnabled: false,
});
Copy
type: azure:appplatform:SpringCloudAppRedisAssociation
properties:
    name: string
    redisAccessKey: string
    redisCacheId: string
    springCloudAppId: string
    sslEnabled: false
Copy

SpringCloudAppRedisAssociation 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 SpringCloudAppRedisAssociation resource accepts the following input properties:

RedisAccessKey This property is required. string
Specifies the Redis Cache access key.
RedisCacheId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
SpringCloudAppId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
SslEnabled bool
Should SSL be used when connecting to Redis? Defaults to true.
RedisAccessKey This property is required. string
Specifies the Redis Cache access key.
RedisCacheId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
SpringCloudAppId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
SslEnabled bool
Should SSL be used when connecting to Redis? Defaults to true.
redisAccessKey This property is required. String
Specifies the Redis Cache access key.
redisCacheId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
springCloudAppId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
sslEnabled Boolean
Should SSL be used when connecting to Redis? Defaults to true.
redisAccessKey This property is required. string
Specifies the Redis Cache access key.
redisCacheId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
springCloudAppId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
sslEnabled boolean
Should SSL be used when connecting to Redis? Defaults to true.
redis_access_key This property is required. str
Specifies the Redis Cache access key.
redis_cache_id
This property is required.
Changes to this property will trigger replacement.
str
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
spring_cloud_app_id
This property is required.
Changes to this property will trigger replacement.
str
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
ssl_enabled bool
Should SSL be used when connecting to Redis? Defaults to true.
redisAccessKey This property is required. String
Specifies the Redis Cache access key.
redisCacheId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
springCloudAppId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
sslEnabled Boolean
Should SSL be used when connecting to Redis? Defaults to true.

Outputs

All input properties are implicitly available as output properties. Additionally, the SpringCloudAppRedisAssociation 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 SpringCloudAppRedisAssociation Resource

Get an existing SpringCloudAppRedisAssociation 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?: SpringCloudAppRedisAssociationState, opts?: CustomResourceOptions): SpringCloudAppRedisAssociation
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        redis_access_key: Optional[str] = None,
        redis_cache_id: Optional[str] = None,
        spring_cloud_app_id: Optional[str] = None,
        ssl_enabled: Optional[bool] = None) -> SpringCloudAppRedisAssociation
func GetSpringCloudAppRedisAssociation(ctx *Context, name string, id IDInput, state *SpringCloudAppRedisAssociationState, opts ...ResourceOption) (*SpringCloudAppRedisAssociation, error)
public static SpringCloudAppRedisAssociation Get(string name, Input<string> id, SpringCloudAppRedisAssociationState? state, CustomResourceOptions? opts = null)
public static SpringCloudAppRedisAssociation get(String name, Output<String> id, SpringCloudAppRedisAssociationState state, CustomResourceOptions options)
resources:  _:    type: azure:appplatform:SpringCloudAppRedisAssociation    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Name Changes to this property will trigger replacement. string
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
RedisAccessKey string
Specifies the Redis Cache access key.
RedisCacheId Changes to this property will trigger replacement. string
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
SpringCloudAppId Changes to this property will trigger replacement. string
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
SslEnabled bool
Should SSL be used when connecting to Redis? Defaults to true.
Name Changes to this property will trigger replacement. string
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
RedisAccessKey string
Specifies the Redis Cache access key.
RedisCacheId Changes to this property will trigger replacement. string
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
SpringCloudAppId Changes to this property will trigger replacement. string
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
SslEnabled bool
Should SSL be used when connecting to Redis? Defaults to true.
name Changes to this property will trigger replacement. String
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
redisAccessKey String
Specifies the Redis Cache access key.
redisCacheId Changes to this property will trigger replacement. String
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
springCloudAppId Changes to this property will trigger replacement. String
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
sslEnabled Boolean
Should SSL be used when connecting to Redis? Defaults to true.
name Changes to this property will trigger replacement. string
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
redisAccessKey string
Specifies the Redis Cache access key.
redisCacheId Changes to this property will trigger replacement. string
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
springCloudAppId Changes to this property will trigger replacement. string
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
sslEnabled boolean
Should SSL be used when connecting to Redis? Defaults to true.
name Changes to this property will trigger replacement. str
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
redis_access_key str
Specifies the Redis Cache access key.
redis_cache_id Changes to this property will trigger replacement. str
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
spring_cloud_app_id Changes to this property will trigger replacement. str
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
ssl_enabled bool
Should SSL be used when connecting to Redis? Defaults to true.
name Changes to this property will trigger replacement. String
Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
redisAccessKey String
Specifies the Redis Cache access key.
redisCacheId Changes to this property will trigger replacement. String
Specifies the Redis Cache resource ID. Changing this forces a new resource to be created.
springCloudAppId Changes to this property will trigger replacement. String
Specifies the Spring Cloud Application resource ID in which the Association is created. Changing this forces a new resource to be created.
sslEnabled Boolean
Should SSL be used when connecting to Redis? Defaults to true.

Import

Spring Cloud Application Redis Association can be imported using the resource id, e.g.

$ pulumi import azure:appplatform/springCloudAppRedisAssociation:SpringCloudAppRedisAssociation example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.AppPlatform/spring/myservice/apps/myapp/bindings/bind1
Copy

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure