azure-native.dbforpostgresql.PrivateEndpointConnection
Explore with Pulumi AI
The private endpoint connection resource. Azure REST API version: 2022-11-08. Prior API version in Azure Native 1.x: 2018-06-01.
Other available API versions: 2018-06-01-privatepreview, 2023-03-02-preview, 2023-06-01-preview, 2023-12-01-preview, 2024-03-01-preview, 2024-08-01.
Example Usage
Approves or Rejects a Private Endpoint Connection with a given name.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var privateEndpointConnection = new AzureNative.DBforPostgreSQL.PrivateEndpointConnection("privateEndpointConnection", new()
{
ClusterName = "testcluster",
PrivateEndpointConnectionName = "private-endpoint-connection-name",
PrivateLinkServiceConnectionState = new AzureNative.DBforPostgreSQL.Inputs.PrivateLinkServiceConnectionStateArgs
{
Description = "Approved by johndoe@contoso.com",
Status = AzureNative.DBforPostgreSQL.PrivateEndpointServiceConnectionStatus.Approved,
},
ResourceGroupName = "TestGroup",
});
});
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.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &dbforpostgresql.PrivateEndpointConnectionArgs{
ClusterName: pulumi.String("testcluster"),
PrivateEndpointConnectionName: pulumi.String("private-endpoint-connection-name"),
PrivateLinkServiceConnectionState: &dbforpostgresql.PrivateLinkServiceConnectionStateArgs{
Description: pulumi.String("Approved by johndoe@contoso.com"),
Status: pulumi.String(dbforpostgresql.PrivateEndpointServiceConnectionStatusApproved),
},
ResourceGroupName: pulumi.String("TestGroup"),
})
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.PrivateEndpointConnection;
import com.pulumi.azurenative.dbforpostgresql.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.dbforpostgresql.inputs.PrivateLinkServiceConnectionStateArgs;
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 privateEndpointConnection = new PrivateEndpointConnection("privateEndpointConnection", PrivateEndpointConnectionArgs.builder()
.clusterName("testcluster")
.privateEndpointConnectionName("private-endpoint-connection-name")
.privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
.description("Approved by johndoe@contoso.com")
.status("Approved")
.build())
.resourceGroupName("TestGroup")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
private_endpoint_connection = azure_native.dbforpostgresql.PrivateEndpointConnection("privateEndpointConnection",
cluster_name="testcluster",
private_endpoint_connection_name="private-endpoint-connection-name",
private_link_service_connection_state={
"description": "Approved by johndoe@contoso.com",
"status": azure_native.dbforpostgresql.PrivateEndpointServiceConnectionStatus.APPROVED,
},
resource_group_name="TestGroup")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const privateEndpointConnection = new azure_native.dbforpostgresql.PrivateEndpointConnection("privateEndpointConnection", {
clusterName: "testcluster",
privateEndpointConnectionName: "private-endpoint-connection-name",
privateLinkServiceConnectionState: {
description: "Approved by johndoe@contoso.com",
status: azure_native.dbforpostgresql.PrivateEndpointServiceConnectionStatus.Approved,
},
resourceGroupName: "TestGroup",
});
resources:
privateEndpointConnection:
type: azure-native:dbforpostgresql:PrivateEndpointConnection
properties:
clusterName: testcluster
privateEndpointConnectionName: private-endpoint-connection-name
privateLinkServiceConnectionState:
description: Approved by johndoe@contoso.com
status: Approved
resourceGroupName: TestGroup
Create PrivateEndpointConnection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpointConnection(resource_name: str,
args: PrivateEndpointConnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PrivateEndpointConnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_name: Optional[str] = None,
private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = None,
resource_group_name: Optional[str] = None,
private_endpoint_connection_name: Optional[str] = None)
func NewPrivateEndpointConnection(ctx *Context, name string, args PrivateEndpointConnectionArgs, opts ...ResourceOption) (*PrivateEndpointConnection, error)
public PrivateEndpointConnection(string name, PrivateEndpointConnectionArgs args, CustomResourceOptions? opts = null)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args, CustomResourceOptions options)
type: azure-native:dbforpostgresql:PrivateEndpointConnection
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 PrivateEndpointConnectionArgs
- 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 PrivateEndpointConnectionArgs
- 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 PrivateEndpointConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- 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 exampleprivateEndpointConnectionResourceResourceFromDbforpostgresql = new AzureNative.DBforPostgreSQL.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDbforpostgresql", new()
{
ClusterName = "string",
PrivateLinkServiceConnectionState = new AzureNative.DBforPostgreSQL.Inputs.PrivateLinkServiceConnectionStateArgs
{
ActionsRequired = "string",
Description = "string",
Status = "string",
},
ResourceGroupName = "string",
PrivateEndpointConnectionName = "string",
});
example, err := dbforpostgresql.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromDbforpostgresql", &dbforpostgresql.PrivateEndpointConnectionArgs{
ClusterName: pulumi.String("string"),
PrivateLinkServiceConnectionState: &dbforpostgresql.PrivateLinkServiceConnectionStateArgs{
ActionsRequired: pulumi.String("string"),
Description: pulumi.String("string"),
Status: pulumi.String("string"),
},
ResourceGroupName: pulumi.String("string"),
PrivateEndpointConnectionName: pulumi.String("string"),
})
var exampleprivateEndpointConnectionResourceResourceFromDbforpostgresql = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDbforpostgresql", PrivateEndpointConnectionArgs.builder()
.clusterName("string")
.privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
.actionsRequired("string")
.description("string")
.status("string")
.build())
.resourceGroupName("string")
.privateEndpointConnectionName("string")
.build());
exampleprivate_endpoint_connection_resource_resource_from_dbforpostgresql = azure_native.dbforpostgresql.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDbforpostgresql",
cluster_name="string",
private_link_service_connection_state={
"actionsRequired": "string",
"description": "string",
"status": "string",
},
resource_group_name="string",
private_endpoint_connection_name="string")
const exampleprivateEndpointConnectionResourceResourceFromDbforpostgresql = new azure_native.dbforpostgresql.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDbforpostgresql", {
clusterName: "string",
privateLinkServiceConnectionState: {
actionsRequired: "string",
description: "string",
status: "string",
},
resourceGroupName: "string",
privateEndpointConnectionName: "string",
});
type: azure-native:dbforpostgresql:PrivateEndpointConnection
properties:
clusterName: string
privateEndpointConnectionName: string
privateLinkServiceConnectionState:
actionsRequired: string
description: string
status: string
resourceGroupName: string
PrivateEndpointConnection 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 PrivateEndpointConnection resource accepts the following input properties:
- Cluster
Name string - The name of the cluster.
- Private
Link Pulumi.Service Connection State Azure Native. DBfor Postgre SQL. Inputs. Private Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Private
Endpoint stringConnection Name - The name of the private endpoint connection associated with the cluster.
- Cluster
Name string - The name of the cluster.
- Private
Link PrivateService Connection State Link Service Connection State Args - A collection of information about the state of the connection between service consumer and provider.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Private
Endpoint stringConnection Name - The name of the private endpoint connection associated with the cluster.
- cluster
Name String - The name of the cluster.
- private
Link PrivateService Connection State Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- private
Endpoint StringConnection Name - The name of the private endpoint connection associated with the cluster.
- cluster
Name string - The name of the cluster.
- private
Link PrivateService Connection State Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- private
Endpoint stringConnection Name - The name of the private endpoint connection associated with the cluster.
- cluster_
name str - The name of the cluster.
- private_
link_ Privateservice_ connection_ state Link Service Connection State Args - A collection of information about the state of the connection between service consumer and provider.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- private_
endpoint_ strconnection_ name - The name of the private endpoint connection associated with the cluster.
- cluster
Name String - The name of the cluster.
- private
Link Property MapService Connection State - A collection of information about the state of the connection between service consumer and provider.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- private
Endpoint StringConnection Name - The name of the private endpoint connection associated with the cluster.
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivateEndpointConnection resource produces the following output properties:
- Group
Ids List<string> - The group ids for the private endpoint resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - The provisioning state of the private endpoint connection 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"
- Private
Endpoint Pulumi.Azure Native. DBfor Postgre SQL. Outputs. Private Endpoint Response - The private endpoint resource.
- Group
Ids []string - The group ids for the private endpoint resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - The provisioning state of the private endpoint connection 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"
- Private
Endpoint PrivateEndpoint Response - The private endpoint resource.
- group
Ids List<String> - The group ids for the private endpoint resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - The provisioning state of the private endpoint connection 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"
- private
Endpoint PrivateEndpoint Response - The private endpoint resource.
- group
Ids string[] - The group ids for the private endpoint resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- provisioning
State string - The provisioning state of the private endpoint connection 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"
- private
Endpoint PrivateEndpoint Response - The private endpoint resource.
- group_
ids Sequence[str] - The group ids for the private endpoint resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- provisioning_
state str - The provisioning state of the private endpoint connection 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"
- private_
endpoint PrivateEndpoint Response - The private endpoint resource.
- group
Ids List<String> - The group ids for the private endpoint resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - The provisioning state of the private endpoint connection 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"
- private
Endpoint Property Map - The private endpoint resource.
Supporting Types
PrivateEndpointResponse, PrivateEndpointResponseArgs
- Id string
- The ARM identifier for private endpoint.
- Id string
- The ARM identifier for private endpoint.
- id String
- The ARM identifier for private endpoint.
- id string
- The ARM identifier for private endpoint.
- id str
- The ARM identifier for private endpoint.
- id String
- The ARM identifier for private endpoint.
PrivateEndpointServiceConnectionStatus, PrivateEndpointServiceConnectionStatusArgs
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Private
Endpoint Service Connection Status Pending - Pending
- Private
Endpoint Service Connection Status Approved - Approved
- Private
Endpoint Service Connection Status Rejected - Rejected
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- PENDING
- Pending
- APPROVED
- Approved
- REJECTED
- Rejected
- "Pending"
- Pending
- "Approved"
- Approved
- "Rejected"
- Rejected
PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status
string | Pulumi.
Azure Native. DBfor Postgre SQL. Private Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status
string | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status
String | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- description string
- The reason for approval/rejection of the connection.
- status
string | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions_
required str - A message indicating if changes on the service provider require any updates on the consumer.
- description str
- The reason for approval/rejection of the connection.
- status
str | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String | "Pending" | "Approved" | "Rejected"
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- description string
- The reason for approval/rejection of the connection.
- status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions_
required str - A message indicating if changes on the service provider require any updates on the consumer.
- description str
- The reason for approval/rejection of the connection.
- status str
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
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.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:dbforpostgresql:PrivateEndpointConnection private-endpoint-connection-name /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0