1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. PostgresqlCoordinatorConfiguration

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi

azure.cosmosdb.PostgresqlCoordinatorConfiguration

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi

    Sets a Coordinator Configuration value on Azure Cosmos DB for PostgreSQL Cluster.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const test = new azure.core.ResourceGroup("test", {
        name: "example-resources",
        location: "West Europe",
    });
    const example = new azure.cosmosdb.PostgresqlCluster("example", {
        name: "examplecluster",
        resourceGroupName: exampleAzurermResourceGroup.name,
        location: exampleAzurermResourceGroup.location,
        administratorLoginPassword: "H@Sh1CoR3!",
        coordinatorStorageQuotaInMb: 131072,
        coordinatorVcoreCount: 2,
        nodeCount: 2,
        nodeStorageQuotaInMb: 131072,
        nodeVcores: 2,
    });
    const examplePostgresqlCoordinatorConfiguration = new azure.cosmosdb.PostgresqlCoordinatorConfiguration("example", {
        name: "array_nulls",
        clusterId: example.id,
        value: "on",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    test = azure.core.ResourceGroup("test",
        name="example-resources",
        location="West Europe")
    example = azure.cosmosdb.PostgresqlCluster("example",
        name="examplecluster",
        resource_group_name=example_azurerm_resource_group["name"],
        location=example_azurerm_resource_group["location"],
        administrator_login_password="H@Sh1CoR3!",
        coordinator_storage_quota_in_mb=131072,
        coordinator_vcore_count=2,
        node_count=2,
        node_storage_quota_in_mb=131072,
        node_vcores=2)
    example_postgresql_coordinator_configuration = azure.cosmosdb.PostgresqlCoordinatorConfiguration("example",
        name="array_nulls",
        cluster_id=example.id,
        value="on")
    
    package main
    
    import (
    	"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 {
    		_, err := core.NewResourceGroup(ctx, "test", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		example, err := cosmosdb.NewPostgresqlCluster(ctx, "example", &cosmosdb.PostgresqlClusterArgs{
    			Name:                        pulumi.String("examplecluster"),
    			ResourceGroupName:           pulumi.Any(exampleAzurermResourceGroup.Name),
    			Location:                    pulumi.Any(exampleAzurermResourceGroup.Location),
    			AdministratorLoginPassword:  pulumi.String("H@Sh1CoR3!"),
    			CoordinatorStorageQuotaInMb: pulumi.Int(131072),
    			CoordinatorVcoreCount:       pulumi.Int(2),
    			NodeCount:                   pulumi.Int(2),
    			NodeStorageQuotaInMb:        pulumi.Int(131072),
    			NodeVcores:                  pulumi.Int(2),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = cosmosdb.NewPostgresqlCoordinatorConfiguration(ctx, "example", &cosmosdb.PostgresqlCoordinatorConfigurationArgs{
    			Name:      pulumi.String("array_nulls"),
    			ClusterId: example.ID(),
    			Value:     pulumi.String("on"),
    		})
    		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 test = new Azure.Core.ResourceGroup("test", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var example = new Azure.CosmosDB.PostgresqlCluster("example", new()
        {
            Name = "examplecluster",
            ResourceGroupName = exampleAzurermResourceGroup.Name,
            Location = exampleAzurermResourceGroup.Location,
            AdministratorLoginPassword = "H@Sh1CoR3!",
            CoordinatorStorageQuotaInMb = 131072,
            CoordinatorVcoreCount = 2,
            NodeCount = 2,
            NodeStorageQuotaInMb = 131072,
            NodeVcores = 2,
        });
    
        var examplePostgresqlCoordinatorConfiguration = new Azure.CosmosDB.PostgresqlCoordinatorConfiguration("example", new()
        {
            Name = "array_nulls",
            ClusterId = example.Id,
            Value = "on",
        });
    
    });
    
    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.cosmosdb.PostgresqlCluster;
    import com.pulumi.azure.cosmosdb.PostgresqlClusterArgs;
    import com.pulumi.azure.cosmosdb.PostgresqlCoordinatorConfiguration;
    import com.pulumi.azure.cosmosdb.PostgresqlCoordinatorConfigurationArgs;
    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 test = new ResourceGroup("test", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var example = new PostgresqlCluster("example", PostgresqlClusterArgs.builder()
                .name("examplecluster")
                .resourceGroupName(exampleAzurermResourceGroup.name())
                .location(exampleAzurermResourceGroup.location())
                .administratorLoginPassword("H@Sh1CoR3!")
                .coordinatorStorageQuotaInMb(131072)
                .coordinatorVcoreCount(2)
                .nodeCount(2)
                .nodeStorageQuotaInMb(131072)
                .nodeVcores(2)
                .build());
    
            var examplePostgresqlCoordinatorConfiguration = new PostgresqlCoordinatorConfiguration("examplePostgresqlCoordinatorConfiguration", PostgresqlCoordinatorConfigurationArgs.builder()
                .name("array_nulls")
                .clusterId(example.id())
                .value("on")
                .build());
    
        }
    }
    
    resources:
      test:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      example:
        type: azure:cosmosdb:PostgresqlCluster
        properties:
          name: examplecluster
          resourceGroupName: ${exampleAzurermResourceGroup.name}
          location: ${exampleAzurermResourceGroup.location}
          administratorLoginPassword: H@Sh1CoR3!
          coordinatorStorageQuotaInMb: 131072
          coordinatorVcoreCount: 2
          nodeCount: 2
          nodeStorageQuotaInMb: 131072
          nodeVcores: 2
      examplePostgresqlCoordinatorConfiguration:
        type: azure:cosmosdb:PostgresqlCoordinatorConfiguration
        name: example
        properties:
          name: array_nulls
          clusterId: ${example.id}
          value: on
    

    Create PostgresqlCoordinatorConfiguration Resource

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

    Constructor syntax

    new PostgresqlCoordinatorConfiguration(name: string, args: PostgresqlCoordinatorConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def PostgresqlCoordinatorConfiguration(resource_name: str,
                                           args: PostgresqlCoordinatorConfigurationArgs,
                                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def PostgresqlCoordinatorConfiguration(resource_name: str,
                                           opts: Optional[ResourceOptions] = None,
                                           cluster_id: Optional[str] = None,
                                           value: Optional[str] = None,
                                           name: Optional[str] = None)
    func NewPostgresqlCoordinatorConfiguration(ctx *Context, name string, args PostgresqlCoordinatorConfigurationArgs, opts ...ResourceOption) (*PostgresqlCoordinatorConfiguration, error)
    public PostgresqlCoordinatorConfiguration(string name, PostgresqlCoordinatorConfigurationArgs args, CustomResourceOptions? opts = null)
    public PostgresqlCoordinatorConfiguration(String name, PostgresqlCoordinatorConfigurationArgs args)
    public PostgresqlCoordinatorConfiguration(String name, PostgresqlCoordinatorConfigurationArgs args, CustomResourceOptions options)
    
    type: azure:cosmosdb:PostgresqlCoordinatorConfiguration
    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 PostgresqlCoordinatorConfigurationArgs
    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 PostgresqlCoordinatorConfigurationArgs
    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 PostgresqlCoordinatorConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PostgresqlCoordinatorConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PostgresqlCoordinatorConfigurationArgs
    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 postgresqlCoordinatorConfigurationResource = new Azure.CosmosDB.PostgresqlCoordinatorConfiguration("postgresqlCoordinatorConfigurationResource", new()
    {
        ClusterId = "string",
        Value = "string",
        Name = "string",
    });
    
    example, err := cosmosdb.NewPostgresqlCoordinatorConfiguration(ctx, "postgresqlCoordinatorConfigurationResource", &cosmosdb.PostgresqlCoordinatorConfigurationArgs{
    	ClusterId: pulumi.String("string"),
    	Value:     pulumi.String("string"),
    	Name:      pulumi.String("string"),
    })
    
    var postgresqlCoordinatorConfigurationResource = new PostgresqlCoordinatorConfiguration("postgresqlCoordinatorConfigurationResource", PostgresqlCoordinatorConfigurationArgs.builder()
        .clusterId("string")
        .value("string")
        .name("string")
        .build());
    
    postgresql_coordinator_configuration_resource = azure.cosmosdb.PostgresqlCoordinatorConfiguration("postgresqlCoordinatorConfigurationResource",
        cluster_id="string",
        value="string",
        name="string")
    
    const postgresqlCoordinatorConfigurationResource = new azure.cosmosdb.PostgresqlCoordinatorConfiguration("postgresqlCoordinatorConfigurationResource", {
        clusterId: "string",
        value: "string",
        name: "string",
    });
    
    type: azure:cosmosdb:PostgresqlCoordinatorConfiguration
    properties:
        clusterId: string
        name: string
        value: string
    

    PostgresqlCoordinatorConfiguration Resource Properties

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

    Inputs

    The PostgresqlCoordinatorConfiguration resource accepts the following input properties:

    ClusterId string
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    Value string
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.
    Name string
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    ClusterId string
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    Value string
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.
    Name string
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    clusterId String
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    value String
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.
    name String
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    clusterId string
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    value string
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.
    name string
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    cluster_id str
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    value str
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.
    name str
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    clusterId String
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    value String
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.
    name String
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.

    Outputs

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

    Get an existing PostgresqlCoordinatorConfiguration 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?: PostgresqlCoordinatorConfigurationState, opts?: CustomResourceOptions): PostgresqlCoordinatorConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cluster_id: Optional[str] = None,
            name: Optional[str] = None,
            value: Optional[str] = None) -> PostgresqlCoordinatorConfiguration
    func GetPostgresqlCoordinatorConfiguration(ctx *Context, name string, id IDInput, state *PostgresqlCoordinatorConfigurationState, opts ...ResourceOption) (*PostgresqlCoordinatorConfiguration, error)
    public static PostgresqlCoordinatorConfiguration Get(string name, Input<string> id, PostgresqlCoordinatorConfigurationState? state, CustomResourceOptions? opts = null)
    public static PostgresqlCoordinatorConfiguration get(String name, Output<String> id, PostgresqlCoordinatorConfigurationState 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:
    ClusterId string
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    Name string
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    Value string
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.
    ClusterId string
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    Name string
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    Value string
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.
    clusterId String
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    name String
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    value String
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.
    clusterId string
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    name string
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    value string
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.
    cluster_id str
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    name str
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    value str
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.
    clusterId String
    The resource ID of the Azure Cosmos DB for PostgreSQL Cluster where we want to change configuration. Changing this forces a new resource to be created.
    name String
    The name of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    value String
    The value of the Coordinator Configuration on Azure Cosmos DB for PostgreSQL Cluster.

    Import

    Coordinator Configurations on Azure Cosmos DB for PostgreSQL Clusters can be imported using the resource id, e.g.

    $ pulumi import azure:cosmosdb/postgresqlCoordinatorConfiguration:PostgresqlCoordinatorConfiguration example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/cluster1/coordinatorConfigurations/array_nulls
    

    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 Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi