Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. getPrivateLinkHub
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.getPrivateLinkHub

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a privateLinkHub

Uses Azure REST API version 2021-06-01.

Other available API versions: 2021-04-01-preview, 2021-05-01, 2021-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native synapse [ApiVersion]. See the version guide for details.

Using getPrivateLinkHub

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 getPrivateLinkHub(args: GetPrivateLinkHubArgs, opts?: InvokeOptions): Promise<GetPrivateLinkHubResult>
function getPrivateLinkHubOutput(args: GetPrivateLinkHubOutputArgs, opts?: InvokeOptions): Output<GetPrivateLinkHubResult>
Copy
def get_private_link_hub(private_link_hub_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPrivateLinkHubResult
def get_private_link_hub_output(private_link_hub_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPrivateLinkHubResult]
Copy
func LookupPrivateLinkHub(ctx *Context, args *LookupPrivateLinkHubArgs, opts ...InvokeOption) (*LookupPrivateLinkHubResult, error)
func LookupPrivateLinkHubOutput(ctx *Context, args *LookupPrivateLinkHubOutputArgs, opts ...InvokeOption) LookupPrivateLinkHubResultOutput
Copy

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

public static class GetPrivateLinkHub 
{
    public static Task<GetPrivateLinkHubResult> InvokeAsync(GetPrivateLinkHubArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateLinkHubResult> Invoke(GetPrivateLinkHubInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPrivateLinkHubResult> getPrivateLinkHub(GetPrivateLinkHubArgs args, InvokeOptions options)
public static Output<GetPrivateLinkHubResult> getPrivateLinkHub(GetPrivateLinkHubArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:synapse:getPrivateLinkHub
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PrivateLinkHubName
This property is required.
Changes to this property will trigger replacement.
string
Name of the privateLinkHub
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
PrivateLinkHubName
This property is required.
Changes to this property will trigger replacement.
string
Name of the privateLinkHub
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
privateLinkHubName
This property is required.
Changes to this property will trigger replacement.
String
Name of the privateLinkHub
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
privateLinkHubName
This property is required.
Changes to this property will trigger replacement.
string
Name of the privateLinkHub
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
private_link_hub_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the privateLinkHub
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
privateLinkHubName
This property is required.
Changes to this property will trigger replacement.
String
Name of the privateLinkHub
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getPrivateLinkHub Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
PrivateEndpointConnections List<Pulumi.AzureNative.Synapse.Outputs.PrivateEndpointConnectionForPrivateLinkHubBasicResponse>
List of private endpoint connections
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ProvisioningState string
PrivateLinkHub provisioning state
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
PrivateEndpointConnections []PrivateEndpointConnectionForPrivateLinkHubBasicResponse
List of private endpoint connections
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ProvisioningState string
PrivateLinkHub provisioning state
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
privateEndpointConnections List<PrivateEndpointConnectionForPrivateLinkHubBasicResponse>
List of private endpoint connections
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
provisioningState String
PrivateLinkHub provisioning state
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
privateEndpointConnections PrivateEndpointConnectionForPrivateLinkHubBasicResponse[]
List of private endpoint connections
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
provisioningState string
PrivateLinkHub provisioning state
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
private_endpoint_connections Sequence[PrivateEndpointConnectionForPrivateLinkHubBasicResponse]
List of private endpoint connections
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
provisioning_state str
PrivateLinkHub provisioning state
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
privateEndpointConnections List<Property Map>
List of private endpoint connections
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
provisioningState String
PrivateLinkHub provisioning state
tags Map<String>
Resource tags.

Supporting Types

PrivateEndpointConnectionForPrivateLinkHubBasicResponse

Id This property is required. string
identifier
ProvisioningState This property is required. string
Provisioning state of the private endpoint connection.
PrivateEndpoint Pulumi.AzureNative.Synapse.Inputs.PrivateEndpointResponse
The private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Synapse.Inputs.PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
Id This property is required. string
identifier
ProvisioningState This property is required. string
Provisioning state of the private endpoint connection.
PrivateEndpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
id This property is required. String
identifier
provisioningState This property is required. String
Provisioning state of the private endpoint connection.
privateEndpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
id This property is required. string
identifier
provisioningState This property is required. string
Provisioning state of the private endpoint connection.
privateEndpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
id This property is required. str
identifier
provisioning_state This property is required. str
Provisioning state of the private endpoint connection.
private_endpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
id This property is required. String
identifier
provisioningState This property is required. String
Provisioning state of the private endpoint connection.
privateEndpoint Property Map
The private endpoint which the connection belongs to.
privateLinkServiceConnectionState Property Map
Connection state of the private endpoint connection.

PrivateEndpointResponse

Id This property is required. string
Resource id of the private endpoint.
Id This property is required. string
Resource id of the private endpoint.
id This property is required. String
Resource id of the private endpoint.
id This property is required. string
Resource id of the private endpoint.
id This property is required. str
Resource id of the private endpoint.
id This property is required. String
Resource id of the private endpoint.

PrivateLinkServiceConnectionStateResponse

ActionsRequired This property is required. string
The actions required for private link service connection.
Description string
The private link service connection description.
Status string
The private link service connection status.
ActionsRequired This property is required. string
The actions required for private link service connection.
Description string
The private link service connection description.
Status string
The private link service connection status.
actionsRequired This property is required. String
The actions required for private link service connection.
description String
The private link service connection description.
status String
The private link service connection status.
actionsRequired This property is required. string
The actions required for private link service connection.
description string
The private link service connection description.
status string
The private link service connection status.
actions_required This property is required. str
The actions required for private link service connection.
description str
The private link service connection description.
status str
The private link service connection status.
actionsRequired This property is required. String
The actions required for private link service connection.
description String
The private link service connection description.
status String
The private link service connection status.

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native