1. Packages
  2. Azure Classic
  3. API Docs
  4. appplatform
  5. SpringCloudAppCosmosDBAssociation

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

azure.appplatform.SpringCloudAppCosmosDBAssociation

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Associates a Spring Cloud Application with a CosmosDB Account.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleSpringCloudService = new azure.appplatform.SpringCloudService("example", {
        name: "example-springcloud",
        resourceGroupName: example.name,
        location: example.location,
    });
    const exampleSpringCloudApp = new azure.appplatform.SpringCloudApp("example", {
        name: "example-springcloudapp",
        resourceGroupName: example.name,
        serviceName: exampleSpringCloudService.name,
    });
    const exampleAccount = new azure.cosmosdb.Account("example", {
        name: "example-cosmosdb-account",
        location: example.location,
        resourceGroupName: example.name,
        offerType: "Standard",
        kind: "GlobalDocumentDB",
        consistencyPolicy: {
            consistencyLevel: "Strong",
        },
        geoLocations: [{
            location: example.location,
            failoverPriority: 0,
        }],
    });
    const exampleSpringCloudAppCosmosDBAssociation = new azure.appplatform.SpringCloudAppCosmosDBAssociation("example", {
        name: "example-bind",
        springCloudAppId: exampleSpringCloudApp.id,
        cosmosdbAccountId: exampleAccount.id,
        apiType: "table",
        cosmosdbAccessKey: exampleAccount.primaryKey,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_spring_cloud_service = azure.appplatform.SpringCloudService("example",
        name="example-springcloud",
        resource_group_name=example.name,
        location=example.location)
    example_spring_cloud_app = azure.appplatform.SpringCloudApp("example",
        name="example-springcloudapp",
        resource_group_name=example.name,
        service_name=example_spring_cloud_service.name)
    example_account = azure.cosmosdb.Account("example",
        name="example-cosmosdb-account",
        location=example.location,
        resource_group_name=example.name,
        offer_type="Standard",
        kind="GlobalDocumentDB",
        consistency_policy={
            "consistency_level": "Strong",
        },
        geo_locations=[{
            "location": example.location,
            "failover_priority": 0,
        }])
    example_spring_cloud_app_cosmos_dbassociation = azure.appplatform.SpringCloudAppCosmosDBAssociation("example",
        name="example-bind",
        spring_cloud_app_id=example_spring_cloud_app.id,
        cosmosdb_account_id=example_account.id,
        api_type="table",
        cosmosdb_access_key=example_account.primary_key)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appplatform"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/cosmosdb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleSpringCloudService, err := appplatform.NewSpringCloudService(ctx, "example", &appplatform.SpringCloudServiceArgs{
    			Name:              pulumi.String("example-springcloud"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    		})
    		if err != nil {
    			return err
    		}
    		exampleSpringCloudApp, err := appplatform.NewSpringCloudApp(ctx, "example", &appplatform.SpringCloudAppArgs{
    			Name:              pulumi.String("example-springcloudapp"),
    			ResourceGroupName: example.Name,
    			ServiceName:       exampleSpringCloudService.Name,
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := cosmosdb.NewAccount(ctx, "example", &cosmosdb.AccountArgs{
    			Name:              pulumi.String("example-cosmosdb-account"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			OfferType:         pulumi.String("Standard"),
    			Kind:              pulumi.String("GlobalDocumentDB"),
    			ConsistencyPolicy: &cosmosdb.AccountConsistencyPolicyArgs{
    				ConsistencyLevel: pulumi.String("Strong"),
    			},
    			GeoLocations: cosmosdb.AccountGeoLocationArray{
    				&cosmosdb.AccountGeoLocationArgs{
    					Location:         example.Location,
    					FailoverPriority: pulumi.Int(0),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = appplatform.NewSpringCloudAppCosmosDBAssociation(ctx, "example", &appplatform.SpringCloudAppCosmosDBAssociationArgs{
    			Name:              pulumi.String("example-bind"),
    			SpringCloudAppId:  exampleSpringCloudApp.ID(),
    			CosmosdbAccountId: exampleAccount.ID(),
    			ApiType:           pulumi.String("table"),
    			CosmosdbAccessKey: exampleAccount.PrimaryKey,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleSpringCloudService = new Azure.AppPlatform.SpringCloudService("example", new()
        {
            Name = "example-springcloud",
            ResourceGroupName = example.Name,
            Location = example.Location,
        });
    
        var exampleSpringCloudApp = new Azure.AppPlatform.SpringCloudApp("example", new()
        {
            Name = "example-springcloudapp",
            ResourceGroupName = example.Name,
            ServiceName = exampleSpringCloudService.Name,
        });
    
        var exampleAccount = new Azure.CosmosDB.Account("example", new()
        {
            Name = "example-cosmosdb-account",
            Location = example.Location,
            ResourceGroupName = example.Name,
            OfferType = "Standard",
            Kind = "GlobalDocumentDB",
            ConsistencyPolicy = new Azure.CosmosDB.Inputs.AccountConsistencyPolicyArgs
            {
                ConsistencyLevel = "Strong",
            },
            GeoLocations = new[]
            {
                new Azure.CosmosDB.Inputs.AccountGeoLocationArgs
                {
                    Location = example.Location,
                    FailoverPriority = 0,
                },
            },
        });
    
        var exampleSpringCloudAppCosmosDBAssociation = new Azure.AppPlatform.SpringCloudAppCosmosDBAssociation("example", new()
        {
            Name = "example-bind",
            SpringCloudAppId = exampleSpringCloudApp.Id,
            CosmosdbAccountId = exampleAccount.Id,
            ApiType = "table",
            CosmosdbAccessKey = exampleAccount.PrimaryKey,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.appplatform.SpringCloudService;
    import com.pulumi.azure.appplatform.SpringCloudServiceArgs;
    import com.pulumi.azure.appplatform.SpringCloudApp;
    import com.pulumi.azure.appplatform.SpringCloudAppArgs;
    import com.pulumi.azure.cosmosdb.Account;
    import com.pulumi.azure.cosmosdb.AccountArgs;
    import com.pulumi.azure.cosmosdb.inputs.AccountConsistencyPolicyArgs;
    import com.pulumi.azure.cosmosdb.inputs.AccountGeoLocationArgs;
    import com.pulumi.azure.appplatform.SpringCloudAppCosmosDBAssociation;
    import com.pulumi.azure.appplatform.SpringCloudAppCosmosDBAssociationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleSpringCloudService = new SpringCloudService("exampleSpringCloudService", SpringCloudServiceArgs.builder()
                .name("example-springcloud")
                .resourceGroupName(example.name())
                .location(example.location())
                .build());
    
            var exampleSpringCloudApp = new SpringCloudApp("exampleSpringCloudApp", SpringCloudAppArgs.builder()
                .name("example-springcloudapp")
                .resourceGroupName(example.name())
                .serviceName(exampleSpringCloudService.name())
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
                .name("example-cosmosdb-account")
                .location(example.location())
                .resourceGroupName(example.name())
                .offerType("Standard")
                .kind("GlobalDocumentDB")
                .consistencyPolicy(AccountConsistencyPolicyArgs.builder()
                    .consistencyLevel("Strong")
                    .build())
                .geoLocations(AccountGeoLocationArgs.builder()
                    .location(example.location())
                    .failoverPriority(0)
                    .build())
                .build());
    
            var exampleSpringCloudAppCosmosDBAssociation = new SpringCloudAppCosmosDBAssociation("exampleSpringCloudAppCosmosDBAssociation", SpringCloudAppCosmosDBAssociationArgs.builder()
                .name("example-bind")
                .springCloudAppId(exampleSpringCloudApp.id())
                .cosmosdbAccountId(exampleAccount.id())
                .apiType("table")
                .cosmosdbAccessKey(exampleAccount.primaryKey())
                .build());
    
        }
    }
    
    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}
      exampleAccount:
        type: azure:cosmosdb:Account
        name: example
        properties:
          name: example-cosmosdb-account
          location: ${example.location}
          resourceGroupName: ${example.name}
          offerType: Standard
          kind: GlobalDocumentDB
          consistencyPolicy:
            consistencyLevel: Strong
          geoLocations:
            - location: ${example.location}
              failoverPriority: 0
      exampleSpringCloudAppCosmosDBAssociation:
        type: azure:appplatform:SpringCloudAppCosmosDBAssociation
        name: example
        properties:
          name: example-bind
          springCloudAppId: ${exampleSpringCloudApp.id}
          cosmosdbAccountId: ${exampleAccount.id}
          apiType: table
          cosmosdbAccessKey: ${exampleAccount.primaryKey}
    

    Create SpringCloudAppCosmosDBAssociation Resource

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

    Constructor syntax

    new SpringCloudAppCosmosDBAssociation(name: string, args: SpringCloudAppCosmosDBAssociationArgs, opts?: CustomResourceOptions);
    @overload
    def SpringCloudAppCosmosDBAssociation(resource_name: str,
                                          args: SpringCloudAppCosmosDBAssociationArgs,
                                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def SpringCloudAppCosmosDBAssociation(resource_name: str,
                                          opts: Optional[ResourceOptions] = None,
                                          api_type: Optional[str] = None,
                                          cosmosdb_access_key: Optional[str] = None,
                                          cosmosdb_account_id: Optional[str] = None,
                                          spring_cloud_app_id: Optional[str] = None,
                                          cosmosdb_cassandra_keyspace_name: Optional[str] = None,
                                          cosmosdb_gremlin_database_name: Optional[str] = None,
                                          cosmosdb_gremlin_graph_name: Optional[str] = None,
                                          cosmosdb_mongo_database_name: Optional[str] = None,
                                          cosmosdb_sql_database_name: Optional[str] = None,
                                          name: Optional[str] = None)
    func NewSpringCloudAppCosmosDBAssociation(ctx *Context, name string, args SpringCloudAppCosmosDBAssociationArgs, opts ...ResourceOption) (*SpringCloudAppCosmosDBAssociation, error)
    public SpringCloudAppCosmosDBAssociation(string name, SpringCloudAppCosmosDBAssociationArgs args, CustomResourceOptions? opts = null)
    public SpringCloudAppCosmosDBAssociation(String name, SpringCloudAppCosmosDBAssociationArgs args)
    public SpringCloudAppCosmosDBAssociation(String name, SpringCloudAppCosmosDBAssociationArgs args, CustomResourceOptions options)
    
    type: azure:appplatform:SpringCloudAppCosmosDBAssociation
    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 SpringCloudAppCosmosDBAssociationArgs
    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 SpringCloudAppCosmosDBAssociationArgs
    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 SpringCloudAppCosmosDBAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SpringCloudAppCosmosDBAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SpringCloudAppCosmosDBAssociationArgs
    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 springCloudAppCosmosDBAssociationResource = new Azure.AppPlatform.SpringCloudAppCosmosDBAssociation("springCloudAppCosmosDBAssociationResource", new()
    {
        ApiType = "string",
        CosmosdbAccessKey = "string",
        CosmosdbAccountId = "string",
        SpringCloudAppId = "string",
        CosmosdbCassandraKeyspaceName = "string",
        CosmosdbGremlinDatabaseName = "string",
        CosmosdbGremlinGraphName = "string",
        CosmosdbMongoDatabaseName = "string",
        CosmosdbSqlDatabaseName = "string",
        Name = "string",
    });
    
    example, err := appplatform.NewSpringCloudAppCosmosDBAssociation(ctx, "springCloudAppCosmosDBAssociationResource", &appplatform.SpringCloudAppCosmosDBAssociationArgs{
    	ApiType:                       pulumi.String("string"),
    	CosmosdbAccessKey:             pulumi.String("string"),
    	CosmosdbAccountId:             pulumi.String("string"),
    	SpringCloudAppId:              pulumi.String("string"),
    	CosmosdbCassandraKeyspaceName: pulumi.String("string"),
    	CosmosdbGremlinDatabaseName:   pulumi.String("string"),
    	CosmosdbGremlinGraphName:      pulumi.String("string"),
    	CosmosdbMongoDatabaseName:     pulumi.String("string"),
    	CosmosdbSqlDatabaseName:       pulumi.String("string"),
    	Name:                          pulumi.String("string"),
    })
    
    var springCloudAppCosmosDBAssociationResource = new SpringCloudAppCosmosDBAssociation("springCloudAppCosmosDBAssociationResource", SpringCloudAppCosmosDBAssociationArgs.builder()
        .apiType("string")
        .cosmosdbAccessKey("string")
        .cosmosdbAccountId("string")
        .springCloudAppId("string")
        .cosmosdbCassandraKeyspaceName("string")
        .cosmosdbGremlinDatabaseName("string")
        .cosmosdbGremlinGraphName("string")
        .cosmosdbMongoDatabaseName("string")
        .cosmosdbSqlDatabaseName("string")
        .name("string")
        .build());
    
    spring_cloud_app_cosmos_dbassociation_resource = azure.appplatform.SpringCloudAppCosmosDBAssociation("springCloudAppCosmosDBAssociationResource",
        api_type="string",
        cosmosdb_access_key="string",
        cosmosdb_account_id="string",
        spring_cloud_app_id="string",
        cosmosdb_cassandra_keyspace_name="string",
        cosmosdb_gremlin_database_name="string",
        cosmosdb_gremlin_graph_name="string",
        cosmosdb_mongo_database_name="string",
        cosmosdb_sql_database_name="string",
        name="string")
    
    const springCloudAppCosmosDBAssociationResource = new azure.appplatform.SpringCloudAppCosmosDBAssociation("springCloudAppCosmosDBAssociationResource", {
        apiType: "string",
        cosmosdbAccessKey: "string",
        cosmosdbAccountId: "string",
        springCloudAppId: "string",
        cosmosdbCassandraKeyspaceName: "string",
        cosmosdbGremlinDatabaseName: "string",
        cosmosdbGremlinGraphName: "string",
        cosmosdbMongoDatabaseName: "string",
        cosmosdbSqlDatabaseName: "string",
        name: "string",
    });
    
    type: azure:appplatform:SpringCloudAppCosmosDBAssociation
    properties:
        apiType: string
        cosmosdbAccessKey: string
        cosmosdbAccountId: string
        cosmosdbCassandraKeyspaceName: string
        cosmosdbGremlinDatabaseName: string
        cosmosdbGremlinGraphName: string
        cosmosdbMongoDatabaseName: string
        cosmosdbSqlDatabaseName: string
        name: string
        springCloudAppId: string
    

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

    ApiType string
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    CosmosdbAccessKey string
    Specifies the CosmosDB Account access key.
    CosmosdbAccountId string
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    SpringCloudAppId string
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.
    CosmosdbCassandraKeyspaceName string
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    CosmosdbGremlinDatabaseName string
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    CosmosdbGremlinGraphName string
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    CosmosdbMongoDatabaseName string
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    CosmosdbSqlDatabaseName string
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    Name string
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
    ApiType string
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    CosmosdbAccessKey string
    Specifies the CosmosDB Account access key.
    CosmosdbAccountId string
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    SpringCloudAppId string
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.
    CosmosdbCassandraKeyspaceName string
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    CosmosdbGremlinDatabaseName string
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    CosmosdbGremlinGraphName string
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    CosmosdbMongoDatabaseName string
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    CosmosdbSqlDatabaseName string
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    Name string
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
    apiType String
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    cosmosdbAccessKey String
    Specifies the CosmosDB Account access key.
    cosmosdbAccountId String
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    springCloudAppId String
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.
    cosmosdbCassandraKeyspaceName String
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    cosmosdbGremlinDatabaseName String
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbGremlinGraphName String
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbMongoDatabaseName String
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    cosmosdbSqlDatabaseName String
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    name String
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
    apiType string
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    cosmosdbAccessKey string
    Specifies the CosmosDB Account access key.
    cosmosdbAccountId string
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    springCloudAppId string
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.
    cosmosdbCassandraKeyspaceName string
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    cosmosdbGremlinDatabaseName string
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbGremlinGraphName string
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbMongoDatabaseName string
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    cosmosdbSqlDatabaseName string
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    name string
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
    api_type str
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    cosmosdb_access_key str
    Specifies the CosmosDB Account access key.
    cosmosdb_account_id str
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    spring_cloud_app_id str
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.
    cosmosdb_cassandra_keyspace_name str
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    cosmosdb_gremlin_database_name str
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdb_gremlin_graph_name str
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdb_mongo_database_name str
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    cosmosdb_sql_database_name str
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    name str
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
    apiType String
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    cosmosdbAccessKey String
    Specifies the CosmosDB Account access key.
    cosmosdbAccountId String
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    springCloudAppId String
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.
    cosmosdbCassandraKeyspaceName String
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    cosmosdbGremlinDatabaseName String
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbGremlinGraphName String
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbMongoDatabaseName String
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    cosmosdbSqlDatabaseName String
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    name String
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.

    Outputs

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

    Get an existing SpringCloudAppCosmosDBAssociation 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?: SpringCloudAppCosmosDBAssociationState, opts?: CustomResourceOptions): SpringCloudAppCosmosDBAssociation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_type: Optional[str] = None,
            cosmosdb_access_key: Optional[str] = None,
            cosmosdb_account_id: Optional[str] = None,
            cosmosdb_cassandra_keyspace_name: Optional[str] = None,
            cosmosdb_gremlin_database_name: Optional[str] = None,
            cosmosdb_gremlin_graph_name: Optional[str] = None,
            cosmosdb_mongo_database_name: Optional[str] = None,
            cosmosdb_sql_database_name: Optional[str] = None,
            name: Optional[str] = None,
            spring_cloud_app_id: Optional[str] = None) -> SpringCloudAppCosmosDBAssociation
    func GetSpringCloudAppCosmosDBAssociation(ctx *Context, name string, id IDInput, state *SpringCloudAppCosmosDBAssociationState, opts ...ResourceOption) (*SpringCloudAppCosmosDBAssociation, error)
    public static SpringCloudAppCosmosDBAssociation Get(string name, Input<string> id, SpringCloudAppCosmosDBAssociationState? state, CustomResourceOptions? opts = null)
    public static SpringCloudAppCosmosDBAssociation get(String name, Output<String> id, SpringCloudAppCosmosDBAssociationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ApiType string
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    CosmosdbAccessKey string
    Specifies the CosmosDB Account access key.
    CosmosdbAccountId string
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    CosmosdbCassandraKeyspaceName string
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    CosmosdbGremlinDatabaseName string
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    CosmosdbGremlinGraphName string
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    CosmosdbMongoDatabaseName string
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    CosmosdbSqlDatabaseName string
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    Name string
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
    SpringCloudAppId string
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.
    ApiType string
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    CosmosdbAccessKey string
    Specifies the CosmosDB Account access key.
    CosmosdbAccountId string
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    CosmosdbCassandraKeyspaceName string
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    CosmosdbGremlinDatabaseName string
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    CosmosdbGremlinGraphName string
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    CosmosdbMongoDatabaseName string
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    CosmosdbSqlDatabaseName string
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    Name string
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
    SpringCloudAppId string
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.
    apiType String
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    cosmosdbAccessKey String
    Specifies the CosmosDB Account access key.
    cosmosdbAccountId String
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    cosmosdbCassandraKeyspaceName String
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    cosmosdbGremlinDatabaseName String
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbGremlinGraphName String
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbMongoDatabaseName String
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    cosmosdbSqlDatabaseName String
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    name String
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
    springCloudAppId String
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.
    apiType string
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    cosmosdbAccessKey string
    Specifies the CosmosDB Account access key.
    cosmosdbAccountId string
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    cosmosdbCassandraKeyspaceName string
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    cosmosdbGremlinDatabaseName string
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbGremlinGraphName string
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbMongoDatabaseName string
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    cosmosdbSqlDatabaseName string
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    name string
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
    springCloudAppId string
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.
    api_type str
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    cosmosdb_access_key str
    Specifies the CosmosDB Account access key.
    cosmosdb_account_id str
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    cosmosdb_cassandra_keyspace_name str
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    cosmosdb_gremlin_database_name str
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdb_gremlin_graph_name str
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdb_mongo_database_name str
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    cosmosdb_sql_database_name str
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    name str
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
    spring_cloud_app_id str
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.
    apiType String
    Specifies the API type which should be used when connecting to the CosmosDB Account. Possible values are cassandra, gremlin, mongo, sql or table. Changing this forces a new resource to be created.
    cosmosdbAccessKey String
    Specifies the CosmosDB Account access key.
    cosmosdbAccountId String
    Specifies the ID of the CosmosDB Account. Changing this forces a new resource to be created.
    cosmosdbCassandraKeyspaceName String
    Specifies the name of the Cassandra Keyspace which the Spring Cloud App should be associated with. Should only be set when api_type is cassandra.
    cosmosdbGremlinDatabaseName String
    Specifies the name of the Gremlin Database which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbGremlinGraphName String
    Specifies the name of the Gremlin Graph which the Spring Cloud App should be associated with. Should only be set when api_type is gremlin.
    cosmosdbMongoDatabaseName String
    Specifies the name of the Mongo Database which the Spring Cloud App should be associated with. Should only be set when api_type is mongo.
    cosmosdbSqlDatabaseName String
    Specifies the name of the SQL Database which the Spring Cloud App should be associated with. Should only be set when api_type is sql.
    name String
    Specifies the name of the Spring Cloud Application Association. Changing this forces a new resource to be created.
    springCloudAppId String
    Specifies the ID of the Spring Cloud Application where this Association is created. Changing this forces a new resource to be created.

    Import

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

    $ pulumi import azure:appplatform/springCloudAppCosmosDBAssociation:SpringCloudAppCosmosDBAssociation example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup1/providers/Microsoft.AppPlatform/spring/service1/apps/app1/bindings/bind1
    

    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.10.0 published on Tuesday, Nov 19, 2024 by Pulumi