Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. signalrservice
  5. getSignalRPrivateEndpointConnection
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.signalrservice.getSignalRPrivateEndpointConnection

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

Get the specified private endpoint connection Azure REST API version: 2023-02-01.

Other available API versions: 2023-03-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2024-01-01-preview, 2024-03-01, 2024-04-01-preview, 2024-08-01-preview, 2024-10-01-preview.

Using getSignalRPrivateEndpointConnection

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 getSignalRPrivateEndpointConnection(args: GetSignalRPrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetSignalRPrivateEndpointConnectionResult>
function getSignalRPrivateEndpointConnectionOutput(args: GetSignalRPrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetSignalRPrivateEndpointConnectionResult>
Copy
def get_signal_r_private_endpoint_connection(private_endpoint_connection_name: Optional[str] = None,
                                             resource_group_name: Optional[str] = None,
                                             resource_name: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetSignalRPrivateEndpointConnectionResult
def get_signal_r_private_endpoint_connection_output(private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                             resource_group_name: Optional[pulumi.Input[str]] = None,
                                             resource_name: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetSignalRPrivateEndpointConnectionResult]
Copy
func LookupSignalRPrivateEndpointConnection(ctx *Context, args *LookupSignalRPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupSignalRPrivateEndpointConnectionResult, error)
func LookupSignalRPrivateEndpointConnectionOutput(ctx *Context, args *LookupSignalRPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupSignalRPrivateEndpointConnectionResultOutput
Copy

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

public static class GetSignalRPrivateEndpointConnection 
{
    public static Task<GetSignalRPrivateEndpointConnectionResult> InvokeAsync(GetSignalRPrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetSignalRPrivateEndpointConnectionResult> Invoke(GetSignalRPrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSignalRPrivateEndpointConnectionResult> getSignalRPrivateEndpointConnection(GetSignalRPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetSignalRPrivateEndpointConnectionResult> getSignalRPrivateEndpointConnection(GetSignalRPrivateEndpointConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:signalrservice:getSignalRPrivateEndpointConnection
  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
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint connection
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint connection
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the private endpoint connection
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint connection
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.

getSignalRPrivateEndpointConnection Result

The following output properties are available:

GroupIds List<string>
Group IDs
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
ProvisioningState string
Provisioning state of the resource.
SystemData Pulumi.AzureNative.SignalRService.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
PrivateEndpoint Pulumi.AzureNative.SignalRService.Outputs.PrivateEndpointResponse
Private endpoint
PrivateLinkServiceConnectionState Pulumi.AzureNative.SignalRService.Outputs.PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection
GroupIds []string
Group IDs
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
ProvisioningState string
Provisioning state of the resource.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
PrivateEndpoint PrivateEndpointResponse
Private endpoint
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection
groupIds List<String>
Group IDs
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
provisioningState String
Provisioning state of the resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
privateEndpoint PrivateEndpointResponse
Private endpoint
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection
groupIds string[]
Group IDs
id string
Fully qualified resource Id for the resource.
name string
The name of the resource.
provisioningState string
Provisioning state of the resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
privateEndpoint PrivateEndpointResponse
Private endpoint
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection
group_ids Sequence[str]
Group IDs
id str
Fully qualified resource Id for the resource.
name str
The name of the resource.
provisioning_state str
Provisioning state of the resource.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
private_endpoint PrivateEndpointResponse
Private endpoint
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection
groupIds List<String>
Group IDs
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
provisioningState String
Provisioning state of the resource.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
privateEndpoint Property Map
Private endpoint
privateLinkServiceConnectionState Property Map
Connection state of the private endpoint connection

Supporting Types

PrivateEndpointResponse

Id string
Full qualified Id of the private endpoint
Id string
Full qualified Id of the private endpoint
id String
Full qualified Id of the private endpoint
id string
Full qualified Id of the private endpoint
id str
Full qualified Id of the private endpoint
id String
Full qualified Id of the 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-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