Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. documentdb
  5. getMongoClusterFirewallRule
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.documentdb.getMongoClusterFirewallRule

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets information about a mongo cluster firewall rule. Azure REST API version: 2023-03-15-preview.

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

Using getMongoClusterFirewallRule

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 getMongoClusterFirewallRule(args: GetMongoClusterFirewallRuleArgs, opts?: InvokeOptions): Promise<GetMongoClusterFirewallRuleResult>
function getMongoClusterFirewallRuleOutput(args: GetMongoClusterFirewallRuleOutputArgs, opts?: InvokeOptions): Output<GetMongoClusterFirewallRuleResult>
Copy
def get_mongo_cluster_firewall_rule(firewall_rule_name: Optional[str] = None,
                                    mongo_cluster_name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetMongoClusterFirewallRuleResult
def get_mongo_cluster_firewall_rule_output(firewall_rule_name: Optional[pulumi.Input[str]] = None,
                                    mongo_cluster_name: Optional[pulumi.Input[str]] = None,
                                    resource_group_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetMongoClusterFirewallRuleResult]
Copy
func LookupMongoClusterFirewallRule(ctx *Context, args *LookupMongoClusterFirewallRuleArgs, opts ...InvokeOption) (*LookupMongoClusterFirewallRuleResult, error)
func LookupMongoClusterFirewallRuleOutput(ctx *Context, args *LookupMongoClusterFirewallRuleOutputArgs, opts ...InvokeOption) LookupMongoClusterFirewallRuleResultOutput
Copy

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

public static class GetMongoClusterFirewallRule 
{
    public static Task<GetMongoClusterFirewallRuleResult> InvokeAsync(GetMongoClusterFirewallRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetMongoClusterFirewallRuleResult> Invoke(GetMongoClusterFirewallRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMongoClusterFirewallRuleResult> getMongoClusterFirewallRule(GetMongoClusterFirewallRuleArgs args, InvokeOptions options)
public static Output<GetMongoClusterFirewallRuleResult> getMongoClusterFirewallRule(GetMongoClusterFirewallRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:documentdb:getMongoClusterFirewallRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FirewallRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the mongo cluster firewall rule.
MongoClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the mongo cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
FirewallRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the mongo cluster firewall rule.
MongoClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the mongo cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
firewallRuleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the mongo cluster firewall rule.
mongoClusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the mongo cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
firewallRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the mongo cluster firewall rule.
mongoClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the mongo cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
firewall_rule_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the mongo cluster firewall rule.
mongo_cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the mongo cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
firewallRuleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the mongo cluster firewall rule.
mongoClusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the mongo cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getMongoClusterFirewallRule Result

The following output properties are available:

EndIpAddress string
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
ProvisioningState string
The provisioning state of the firewall rule.
StartIpAddress string
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
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"
EndIpAddress string
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
ProvisioningState string
The provisioning state of the firewall rule.
StartIpAddress string
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
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"
endIpAddress String
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
provisioningState String
The provisioning state of the firewall rule.
startIpAddress String
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
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"
endIpAddress string
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
provisioningState string
The provisioning state of the firewall rule.
startIpAddress string
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
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"
end_ip_address str
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
provisioning_state str
The provisioning state of the firewall rule.
start_ip_address str
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
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"
endIpAddress String
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
provisioningState String
The provisioning state of the firewall rule.
startIpAddress String
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
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

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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native