Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. mongocluster
  5. FirewallRule
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.mongocluster.FirewallRule

Explore with Pulumi AI

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Represents a mongo cluster firewall rule.

Uses Azure REST API version 2024-07-01.

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

Example Usage

Creates a firewall rule on a Mongo Cluster resource.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var firewallRule = new AzureNative.MongoCluster.FirewallRule("firewallRule", new()
    {
        FirewallRuleName = "rule1",
        MongoClusterName = "myMongoCluster",
        Properties = new AzureNative.MongoCluster.Inputs.FirewallRulePropertiesArgs
        {
            EndIpAddress = "255.255.255.255",
            StartIpAddress = "0.0.0.0",
        },
        ResourceGroupName = "TestGroup",
    });

});
Copy
package main

import (
	mongocluster "github.com/pulumi/pulumi-azure-native-sdk/mongocluster/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongocluster.NewFirewallRule(ctx, "firewallRule", &mongocluster.FirewallRuleArgs{
			FirewallRuleName: pulumi.String("rule1"),
			MongoClusterName: pulumi.String("myMongoCluster"),
			Properties: &mongocluster.FirewallRulePropertiesArgs{
				EndIpAddress:   pulumi.String("255.255.255.255"),
				StartIpAddress: pulumi.String("0.0.0.0"),
			},
			ResourceGroupName: pulumi.String("TestGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.mongocluster.FirewallRule;
import com.pulumi.azurenative.mongocluster.FirewallRuleArgs;
import com.pulumi.azurenative.mongocluster.inputs.FirewallRulePropertiesArgs;
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 firewallRule = new FirewallRule("firewallRule", FirewallRuleArgs.builder()
            .firewallRuleName("rule1")
            .mongoClusterName("myMongoCluster")
            .properties(FirewallRulePropertiesArgs.builder()
                .endIpAddress("255.255.255.255")
                .startIpAddress("0.0.0.0")
                .build())
            .resourceGroupName("TestGroup")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const firewallRule = new azure_native.mongocluster.FirewallRule("firewallRule", {
    firewallRuleName: "rule1",
    mongoClusterName: "myMongoCluster",
    properties: {
        endIpAddress: "255.255.255.255",
        startIpAddress: "0.0.0.0",
    },
    resourceGroupName: "TestGroup",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

firewall_rule = azure_native.mongocluster.FirewallRule("firewallRule",
    firewall_rule_name="rule1",
    mongo_cluster_name="myMongoCluster",
    properties={
        "end_ip_address": "255.255.255.255",
        "start_ip_address": "0.0.0.0",
    },
    resource_group_name="TestGroup")
Copy
resources:
  firewallRule:
    type: azure-native:mongocluster:FirewallRule
    properties:
      firewallRuleName: rule1
      mongoClusterName: myMongoCluster
      properties:
        endIpAddress: 255.255.255.255
        startIpAddress: 0.0.0.0
      resourceGroupName: TestGroup
Copy

Create FirewallRule Resource

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

Constructor syntax

new FirewallRule(name: string, args: FirewallRuleArgs, opts?: CustomResourceOptions);
@overload
def FirewallRule(resource_name: str,
                 args: FirewallRuleArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def FirewallRule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 mongo_cluster_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 firewall_rule_name: Optional[str] = None,
                 properties: Optional[FirewallRulePropertiesArgs] = None)
func NewFirewallRule(ctx *Context, name string, args FirewallRuleArgs, opts ...ResourceOption) (*FirewallRule, error)
public FirewallRule(string name, FirewallRuleArgs args, CustomResourceOptions? opts = null)
public FirewallRule(String name, FirewallRuleArgs args)
public FirewallRule(String name, FirewallRuleArgs args, CustomResourceOptions options)

type: azure-native:mongocluster:FirewallRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FirewallRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FirewallRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FirewallRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FirewallRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FirewallRuleArgs
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 examplefirewallRuleResourceResourceFromMongocluster = new AzureNative.MongoCluster.FirewallRule("examplefirewallRuleResourceResourceFromMongocluster", new()
{
    MongoClusterName = "string",
    ResourceGroupName = "string",
    FirewallRuleName = "string",
    Properties = new AzureNative.MongoCluster.Inputs.FirewallRulePropertiesArgs
    {
        EndIpAddress = "string",
        StartIpAddress = "string",
    },
});
Copy
example, err := mongocluster.NewFirewallRule(ctx, "examplefirewallRuleResourceResourceFromMongocluster", &mongocluster.FirewallRuleArgs{
	MongoClusterName:  pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	FirewallRuleName:  pulumi.String("string"),
	Properties: &mongocluster.FirewallRulePropertiesArgs{
		EndIpAddress:   pulumi.String("string"),
		StartIpAddress: pulumi.String("string"),
	},
})
Copy
var examplefirewallRuleResourceResourceFromMongocluster = new FirewallRule("examplefirewallRuleResourceResourceFromMongocluster", FirewallRuleArgs.builder()
    .mongoClusterName("string")
    .resourceGroupName("string")
    .firewallRuleName("string")
    .properties(FirewallRulePropertiesArgs.builder()
        .endIpAddress("string")
        .startIpAddress("string")
        .build())
    .build());
Copy
examplefirewall_rule_resource_resource_from_mongocluster = azure_native.mongocluster.FirewallRule("examplefirewallRuleResourceResourceFromMongocluster",
    mongo_cluster_name="string",
    resource_group_name="string",
    firewall_rule_name="string",
    properties={
        "end_ip_address": "string",
        "start_ip_address": "string",
    })
Copy
const examplefirewallRuleResourceResourceFromMongocluster = new azure_native.mongocluster.FirewallRule("examplefirewallRuleResourceResourceFromMongocluster", {
    mongoClusterName: "string",
    resourceGroupName: "string",
    firewallRuleName: "string",
    properties: {
        endIpAddress: "string",
        startIpAddress: "string",
    },
});
Copy
type: azure-native:mongocluster:FirewallRule
properties:
    firewallRuleName: string
    mongoClusterName: string
    properties:
        endIpAddress: string
        startIpAddress: string
    resourceGroupName: string
Copy

FirewallRule Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The FirewallRule resource accepts the following input properties:

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 Changes to this property will trigger replacement. string
The name of the mongo cluster firewall rule.
Properties Pulumi.AzureNative.MongoCluster.Inputs.FirewallRuleProperties
The resource-specific properties for this resource.
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 Changes to this property will trigger replacement. string
The name of the mongo cluster firewall rule.
Properties FirewallRulePropertiesArgs
The resource-specific properties for this resource.
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 Changes to this property will trigger replacement. String
The name of the mongo cluster firewall rule.
properties FirewallRuleProperties
The resource-specific properties for this resource.
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 Changes to this property will trigger replacement. string
The name of the mongo cluster firewall rule.
properties FirewallRuleProperties
The resource-specific properties for this resource.
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.
firewall_rule_name Changes to this property will trigger replacement. str
The name of the mongo cluster firewall rule.
properties FirewallRulePropertiesArgs
The resource-specific properties for this resource.
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 Changes to this property will trigger replacement. String
The name of the mongo cluster firewall rule.
properties Property Map
The resource-specific properties for this resource.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData Pulumi.AzureNative.MongoCluster.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"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
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"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
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"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
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"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
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"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
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

FirewallRuleProperties
, FirewallRulePropertiesArgs

EndIpAddress This property is required. string
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
StartIpAddress This property is required. string
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
EndIpAddress This property is required. string
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
StartIpAddress This property is required. string
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
endIpAddress This property is required. String
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
startIpAddress This property is required. String
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
endIpAddress This property is required. string
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
startIpAddress This property is required. string
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
end_ip_address This property is required. str
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
start_ip_address This property is required. str
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
endIpAddress This property is required. String
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
startIpAddress This property is required. String
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.

FirewallRulePropertiesResponse
, FirewallRulePropertiesResponseArgs

EndIpAddress This property is required. string
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
ProvisioningState This property is required. string
The provisioning state of the firewall rule.
StartIpAddress This property is required. string
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
EndIpAddress This property is required. string
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
ProvisioningState This property is required. string
The provisioning state of the firewall rule.
StartIpAddress This property is required. string
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
endIpAddress This property is required. String
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
provisioningState This property is required. String
The provisioning state of the firewall rule.
startIpAddress This property is required. String
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
endIpAddress This property is required. string
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
provisioningState This property is required. string
The provisioning state of the firewall rule.
startIpAddress This property is required. string
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
end_ip_address This property is required. str
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
provisioning_state This property is required. str
The provisioning state of the firewall rule.
start_ip_address This property is required. str
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
endIpAddress This property is required. String
The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
provisioningState This property is required. String
The provisioning state of the firewall rule.
startIpAddress This property is required. String
The start IP address of the mongo cluster firewall rule. Must be IPv4 format.

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:mongocluster:FirewallRule rule1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}
Copy

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

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