Azure Native

v1.87.0 published on Tuesday, Nov 22, 2022 by Pulumi

getPrivateEndpointConnectionByName

The Private Endpoint Connection resource. API Version: 2021-04-01-preview.

Using getPrivateEndpointConnectionByName

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 getPrivateEndpointConnectionByName(args: GetPrivateEndpointConnectionByNameArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointConnectionByNameResult>
function getPrivateEndpointConnectionByNameOutput(args: GetPrivateEndpointConnectionByNameOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointConnectionByNameResult>

def get_private_endpoint_connection_by_name(private_endpoint_connection_name: Optional[str] = None,
                                            resource_group_name: Optional[str] = None,
                                            service_name: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionByNameResult
def get_private_endpoint_connection_by_name_output(private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                            resource_group_name: Optional[pulumi.Input[str]] = None,
                                            service_name: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointConnectionByNameResult]

func LookupPrivateEndpointConnectionByName(ctx *Context, args *LookupPrivateEndpointConnectionByNameArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionByNameResult, error)
func LookupPrivateEndpointConnectionByNameOutput(ctx *Context, args *LookupPrivateEndpointConnectionByNameOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionByNameResultOutput

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

public static class GetPrivateEndpointConnectionByName 
{
    public static Task<GetPrivateEndpointConnectionByNameResult> InvokeAsync(GetPrivateEndpointConnectionByNameArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateEndpointConnectionByNameResult> Invoke(GetPrivateEndpointConnectionByNameInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPrivateEndpointConnectionByNameResult> getPrivateEndpointConnectionByName(GetPrivateEndpointConnectionByNameArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:apimanagement:getPrivateEndpointConnectionByName
  arguments:
    # arguments dictionary

The following arguments are supported:

PrivateEndpointConnectionName string: Name of the private endpoint connection.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.

PrivateEndpointConnectionName string: Name of the private endpoint connection.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.

privateEndpointConnectionName String: Name of the private endpoint connection.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.

privateEndpointConnectionName string: Name of the private endpoint connection.
resourceGroupName string: The name of the resource group.
serviceName string: The name of the API Management service.

private_endpoint_connection_name str: Name of the private endpoint connection.
resource_group_name str: The name of the resource group.
service_name str: The name of the API Management service.

privateEndpointConnectionName String: Name of the private endpoint connection.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.

getPrivateEndpointConnectionByName 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.ApiManagement.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.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint Pulumi.AzureNative.ApiManagement.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.
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.
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.
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.
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.
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.

Package Details

Repository: https://github.com/pulumi/pulumi-azure-native
License: Apache-2.0