Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. desktopvirtualization
  5. PrivateEndpointConnectionByWorkspace
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.desktopvirtualization.PrivateEndpointConnectionByWorkspace

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

The Private Endpoint Connection resource. Azure REST API version: 2022-10-14-preview. Prior API version in Azure Native 1.x: 2021-04-01-preview.

Other available API versions: 2023-07-07-preview, 2023-09-05, 2023-10-04-preview, 2023-11-01-preview, 2024-01-16-preview, 2024-03-06-preview, 2024-04-03, 2024-04-08-preview, 2024-08-08-preview.

Example Usage

PrivateEndpointConnection_UpdateByWorkspace

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnectionByWorkspace = new AzureNative.DesktopVirtualization.PrivateEndpointConnectionByWorkspace("privateEndpointConnectionByWorkspace", new()
    {
        PrivateEndpointConnectionName = "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b",
        PrivateLinkServiceConnectionState = new AzureNative.DesktopVirtualization.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            ActionsRequired = "None",
            Description = "Approved by admin@consoto.com",
            Status = AzureNative.DesktopVirtualization.PrivateEndpointServiceConnectionStatus.Approved,
        },
        ResourceGroupName = "resourceGroup1",
        WorkspaceName = "workspace1",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := desktopvirtualization.NewPrivateEndpointConnectionByWorkspace(ctx, "privateEndpointConnectionByWorkspace", &desktopvirtualization.PrivateEndpointConnectionByWorkspaceArgs{
			PrivateEndpointConnectionName: pulumi.String("workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b"),
			PrivateLinkServiceConnectionState: &desktopvirtualization.PrivateLinkServiceConnectionStateArgs{
				ActionsRequired: pulumi.String("None"),
				Description:     pulumi.String("Approved by admin@consoto.com"),
				Status:          pulumi.String(desktopvirtualization.PrivateEndpointServiceConnectionStatusApproved),
			},
			ResourceGroupName: pulumi.String("resourceGroup1"),
			WorkspaceName:     pulumi.String("workspace1"),
		})
		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.desktopvirtualization.PrivateEndpointConnectionByWorkspace;
import com.pulumi.azurenative.desktopvirtualization.PrivateEndpointConnectionByWorkspaceArgs;
import com.pulumi.azurenative.desktopvirtualization.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 privateEndpointConnectionByWorkspace = new PrivateEndpointConnectionByWorkspace("privateEndpointConnectionByWorkspace", PrivateEndpointConnectionByWorkspaceArgs.builder()
            .privateEndpointConnectionName("workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b")
            .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                .actionsRequired("None")
                .description("Approved by admin@consoto.com")
                .status("Approved")
                .build())
            .resourceGroupName("resourceGroup1")
            .workspaceName("workspace1")
            .build());

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

const privateEndpointConnectionByWorkspace = new azure_native.desktopvirtualization.PrivateEndpointConnectionByWorkspace("privateEndpointConnectionByWorkspace", {
    privateEndpointConnectionName: "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b",
    privateLinkServiceConnectionState: {
        actionsRequired: "None",
        description: "Approved by admin@consoto.com",
        status: azure_native.desktopvirtualization.PrivateEndpointServiceConnectionStatus.Approved,
    },
    resourceGroupName: "resourceGroup1",
    workspaceName: "workspace1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection_by_workspace = azure_native.desktopvirtualization.PrivateEndpointConnectionByWorkspace("privateEndpointConnectionByWorkspace",
    private_endpoint_connection_name="workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b",
    private_link_service_connection_state={
        "actions_required": "None",
        "description": "Approved by admin@consoto.com",
        "status": azure_native.desktopvirtualization.PrivateEndpointServiceConnectionStatus.APPROVED,
    },
    resource_group_name="resourceGroup1",
    workspace_name="workspace1")
Copy
resources:
  privateEndpointConnectionByWorkspace:
    type: azure-native:desktopvirtualization:PrivateEndpointConnectionByWorkspace
    properties:
      privateEndpointConnectionName: workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b
      privateLinkServiceConnectionState:
        actionsRequired: None
        description: Approved by admin@consoto.com
        status: Approved
      resourceGroupName: resourceGroup1
      workspaceName: workspace1
Copy

Create PrivateEndpointConnectionByWorkspace Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PrivateEndpointConnectionByWorkspace(name: string, args: PrivateEndpointConnectionByWorkspaceArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpointConnectionByWorkspace(resource_name: str,
                                         args: PrivateEndpointConnectionByWorkspaceArgs,
                                         opts: Optional[ResourceOptions] = None)

@overload
def PrivateEndpointConnectionByWorkspace(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = None,
                                         resource_group_name: Optional[str] = None,
                                         workspace_name: Optional[str] = None,
                                         private_endpoint_connection_name: Optional[str] = None)
func NewPrivateEndpointConnectionByWorkspace(ctx *Context, name string, args PrivateEndpointConnectionByWorkspaceArgs, opts ...ResourceOption) (*PrivateEndpointConnectionByWorkspace, error)
public PrivateEndpointConnectionByWorkspace(string name, PrivateEndpointConnectionByWorkspaceArgs args, CustomResourceOptions? opts = null)
public PrivateEndpointConnectionByWorkspace(String name, PrivateEndpointConnectionByWorkspaceArgs args)
public PrivateEndpointConnectionByWorkspace(String name, PrivateEndpointConnectionByWorkspaceArgs args, CustomResourceOptions options)

type: azure-native:desktopvirtualization:PrivateEndpointConnectionByWorkspace
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. PrivateEndpointConnectionByWorkspaceArgs
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. PrivateEndpointConnectionByWorkspaceArgs
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. PrivateEndpointConnectionByWorkspaceArgs
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. PrivateEndpointConnectionByWorkspaceArgs
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. PrivateEndpointConnectionByWorkspaceArgs
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 privateEndpointConnectionByWorkspaceResource = new AzureNative.Desktopvirtualization.PrivateEndpointConnectionByWorkspace("privateEndpointConnectionByWorkspaceResource", new()
{
    PrivateLinkServiceConnectionState = 
    {
        { "actionsRequired", "string" },
        { "description", "string" },
        { "status", "string" },
    },
    ResourceGroupName = "string",
    WorkspaceName = "string",
    PrivateEndpointConnectionName = "string",
});
Copy
example, err := desktopvirtualization.NewPrivateEndpointConnectionByWorkspace(ctx, "privateEndpointConnectionByWorkspaceResource", &desktopvirtualization.PrivateEndpointConnectionByWorkspaceArgs{
	PrivateLinkServiceConnectionState: map[string]interface{}{
		"actionsRequired": "string",
		"description":     "string",
		"status":          "string",
	},
	ResourceGroupName:             "string",
	WorkspaceName:                 "string",
	PrivateEndpointConnectionName: "string",
})
Copy
var privateEndpointConnectionByWorkspaceResource = new PrivateEndpointConnectionByWorkspace("privateEndpointConnectionByWorkspaceResource", PrivateEndpointConnectionByWorkspaceArgs.builder()
    .privateLinkServiceConnectionState(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .workspaceName("string")
    .privateEndpointConnectionName("string")
    .build());
Copy
private_endpoint_connection_by_workspace_resource = azure_native.desktopvirtualization.PrivateEndpointConnectionByWorkspace("privateEndpointConnectionByWorkspaceResource",
    private_link_service_connection_state={
        actionsRequired: string,
        description: string,
        status: string,
    },
    resource_group_name=string,
    workspace_name=string,
    private_endpoint_connection_name=string)
Copy
const privateEndpointConnectionByWorkspaceResource = new azure_native.desktopvirtualization.PrivateEndpointConnectionByWorkspace("privateEndpointConnectionByWorkspaceResource", {
    privateLinkServiceConnectionState: {
        actionsRequired: "string",
        description: "string",
        status: "string",
    },
    resourceGroupName: "string",
    workspaceName: "string",
    privateEndpointConnectionName: "string",
});
Copy
type: azure-native:desktopvirtualization:PrivateEndpointConnectionByWorkspace
properties:
    privateEndpointConnectionName: string
    privateLinkServiceConnectionState:
        actionsRequired: string
        description: string
        status: string
    resourceGroupName: string
    workspaceName: string
Copy

PrivateEndpointConnectionByWorkspace 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 PrivateEndpointConnectionByWorkspace resource accepts the following input properties:

PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.DesktopVirtualization.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.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace
PrivateEndpointConnectionName Changes to this property will trigger replacement. string
The name of the private endpoint connection associated with the Azure resource
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.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace
PrivateEndpointConnectionName Changes to this property will trigger replacement. string
The name of the private endpoint connection associated with the Azure resource
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.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace
privateEndpointConnectionName Changes to this property will trigger replacement. String
The name of the private endpoint connection associated with the Azure resource
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.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace
privateEndpointConnectionName Changes to this property will trigger replacement. string
The name of the private endpoint connection associated with the Azure resource
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.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace
private_endpoint_connection_name Changes to this property will trigger replacement. str
The name of the private endpoint connection associated with the Azure resource
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.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace
privateEndpointConnectionName Changes to this property will trigger replacement. String
The name of the private endpoint connection associated with the Azure resource

Outputs

All input properties are implicitly available as output properties. Additionally, the PrivateEndpointConnectionByWorkspace 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
The provisioning state of the private endpoint connection resource.
SystemData Pulumi.AzureNative.DesktopVirtualization.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint Pulumi.AzureNative.DesktopVirtualization.Outputs.PrivateEndpointResponse
The resource of private end point.
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
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint PrivateEndpointResponse
The resource of private end point.
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
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
The resource of private end point.
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
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
The resource of private end point.
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
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
private_endpoint PrivateEndpointResponse
The resource of private end point.
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
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint Property Map
The resource of private end point.

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.DesktopVirtualization.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:desktopvirtualization:PrivateEndpointConnectionByWorkspace workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native