Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getPrivateEndpointConnection

Describes an existing Private Endpoint connection to the Azure Cognitive Search service. API Version: 2020-08-01.

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,
                                    search_service_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,
                                    search_service_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:search:getPrivateEndpointConnection
  Arguments:
    # Arguments dictionary

The following arguments are supported:

PrivateEndpointConnectionName string

The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.

ResourceGroupName string

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

SearchServiceName string

The name of the Azure Cognitive Search service associated with the specified resource group.

PrivateEndpointConnectionName string

The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.

ResourceGroupName string

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

SearchServiceName string

The name of the Azure Cognitive Search service associated with the specified resource group.

privateEndpointConnectionName String

The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.

resourceGroupName String

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

searchServiceName String

The name of the Azure Cognitive Search service associated with the specified resource group.

privateEndpointConnectionName string

The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.

resourceGroupName string

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

searchServiceName string

The name of the Azure Cognitive Search service associated with the specified resource group.

private_endpoint_connection_name str

The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.

resource_group_name str

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

search_service_name str

The name of the Azure Cognitive Search service associated with the specified resource group.

privateEndpointConnectionName String

The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.

resourceGroupName String

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

searchServiceName String

The name of the Azure Cognitive Search service associated with the specified resource group.

getPrivateEndpointConnection 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

Properties Pulumi.AzureNative.Search.Outputs.PrivateEndpointConnectionPropertiesResponse

Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.

Type string

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

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

Properties PrivateEndpointConnectionPropertiesResponse

Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.

Type string

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

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

properties PrivateEndpointConnectionPropertiesResponse

Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.

type String

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

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

properties PrivateEndpointConnectionPropertiesResponse

Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.

type string

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

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

properties PrivateEndpointConnectionPropertiesResponse

Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.

type str

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

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

properties Property Map

Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.

type String

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

Supporting Types

PrivateEndpointConnectionPropertiesResponse

PrivateEndpoint Pulumi.AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesResponsePrivateEndpoint

The private endpoint resource from Microsoft.Network provider.

PrivateLinkServiceConnectionState Pulumi.AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState

Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.

PrivateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint

The private endpoint resource from Microsoft.Network provider.

PrivateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState

Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.

privateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint

The private endpoint resource from Microsoft.Network provider.

privateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState

Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.

privateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint

The private endpoint resource from Microsoft.Network provider.

privateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState

Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.

private_endpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint

The private endpoint resource from Microsoft.Network provider.

private_link_service_connection_state PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState

Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.

privateEndpoint Property Map

The private endpoint resource from Microsoft.Network provider.

privateLinkServiceConnectionState Property Map

Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.

PrivateEndpointConnectionPropertiesResponsePrivateEndpoint

Id string

The resource id of the private endpoint resource from Microsoft.Network provider.

Id string

The resource id of the private endpoint resource from Microsoft.Network provider.

id String

The resource id of the private endpoint resource from Microsoft.Network provider.

id string

The resource id of the private endpoint resource from Microsoft.Network provider.

id str

The resource id of the private endpoint resource from Microsoft.Network provider.

id String

The resource id of the private endpoint resource from Microsoft.Network provider.

PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState

ActionsRequired string

A description of any extra actions that may be required.

Description string

The description for the private link service connection state.

Status string

Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.

ActionsRequired string

A description of any extra actions that may be required.

Description string

The description for the private link service connection state.

Status string

Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.

actionsRequired String

A description of any extra actions that may be required.

description String

The description for the private link service connection state.

status String

Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.

actionsRequired string

A description of any extra actions that may be required.

description string

The description for the private link service connection state.

status string

Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.

actions_required str

A description of any extra actions that may be required.

description str

The description for the private link service connection state.

status str

Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.

actionsRequired String

A description of any extra actions that may be required.

description String

The description for the private link service connection state.

status String

Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.

Package Details

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