Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. FirewallRule
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.documentdb.FirewallRule

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Represents a mongo cluster firewall rule. Azure REST API version: 2024-03-01-preview.

    Other available API versions: 2024-06-01-preview, 2024-07-01.

    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.DocumentDB.FirewallRule("firewallRule", new()
    {
        FirewallRuleName = "rule1",
        MongoClusterName = "myMongoCluster",
        Properties = new AzureNative.DocumentDB.Inputs.FirewallRulePropertiesArgs
        {
            EndIpAddress = "255.255.255.255",
            StartIpAddress = "0.0.0.0",
        },
        ResourceGroupName = "TestGroup",
    });

});

    package main

import (
	documentdb "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.NewFirewallRule(ctx, "firewallRule", &documentdb.FirewallRuleArgs{
			FirewallRuleName: pulumi.String("rule1"),
			MongoClusterName: pulumi.String("myMongoCluster"),
			Properties: &documentdb.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
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.FirewallRule;
import com.pulumi.azurenative.documentdb.FirewallRuleArgs;
import com.pulumi.azurenative.documentdb.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());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

firewall_rule = azure_native.documentdb.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")

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

const firewallRule = new azure_native.documentdb.FirewallRule("firewallRule", {
    firewallRuleName: "rule1",
    mongoClusterName: "myMongoCluster",
    properties: {
        endIpAddress: "255.255.255.255",
        startIpAddress: "0.0.0.0",
    },
    resourceGroupName: "TestGroup",
});

    resources:
  firewallRule:
    type: azure-native:documentdb:FirewallRule
    properties:
      firewallRuleName: rule1
      mongoClusterName: myMongoCluster
      properties:
        endIpAddress: 255.255.255.255
        startIpAddress: 0.0.0.0
      resourceGroupName: TestGroup

    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:documentdb:FirewallRule
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 FirewallRuleArgs
    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 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 string
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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 examplefirewallRuleResourceResourceFromDocumentdb = new AzureNative.DocumentDB.FirewallRule("examplefirewallRuleResourceResourceFromDocumentdb", new()
{
    MongoClusterName = "string",
    ResourceGroupName = "string",
    FirewallRuleName = "string",
    Properties = new AzureNative.DocumentDB.Inputs.FirewallRulePropertiesArgs
    {
        EndIpAddress = "string",
        StartIpAddress = "string",
    },
});

    example, err := documentdb.NewFirewallRule(ctx, "examplefirewallRuleResourceResourceFromDocumentdb", &documentdb.FirewallRuleArgs{
	MongoClusterName:  pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	FirewallRuleName:  pulumi.String("string"),
	Properties: &documentdb.FirewallRulePropertiesArgs{
		EndIpAddress:   pulumi.String("string"),
		StartIpAddress: pulumi.String("string"),
	},
})

    var examplefirewallRuleResourceResourceFromDocumentdb = new FirewallRule("examplefirewallRuleResourceResourceFromDocumentdb", FirewallRuleArgs.builder()
    .mongoClusterName("string")
    .resourceGroupName("string")
    .firewallRuleName("string")
    .properties(FirewallRulePropertiesArgs.builder()
        .endIpAddress("string")
        .startIpAddress("string")
        .build())
    .build());

    examplefirewall_rule_resource_resource_from_documentdb = azure_native.documentdb.FirewallRule("examplefirewallRuleResourceResourceFromDocumentdb",
    mongo_cluster_name="string",
    resource_group_name="string",
    firewall_rule_name="string",
    properties={
        "end_ip_address": "string",
        "start_ip_address": "string",
    })

    const examplefirewallRuleResourceResourceFromDocumentdb = new azure_native.documentdb.FirewallRule("examplefirewallRuleResourceResourceFromDocumentdb", {
    mongoClusterName: "string",
    resourceGroupName: "string",
    firewallRuleName: "string",
    properties: {
        endIpAddress: "string",
        startIpAddress: "string",
    },
});

    type: azure-native:documentdb:FirewallRule
properties:
    firewallRuleName: string
    mongoClusterName: string
    properties:
        endIpAddress: string
        startIpAddress: string
    resourceGroupName: string

    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 string
    The name of the mongo cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    FirewallRuleName string
    The name of the mongo cluster firewall rule.
    Properties Pulumi.AzureNative.DocumentDB.Inputs.FirewallRuleProperties
    The resource-specific properties for this resource.
    MongoClusterName string
    The name of the mongo cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    FirewallRuleName string
    The name of the mongo cluster firewall rule.
    Properties FirewallRulePropertiesArgs
    The resource-specific properties for this resource.
    mongoClusterName String
    The name of the mongo cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    firewallRuleName String
    The name of the mongo cluster firewall rule.
    properties FirewallRuleProperties
    The resource-specific properties for this resource.
    mongoClusterName string
    The name of the mongo cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    firewallRuleName string
    The name of the mongo cluster firewall rule.
    properties FirewallRuleProperties
    The resource-specific properties for this resource.
    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.
    firewall_rule_name str
    The name of the mongo cluster firewall rule.
    properties FirewallRulePropertiesArgs
    The resource-specific properties for this resource.
    mongoClusterName String
    The name of the mongo cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    firewallRuleName 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:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    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"
    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"
    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"
    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"
    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"
    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 string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    StartIpAddress string
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    EndIpAddress string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    StartIpAddress string
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    endIpAddress String
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    startIpAddress String
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    endIpAddress string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    startIpAddress string
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    end_ip_address str
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    start_ip_address str
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    endIpAddress String
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    startIpAddress String
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.

    FirewallRulePropertiesResponse, FirewallRulePropertiesResponseArgs

    EndIpAddress string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    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.
    EndIpAddress string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    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.
    endIpAddress String
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    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.
    endIpAddress string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    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.
    end_ip_address str
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    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.
    endIpAddress String
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    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.

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

    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native