Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. dbformysql
  5. PrivateEndpointConnection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.dbformysql.PrivateEndpointConnection

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.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

The private endpoint connection resource. Azure REST API version: 2022-09-30-preview. Prior API version in Azure Native 1.x: 2018-06-01.

Other available API versions: 2018-06-01-privatepreview, 2023-06-30.

Example Usage

Approve or reject 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.DBforMySQL.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PrivateEndpointConnectionName = "private-endpoint-connection-name",
        PrivateLinkServiceConnectionState = new AzureNative.DBforMySQL.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            Description = "Approved by johndoe@contoso.com",
            Status = AzureNative.DBforMySQL.PrivateEndpointServiceConnectionStatus.Approved,
        },
        ResourceGroupName = "Default",
        ServerName = "test-svr",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dbformysql.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &dbformysql.PrivateEndpointConnectionArgs{
			PrivateEndpointConnectionName: pulumi.String("private-endpoint-connection-name"),
			PrivateLinkServiceConnectionState: &dbformysql.PrivateLinkServiceConnectionStateArgs{
				Description: pulumi.String("Approved by johndoe@contoso.com"),
				Status:      pulumi.String(dbformysql.PrivateEndpointServiceConnectionStatusApproved),
			},
			ResourceGroupName: pulumi.String("Default"),
			ServerName:        pulumi.String("test-svr"),
		})
		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.dbformysql.PrivateEndpointConnection;
import com.pulumi.azurenative.dbformysql.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.dbformysql.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()
            .privateEndpointConnectionName("private-endpoint-connection-name")
            .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                .description("Approved by johndoe@contoso.com")
                .status("Approved")
                .build())
            .resourceGroupName("Default")
            .serverName("test-svr")
            .build());

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

const privateEndpointConnection = new azure_native.dbformysql.PrivateEndpointConnection("privateEndpointConnection", {
    privateEndpointConnectionName: "private-endpoint-connection-name",
    privateLinkServiceConnectionState: {
        description: "Approved by johndoe@contoso.com",
        status: azure_native.dbformysql.PrivateEndpointServiceConnectionStatus.Approved,
    },
    resourceGroupName: "Default",
    serverName: "test-svr",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.dbformysql.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="private-endpoint-connection-name",
    private_link_service_connection_state={
        "description": "Approved by johndoe@contoso.com",
        "status": azure_native.dbformysql.PrivateEndpointServiceConnectionStatus.APPROVED,
    },
    resource_group_name="Default",
    server_name="test-svr")
Copy
resources:
  privateEndpointConnection:
    type: azure-native:dbformysql:PrivateEndpointConnection
    properties:
      privateEndpointConnectionName: private-endpoint-connection-name
      privateLinkServiceConnectionState:
        description: Approved by johndoe@contoso.com
        status: Approved
      resourceGroupName: Default
      serverName: test-svr
Copy

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,
                              private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = None,
                              resource_group_name: Optional[str] = None,
                              server_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:dbformysql:PrivateEndpointConnection
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. PrivateEndpointConnectionArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. PrivateEndpointConnectionArgs
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. PrivateEndpointConnectionArgs
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. 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 exampleprivateEndpointConnectionResourceResourceFromDbformysql = new AzureNative.Dbformysql.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDbformysql", new()
{
    PrivateLinkServiceConnectionState = 
    {
        { "actionsRequired", "string" },
        { "description", "string" },
        { "status", "string" },
    },
    ResourceGroupName = "string",
    ServerName = "string",
    PrivateEndpointConnectionName = "string",
});
Copy
example, err := dbformysql.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromDbformysql", &dbformysql.PrivateEndpointConnectionArgs{
	PrivateLinkServiceConnectionState: map[string]interface{}{
		"actionsRequired": "string",
		"description":     "string",
		"status":          "string",
	},
	ResourceGroupName:             "string",
	ServerName:                    "string",
	PrivateEndpointConnectionName: "string",
})
Copy
var exampleprivateEndpointConnectionResourceResourceFromDbformysql = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDbformysql", PrivateEndpointConnectionArgs.builder()
    .privateLinkServiceConnectionState(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .serverName("string")
    .privateEndpointConnectionName("string")
    .build());
Copy
exampleprivate_endpoint_connection_resource_resource_from_dbformysql = azure_native.dbformysql.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDbformysql",
    private_link_service_connection_state={
        actionsRequired: string,
        description: string,
        status: string,
    },
    resource_group_name=string,
    server_name=string,
    private_endpoint_connection_name=string)
Copy
const exampleprivateEndpointConnectionResourceResourceFromDbformysql = new azure_native.dbformysql.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDbformysql", {
    privateLinkServiceConnectionState: {
        actionsRequired: "string",
        description: "string",
        status: "string",
    },
    resourceGroupName: "string",
    serverName: "string",
    privateEndpointConnectionName: "string",
});
Copy
type: azure-native:dbformysql:PrivateEndpointConnection
properties:
    privateEndpointConnectionName: string
    privateLinkServiceConnectionState:
        actionsRequired: string
        description: string
        status: string
    resourceGroupName: string
    serverName: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PrivateEndpointConnection resource accepts the following input properties:

PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.DBforMySQL.Inputs.PrivateLinkServiceConnectionState
A collection of information about the state of the connection between service consumer and provider.
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.
PrivateEndpointConnectionName Changes to this property will trigger replacement. string
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateArgs
A collection of information about the state of the connection between service consumer and provider.
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.
PrivateEndpointConnectionName Changes to this property will trigger replacement. string
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionState
A collection of information about the state of the connection between service consumer and provider.
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.
privateEndpointConnectionName Changes to this property will trigger replacement. String
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionState
A collection of information about the state of the connection between service consumer and provider.
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.
privateEndpointConnectionName Changes to this property will trigger replacement. string
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionStateArgs
A collection of information about the state of the connection between service consumer and provider.
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.
private_endpoint_connection_name Changes to this property will trigger replacement. str
privateLinkServiceConnectionState This property is required. Property Map
A collection of information about the state of the connection between service consumer and provider.
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.
privateEndpointConnectionName Changes to this property will trigger replacement. String

Outputs

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

GroupIds 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
ProvisioningState string
The provisioning state of the private endpoint connection resource.
SystemData Pulumi.AzureNative.DBforMySQL.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"
PrivateEndpoint Pulumi.AzureNative.DBforMySQL.Outputs.PrivateEndpointResponse
The private endpoint resource.
GroupIds []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
ProvisioningState string
The provisioning state of the private endpoint connection 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"
PrivateEndpoint PrivateEndpointResponse
The private endpoint resource.
groupIds 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
provisioningState String
The provisioning state of the private endpoint connection 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"
privateEndpoint PrivateEndpointResponse
The private endpoint resource.
groupIds 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
provisioningState string
The provisioning state of the private endpoint connection 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"
privateEndpoint PrivateEndpointResponse
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 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"
private_endpoint PrivateEndpointResponse
The private endpoint resource.
groupIds 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
provisioningState String
The provisioning state of the private endpoint connection 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"
privateEndpoint Property Map
The private endpoint resource.

Supporting Types

PrivateEndpointResponse
, PrivateEndpointResponseArgs

Id This property is required. string
The ARM identifier for private endpoint.
Id This property is required. string
The ARM identifier for private endpoint.
id This property is required. String
The ARM identifier for private endpoint.
id This property is required. string
The ARM identifier for private endpoint.
id This property is required. str
The ARM identifier for private endpoint.
id This property is required. String
The ARM identifier for private endpoint.

PrivateEndpointServiceConnectionStatus
, PrivateEndpointServiceConnectionStatusArgs

Pending
Pending
Approved
Approved
Rejected
Rejected
PrivateEndpointServiceConnectionStatusPending
Pending
PrivateEndpointServiceConnectionStatusApproved
Approved
PrivateEndpointServiceConnectionStatusRejected
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

ActionsRequired 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.AzureNative.DBforMySQL.PrivateEndpointServiceConnectionStatus
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
ActionsRequired 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 | PrivateEndpointServiceConnectionStatus
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired 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 | PrivateEndpointServiceConnectionStatus
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired 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 | PrivateEndpointServiceConnectionStatus
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 | PrivateEndpointServiceConnectionStatus
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired 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

ActionsRequired 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.
ActionsRequired 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.
actionsRequired 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.
actionsRequired 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.
actionsRequired 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

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

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

$ pulumi import azure-native:dbformysql:PrivateEndpointConnection private-endpoint-connection-name /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}
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.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native