1. Packages
  2. Azure Native v2
  3. API Docs
  4. devices
  5. getIotDpsResourcePrivateEndpointConnection
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

azure-native-v2.devices.getIotDpsResourcePrivateEndpointConnection

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

Get private endpoint connection properties Azure REST API version: 2022-12-12.

Other available API versions: 2023-03-01-preview, 2025-02-01-preview.

Using getIotDpsResourcePrivateEndpointConnection

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 getIotDpsResourcePrivateEndpointConnection(args: GetIotDpsResourcePrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetIotDpsResourcePrivateEndpointConnectionResult>
function getIotDpsResourcePrivateEndpointConnectionOutput(args: GetIotDpsResourcePrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetIotDpsResourcePrivateEndpointConnectionResult>
Copy
def get_iot_dps_resource_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) -> GetIotDpsResourcePrivateEndpointConnectionResult
def get_iot_dps_resource_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[GetIotDpsResourcePrivateEndpointConnectionResult]
Copy
func LookupIotDpsResourcePrivateEndpointConnection(ctx *Context, args *LookupIotDpsResourcePrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupIotDpsResourcePrivateEndpointConnectionResult, error)
func LookupIotDpsResourcePrivateEndpointConnectionOutput(ctx *Context, args *LookupIotDpsResourcePrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupIotDpsResourcePrivateEndpointConnectionResultOutput
Copy

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

public static class GetIotDpsResourcePrivateEndpointConnection 
{
    public static Task<GetIotDpsResourcePrivateEndpointConnectionResult> InvokeAsync(GetIotDpsResourcePrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetIotDpsResourcePrivateEndpointConnectionResult> Invoke(GetIotDpsResourcePrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIotDpsResourcePrivateEndpointConnectionResult> getIotDpsResourcePrivateEndpointConnection(GetIotDpsResourcePrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetIotDpsResourcePrivateEndpointConnectionResult> getIotDpsResourcePrivateEndpointConnection(GetIotDpsResourcePrivateEndpointConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:devices:getIotDpsResourcePrivateEndpointConnection
  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 provisioning service.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the provisioning service.
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 provisioning service.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the provisioning service.
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 provisioning service.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the provisioning service.
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 provisioning service.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the provisioning service.
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 provisioning service.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the provisioning service.
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 provisioning service.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the provisioning service.

getIotDpsResourcePrivateEndpointConnection Result

The following output properties are available:

Id string
The resource identifier.
Name string
The resource name.
Properties Pulumi.AzureNative.Devices.Outputs.PrivateEndpointConnectionPropertiesResponse
The properties of a private endpoint connection
SystemData Pulumi.AzureNative.Devices.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The resource type.
Id string
The resource identifier.
Name string
The resource name.
Properties PrivateEndpointConnectionPropertiesResponse
The properties of a private endpoint connection
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The resource type.
id String
The resource identifier.
name String
The resource name.
properties PrivateEndpointConnectionPropertiesResponse
The properties of a private endpoint connection
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The resource type.
id string
The resource identifier.
name string
The resource name.
properties PrivateEndpointConnectionPropertiesResponse
The properties of a private endpoint connection
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The resource type.
id str
The resource identifier.
name str
The resource name.
properties PrivateEndpointConnectionPropertiesResponse
The properties of a private endpoint connection
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The resource type.
id String
The resource identifier.
name String
The resource name.
properties Property Map
The properties of a private endpoint connection
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The resource type.

Supporting Types

PrivateEndpointConnectionPropertiesResponse

PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.Devices.Inputs.PrivateLinkServiceConnectionStateResponse
The current state of a private endpoint connection
PrivateEndpoint Pulumi.AzureNative.Devices.Inputs.PrivateEndpointResponse
The private endpoint property of a private endpoint connection
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
The current state of a private endpoint connection
PrivateEndpoint PrivateEndpointResponse
The private endpoint property of a private endpoint connection
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
The current state of a private endpoint connection
privateEndpoint PrivateEndpointResponse
The private endpoint property of a private endpoint connection
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
The current state of a private endpoint connection
privateEndpoint PrivateEndpointResponse
The private endpoint property of a private endpoint connection
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionStateResponse
The current state of a private endpoint connection
private_endpoint PrivateEndpointResponse
The private endpoint property of a private endpoint connection
privateLinkServiceConnectionState This property is required. Property Map
The current state of a private endpoint connection
privateEndpoint Property Map
The private endpoint property of a private endpoint connection

PrivateEndpointResponse

Id This property is required. string
The resource identifier.
Id This property is required. string
The resource identifier.
id This property is required. String
The resource identifier.
id This property is required. string
The resource identifier.
id This property is required. str
The resource identifier.
id This property is required. String
The resource identifier.

PrivateLinkServiceConnectionStateResponse

Description This property is required. string
The description for the current state of a private endpoint connection
Status This property is required. string
The status of a private endpoint connection
ActionsRequired string
Actions required for a private endpoint connection
Description This property is required. string
The description for the current state of a private endpoint connection
Status This property is required. string
The status of a private endpoint connection
ActionsRequired string
Actions required for a private endpoint connection
description This property is required. String
The description for the current state of a private endpoint connection
status This property is required. String
The status of a private endpoint connection
actionsRequired String
Actions required for a private endpoint connection
description This property is required. string
The description for the current state of a private endpoint connection
status This property is required. string
The status of a private endpoint connection
actionsRequired string
Actions required for a private endpoint connection
description This property is required. str
The description for the current state of a private endpoint connection
status This property is required. str
The status of a private endpoint connection
actions_required str
Actions required for a private endpoint connection
description This property is required. String
The description for the current state of a private endpoint connection
status This property is required. String
The status of a private endpoint connection
actionsRequired String
Actions required for a private endpoint connection

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