Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. postgresql
  5. VirtualNetworkRule

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.postgresql.VirtualNetworkRule

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a PostgreSQL Virtual Network Rule.

NOTE: PostgreSQL Virtual Network Rules can only be used with SKU Tiers of GeneralPurpose or MemoryOptimized

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
    name: "example-vnet",
    addressSpaces: ["10.7.29.0/29"],
    location: example.location,
    resourceGroupName: example.name,
});
const internal = new azure.network.Subnet("internal", {
    name: "internal",
    resourceGroupName: example.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.7.29.0/29"],
    serviceEndpoints: ["Microsoft.Sql"],
});
const exampleServer = new azure.postgresql.Server("example", {
    name: "postgresql-server-1",
    location: example.location,
    resourceGroupName: example.name,
    skuName: "GP_Gen5_2",
    storageMb: 5120,
    backupRetentionDays: 7,
    administratorLogin: "psqladmin",
    administratorLoginPassword: "H@Sh1CoR3!",
    version: "9.5",
    sslEnforcementEnabled: true,
});
const exampleVirtualNetworkRule = new azure.postgresql.VirtualNetworkRule("example", {
    name: "postgresql-vnet-rule",
    resourceGroupName: example.name,
    serverName: exampleServer.name,
    subnetId: internal.id,
    ignoreMissingVnetServiceEndpoint: true,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("example",
    name="example-vnet",
    address_spaces=["10.7.29.0/29"],
    location=example.location,
    resource_group_name=example.name)
internal = azure.network.Subnet("internal",
    name="internal",
    resource_group_name=example.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.7.29.0/29"],
    service_endpoints=["Microsoft.Sql"])
example_server = azure.postgresql.Server("example",
    name="postgresql-server-1",
    location=example.location,
    resource_group_name=example.name,
    sku_name="GP_Gen5_2",
    storage_mb=5120,
    backup_retention_days=7,
    administrator_login="psqladmin",
    administrator_login_password="H@Sh1CoR3!",
    version="9.5",
    ssl_enforcement_enabled=True)
example_virtual_network_rule = azure.postgresql.VirtualNetworkRule("example",
    name="postgresql-vnet-rule",
    resource_group_name=example.name,
    server_name=example_server.name,
    subnet_id=internal.id,
    ignore_missing_vnet_service_endpoint=True)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/postgresql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
			Name: pulumi.String("example-vnet"),
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.7.29.0/29"),
			},
			Location:          example.Location,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		internal, err := network.NewSubnet(ctx, "internal", &network.SubnetArgs{
			Name:               pulumi.String("internal"),
			ResourceGroupName:  example.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.7.29.0/29"),
			},
			ServiceEndpoints: pulumi.StringArray{
				pulumi.String("Microsoft.Sql"),
			},
		})
		if err != nil {
			return err
		}
		exampleServer, err := postgresql.NewServer(ctx, "example", &postgresql.ServerArgs{
			Name:                       pulumi.String("postgresql-server-1"),
			Location:                   example.Location,
			ResourceGroupName:          example.Name,
			SkuName:                    pulumi.String("GP_Gen5_2"),
			StorageMb:                  pulumi.Int(5120),
			BackupRetentionDays:        pulumi.Int(7),
			AdministratorLogin:         pulumi.String("psqladmin"),
			AdministratorLoginPassword: pulumi.String("H@Sh1CoR3!"),
			Version:                    pulumi.String("9.5"),
			SslEnforcementEnabled:      pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = postgresql.NewVirtualNetworkRule(ctx, "example", &postgresql.VirtualNetworkRuleArgs{
			Name:                             pulumi.String("postgresql-vnet-rule"),
			ResourceGroupName:                example.Name,
			ServerName:                       exampleServer.Name,
			SubnetId:                         internal.ID(),
			IgnoreMissingVnetServiceEndpoint: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
    {
        Name = "example-vnet",
        AddressSpaces = new[]
        {
            "10.7.29.0/29",
        },
        Location = example.Location,
        ResourceGroupName = example.Name,
    });

    var @internal = new Azure.Network.Subnet("internal", new()
    {
        Name = "internal",
        ResourceGroupName = example.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.7.29.0/29",
        },
        ServiceEndpoints = new[]
        {
            "Microsoft.Sql",
        },
    });

    var exampleServer = new Azure.PostgreSql.Server("example", new()
    {
        Name = "postgresql-server-1",
        Location = example.Location,
        ResourceGroupName = example.Name,
        SkuName = "GP_Gen5_2",
        StorageMb = 5120,
        BackupRetentionDays = 7,
        AdministratorLogin = "psqladmin",
        AdministratorLoginPassword = "H@Sh1CoR3!",
        Version = "9.5",
        SslEnforcementEnabled = true,
    });

    var exampleVirtualNetworkRule = new Azure.PostgreSql.VirtualNetworkRule("example", new()
    {
        Name = "postgresql-vnet-rule",
        ResourceGroupName = example.Name,
        ServerName = exampleServer.Name,
        SubnetId = @internal.Id,
        IgnoreMissingVnetServiceEndpoint = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.postgresql.Server;
import com.pulumi.azure.postgresql.ServerArgs;
import com.pulumi.azure.postgresql.VirtualNetworkRule;
import com.pulumi.azure.postgresql.VirtualNetworkRuleArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .name("example-vnet")
            .addressSpaces("10.7.29.0/29")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());

        var internal = new Subnet("internal", SubnetArgs.builder()
            .name("internal")
            .resourceGroupName(example.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.7.29.0/29")
            .serviceEndpoints("Microsoft.Sql")
            .build());

        var exampleServer = new Server("exampleServer", ServerArgs.builder()
            .name("postgresql-server-1")
            .location(example.location())
            .resourceGroupName(example.name())
            .skuName("GP_Gen5_2")
            .storageMb(5120)
            .backupRetentionDays(7)
            .administratorLogin("psqladmin")
            .administratorLoginPassword("H@Sh1CoR3!")
            .version("9.5")
            .sslEnforcementEnabled(true)
            .build());

        var exampleVirtualNetworkRule = new VirtualNetworkRule("exampleVirtualNetworkRule", VirtualNetworkRuleArgs.builder()
            .name("postgresql-vnet-rule")
            .resourceGroupName(example.name())
            .serverName(exampleServer.name())
            .subnetId(internal.id())
            .ignoreMissingVnetServiceEndpoint(true)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: example-vnet
      addressSpaces:
        - 10.7.29.0/29
      location: ${example.location}
      resourceGroupName: ${example.name}
  internal:
    type: azure:network:Subnet
    properties:
      name: internal
      resourceGroupName: ${example.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.7.29.0/29
      serviceEndpoints:
        - Microsoft.Sql
  exampleServer:
    type: azure:postgresql:Server
    name: example
    properties:
      name: postgresql-server-1
      location: ${example.location}
      resourceGroupName: ${example.name}
      skuName: GP_Gen5_2
      storageMb: 5120
      backupRetentionDays: 7
      administratorLogin: psqladmin
      administratorLoginPassword: H@Sh1CoR3!
      version: '9.5'
      sslEnforcementEnabled: true
  exampleVirtualNetworkRule:
    type: azure:postgresql:VirtualNetworkRule
    name: example
    properties:
      name: postgresql-vnet-rule
      resourceGroupName: ${example.name}
      serverName: ${exampleServer.name}
      subnetId: ${internal.id}
      ignoreMissingVnetServiceEndpoint: true
Copy

Create VirtualNetworkRule Resource

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

Constructor syntax

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

@overload
def VirtualNetworkRule(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       resource_group_name: Optional[str] = None,
                       server_name: Optional[str] = None,
                       subnet_id: Optional[str] = None,
                       ignore_missing_vnet_service_endpoint: Optional[bool] = None,
                       name: Optional[str] = None)
func NewVirtualNetworkRule(ctx *Context, name string, args VirtualNetworkRuleArgs, opts ...ResourceOption) (*VirtualNetworkRule, error)
public VirtualNetworkRule(string name, VirtualNetworkRuleArgs args, CustomResourceOptions? opts = null)
public VirtualNetworkRule(String name, VirtualNetworkRuleArgs args)
public VirtualNetworkRule(String name, VirtualNetworkRuleArgs args, CustomResourceOptions options)

type: azure:postgresql:VirtualNetworkRule
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. VirtualNetworkRuleArgs
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. VirtualNetworkRuleArgs
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. VirtualNetworkRuleArgs
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. VirtualNetworkRuleArgs
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. VirtualNetworkRuleArgs
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 azureVirtualNetworkRuleResource = new Azure.PostgreSql.VirtualNetworkRule("azureVirtualNetworkRuleResource", new()
{
    ResourceGroupName = "string",
    ServerName = "string",
    SubnetId = "string",
    IgnoreMissingVnetServiceEndpoint = false,
    Name = "string",
});
Copy
example, err := postgresql.NewVirtualNetworkRule(ctx, "azureVirtualNetworkRuleResource", &postgresql.VirtualNetworkRuleArgs{
	ResourceGroupName:                pulumi.String("string"),
	ServerName:                       pulumi.String("string"),
	SubnetId:                         pulumi.String("string"),
	IgnoreMissingVnetServiceEndpoint: pulumi.Bool(false),
	Name:                             pulumi.String("string"),
})
Copy
var azureVirtualNetworkRuleResource = new VirtualNetworkRule("azureVirtualNetworkRuleResource", VirtualNetworkRuleArgs.builder()
    .resourceGroupName("string")
    .serverName("string")
    .subnetId("string")
    .ignoreMissingVnetServiceEndpoint(false)
    .name("string")
    .build());
Copy
azure_virtual_network_rule_resource = azure.postgresql.VirtualNetworkRule("azureVirtualNetworkRuleResource",
    resource_group_name="string",
    server_name="string",
    subnet_id="string",
    ignore_missing_vnet_service_endpoint=False,
    name="string")
Copy
const azureVirtualNetworkRuleResource = new azure.postgresql.VirtualNetworkRule("azureVirtualNetworkRuleResource", {
    resourceGroupName: "string",
    serverName: "string",
    subnetId: "string",
    ignoreMissingVnetServiceEndpoint: false,
    name: "string",
});
Copy
type: azure:postgresql:VirtualNetworkRule
properties:
    ignoreMissingVnetServiceEndpoint: false
    name: string
    resourceGroupName: string
    serverName: string
    subnetId: string
Copy

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

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
SubnetId This property is required. string
The ID of the subnet that the PostgreSQL server will be connected to.
IgnoreMissingVnetServiceEndpoint bool
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
Name Changes to this property will trigger replacement. string

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
SubnetId This property is required. string
The ID of the subnet that the PostgreSQL server will be connected to.
IgnoreMissingVnetServiceEndpoint bool
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
Name Changes to this property will trigger replacement. string

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
subnetId This property is required. String
The ID of the subnet that the PostgreSQL server will be connected to.
ignoreMissingVnetServiceEndpoint Boolean
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
name Changes to this property will trigger replacement. String

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
subnetId This property is required. string
The ID of the subnet that the PostgreSQL server will be connected to.
ignoreMissingVnetServiceEndpoint boolean
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
name Changes to this property will trigger replacement. string

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
subnet_id This property is required. str
The ID of the subnet that the PostgreSQL server will be connected to.
ignore_missing_vnet_service_endpoint bool
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
name Changes to this property will trigger replacement. str

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
subnetId This property is required. String
The ID of the subnet that the PostgreSQL server will be connected to.
ignoreMissingVnetServiceEndpoint Boolean
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
name Changes to this property will trigger replacement. String

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing VirtualNetworkRule Resource

Get an existing VirtualNetworkRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VirtualNetworkRuleState, opts?: CustomResourceOptions): VirtualNetworkRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ignore_missing_vnet_service_endpoint: Optional[bool] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        server_name: Optional[str] = None,
        subnet_id: Optional[str] = None) -> VirtualNetworkRule
func GetVirtualNetworkRule(ctx *Context, name string, id IDInput, state *VirtualNetworkRuleState, opts ...ResourceOption) (*VirtualNetworkRule, error)
public static VirtualNetworkRule Get(string name, Input<string> id, VirtualNetworkRuleState? state, CustomResourceOptions? opts = null)
public static VirtualNetworkRule get(String name, Output<String> id, VirtualNetworkRuleState state, CustomResourceOptions options)
resources:  _:    type: azure:postgresql:VirtualNetworkRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
IgnoreMissingVnetServiceEndpoint bool
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
Name Changes to this property will trigger replacement. string

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
ServerName Changes to this property will trigger replacement. string
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
SubnetId string
The ID of the subnet that the PostgreSQL server will be connected to.
IgnoreMissingVnetServiceEndpoint bool
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
Name Changes to this property will trigger replacement. string

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
ServerName Changes to this property will trigger replacement. string
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
SubnetId string
The ID of the subnet that the PostgreSQL server will be connected to.
ignoreMissingVnetServiceEndpoint Boolean
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
name Changes to this property will trigger replacement. String

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
serverName Changes to this property will trigger replacement. String
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
subnetId String
The ID of the subnet that the PostgreSQL server will be connected to.
ignoreMissingVnetServiceEndpoint boolean
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
name Changes to this property will trigger replacement. string

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
serverName Changes to this property will trigger replacement. string
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
subnetId string
The ID of the subnet that the PostgreSQL server will be connected to.
ignore_missing_vnet_service_endpoint bool
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
name Changes to this property will trigger replacement. str

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
server_name Changes to this property will trigger replacement. str
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
subnet_id str
The ID of the subnet that the PostgreSQL server will be connected to.
ignoreMissingVnetServiceEndpoint Boolean
Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled?
name Changes to this property will trigger replacement. String

The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

NOTE: name must be between 1-128 characters long and must satisfy all of the requirements below:

  1. Contains only alphanumeric and hyphen characters
  2. Cannot start with a number or hyphen
  3. Cannot end with a hyphen
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group where the PostgreSQL server resides. Changing this forces a new resource to be created.
serverName Changes to this property will trigger replacement. String
The name of the SQL Server to which this PostgreSQL virtual network rule will be applied to. Changing this forces a new resource to be created.
subnetId String
The ID of the subnet that the PostgreSQL server will be connected to.

Import

PostgreSQL Virtual Network Rules can be imported using the resource id, e.g.

$ pulumi import azure:postgresql/virtualNetworkRule:VirtualNetworkRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.DBforPostgreSQL/servers/myserver/virtualNetworkRules/vnetrulename
Copy

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure