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.77.0 published on Thursday, Dec 12, 2024 by Pulumi
azure-native.documentdb.getMongoCluster
Explore with Pulumi AI
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.77.0 published on Thursday, Dec 12, 2024 by Pulumi
Gets information about a mongo cluster. 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, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:documentdb:getMongoCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Mongo
Cluster stringName - The name of the mongo cluster.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Mongo
Cluster stringName - The name of the mongo cluster.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- mongo
Cluster StringName - The name of the mongo cluster.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- mongo
Cluster stringName - The name of the mongo cluster.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- mongo_
cluster_ strname - The name of the mongo cluster.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- mongo
Cluster StringName - The name of the mongo cluster.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getMongoCluster Result
The following output properties are available:
- Cluster
Status string - A status of the mongo cluster.
- Connection
String string - The default mongo connection string for the cluster.
- Earliest
Restore stringTime - 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
- Provisioning
State string - A provisioning state of the mongo cluster.
- System
Data Pulumi.Azure Native. Document DB. Outputs. System Data Response - 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"
- Administrator
Login string - The administrator's login for the mongo cluster.
- Node
Group List<Pulumi.Specs Azure Native. Document DB. Outputs. Node Group Spec Response> - The list of node group specs in the cluster.
- Server
Version string - The Mongo DB server version. Defaults to the latest available version if not specified.
- Dictionary<string, string>
- Resource tags.
- Cluster
Status string - A status of the mongo cluster.
- Connection
String string - The default mongo connection string for the cluster.
- Earliest
Restore stringTime - 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
- Provisioning
State string - A provisioning state of the mongo cluster.
- System
Data SystemData Response - 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"
- Administrator
Login string - The administrator's login for the mongo cluster.
- Node
Group []NodeSpecs Group Spec Response - The list of node group specs in the cluster.
- Server
Version string - The Mongo DB server version. Defaults to the latest available version if not specified.
- map[string]string
- Resource tags.
- cluster
Status String - A status of the mongo cluster.
- connection
String String - The default mongo connection string for the cluster.
- earliest
Restore StringTime - 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
- provisioning
State String - A provisioning state of the mongo cluster.
- system
Data SystemData Response - 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"
- administrator
Login String - The administrator's login for the mongo cluster.
- node
Group List<NodeSpecs Group Spec Response> - The list of node group specs in the cluster.
- server
Version String - The Mongo DB server version. Defaults to the latest available version if not specified.
- Map<String,String>
- Resource tags.
- cluster
Status string - A status of the mongo cluster.
- connection
String string - The default mongo connection string for the cluster.
- earliest
Restore stringTime - 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
- provisioning
State string - A provisioning state of the mongo cluster.
- system
Data SystemData Response - 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"
- administrator
Login string - The administrator's login for the mongo cluster.
- node
Group NodeSpecs Group Spec Response[] - The list of node group specs in the cluster.
- server
Version string - The Mongo DB server version. Defaults to the latest available version if not specified.
- {[key: string]: string}
- Resource tags.
- cluster_
status str - A status of the mongo cluster.
- connection_
string str - The default mongo connection string for the cluster.
- earliest_
restore_ strtime - 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 SystemData Response - 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_ Sequence[Nodespecs Group Spec Response] - 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.
- Mapping[str, str]
- Resource tags.
- cluster
Status String - A status of the mongo cluster.
- connection
String String - The default mongo connection string for the cluster.
- earliest
Restore StringTime - 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
- provisioning
State String - A provisioning state of the mongo cluster.
- system
Data 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"
- administrator
Login String - The administrator's login for the mongo cluster.
- node
Group List<Property Map>Specs - The list of node group specs in the cluster.
- server
Version String - The Mongo DB server version. Defaults to the latest available version if not specified.
- Map<String>
- Resource tags.
Supporting Types
NodeGroupSpecResponse
- Disk
Size doubleGB - 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 string
- The node type deployed in the node group.
- Node
Count 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'.
- Disk
Size float64GB - 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 string
- The node type deployed in the node group.
- Node
Count 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'.
- disk
Size DoubleGB - The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
- enable
Ha Boolean - Whether high availability is enabled on the node group.
- kind String
- The node type deployed in the node group.
- node
Count 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'.
- disk
Size numberGB - The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
- enable
Ha boolean - Whether high availability is enabled on the node group.
- kind string
- The node type deployed in the node group.
- node
Count 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_ floatgb - 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'.
- disk
Size NumberGB - The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
- enable
Ha Boolean - Whether high availability is enabled on the node group.
- kind String
- The node type deployed in the node group.
- node
Count 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
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.77.0 published on Thursday, Dec 12, 2024 by Pulumi