Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. getMongoCluster
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.getMongoCluster

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets information about a mongo cluster.

    Uses Azure REST API version 2024-02-15-preview.

    Other available API versions: 2023-03-01-preview, 2023-03-15-preview, 2023-09-15-preview, 2023-11-15-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.

    Using getMongoCluster

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getMongoCluster(args: GetMongoClusterArgs, opts?: InvokeOptions): Promise<GetMongoClusterResult>
function getMongoClusterOutput(args: GetMongoClusterOutputArgs, opts?: InvokeOptions): Output<GetMongoClusterResult>
    def get_mongo_cluster(mongo_cluster_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetMongoClusterResult
def get_mongo_cluster_output(mongo_cluster_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetMongoClusterResult]
    func LookupMongoCluster(ctx *Context, args *LookupMongoClusterArgs, opts ...InvokeOption) (*LookupMongoClusterResult, error)
func LookupMongoClusterOutput(ctx *Context, args *LookupMongoClusterOutputArgs, opts ...InvokeOption) LookupMongoClusterResultOutput

    > Note: This function is named LookupMongoCluster in the Go SDK.

    public static class GetMongoCluster 
{
    public static Task<GetMongoClusterResult> InvokeAsync(GetMongoClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetMongoClusterResult> Invoke(GetMongoClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMongoClusterResult> getMongoCluster(GetMongoClusterArgs args, InvokeOptions options)
public static Output<GetMongoClusterResult> getMongoCluster(GetMongoClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:cosmosdb:getMongoCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    MongoClusterName string
    The name of the mongo cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    MongoClusterName string
    The name of the mongo cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    mongoClusterName String
    The name of the mongo cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    mongoClusterName string
    The name of the mongo cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    mongo_cluster_name str
    The name of the mongo cluster.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    mongoClusterName String
    The name of the mongo cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getMongoCluster Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    A provisioning state of the mongo cluster.
    SystemData Pulumi.AzureNative.CosmosDB.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"
    AdministratorLogin string
    The administrator's login for the mongo cluster.
    NodeGroupSpecs List<Pulumi.AzureNative.CosmosDB.Outputs.NodeGroupSpecResponse>
    The list of node group specs in the cluster.
    ServerVersion string
    The Mongo DB server version. Defaults to the latest available version if not specified.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    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"
    AdministratorLogin string
    The administrator's login for the mongo cluster.
    NodeGroupSpecs []NodeGroupSpecResponse
    The list of node group specs in the cluster.
    ServerVersion string
    The Mongo DB server version. Defaults to the latest available version if not specified.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    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"
    administratorLogin String
    The administrator's login for the mongo cluster.
    nodeGroupSpecs List<NodeGroupSpecResponse>
    The list of node group specs in the cluster.
    serverVersion String
    The Mongo DB server version. Defaults to the latest available version if not specified.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    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"
    administratorLogin string
    The administrator's login for the mongo cluster.
    nodeGroupSpecs NodeGroupSpecResponse[]
    The list of node group specs in the cluster.
    serverVersion string
    The Mongo DB server version. Defaults to the latest available version if not specified.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    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"
    administrator_login str
    The administrator's login for the mongo cluster.
    node_group_specs Sequence[NodeGroupSpecResponse]
    The list of node group specs in the cluster.
    server_version str
    The Mongo DB server version. Defaults to the latest available version if not specified.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    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"
    administratorLogin String
    The administrator's login for the mongo cluster.
    nodeGroupSpecs List<Property Map>
    The list of node group specs in the cluster.
    serverVersion String
    The Mongo DB server version. Defaults to the latest available version if not specified.
    tags Map<String>
    Resource tags.

    Supporting Types

    NodeGroupSpecResponse

    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'.

    SystemDataResponse

    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.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native