Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. dbforpostgresql
  5. ServerGroupFirewallRule
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.dbforpostgresql.ServerGroupFirewallRule

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 cluster firewall rule.

Uses Azure REST API version 2023-03-02-preview.

Other available API versions: 2022-11-08. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native dbforpostgresql [ApiVersion]. See the version guide for details.

Example Usage

Create a firewall rule of the cluster

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

return await Deployment.RunAsync(() => 
{
    var serverGroupFirewallRule = new AzureNative.DBforPostgreSQL.ServerGroupFirewallRule("serverGroupFirewallRule", new()
    {
        ClusterName = "pgtestsvc4",
        EndIpAddress = "255.255.255.255",
        FirewallRuleName = "rule1",
        ResourceGroupName = "TestGroup",
        StartIpAddress = "0.0.0.0",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dbforpostgresql.NewServerGroupFirewallRule(ctx, "serverGroupFirewallRule", &dbforpostgresql.ServerGroupFirewallRuleArgs{
			ClusterName:       pulumi.String("pgtestsvc4"),
			EndIpAddress:      pulumi.String("255.255.255.255"),
			FirewallRuleName:  pulumi.String("rule1"),
			ResourceGroupName: pulumi.String("TestGroup"),
			StartIpAddress:    pulumi.String("0.0.0.0"),
		})
		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.dbforpostgresql.ServerGroupFirewallRule;
import com.pulumi.azurenative.dbforpostgresql.ServerGroupFirewallRuleArgs;
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 serverGroupFirewallRule = new ServerGroupFirewallRule("serverGroupFirewallRule", ServerGroupFirewallRuleArgs.builder()
            .clusterName("pgtestsvc4")
            .endIpAddress("255.255.255.255")
            .firewallRuleName("rule1")
            .resourceGroupName("TestGroup")
            .startIpAddress("0.0.0.0")
            .build());

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

const serverGroupFirewallRule = new azure_native.dbforpostgresql.ServerGroupFirewallRule("serverGroupFirewallRule", {
    clusterName: "pgtestsvc4",
    endIpAddress: "255.255.255.255",
    firewallRuleName: "rule1",
    resourceGroupName: "TestGroup",
    startIpAddress: "0.0.0.0",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

server_group_firewall_rule = azure_native.dbforpostgresql.ServerGroupFirewallRule("serverGroupFirewallRule",
    cluster_name="pgtestsvc4",
    end_ip_address="255.255.255.255",
    firewall_rule_name="rule1",
    resource_group_name="TestGroup",
    start_ip_address="0.0.0.0")
Copy
resources:
  serverGroupFirewallRule:
    type: azure-native:dbforpostgresql:ServerGroupFirewallRule
    properties:
      clusterName: pgtestsvc4
      endIpAddress: 255.255.255.255
      firewallRuleName: rule1
      resourceGroupName: TestGroup
      startIpAddress: 0.0.0.0
Copy

Create ServerGroupFirewallRule Resource

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

Constructor syntax

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

@overload
def ServerGroupFirewallRule(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            cluster_name: Optional[str] = None,
                            end_ip_address: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            start_ip_address: Optional[str] = None,
                            firewall_rule_name: Optional[str] = None)
func NewServerGroupFirewallRule(ctx *Context, name string, args ServerGroupFirewallRuleArgs, opts ...ResourceOption) (*ServerGroupFirewallRule, error)
public ServerGroupFirewallRule(string name, ServerGroupFirewallRuleArgs args, CustomResourceOptions? opts = null)
public ServerGroupFirewallRule(String name, ServerGroupFirewallRuleArgs args)
public ServerGroupFirewallRule(String name, ServerGroupFirewallRuleArgs args, CustomResourceOptions options)

type: azure-native:dbforpostgresql:ServerGroupFirewallRule
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. ServerGroupFirewallRuleArgs
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. ServerGroupFirewallRuleArgs
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. ServerGroupFirewallRuleArgs
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. ServerGroupFirewallRuleArgs
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. ServerGroupFirewallRuleArgs
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 serverGroupFirewallRuleResource = new AzureNative.DBforPostgreSQL.ServerGroupFirewallRule("serverGroupFirewallRuleResource", new()
{
    ClusterName = "string",
    EndIpAddress = "string",
    ResourceGroupName = "string",
    StartIpAddress = "string",
    FirewallRuleName = "string",
});
Copy
example, err := dbforpostgresql.NewServerGroupFirewallRule(ctx, "serverGroupFirewallRuleResource", &dbforpostgresql.ServerGroupFirewallRuleArgs{
	ClusterName:       pulumi.String("string"),
	EndIpAddress:      pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	StartIpAddress:    pulumi.String("string"),
	FirewallRuleName:  pulumi.String("string"),
})
Copy
var serverGroupFirewallRuleResource = new ServerGroupFirewallRule("serverGroupFirewallRuleResource", ServerGroupFirewallRuleArgs.builder()
    .clusterName("string")
    .endIpAddress("string")
    .resourceGroupName("string")
    .startIpAddress("string")
    .firewallRuleName("string")
    .build());
Copy
server_group_firewall_rule_resource = azure_native.dbforpostgresql.ServerGroupFirewallRule("serverGroupFirewallRuleResource",
    cluster_name="string",
    end_ip_address="string",
    resource_group_name="string",
    start_ip_address="string",
    firewall_rule_name="string")
Copy
const serverGroupFirewallRuleResource = new azure_native.dbforpostgresql.ServerGroupFirewallRule("serverGroupFirewallRuleResource", {
    clusterName: "string",
    endIpAddress: "string",
    resourceGroupName: "string",
    startIpAddress: "string",
    firewallRuleName: "string",
});
Copy
type: azure-native:dbforpostgresql:ServerGroupFirewallRule
properties:
    clusterName: string
    endIpAddress: string
    firewallRuleName: string
    resourceGroupName: string
    startIpAddress: string
Copy

ServerGroupFirewallRule 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 ServerGroupFirewallRule resource accepts the following input properties:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
EndIpAddress This property is required. string
The end IP address of the cluster firewall rule. Must be IPv4 format.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StartIpAddress This property is required. string
The start IP address of the cluster firewall rule. Must be IPv4 format.
FirewallRuleName Changes to this property will trigger replacement. string
The name of the cluster firewall rule.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
EndIpAddress This property is required. string
The end IP address of the cluster firewall rule. Must be IPv4 format.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StartIpAddress This property is required. string
The start IP address of the cluster firewall rule. Must be IPv4 format.
FirewallRuleName Changes to this property will trigger replacement. string
The name of the cluster firewall rule.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
endIpAddress This property is required. String
The end IP address of the cluster firewall rule. Must be IPv4 format.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
startIpAddress This property is required. String
The start IP address of the cluster firewall rule. Must be IPv4 format.
firewallRuleName Changes to this property will trigger replacement. String
The name of the cluster firewall rule.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
endIpAddress This property is required. string
The end IP address of the cluster firewall rule. Must be IPv4 format.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
startIpAddress This property is required. string
The start IP address of the cluster firewall rule. Must be IPv4 format.
firewallRuleName Changes to this property will trigger replacement. string
The name of the cluster firewall rule.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cluster.
end_ip_address This property is required. str
The end IP address of the cluster firewall rule. Must be IPv4 format.
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.
start_ip_address This property is required. str
The start IP address of the cluster firewall rule. Must be IPv4 format.
firewall_rule_name Changes to this property will trigger replacement. str
The name of the cluster firewall rule.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
endIpAddress This property is required. String
The end IP address of the cluster firewall rule. Must be IPv4 format.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
startIpAddress This property is required. String
The start IP address of the cluster firewall rule. Must be IPv4 format.
firewallRuleName Changes to this property will trigger replacement. String
The name of the cluster firewall rule.

Outputs

All input properties are implicitly available as output properties. Additionally, the ServerGroupFirewallRule 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
ProvisioningState string
Provisioning state of the firewall rule.
SystemData Pulumi.AzureNative.DBforPostgreSQL.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
ProvisioningState string
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"
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
provisioningState String
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"
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
provisioningState string
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"
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
provisioning_state str
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"
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
provisioningState String
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:dbforpostgresql:ServerGroupFirewallRule rule1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/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