1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. MongoCluster
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.42.1 published on Wednesday, May 22, 2024 by Pulumi

azure-native.documentdb.MongoCluster

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.42.1 published on Wednesday, May 22, 2024 by Pulumi

    Represents a mongo cluster resource. Azure REST API version: 2023-03-15-preview.

    Other available API versions: 2023-09-15-preview, 2023-11-15-preview, 2024-02-15-preview, 2024-03-01-preview.

    Example Usage

    Create a new mongo cluster

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var mongoCluster = new AzureNative.DocumentDB.MongoCluster("mongoCluster", new()
        {
            AdministratorLogin = "mongoAdmin",
            AdministratorLoginPassword = "password",
            Location = "westus2",
            MongoClusterName = "myMongoCluster",
            NodeGroupSpecs = new[]
            {
                new AzureNative.DocumentDB.Inputs.NodeGroupSpecArgs
                {
                    DiskSizeGB = 128,
                    EnableHa = true,
                    Kind = AzureNative.DocumentDB.NodeKind.Shard,
                    NodeCount = 3,
                    Sku = "M30",
                },
            },
            ResourceGroupName = "TestResourceGroup",
            ServerVersion = "5.0",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/documentdb/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := documentdb.NewMongoCluster(ctx, "mongoCluster", &documentdb.MongoClusterArgs{
    			AdministratorLogin:         pulumi.String("mongoAdmin"),
    			AdministratorLoginPassword: pulumi.String("password"),
    			Location:                   pulumi.String("westus2"),
    			MongoClusterName:           pulumi.String("myMongoCluster"),
    			NodeGroupSpecs: documentdb.NodeGroupSpecArray{
    				&documentdb.NodeGroupSpecArgs{
    					DiskSizeGB: pulumi.Float64(128),
    					EnableHa:   pulumi.Bool(true),
    					Kind:       pulumi.String(documentdb.NodeKindShard),
    					NodeCount:  pulumi.Int(3),
    					Sku:        pulumi.String("M30"),
    				},
    			},
    			ResourceGroupName: pulumi.String("TestResourceGroup"),
    			ServerVersion:     pulumi.String("5.0"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.documentdb.MongoCluster;
    import com.pulumi.azurenative.documentdb.MongoClusterArgs;
    import com.pulumi.azurenative.documentdb.inputs.NodeGroupSpecArgs;
    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 mongoCluster = new MongoCluster("mongoCluster", MongoClusterArgs.builder()
                .administratorLogin("mongoAdmin")
                .administratorLoginPassword("password")
                .location("westus2")
                .mongoClusterName("myMongoCluster")
                .nodeGroupSpecs(NodeGroupSpecArgs.builder()
                    .diskSizeGB(128)
                    .enableHa(true)
                    .kind("Shard")
                    .nodeCount(3)
                    .sku("M30")
                    .build())
                .resourceGroupName("TestResourceGroup")
                .serverVersion("5.0")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    mongo_cluster = azure_native.documentdb.MongoCluster("mongoCluster",
        administrator_login="mongoAdmin",
        administrator_login_password="password",
        location="westus2",
        mongo_cluster_name="myMongoCluster",
        node_group_specs=[azure_native.documentdb.NodeGroupSpecArgs(
            disk_size_gb=128,
            enable_ha=True,
            kind=azure_native.documentdb.NodeKind.SHARD,
            node_count=3,
            sku="M30",
        )],
        resource_group_name="TestResourceGroup",
        server_version="5.0")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const mongoCluster = new azure_native.documentdb.MongoCluster("mongoCluster", {
        administratorLogin: "mongoAdmin",
        administratorLoginPassword: "password",
        location: "westus2",
        mongoClusterName: "myMongoCluster",
        nodeGroupSpecs: [{
            diskSizeGB: 128,
            enableHa: true,
            kind: azure_native.documentdb.NodeKind.Shard,
            nodeCount: 3,
            sku: "M30",
        }],
        resourceGroupName: "TestResourceGroup",
        serverVersion: "5.0",
    });
    
    resources:
      mongoCluster:
        type: azure-native:documentdb:MongoCluster
        properties:
          administratorLogin: mongoAdmin
          administratorLoginPassword: password
          location: westus2
          mongoClusterName: myMongoCluster
          nodeGroupSpecs:
            - diskSizeGB: 128
              enableHa: true
              kind: Shard
              nodeCount: 3
              sku: M30
          resourceGroupName: TestResourceGroup
          serverVersion: '5.0'
    

    Create a new mongo cluster with point in time restore

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var mongoCluster = new AzureNative.DocumentDB.MongoCluster("mongoCluster", new()
        {
            CreateMode = AzureNative.DocumentDB.CreateMode.PointInTimeRestore,
            Location = "westus2",
            MongoClusterName = "myMongoCluster",
            ResourceGroupName = "TestResourceGroup",
            RestoreParameters = new AzureNative.DocumentDB.Inputs.MongoClusterRestoreParametersArgs
            {
                PointInTimeUTC = "2023-01-13T20:07:35Z",
                SourceResourceId = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/documentdb/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := documentdb.NewMongoCluster(ctx, "mongoCluster", &documentdb.MongoClusterArgs{
    			CreateMode:        pulumi.String(documentdb.CreateModePointInTimeRestore),
    			Location:          pulumi.String("westus2"),
    			MongoClusterName:  pulumi.String("myMongoCluster"),
    			ResourceGroupName: pulumi.String("TestResourceGroup"),
    			RestoreParameters: &documentdb.MongoClusterRestoreParametersArgs{
    				PointInTimeUTC:   pulumi.String("2023-01-13T20:07:35Z"),
    				SourceResourceId: pulumi.String("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.documentdb.MongoCluster;
    import com.pulumi.azurenative.documentdb.MongoClusterArgs;
    import com.pulumi.azurenative.documentdb.inputs.MongoClusterRestoreParametersArgs;
    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 mongoCluster = new MongoCluster("mongoCluster", MongoClusterArgs.builder()
                .createMode("PointInTimeRestore")
                .location("westus2")
                .mongoClusterName("myMongoCluster")
                .resourceGroupName("TestResourceGroup")
                .restoreParameters(MongoClusterRestoreParametersArgs.builder()
                    .pointInTimeUTC("2023-01-13T20:07:35Z")
                    .sourceResourceId("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster")
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    mongo_cluster = azure_native.documentdb.MongoCluster("mongoCluster",
        create_mode=azure_native.documentdb.CreateMode.POINT_IN_TIME_RESTORE,
        location="westus2",
        mongo_cluster_name="myMongoCluster",
        resource_group_name="TestResourceGroup",
        restore_parameters=azure_native.documentdb.MongoClusterRestoreParametersArgs(
            point_in_time_utc="2023-01-13T20:07:35Z",
            source_resource_id="/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster",
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const mongoCluster = new azure_native.documentdb.MongoCluster("mongoCluster", {
        createMode: azure_native.documentdb.CreateMode.PointInTimeRestore,
        location: "westus2",
        mongoClusterName: "myMongoCluster",
        resourceGroupName: "TestResourceGroup",
        restoreParameters: {
            pointInTimeUTC: "2023-01-13T20:07:35Z",
            sourceResourceId: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster",
        },
    });
    
    resources:
      mongoCluster:
        type: azure-native:documentdb:MongoCluster
        properties:
          createMode: PointInTimeRestore
          location: westus2
          mongoClusterName: myMongoCluster
          resourceGroupName: TestResourceGroup
          restoreParameters:
            pointInTimeUTC: 2023-01-13T20:07:35Z
            sourceResourceId: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DocumentDB/mongoClusters/myOtherMongoCluster
    

    Create MongoCluster Resource

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

    Constructor syntax

    new MongoCluster(name: string, args: MongoClusterArgs, opts?: CustomResourceOptions);
    @overload
    def MongoCluster(resource_name: str,
                     args: MongoClusterArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def MongoCluster(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     resource_group_name: Optional[str] = None,
                     administrator_login: Optional[str] = None,
                     administrator_login_password: Optional[str] = None,
                     create_mode: Optional[Union[str, CreateMode]] = None,
                     location: Optional[str] = None,
                     mongo_cluster_name: Optional[str] = None,
                     node_group_specs: Optional[Sequence[NodeGroupSpecArgs]] = None,
                     restore_parameters: Optional[MongoClusterRestoreParametersArgs] = None,
                     server_version: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewMongoCluster(ctx *Context, name string, args MongoClusterArgs, opts ...ResourceOption) (*MongoCluster, error)
    public MongoCluster(string name, MongoClusterArgs args, CustomResourceOptions? opts = null)
    public MongoCluster(String name, MongoClusterArgs args)
    public MongoCluster(String name, MongoClusterArgs args, CustomResourceOptions options)
    
    type: azure-native:documentdb:MongoCluster
    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 MongoClusterArgs
    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 MongoClusterArgs
    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 MongoClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MongoClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MongoClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var mongoClusterResource = new AzureNative.DocumentDB.MongoCluster("mongoClusterResource", new()
    {
        ResourceGroupName = "string",
        AdministratorLogin = "string",
        AdministratorLoginPassword = "string",
        CreateMode = "string",
        Location = "string",
        MongoClusterName = "string",
        NodeGroupSpecs = new[]
        {
            new AzureNative.DocumentDB.Inputs.NodeGroupSpecArgs
            {
                DiskSizeGB = 0,
                EnableHa = false,
                Kind = "string",
                NodeCount = 0,
                Sku = "string",
            },
        },
        RestoreParameters = new AzureNative.DocumentDB.Inputs.MongoClusterRestoreParametersArgs
        {
            PointInTimeUTC = "string",
            SourceResourceId = "string",
        },
        ServerVersion = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := documentdb.NewMongoCluster(ctx, "mongoClusterResource", &documentdb.MongoClusterArgs{
    ResourceGroupName: pulumi.String("string"),
    AdministratorLogin: pulumi.String("string"),
    AdministratorLoginPassword: pulumi.String("string"),
    CreateMode: pulumi.String("string"),
    Location: pulumi.String("string"),
    MongoClusterName: pulumi.String("string"),
    NodeGroupSpecs: documentdb.NodeGroupSpecArray{
    &documentdb.NodeGroupSpecArgs{
    DiskSizeGB: pulumi.Float64(0),
    EnableHa: pulumi.Bool(false),
    Kind: pulumi.String("string"),
    NodeCount: pulumi.Int(0),
    Sku: pulumi.String("string"),
    },
    },
    RestoreParameters: &documentdb.MongoClusterRestoreParametersArgs{
    PointInTimeUTC: pulumi.String("string"),
    SourceResourceId: pulumi.String("string"),
    },
    ServerVersion: pulumi.String("string"),
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    })
    
    var mongoClusterResource = new MongoCluster("mongoClusterResource", MongoClusterArgs.builder()        
        .resourceGroupName("string")
        .administratorLogin("string")
        .administratorLoginPassword("string")
        .createMode("string")
        .location("string")
        .mongoClusterName("string")
        .nodeGroupSpecs(NodeGroupSpecArgs.builder()
            .diskSizeGB(0)
            .enableHa(false)
            .kind("string")
            .nodeCount(0)
            .sku("string")
            .build())
        .restoreParameters(MongoClusterRestoreParametersArgs.builder()
            .pointInTimeUTC("string")
            .sourceResourceId("string")
            .build())
        .serverVersion("string")
        .tags(Map.of("string", "string"))
        .build());
    
    mongo_cluster_resource = azure_native.documentdb.MongoCluster("mongoClusterResource",
        resource_group_name="string",
        administrator_login="string",
        administrator_login_password="string",
        create_mode="string",
        location="string",
        mongo_cluster_name="string",
        node_group_specs=[azure_native.documentdb.NodeGroupSpecArgs(
            disk_size_gb=0,
            enable_ha=False,
            kind="string",
            node_count=0,
            sku="string",
        )],
        restore_parameters=azure_native.documentdb.MongoClusterRestoreParametersArgs(
            point_in_time_utc="string",
            source_resource_id="string",
        ),
        server_version="string",
        tags={
            "string": "string",
        })
    
    const mongoClusterResource = new azure_native.documentdb.MongoCluster("mongoClusterResource", {
        resourceGroupName: "string",
        administratorLogin: "string",
        administratorLoginPassword: "string",
        createMode: "string",
        location: "string",
        mongoClusterName: "string",
        nodeGroupSpecs: [{
            diskSizeGB: 0,
            enableHa: false,
            kind: "string",
            nodeCount: 0,
            sku: "string",
        }],
        restoreParameters: {
            pointInTimeUTC: "string",
            sourceResourceId: "string",
        },
        serverVersion: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:documentdb:MongoCluster
    properties:
        administratorLogin: string
        administratorLoginPassword: string
        createMode: string
        location: string
        mongoClusterName: string
        nodeGroupSpecs:
            - diskSizeGB: 0
              enableHa: false
              kind: string
              nodeCount: 0
              sku: string
        resourceGroupName: string
        restoreParameters:
            pointInTimeUTC: string
            sourceResourceId: string
        serverVersion: string
        tags:
            string: string
    

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

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AdministratorLogin string
    The administrator's login for the mongo cluster.
    AdministratorLoginPassword string
    The password of the administrator login.
    CreateMode string | Pulumi.AzureNative.DocumentDB.CreateMode
    The mode to create a mongo cluster.
    Location string
    The geo-location where the resource lives
    MongoClusterName string
    The name of the mongo cluster.
    NodeGroupSpecs List<Pulumi.AzureNative.DocumentDB.Inputs.NodeGroupSpec>
    The list of node group specs in the cluster.
    RestoreParameters Pulumi.AzureNative.DocumentDB.Inputs.MongoClusterRestoreParameters
    Parameters used for restore operations
    ServerVersion string
    The Mongo DB server version. Defaults to the latest available version if not specified.
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AdministratorLogin string
    The administrator's login for the mongo cluster.
    AdministratorLoginPassword string
    The password of the administrator login.
    CreateMode string | CreateMode
    The mode to create a mongo cluster.
    Location string
    The geo-location where the resource lives
    MongoClusterName string
    The name of the mongo cluster.
    NodeGroupSpecs []NodeGroupSpecArgs
    The list of node group specs in the cluster.
    RestoreParameters MongoClusterRestoreParametersArgs
    Parameters used for restore operations
    ServerVersion string
    The Mongo DB server version. Defaults to the latest available version if not specified.
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    administratorLogin String
    The administrator's login for the mongo cluster.
    administratorLoginPassword String
    The password of the administrator login.
    createMode String | CreateMode
    The mode to create a mongo cluster.
    location String
    The geo-location where the resource lives
    mongoClusterName String
    The name of the mongo cluster.
    nodeGroupSpecs List<NodeGroupSpec>
    The list of node group specs in the cluster.
    restoreParameters MongoClusterRestoreParameters
    Parameters used for restore operations
    serverVersion String
    The Mongo DB server version. Defaults to the latest available version if not specified.
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    administratorLogin string
    The administrator's login for the mongo cluster.
    administratorLoginPassword string
    The password of the administrator login.
    createMode string | CreateMode
    The mode to create a mongo cluster.
    location string
    The geo-location where the resource lives
    mongoClusterName string
    The name of the mongo cluster.
    nodeGroupSpecs NodeGroupSpec[]
    The list of node group specs in the cluster.
    restoreParameters MongoClusterRestoreParameters
    Parameters used for restore operations
    serverVersion string
    The Mongo DB server version. Defaults to the latest available version if not specified.
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    administrator_login str
    The administrator's login for the mongo cluster.
    administrator_login_password str
    The password of the administrator login.
    create_mode str | CreateMode
    The mode to create a mongo cluster.
    location str
    The geo-location where the resource lives
    mongo_cluster_name str
    The name of the mongo cluster.
    node_group_specs Sequence[NodeGroupSpecArgs]
    The list of node group specs in the cluster.
    restore_parameters MongoClusterRestoreParametersArgs
    Parameters used for restore operations
    server_version str
    The Mongo DB server version. Defaults to the latest available version if not specified.
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    administratorLogin String
    The administrator's login for the mongo cluster.
    administratorLoginPassword String
    The password of the administrator login.
    createMode String | "Default" | "PointInTimeRestore"
    The mode to create a mongo cluster.
    location String
    The geo-location where the resource lives
    mongoClusterName String
    The name of the mongo cluster.
    nodeGroupSpecs List<Property Map>
    The list of node group specs in the cluster.
    restoreParameters Property Map
    Parameters used for restore operations
    serverVersion String
    The Mongo DB server version. Defaults to the latest available version if not specified.
    tags Map<String>
    Resource tags.

    Outputs

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

    ClusterStatus string
    A status of the mongo cluster.
    ConnectionString string
    The default mongo connection string for the cluster.
    EarliestRestoreTime string
    Earliest restore timestamp in UTC ISO8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    A provisioning state of the mongo cluster.
    SystemData Pulumi.AzureNative.DocumentDB.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ClusterStatus string
    A status of the mongo cluster.
    ConnectionString string
    The default mongo connection string for the cluster.
    EarliestRestoreTime string
    Earliest restore timestamp in UTC ISO8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    A provisioning state of the mongo cluster.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    clusterStatus String
    A status of the mongo cluster.
    connectionString String
    The default mongo connection string for the cluster.
    earliestRestoreTime String
    Earliest restore timestamp in UTC ISO8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    A provisioning state of the mongo cluster.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    clusterStatus string
    A status of the mongo cluster.
    connectionString string
    The default mongo connection string for the cluster.
    earliestRestoreTime string
    Earliest restore timestamp in UTC ISO8601 format.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    A provisioning state of the mongo cluster.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    cluster_status str
    A status of the mongo cluster.
    connection_string str
    The default mongo connection string for the cluster.
    earliest_restore_time str
    Earliest restore timestamp in UTC ISO8601 format.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    A provisioning state of the mongo cluster.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    clusterStatus String
    A status of the mongo cluster.
    connectionString String
    The default mongo connection string for the cluster.
    earliestRestoreTime String
    Earliest restore timestamp in UTC ISO8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    A provisioning state of the mongo cluster.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    CreateMode, CreateModeArgs

    Default
    Default
    PointInTimeRestore
    PointInTimeRestore
    CreateModeDefault
    Default
    CreateModePointInTimeRestore
    PointInTimeRestore
    Default
    Default
    PointInTimeRestore
    PointInTimeRestore
    Default
    Default
    PointInTimeRestore
    PointInTimeRestore
    DEFAULT
    Default
    POINT_IN_TIME_RESTORE
    PointInTimeRestore
    "Default"
    Default
    "PointInTimeRestore"
    PointInTimeRestore

    MongoClusterRestoreParameters, MongoClusterRestoreParametersArgs

    PointInTimeUTC string
    UTC point in time to restore a mongo cluster
    SourceResourceId string
    Resource ID to locate the source cluster to restore
    PointInTimeUTC string
    UTC point in time to restore a mongo cluster
    SourceResourceId string
    Resource ID to locate the source cluster to restore
    pointInTimeUTC String
    UTC point in time to restore a mongo cluster
    sourceResourceId String
    Resource ID to locate the source cluster to restore
    pointInTimeUTC string
    UTC point in time to restore a mongo cluster
    sourceResourceId string
    Resource ID to locate the source cluster to restore
    point_in_time_utc str
    UTC point in time to restore a mongo cluster
    source_resource_id str
    Resource ID to locate the source cluster to restore
    pointInTimeUTC String
    UTC point in time to restore a mongo cluster
    sourceResourceId String
    Resource ID to locate the source cluster to restore

    NodeGroupSpec, NodeGroupSpecArgs

    DiskSizeGB double
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    EnableHa bool
    Whether high availability is enabled on the node group.
    Kind string | Pulumi.AzureNative.DocumentDB.NodeKind
    The node type deployed in the node group.
    NodeCount int
    The number of nodes in the node group.
    Sku string
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.
    DiskSizeGB float64
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    EnableHa bool
    Whether high availability is enabled on the node group.
    Kind string | NodeKind
    The node type deployed in the node group.
    NodeCount int
    The number of nodes in the node group.
    Sku string
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.
    diskSizeGB Double
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    enableHa Boolean
    Whether high availability is enabled on the node group.
    kind String | NodeKind
    The node type deployed in the node group.
    nodeCount Integer
    The number of nodes in the node group.
    sku String
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.
    diskSizeGB number
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    enableHa boolean
    Whether high availability is enabled on the node group.
    kind string | NodeKind
    The node type deployed in the node group.
    nodeCount number
    The number of nodes in the node group.
    sku string
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.
    disk_size_gb float
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    enable_ha bool
    Whether high availability is enabled on the node group.
    kind str | NodeKind
    The node type deployed in the node group.
    node_count int
    The number of nodes in the node group.
    sku str
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.
    diskSizeGB Number
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    enableHa Boolean
    Whether high availability is enabled on the node group.
    kind String | "Shard"
    The node type deployed in the node group.
    nodeCount Number
    The number of nodes in the node group.
    sku String
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.

    NodeGroupSpecResponse, NodeGroupSpecResponseArgs

    DiskSizeGB double
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    EnableHa bool
    Whether high availability is enabled on the node group.
    Kind string
    The node type deployed in the node group.
    NodeCount int
    The number of nodes in the node group.
    Sku string
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.
    DiskSizeGB float64
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    EnableHa bool
    Whether high availability is enabled on the node group.
    Kind string
    The node type deployed in the node group.
    NodeCount int
    The number of nodes in the node group.
    Sku string
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.
    diskSizeGB Double
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    enableHa Boolean
    Whether high availability is enabled on the node group.
    kind String
    The node type deployed in the node group.
    nodeCount Integer
    The number of nodes in the node group.
    sku String
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.
    diskSizeGB number
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    enableHa boolean
    Whether high availability is enabled on the node group.
    kind string
    The node type deployed in the node group.
    nodeCount number
    The number of nodes in the node group.
    sku string
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.
    disk_size_gb float
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    enable_ha bool
    Whether high availability is enabled on the node group.
    kind str
    The node type deployed in the node group.
    node_count int
    The number of nodes in the node group.
    sku str
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.
    diskSizeGB Number
    The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
    enableHa Boolean
    Whether high availability is enabled on the node group.
    kind String
    The node type deployed in the node group.
    nodeCount Number
    The number of nodes in the node group.
    sku String
    The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.

    NodeKind, NodeKindArgs

    Shard
    Shard
    NodeKindShard
    Shard
    Shard
    Shard
    Shard
    Shard
    SHARD
    Shard
    "Shard"
    Shard

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:documentdb:MongoCluster myMongoCluster /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.42.1 published on Wednesday, May 22, 2024 by Pulumi