Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. dbforpostgresql
  5. VirtualEndpoint
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.dbforpostgresql.VirtualEndpoint

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Represents a virtual endpoint for a server. Azure REST API version: 2023-06-01-preview.

Other available API versions: 2023-12-01-preview, 2024-03-01-preview, 2024-08-01, 2024-11-01-preview.

Example Usage

Create a new virtual endpoint for a flexible server

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

return await Deployment.RunAsync(() => 
{
    var virtualEndpoint = new AzureNative.DBforPostgreSQL.VirtualEndpoint("virtualEndpoint", new()
    {
        EndpointType = AzureNative.DBforPostgreSQL.VirtualEndpointType.ReadWrite,
        Members = new[]
        {
            "testPrimary1",
        },
        ResourceGroupName = "testrg",
        ServerName = "pgtestsvc4",
        VirtualEndpointName = "pgVirtualEndpoint1",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dbforpostgresql.NewVirtualEndpoint(ctx, "virtualEndpoint", &dbforpostgresql.VirtualEndpointArgs{
			EndpointType: pulumi.String(dbforpostgresql.VirtualEndpointTypeReadWrite),
			Members: pulumi.StringArray{
				pulumi.String("testPrimary1"),
			},
			ResourceGroupName:   pulumi.String("testrg"),
			ServerName:          pulumi.String("pgtestsvc4"),
			VirtualEndpointName: pulumi.String("pgVirtualEndpoint1"),
		})
		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.VirtualEndpoint;
import com.pulumi.azurenative.dbforpostgresql.VirtualEndpointArgs;
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 virtualEndpoint = new VirtualEndpoint("virtualEndpoint", VirtualEndpointArgs.builder()
            .endpointType("ReadWrite")
            .members("testPrimary1")
            .resourceGroupName("testrg")
            .serverName("pgtestsvc4")
            .virtualEndpointName("pgVirtualEndpoint1")
            .build());

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

const virtualEndpoint = new azure_native.dbforpostgresql.VirtualEndpoint("virtualEndpoint", {
    endpointType: azure_native.dbforpostgresql.VirtualEndpointType.ReadWrite,
    members: ["testPrimary1"],
    resourceGroupName: "testrg",
    serverName: "pgtestsvc4",
    virtualEndpointName: "pgVirtualEndpoint1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

virtual_endpoint = azure_native.dbforpostgresql.VirtualEndpoint("virtualEndpoint",
    endpoint_type=azure_native.dbforpostgresql.VirtualEndpointType.READ_WRITE,
    members=["testPrimary1"],
    resource_group_name="testrg",
    server_name="pgtestsvc4",
    virtual_endpoint_name="pgVirtualEndpoint1")
Copy
resources:
  virtualEndpoint:
    type: azure-native:dbforpostgresql:VirtualEndpoint
    properties:
      endpointType: ReadWrite
      members:
        - testPrimary1
      resourceGroupName: testrg
      serverName: pgtestsvc4
      virtualEndpointName: pgVirtualEndpoint1
Copy

Create VirtualEndpoint Resource

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

Constructor syntax

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

@overload
def VirtualEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    resource_group_name: Optional[str] = None,
                    server_name: Optional[str] = None,
                    endpoint_type: Optional[Union[str, VirtualEndpointType]] = None,
                    members: Optional[Sequence[str]] = None,
                    virtual_endpoint_name: Optional[str] = None)
func NewVirtualEndpoint(ctx *Context, name string, args VirtualEndpointArgs, opts ...ResourceOption) (*VirtualEndpoint, error)
public VirtualEndpoint(string name, VirtualEndpointArgs args, CustomResourceOptions? opts = null)
public VirtualEndpoint(String name, VirtualEndpointArgs args)
public VirtualEndpoint(String name, VirtualEndpointArgs args, CustomResourceOptions options)

type: azure-native:dbforpostgresql:VirtualEndpoint
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. VirtualEndpointArgs
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. VirtualEndpointArgs
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. VirtualEndpointArgs
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. VirtualEndpointArgs
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. VirtualEndpointArgs
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 virtualEndpointResource = new AzureNative.Dbforpostgresql.VirtualEndpoint("virtualEndpointResource", new()
{
    ResourceGroupName = "string",
    ServerName = "string",
    EndpointType = "string",
    Members = new[]
    {
        "string",
    },
    VirtualEndpointName = "string",
});
Copy
example, err := dbforpostgresql.NewVirtualEndpoint(ctx, "virtualEndpointResource", &dbforpostgresql.VirtualEndpointArgs{
	ResourceGroupName: "string",
	ServerName:        "string",
	EndpointType:      "string",
	Members: []string{
		"string",
	},
	VirtualEndpointName: "string",
})
Copy
var virtualEndpointResource = new VirtualEndpoint("virtualEndpointResource", VirtualEndpointArgs.builder()
    .resourceGroupName("string")
    .serverName("string")
    .endpointType("string")
    .members("string")
    .virtualEndpointName("string")
    .build());
Copy
virtual_endpoint_resource = azure_native.dbforpostgresql.VirtualEndpoint("virtualEndpointResource",
    resource_group_name=string,
    server_name=string,
    endpoint_type=string,
    members=[string],
    virtual_endpoint_name=string)
Copy
const virtualEndpointResource = new azure_native.dbforpostgresql.VirtualEndpoint("virtualEndpointResource", {
    resourceGroupName: "string",
    serverName: "string",
    endpointType: "string",
    members: ["string"],
    virtualEndpointName: "string",
});
Copy
type: azure-native:dbforpostgresql:VirtualEndpoint
properties:
    endpointType: string
    members:
        - string
    resourceGroupName: string
    serverName: string
    virtualEndpointName: string
Copy

VirtualEndpoint 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 VirtualEndpoint 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. The name is case insensitive.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
EndpointType string | Pulumi.AzureNative.DBforPostgreSQL.VirtualEndpointType
The endpoint type for the virtual endpoint.
Members List<string>
List of members for a virtual endpoint
VirtualEndpointName Changes to this property will trigger replacement. string
The name of the virtual endpoint.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
EndpointType string | VirtualEndpointType
The endpoint type for the virtual endpoint.
Members []string
List of members for a virtual endpoint
VirtualEndpointName Changes to this property will trigger replacement. string
The name of the virtual endpoint.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
endpointType String | VirtualEndpointType
The endpoint type for the virtual endpoint.
members List<String>
List of members for a virtual endpoint
virtualEndpointName Changes to this property will trigger replacement. String
The name of the virtual endpoint.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
endpointType string | VirtualEndpointType
The endpoint type for the virtual endpoint.
members string[]
List of members for a virtual endpoint
virtualEndpointName Changes to this property will trigger replacement. string
The name of the virtual endpoint.
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.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
endpoint_type str | VirtualEndpointType
The endpoint type for the virtual endpoint.
members Sequence[str]
List of members for a virtual endpoint
virtual_endpoint_name Changes to this property will trigger replacement. str
The name of the virtual endpoint.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
endpointType String | "ReadWrite"
The endpoint type for the virtual endpoint.
members List<String>
List of members for a virtual endpoint
virtualEndpointName Changes to this property will trigger replacement. String
The name of the virtual endpoint.

Outputs

All input properties are implicitly available as output properties. Additionally, the VirtualEndpoint 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.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"
VirtualEndpoints List<string>
List of virtual endpoints for a server
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"
VirtualEndpoints []string
List of virtual endpoints for a server
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"
virtualEndpoints List<String>
List of virtual endpoints for a server
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"
virtualEndpoints string[]
List of virtual endpoints for a server
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"
virtual_endpoints Sequence[str]
List of virtual endpoints for a server
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"
virtualEndpoints List<String>
List of virtual endpoints for a server

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.

VirtualEndpointType
, VirtualEndpointTypeArgs

ReadWrite
ReadWrite
VirtualEndpointTypeReadWrite
ReadWrite
ReadWrite
ReadWrite
ReadWrite
ReadWrite
READ_WRITE
ReadWrite
"ReadWrite"
ReadWrite

Import

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

$ pulumi import azure-native:dbforpostgresql:VirtualEndpoint pgVirtualEndpoint1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native