1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. MongoClusterFirewallRule
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.42.1 published on Wednesday, May 22, 2024 by Pulumi

azure-native.documentdb.MongoClusterFirewallRule

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.42.1 published on Wednesday, May 22, 2024 by Pulumi

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

    Example Usage

    Create a firewall rule of the mongo cluster

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var mongoClusterFirewallRule = new AzureNative.DocumentDB.MongoClusterFirewallRule("mongoClusterFirewallRule", new()
        {
            EndIpAddress = "255.255.255.255",
            FirewallRuleName = "rule1",
            MongoClusterName = "myMongoCluster",
            ResourceGroupName = "TestGroup",
            StartIpAddress = "0.0.0.0",
        });
    
    });
    
    package main
    
    import (
    	"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.NewMongoClusterFirewallRule(ctx, "mongoClusterFirewallRule", &documentdb.MongoClusterFirewallRuleArgs{
    			EndIpAddress:      pulumi.String("255.255.255.255"),
    			FirewallRuleName:  pulumi.String("rule1"),
    			MongoClusterName:  pulumi.String("myMongoCluster"),
    			ResourceGroupName: pulumi.String("TestGroup"),
    			StartIpAddress:    pulumi.String("0.0.0.0"),
    		})
    		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.MongoClusterFirewallRule;
    import com.pulumi.azurenative.documentdb.MongoClusterFirewallRuleArgs;
    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 mongoClusterFirewallRule = new MongoClusterFirewallRule("mongoClusterFirewallRule", MongoClusterFirewallRuleArgs.builder()
                .endIpAddress("255.255.255.255")
                .firewallRuleName("rule1")
                .mongoClusterName("myMongoCluster")
                .resourceGroupName("TestGroup")
                .startIpAddress("0.0.0.0")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    mongo_cluster_firewall_rule = azure_native.documentdb.MongoClusterFirewallRule("mongoClusterFirewallRule",
        end_ip_address="255.255.255.255",
        firewall_rule_name="rule1",
        mongo_cluster_name="myMongoCluster",
        resource_group_name="TestGroup",
        start_ip_address="0.0.0.0")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const mongoClusterFirewallRule = new azure_native.documentdb.MongoClusterFirewallRule("mongoClusterFirewallRule", {
        endIpAddress: "255.255.255.255",
        firewallRuleName: "rule1",
        mongoClusterName: "myMongoCluster",
        resourceGroupName: "TestGroup",
        startIpAddress: "0.0.0.0",
    });
    
    resources:
      mongoClusterFirewallRule:
        type: azure-native:documentdb:MongoClusterFirewallRule
        properties:
          endIpAddress: 255.255.255.255
          firewallRuleName: rule1
          mongoClusterName: myMongoCluster
          resourceGroupName: TestGroup
          startIpAddress: 0.0.0.0
    

    Create MongoClusterFirewallRule Resource

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

    Constructor syntax

    new MongoClusterFirewallRule(name: string, args: MongoClusterFirewallRuleArgs, opts?: CustomResourceOptions);
    @overload
    def MongoClusterFirewallRule(resource_name: str,
                                 args: MongoClusterFirewallRuleArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def MongoClusterFirewallRule(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 end_ip_address: Optional[str] = None,
                                 mongo_cluster_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 start_ip_address: Optional[str] = None,
                                 firewall_rule_name: Optional[str] = None)
    func NewMongoClusterFirewallRule(ctx *Context, name string, args MongoClusterFirewallRuleArgs, opts ...ResourceOption) (*MongoClusterFirewallRule, error)
    public MongoClusterFirewallRule(string name, MongoClusterFirewallRuleArgs args, CustomResourceOptions? opts = null)
    public MongoClusterFirewallRule(String name, MongoClusterFirewallRuleArgs args)
    public MongoClusterFirewallRule(String name, MongoClusterFirewallRuleArgs args, CustomResourceOptions options)
    
    type: azure-native:documentdb:MongoClusterFirewallRule
    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 MongoClusterFirewallRuleArgs
    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 MongoClusterFirewallRuleArgs
    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 MongoClusterFirewallRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MongoClusterFirewallRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MongoClusterFirewallRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var mongoClusterFirewallRuleResource = new AzureNative.DocumentDB.MongoClusterFirewallRule("mongoClusterFirewallRuleResource", new()
    {
        EndIpAddress = "string",
        MongoClusterName = "string",
        ResourceGroupName = "string",
        StartIpAddress = "string",
        FirewallRuleName = "string",
    });
    
    example, err := documentdb.NewMongoClusterFirewallRule(ctx, "mongoClusterFirewallRuleResource", &documentdb.MongoClusterFirewallRuleArgs{
    EndIpAddress: pulumi.String("string"),
    MongoClusterName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    StartIpAddress: pulumi.String("string"),
    FirewallRuleName: pulumi.String("string"),
    })
    
    var mongoClusterFirewallRuleResource = new MongoClusterFirewallRule("mongoClusterFirewallRuleResource", MongoClusterFirewallRuleArgs.builder()        
        .endIpAddress("string")
        .mongoClusterName("string")
        .resourceGroupName("string")
        .startIpAddress("string")
        .firewallRuleName("string")
        .build());
    
    mongo_cluster_firewall_rule_resource = azure_native.documentdb.MongoClusterFirewallRule("mongoClusterFirewallRuleResource",
        end_ip_address="string",
        mongo_cluster_name="string",
        resource_group_name="string",
        start_ip_address="string",
        firewall_rule_name="string")
    
    const mongoClusterFirewallRuleResource = new azure_native.documentdb.MongoClusterFirewallRule("mongoClusterFirewallRuleResource", {
        endIpAddress: "string",
        mongoClusterName: "string",
        resourceGroupName: "string",
        startIpAddress: "string",
        firewallRuleName: "string",
    });
    
    type: azure-native:documentdb:MongoClusterFirewallRule
    properties:
        endIpAddress: string
        firewallRuleName: string
        mongoClusterName: string
        resourceGroupName: string
        startIpAddress: string
    

    MongoClusterFirewallRule Resource Properties

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

    Inputs

    The MongoClusterFirewallRule resource accepts the following input properties:

    EndIpAddress string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    MongoClusterName string
    The name of the mongo cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    StartIpAddress string
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    FirewallRuleName string
    The name of the mongo cluster firewall rule.
    EndIpAddress string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    MongoClusterName string
    The name of the mongo cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    StartIpAddress string
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    FirewallRuleName string
    The name of the mongo cluster firewall rule.
    endIpAddress String
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    mongoClusterName String
    The name of the mongo cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    startIpAddress String
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    firewallRuleName String
    The name of the mongo cluster firewall rule.
    endIpAddress string
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    mongoClusterName string
    The name of the mongo cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    startIpAddress string
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    firewallRuleName string
    The name of the mongo cluster firewall rule.
    end_ip_address str
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    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.
    start_ip_address str
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    firewall_rule_name str
    The name of the mongo cluster firewall rule.
    endIpAddress String
    The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
    mongoClusterName String
    The name of the mongo cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    startIpAddress String
    The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
    firewallRuleName String
    The name of the mongo cluster firewall rule.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the firewall rule.
    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
    ProvisioningState string
    The provisioning state of the firewall rule.
    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
    provisioningState String
    The provisioning state of the firewall rule.
    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
    provisioningState string
    The provisioning state of the firewall rule.
    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
    provisioning_state str
    The provisioning state of the firewall rule.
    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
    provisioningState String
    The provisioning state of the firewall rule.
    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, 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:MongoClusterFirewallRule 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.42.1 published on Wednesday, May 22, 2024 by Pulumi