Azure Native v3.2.0, Apr 14 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.streamanalytics.getPrivateEndpoint

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Using getPrivateEndpoint

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.

TypeScript
Python
Go
C#
Java
YAML

function getPrivateEndpoint(args: GetPrivateEndpointArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointResult>
function getPrivateEndpointOutput(args: GetPrivateEndpointOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointResult>

def get_private_endpoint(cluster_name: Optional[str] = None,
                         private_endpoint_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointResult
def get_private_endpoint_output(cluster_name: Optional[pulumi.Input[str]] = None,
                         private_endpoint_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointResult]

func LookupPrivateEndpoint(ctx *Context, args *LookupPrivateEndpointArgs, opts ...InvokeOption) (*LookupPrivateEndpointResult, error)
func LookupPrivateEndpointOutput(ctx *Context, args *LookupPrivateEndpointOutputArgs, opts ...InvokeOption) LookupPrivateEndpointResultOutput

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

public static class GetPrivateEndpoint 
{
    public static Task<GetPrivateEndpointResult> InvokeAsync(GetPrivateEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateEndpointResult> Invoke(GetPrivateEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPrivateEndpointResult> getPrivateEndpoint(GetPrivateEndpointArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointResult> getPrivateEndpoint(GetPrivateEndpointArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:streamanalytics:getPrivateEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterName string: The name of the cluster.
PrivateEndpointName string: The name of the private endpoint.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

ClusterName string: The name of the cluster.
PrivateEndpointName string: The name of the private endpoint.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

clusterName String: The name of the cluster.
privateEndpointName String: The name of the private endpoint.
resourceGroupName String: The name of the resource group. The name is case insensitive.

clusterName string: The name of the cluster.
privateEndpointName string: The name of the private endpoint.
resourceGroupName string: The name of the resource group. The name is case insensitive.

cluster_name str: The name of the cluster.
private_endpoint_name str: The name of the private endpoint.
resource_group_name str: The name of the resource group. The name is case insensitive.

clusterName String: The name of the cluster.
privateEndpointName String: The name of the private endpoint.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getPrivateEndpoint Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
CreatedDate string: The date when this private endpoint was created.
Etag string: Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
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
Type string: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
ManualPrivateLinkServiceConnections List<Pulumi.AzureNative.StreamAnalytics.Outputs.PrivateLinkServiceConnectionResponse>: A list of connections to the remote resource. Immutable after it is set.

AzureApiVersion string: The Azure API version of the resource.
CreatedDate string: The date when this private endpoint was created.
Etag string: Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
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
Type string: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
ManualPrivateLinkServiceConnections []PrivateLinkServiceConnectionResponse: A list of connections to the remote resource. Immutable after it is set.

azureApiVersion String: The Azure API version of the resource.
createdDate String: The date when this private endpoint was created.
etag String: Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
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
type String: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
manualPrivateLinkServiceConnections List<PrivateLinkServiceConnectionResponse>: A list of connections to the remote resource. Immutable after it is set.

azureApiVersion string: The Azure API version of the resource.
createdDate string: The date when this private endpoint was created.
etag string: Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
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
type string: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
manualPrivateLinkServiceConnections PrivateLinkServiceConnectionResponse[]: A list of connections to the remote resource. Immutable after it is set.

azure_api_version str: The Azure API version of the resource.
created_date str: The date when this private endpoint was created.
etag str: Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
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
type str: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
manual_private_link_service_connections Sequence[PrivateLinkServiceConnectionResponse]: A list of connections to the remote resource. Immutable after it is set.

azureApiVersion String: The Azure API version of the resource.
createdDate String: The date when this private endpoint was created.
etag String: Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
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
type String: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
manualPrivateLinkServiceConnections List<Property Map>: A list of connections to the remote resource. Immutable after it is set.

Supporting Types

PrivateLinkConnectionStateResponse

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 remote resource/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 remote resource/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 remote resource/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 remote resource/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 remote resource/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 remote resource/service.

PrivateLinkServiceConnectionResponse

RequestMessage string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
GroupIds List<string>: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
PrivateLinkServiceConnectionState Pulumi.AzureNative.StreamAnalytics.Inputs.PrivateLinkConnectionStateResponse: A collection of read-only information about the state of the connection to the private remote resource.
PrivateLinkServiceId string: The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.

RequestMessage string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
GroupIds []string: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
PrivateLinkServiceConnectionState PrivateLinkConnectionStateResponse: A collection of read-only information about the state of the connection to the private remote resource.
PrivateLinkServiceId string: The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.

requestMessage String: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
groupIds List<String>: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
privateLinkServiceConnectionState PrivateLinkConnectionStateResponse: A collection of read-only information about the state of the connection to the private remote resource.
privateLinkServiceId String: The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.

requestMessage string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
groupIds string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
privateLinkServiceConnectionState PrivateLinkConnectionStateResponse: A collection of read-only information about the state of the connection to the private remote resource.
privateLinkServiceId string: The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.

request_message str: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
group_ids Sequence[str]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
private_link_service_connection_state PrivateLinkConnectionStateResponse: A collection of read-only information about the state of the connection to the private remote resource.
private_link_service_id str: The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.

requestMessage String: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
groupIds List<String>: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.
privateLinkServiceConnectionState Property Map: A collection of read-only information about the state of the connection to the private remote resource.
privateLinkServiceId String: The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.streamanalytics.getPrivateEndpoint

On this page

On this page

Using getPrivateEndpoint

getPrivateEndpoint Result

Supporting Types

PrivateLinkConnectionStateResponse

PrivateLinkServiceConnectionResponse

Package Details

On this page

On this page