azure-native.dbforpostgresql.VirtualEndpoint
Explore with Pulumi AI
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.
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",
});
});
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
})
}
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());
}
}
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")
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",
});
resources:
virtualEndpoint:
type: azure-native:dbforpostgresql:VirtualEndpoint
properties:
endpointType: ReadWrite
members:
- testPrimary1
resourceGroupName: testrg
serverName: pgtestsvc4
virtualEndpointName: pgVirtualEndpoint1
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 string
- The unique name of the resource.
- args VirtualEndpointArgs
- 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 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 string
- The unique name of the resource.
- args VirtualEndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VirtualEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
example, err := dbforpostgresql.NewVirtualEndpoint(ctx, "virtualEndpointResource", &dbforpostgresql.VirtualEndpointArgs{
ResourceGroupName: pulumi.String("string"),
ServerName: pulumi.String("string"),
EndpointType: pulumi.String("string"),
Members: pulumi.StringArray{
pulumi.String("string"),
},
VirtualEndpointName: pulumi.String("string"),
})
var virtualEndpointResource = new VirtualEndpoint("virtualEndpointResource", VirtualEndpointArgs.builder()
.resourceGroupName("string")
.serverName("string")
.endpointType("string")
.members("string")
.virtualEndpointName("string")
.build());
virtual_endpoint_resource = azure_native.dbforpostgresql.VirtualEndpoint("virtualEndpointResource",
resource_group_name="string",
server_name="string",
endpoint_type="string",
members=["string"],
virtual_endpoint_name="string")
const virtualEndpointResource = new azure_native.dbforpostgresql.VirtualEndpoint("virtualEndpointResource", {
resourceGroupName: "string",
serverName: "string",
endpointType: "string",
members: ["string"],
virtualEndpointName: "string",
});
type: azure-native:dbforpostgresql:VirtualEndpoint
properties:
endpointType: string
members:
- string
resourceGroupName: string
serverName: string
virtualEndpointName: string
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
The VirtualEndpoint resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Server
Name string - The name of the server.
- Endpoint
Type string | Pulumi.Azure Native. DBfor Postgre SQL. Virtual Endpoint Type - The endpoint type for the virtual endpoint.
- Members List<string>
- List of members for a virtual endpoint
- Virtual
Endpoint stringName - The name of the virtual endpoint.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Server
Name string - The name of the server.
- Endpoint
Type string | VirtualEndpoint Type - The endpoint type for the virtual endpoint.
- Members []string
- List of members for a virtual endpoint
- Virtual
Endpoint stringName - The name of the virtual endpoint.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- server
Name String - The name of the server.
- endpoint
Type String | VirtualEndpoint Type - The endpoint type for the virtual endpoint.
- members List<String>
- List of members for a virtual endpoint
- virtual
Endpoint StringName - The name of the virtual endpoint.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- server
Name string - The name of the server.
- endpoint
Type string | VirtualEndpoint Type - The endpoint type for the virtual endpoint.
- members string[]
- List of members for a virtual endpoint
- virtual
Endpoint stringName - The name of the virtual endpoint.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- server_
name str - The name of the server.
- endpoint_
type str | VirtualEndpoint Type - The endpoint type for the virtual endpoint.
- members Sequence[str]
- List of members for a virtual endpoint
- virtual_
endpoint_ strname - The name of the virtual endpoint.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- server
Name String - The name of the server.
- endpoint
Type String | "ReadWrite" - The endpoint type for the virtual endpoint.
- members List<String>
- List of members for a virtual endpoint
- virtual
Endpoint StringName - 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
- System
Data Pulumi.Azure Native. DBfor Postgre SQL. Outputs. System Data Response - 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"
- Virtual
Endpoints 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
- System
Data SystemData Response - 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"
- Virtual
Endpoints []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
- system
Data SystemData Response - 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"
- virtual
Endpoints 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
- system
Data SystemData Response - 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"
- virtual
Endpoints 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 SystemData Response - 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
- system
Data 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"
- virtual
Endpoints List<String> - List of virtual endpoints for a server
Supporting Types
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
VirtualEndpointType, VirtualEndpointTypeArgs
- Read
Write - ReadWrite
- Virtual
Endpoint Type Read Write - ReadWrite
- Read
Write - ReadWrite
- Read
Write - ReadWrite
- READ_WRITE
- ReadWrite
- "Read
Write" - 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0