Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. healthcareapis
  5. getWorkspacePrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.healthcareapis.getWorkspacePrivateEndpointConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified private endpoint connection associated with the workspace.

Uses Azure REST API version 2024-03-31.

Other available API versions: 2022-10-01-preview, 2022-12-01, 2023-02-28, 2023-09-06, 2023-11-01, 2023-12-01, 2024-03-01, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native healthcareapis [ApiVersion]. See the version guide for details.

Using getWorkspacePrivateEndpointConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWorkspacePrivateEndpointConnection(args: GetWorkspacePrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetWorkspacePrivateEndpointConnectionResult>
function getWorkspacePrivateEndpointConnectionOutput(args: GetWorkspacePrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetWorkspacePrivateEndpointConnectionResult>
Copy
def get_workspace_private_endpoint_connection(private_endpoint_connection_name: Optional[str] = None,
                                              resource_group_name: Optional[str] = None,
                                              workspace_name: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetWorkspacePrivateEndpointConnectionResult
def get_workspace_private_endpoint_connection_output(private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                              resource_group_name: Optional[pulumi.Input[str]] = None,
                                              workspace_name: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetWorkspacePrivateEndpointConnectionResult]
Copy
func LookupWorkspacePrivateEndpointConnection(ctx *Context, args *LookupWorkspacePrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupWorkspacePrivateEndpointConnectionResult, error)
func LookupWorkspacePrivateEndpointConnectionOutput(ctx *Context, args *LookupWorkspacePrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupWorkspacePrivateEndpointConnectionResultOutput
Copy

> Note: This function is named LookupWorkspacePrivateEndpointConnection in the Go SDK.

public static class GetWorkspacePrivateEndpointConnection 
{
    public static Task<GetWorkspacePrivateEndpointConnectionResult> InvokeAsync(GetWorkspacePrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspacePrivateEndpointConnectionResult> Invoke(GetWorkspacePrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkspacePrivateEndpointConnectionResult> getWorkspacePrivateEndpointConnection(GetWorkspacePrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetWorkspacePrivateEndpointConnectionResult> getWorkspacePrivateEndpointConnection(GetWorkspacePrivateEndpointConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:healthcareapis:getWorkspacePrivateEndpointConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection associated with the Azure resource
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the service instance.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of workspace resource.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection associated with the Azure resource
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the service instance.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of workspace resource.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint connection associated with the Azure resource
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the service instance.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of workspace resource.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection associated with the Azure resource
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the service instance.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of workspace resource.
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the private endpoint connection associated with the Azure resource
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the service instance.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of workspace resource.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint connection associated with the Azure resource
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the service instance.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of workspace resource.

getWorkspacePrivateEndpointConnection Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
PrivateLinkServiceConnectionState Pulumi.AzureNative.HealthcareApis.Outputs.PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState string
The provisioning state of the private endpoint connection resource.
SystemData Pulumi.AzureNative.HealthcareApis.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.HealthcareApis.Outputs.PrivateEndpointResponse
The resource of private end point.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
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.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
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.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
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.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
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.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
privateLinkServiceConnectionState Property Map
A collection of information about the state of the connection between service consumer and provider.
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

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

PrivateLinkServiceConnectionStateResponse

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

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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native