Azure Native v1.102.0, May 2 23

azure-native.sql.PrivateEndpointConnection

Explore with Pulumi AI

A private endpoint connection API Version: 2020-11-01-preview.

Example Usage

Approve or reject a private endpoint connection with a given name.

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.Sql.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PrivateEndpointConnectionName = "private-endpoint-connection-name",
        PrivateLinkServiceConnectionState = new AzureNative.Sql.Inputs.PrivateLinkServiceConnectionStatePropertyArgs
        {
            Description = "Approved by johndoe@contoso.com",
            Status = "Approved",
        },
        ResourceGroupName = "Default",
        ServerName = "test-svr",
    });

});

package main

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

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

    }
}

import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.sql.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="private-endpoint-connection-name",
    private_link_service_connection_state=azure_native.sql.PrivateLinkServiceConnectionStatePropertyResponseArgs(
        description="Approved by johndoe@contoso.com",
        status="Approved",
    ),
    resource_group_name="Default",
    server_name="test-svr")

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

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

resources:
  privateEndpointConnection:
    type: azure-native:sql:PrivateEndpointConnection
    properties:
      privateEndpointConnectionName: private-endpoint-connection-name
      privateLinkServiceConnectionState:
        description: Approved by johndoe@contoso.com
        status: Approved
      resourceGroupName: Default
      serverName: test-svr

Create PrivateEndpointConnection Resource

new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);

@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              private_endpoint: Optional[PrivateEndpointPropertyArgs] = None,
                              private_endpoint_connection_name: Optional[str] = None,
                              private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStatePropertyArgs] = None,
                              resource_group_name: Optional[str] = None,
                              server_name: Optional[str] = None)
@overload
def PrivateEndpointConnection(resource_name: str,
                              args: PrivateEndpointConnectionArgs,
                              opts: Optional[ResourceOptions] = 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:sql:PrivateEndpointConnection
properties: # The arguments to resource properties.
options: # 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.

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.

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:

ResourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName string: The name of the server.
PrivateEndpoint Pulumi.AzureNative.Sql.Inputs.PrivateEndpointPropertyArgs: Private endpoint which the connection belongs to.
PrivateEndpointConnectionName string
PrivateLinkServiceConnectionState Pulumi.AzureNative.Sql.Inputs.PrivateLinkServiceConnectionStatePropertyArgs: Connection state of the private endpoint connection.

ResourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName string: The name of the server.
PrivateEndpoint PrivateEndpointPropertyArgs: Private endpoint which the connection belongs to.
PrivateEndpointConnectionName string
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyArgs: Connection state of the private endpoint connection.

resourceGroupName String: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName String: The name of the server.
privateEndpoint PrivateEndpointPropertyArgs: Private endpoint which the connection belongs to.
privateEndpointConnectionName String
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyArgs: Connection state of the private endpoint connection.

resourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName string: The name of the server.
privateEndpoint PrivateEndpointPropertyArgs: Private endpoint which the connection belongs to.
privateEndpointConnectionName string
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyArgs: Connection state of the private endpoint connection.

resource_group_name str: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name str: The name of the server.
private_endpoint PrivateEndpointPropertyArgs: Private endpoint which the connection belongs to.
private_endpoint_connection_name str
private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyArgs: Connection state of the private endpoint connection.

resourceGroupName String: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName String: The name of the server.
privateEndpoint Property Map: Private endpoint which the connection belongs to.
privateEndpointConnectionName String
privateLinkServiceConnectionState Property Map: Connection state of the private endpoint connection.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
ProvisioningState string: State of the private endpoint connection.
Type string: Resource type.

Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
ProvisioningState string: State of the private endpoint connection.
Type string: Resource type.

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
provisioningState String: State of the private endpoint connection.
type String: Resource type.

id string: The provider-assigned unique ID for this managed resource.
name string: Resource name.
provisioningState string: State of the private endpoint connection.
type string: Resource type.

id str: The provider-assigned unique ID for this managed resource.
name str: Resource name.
provisioning_state str: State of the private endpoint connection.
type str: Resource type.

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
provisioningState String: State of the private endpoint connection.
type String: Resource type.

Supporting Types

PrivateEndpointProperty

Id string: Resource id of the private endpoint.

Id string: Resource id of the private endpoint.

id String: Resource id of the private endpoint.

id string: Resource id of the private endpoint.

id str: Resource id of the private endpoint.

id String: Resource id of the private endpoint.

PrivateEndpointPropertyResponse

Id string: Resource id of the private endpoint.

Id string: Resource id of the private endpoint.

id String: Resource id of the private endpoint.

id string: Resource id of the private endpoint.

id str: Resource id of the private endpoint.

id String: Resource id of the private endpoint.

PrivateLinkServiceConnectionStateProperty

Description string: The private link service connection description.
Status string | Pulumi.AzureNative.Sql.PrivateLinkServiceConnectionStateStatus: The private link service connection status.

Description string: The private link service connection description.
Status string | PrivateLinkServiceConnectionStateStatus: The private link service connection status.

description String: The private link service connection description.
status String | PrivateLinkServiceConnectionStateStatus: The private link service connection status.

description string: The private link service connection description.
status string | PrivateLinkServiceConnectionStateStatus: The private link service connection status.

description str: The private link service connection description.
status str | PrivateLinkServiceConnectionStateStatus: The private link service connection status.

description String: The private link service connection description.
status String | "Approved" | "Pending" | "Rejected" | "Disconnected": The private link service connection status.

PrivateLinkServiceConnectionStatePropertyResponse

ActionsRequired string: The actions required for private link service connection.
Description string: The private link service connection description.
Status string: The private link service connection status.

ActionsRequired string: The actions required for private link service connection.
Description string: The private link service connection description.
Status string: The private link service connection status.

actionsRequired String: The actions required for private link service connection.
description String: The private link service connection description.
status String: The private link service connection status.

actionsRequired string: The actions required for private link service connection.
description string: The private link service connection description.
status string: The private link service connection status.

actions_required str: The actions required for private link service connection.
description str: The private link service connection description.
status str: The private link service connection status.

actionsRequired String: The actions required for private link service connection.
description String: The private link service connection description.
status String: The private link service connection status.

PrivateLinkServiceConnectionStateStatus

Approved: Approved
Pending: Pending
Rejected: Rejected
Disconnected: Disconnected

PrivateLinkServiceConnectionStateStatusApproved: Approved
PrivateLinkServiceConnectionStateStatusPending: Pending
PrivateLinkServiceConnectionStateStatusRejected: Rejected
PrivateLinkServiceConnectionStateStatusDisconnected: Disconnected

Approved: Approved
Pending: Pending
Rejected: Rejected
Disconnected: Disconnected

Approved: Approved
Pending: Pending
Rejected: Rejected
Disconnected: Disconnected

APPROVED: Approved
PENDING: Pending
REJECTED: Rejected
DISCONNECTED: Disconnected

"Approved": Approved
"Pending": Pending
"Rejected": Rejected
"Disconnected": Disconnected

Import

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

$ pulumi import azure-native:sql:PrivateEndpointConnection private-endpoint-connection-name /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections/private-endpoint-connection-name

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0