Use Pulumi's new import command to generate code from existing cloud resources. Learn More
  1. Docs
  2. Reference
  3. API
  4. Azure NextGen
  5. synapse
  6. PrivateEndpointConnection

PrivateEndpointConnection

A private endpoint connection

Example Usage

Approve private endpoint connection

using Pulumi;
using AzureNextGen = Pulumi.AzureNextGen;

class MyStack : Stack
{
    public MyStack()
    {
        var privateEndpointConnection = new AzureNextGen.Synapse.V20190601Preview.PrivateEndpointConnection("privateEndpointConnection", new AzureNextGen.Synapse.V20190601Preview.PrivateEndpointConnectionArgs
        {
            PrivateEndpointConnectionName = "ExamplePrivateEndpointConnection",
            PrivateLinkServiceConnectionState = new AzureNextGen.Synapse.V20190601Preview.Inputs.PrivateLinkServiceConnectionStateArgs
            {
                Description = "Approved by abc@example.com",
                Status = "Approved",
            },
            ResourceGroupName = "ExampleResourceGroup",
            WorkspaceName = "ExampleWorkspace",
        });
    }

}

package main

import (
    synapse "github.com/pulumi/pulumi-azure-nextgen/sdk/go/azure/synapse/v20190601preview"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := synapse.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &synapse.PrivateEndpointConnectionArgs{
            PrivateEndpointConnectionName: pulumi.String("ExamplePrivateEndpointConnection"),
            PrivateLinkServiceConnectionState: &synapse.PrivateLinkServiceConnectionStateArgs{
                Description: pulumi.String("Approved by abc@example.com"),
                Status:      pulumi.String("Approved"),
            },
            ResourceGroupName: pulumi.String("ExampleResourceGroup"),
            WorkspaceName:     pulumi.String("ExampleWorkspace"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure_nextgen as azure_nextgen

private_endpoint_connection = azure_nextgen.synapse.v20190601preview.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="ExamplePrivateEndpointConnection",
    private_link_service_connection_state=azure_nextgen.synapse.v20190601preview.PrivateLinkServiceConnectionStateArgs(
        description="Approved by abc@example.com",
        status="Approved",
    ),
    resource_group_name="ExampleResourceGroup",
    workspace_name="ExampleWorkspace")
import * as pulumi from "@pulumi/pulumi";
import * as azure_nextgen from "@pulumi/azure-nextgen";

const privateEndpointConnection = new azure_nextgen.synapse.v20190601preview.PrivateEndpointConnection("privateEndpointConnection", {
    privateEndpointConnectionName: "ExamplePrivateEndpointConnection",
    privateLinkServiceConnectionState: {
        description: "Approved by abc@example.com",
        status: "Approved",
    },
    resourceGroupName: "ExampleResourceGroup",
    workspaceName: "ExampleWorkspace",
});

Create a PrivateEndpointConnection Resource

new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
def PrivateEndpointConnection(resource_name: str, opts: Optional[ResourceOptions] = None, private_endpoint_connection_name: Optional[str] = None, private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = None, resource_group_name: Optional[str] = None, workspace_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)
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.
opts ResourceOptions
A bag of options that control this 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.

PrivateEndpointConnection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The PrivateEndpointConnection resource accepts the following input properties:

PrivateEndpointConnectionName string
The name of the private endpoint connection.
ResourceGroupName string
The name of the resource group. The name is case insensitive.
WorkspaceName string
The name of the workspace.
PrivateLinkServiceConnectionState Pulumi.AzureNextGen.Synapse.Inputs.PrivateLinkServiceConnectionStateArgs
Connection state of the private endpoint connection.
PrivateEndpointConnectionName string
The name of the private endpoint connection.
ResourceGroupName string
The name of the resource group. The name is case insensitive.
WorkspaceName string
The name of the workspace.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState
Connection state of the private endpoint connection.
privateEndpointConnectionName string
The name of the private endpoint connection.
resourceGroupName string
The name of the resource group. The name is case insensitive.
workspaceName string
The name of the workspace.
privateLinkServiceConnectionState PrivateLinkServiceConnectionState
Connection state of the private endpoint connection.
private_endpoint_connection_name str
The name of the private endpoint connection.
resource_group_name str
The name of the resource group. The name is case insensitive.
workspace_name str
The name of the workspace.
private_link_service_connection_state PrivateLinkServiceConnectionStateArgs
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
The name of the resource
ProvisioningState string
Provisioning state of the private endpoint connection.
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
PrivateEndpoint Pulumi.AzureNextGen.Synapse.Outputs.PrivateEndpointResponse
The private endpoint which the connection belongs to.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Provisioning state of the private endpoint connection.
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
PrivateEndpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
Provisioning state of the private endpoint connection.
type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
privateEndpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
Provisioning state of the private endpoint connection.
type str
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
private_endpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.

Supporting Types

PrivateEndpointResponse

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.

PrivateLinkServiceConnectionState

Description string
The private link service connection description.
Status string
The private link service connection status.
Description string
The private link service connection description.
Status string
The private link service connection status.
description string
The private link service connection description.
status string
The private link service connection status.
description str
The private link service connection description.
status str
The private link service connection status.

PrivateLinkServiceConnectionStateResponse

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.

Import

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

$ pulumi import azure-nextgen:synapse/v20190601preview:PrivateEndpointConnection sql /subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection

Package Details

Repository
https://github.com/pulumi/pulumi-azure-nextgen
License
Apache-2.0