1. Packages
  2. Azure Native
  3. API Docs
  4. iotcentral
  5. getPrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.21.1 published on Wednesday, Dec 6, 2023 by Pulumi

azure-native.iotcentral.getPrivateEndpointConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.21.1 published on Wednesday, Dec 6, 2023 by Pulumi

    Get the metadata of a private endpoint connection for the IoT Central Application. Azure REST API version: 2021-11-01-preview.

    Using getPrivateEndpointConnection

    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 getPrivateEndpointConnection(args: GetPrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointConnectionResult>
    function getPrivateEndpointConnectionOutput(args: GetPrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointConnectionResult>
    def get_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) -> GetPrivateEndpointConnectionResult
    def get_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[GetPrivateEndpointConnectionResult]
    func LookupPrivateEndpointConnection(ctx *Context, args *LookupPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionResult, error)
    func LookupPrivateEndpointConnectionOutput(ctx *Context, args *LookupPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionResultOutput

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

    public static class GetPrivateEndpointConnection 
    {
        public static Task<GetPrivateEndpointConnectionResult> InvokeAsync(GetPrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetPrivateEndpointConnectionResult> Invoke(GetPrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:iotcentral:getPrivateEndpointConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PrivateEndpointConnectionName string

    The private endpoint connection name.

    ResourceGroupName string

    The name of the resource group that contains the IoT Central application.

    ResourceName string

    The ARM resource name of the IoT Central application.

    PrivateEndpointConnectionName string

    The private endpoint connection name.

    ResourceGroupName string

    The name of the resource group that contains the IoT Central application.

    ResourceName string

    The ARM resource name of the IoT Central application.

    privateEndpointConnectionName String

    The private endpoint connection name.

    resourceGroupName String

    The name of the resource group that contains the IoT Central application.

    resourceName String

    The ARM resource name of the IoT Central application.

    privateEndpointConnectionName string

    The private endpoint connection name.

    resourceGroupName string

    The name of the resource group that contains the IoT Central application.

    resourceName string

    The ARM resource name of the IoT Central application.

    private_endpoint_connection_name str

    The private endpoint connection name.

    resource_group_name str

    The name of the resource group that contains the IoT Central application.

    resource_name str

    The ARM resource name of the IoT Central application.

    privateEndpointConnectionName String

    The private endpoint connection name.

    resourceGroupName String

    The name of the resource group that contains the IoT Central application.

    resourceName String

    The ARM resource name of the IoT Central application.

    getPrivateEndpointConnection Result

    The following output properties are available:

    GroupIds List<string>

    The group ids for the private endpoint resource.

    Id string

    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

    Name string

    The name of the resource

    PrivateLinkServiceConnectionState Pulumi.AzureNative.IoTCentral.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.IoTCentral.Outputs.SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    PrivateEndpoint Pulumi.AzureNative.IoTCentral.Outputs.PrivateEndpointResponse

    The private endpoint resource.

    GroupIds []string

    The group ids for the private endpoint resource.

    Id string

    Fully qualified resource ID for the resource. E.g. "/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

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    PrivateEndpoint PrivateEndpointResponse

    The private endpoint resource.

    groupIds List<String>

    The group ids for the private endpoint resource.

    id String

    Fully qualified resource ID for the resource. E.g. "/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

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    privateEndpoint PrivateEndpointResponse

    The private endpoint resource.

    groupIds string[]

    The group ids for the private endpoint resource.

    id string

    Fully qualified resource ID for the resource. E.g. "/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

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    privateEndpoint PrivateEndpointResponse

    The private endpoint resource.

    group_ids Sequence[str]

    The group ids for the private endpoint resource.

    id str

    Fully qualified resource ID for the resource. E.g. "/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

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type str

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    private_endpoint PrivateEndpointResponse

    The private endpoint resource.

    groupIds List<String>

    The group ids for the private endpoint resource.

    id String

    Fully qualified resource ID for the resource. E.g. "/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

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    privateEndpoint Property Map

    The private endpoint resource.

    Supporting Types

    PrivateEndpointResponse

    Id string

    The ARM identifier for private endpoint.

    Id string

    The ARM identifier for private endpoint.

    id String

    The ARM identifier for private endpoint.

    id string

    The ARM identifier for private endpoint.

    id str

    The ARM identifier for private endpoint.

    id 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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.21.1 published on Wednesday, Dec 6, 2023 by Pulumi