1. Packages
  2. Azure Native
  3. API Docs
  4. desktopvirtualization
  5. getPrivateEndpointConnectionByHostPool
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.66.0 published on Wednesday, Oct 9, 2024 by Pulumi

azure-native.desktopvirtualization.getPrivateEndpointConnectionByHostPool

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.66.0 published on Wednesday, Oct 9, 2024 by Pulumi

    Get a private endpoint connection. Azure REST API version: 2022-10-14-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.

    Using getPrivateEndpointConnectionByHostPool

    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 getPrivateEndpointConnectionByHostPool(args: GetPrivateEndpointConnectionByHostPoolArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointConnectionByHostPoolResult>
    function getPrivateEndpointConnectionByHostPoolOutput(args: GetPrivateEndpointConnectionByHostPoolOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointConnectionByHostPoolResult>
    def get_private_endpoint_connection_by_host_pool(host_pool_name: Optional[str] = None,
                                                     private_endpoint_connection_name: Optional[str] = None,
                                                     resource_group_name: Optional[str] = None,
                                                     opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionByHostPoolResult
    def get_private_endpoint_connection_by_host_pool_output(host_pool_name: Optional[pulumi.Input[str]] = None,
                                                     private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                                     resource_group_name: Optional[pulumi.Input[str]] = None,
                                                     opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointConnectionByHostPoolResult]
    func LookupPrivateEndpointConnectionByHostPool(ctx *Context, args *LookupPrivateEndpointConnectionByHostPoolArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionByHostPoolResult, error)
    func LookupPrivateEndpointConnectionByHostPoolOutput(ctx *Context, args *LookupPrivateEndpointConnectionByHostPoolOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionByHostPoolResultOutput

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

    public static class GetPrivateEndpointConnectionByHostPool 
    {
        public static Task<GetPrivateEndpointConnectionByHostPoolResult> InvokeAsync(GetPrivateEndpointConnectionByHostPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetPrivateEndpointConnectionByHostPoolResult> Invoke(GetPrivateEndpointConnectionByHostPoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPrivateEndpointConnectionByHostPoolResult> getPrivateEndpointConnectionByHostPool(GetPrivateEndpointConnectionByHostPoolArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:desktopvirtualization:getPrivateEndpointConnectionByHostPool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    HostPoolName string
    The name of the host pool within the specified resource group
    PrivateEndpointConnectionName string
    The name of the private endpoint connection associated with the Azure resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    HostPoolName string
    The name of the host pool within the specified resource group
    PrivateEndpointConnectionName string
    The name of the private endpoint connection associated with the Azure resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    hostPoolName String
    The name of the host pool within the specified resource group
    privateEndpointConnectionName String
    The name of the private endpoint connection associated with the Azure resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    hostPoolName string
    The name of the host pool within the specified resource group
    privateEndpointConnectionName string
    The name of the private endpoint connection associated with the Azure resource
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    host_pool_name str
    The name of the host pool within the specified resource group
    private_endpoint_connection_name str
    The name of the private endpoint connection associated with the Azure resource
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    hostPoolName String
    The name of the host pool within the specified resource group
    privateEndpointConnectionName String
    The name of the private endpoint connection associated with the Azure resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getPrivateEndpointConnectionByHostPool Result

    The following output properties are available:

    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.DesktopVirtualization.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.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
    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.
    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.
    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.
    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.
    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 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.66.0 published on Wednesday, Oct 9, 2024 by Pulumi