MongoClusterFirewallRuleArgs

data class MongoClusterFirewallRuleArgs(val endIpAddress: Output<String>? = null, val firewallRuleName: Output<String>? = null, val mongoClusterName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val startIpAddress: Output<String>? = null) : ConvertibleToJava<MongoClusterFirewallRuleArgs>

Represents a mongo cluster firewall rule. Uses Azure REST API version 2024-02-15-preview. Other available API versions: 2023-03-01-preview, 2023-03-15-preview, 2023-09-15-preview, 2023-11-15-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

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.CosmosDB.MongoClusterFirewallRule("mongoClusterFirewallRule", new()
{
EndIpAddress = "255.255.255.255",
FirewallRuleName = "rule1",
MongoClusterName = "myMongoCluster",
ResourceGroupName = "TestGroup",
StartIpAddress = "0.0.0.0",
});
});
package main
import (
cosmosdb "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cosmosdb.NewMongoClusterFirewallRule(ctx, "mongoClusterFirewallRule", &cosmosdb.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.cosmosdb.MongoClusterFirewallRule;
import com.pulumi.azurenative.cosmosdb.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

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:cosmosdb:MongoClusterFirewallRule rule1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/firewallRules/{firewallRuleName}

Constructors

Link copied to clipboard
constructor(endIpAddress: Output<String>? = null, firewallRuleName: Output<String>? = null, mongoClusterName: Output<String>? = null, resourceGroupName: Output<String>? = null, startIpAddress: Output<String>? = null)

Properties

Link copied to clipboard
val endIpAddress: Output<String>? = null

The end IP address of the mongo cluster firewall rule. Must be IPv4 format.

Link copied to clipboard
val firewallRuleName: Output<String>? = null

The name of the mongo cluster firewall rule.

Link copied to clipboard
val mongoClusterName: Output<String>? = null

The name of the mongo cluster.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val startIpAddress: Output<String>? = null

The start IP address of the mongo cluster firewall rule. Must be IPv4 format.

Functions

Link copied to clipboard
open override fun toJava(): MongoClusterFirewallRuleArgs