azure-native.security.getPrivateLink

Azure Native v3.13.0, Jan 28 26

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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

Using getPrivateLink

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 getPrivateLink(args: GetPrivateLinkArgs, opts?: InvokeOptions): Promise<GetPrivateLinkResult>
function getPrivateLinkOutput(args: GetPrivateLinkOutputArgs, opts?: InvokeOptions): Output<GetPrivateLinkResult>

def get_private_link(private_link_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPrivateLinkResult
def get_private_link_output(private_link_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPrivateLinkResult]

func LookupPrivateLink(ctx *Context, args *LookupPrivateLinkArgs, opts ...InvokeOption) (*LookupPrivateLinkResult, error)
func LookupPrivateLinkOutput(ctx *Context, args *LookupPrivateLinkOutputArgs, opts ...InvokeOption) LookupPrivateLinkResultOutput

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

public static class GetPrivateLink 
{
    public static Task<GetPrivateLinkResult> InvokeAsync(GetPrivateLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateLinkResult> Invoke(GetPrivateLinkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPrivateLinkResult> getPrivateLink(GetPrivateLinkArgs args, InvokeOptions options)
public static Output<GetPrivateLinkResult> getPrivateLink(GetPrivateLinkArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:security:getPrivateLink
  arguments:
    # arguments dictionary

The following arguments are supported:

PrivateLinkName string: The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

PrivateLinkName string: The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

privateLinkName String: The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
resourceGroupName String: The name of the resource group. The name is case insensitive.

privateLinkName string: The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
resourceGroupName string: The name of the resource group. The name is case insensitive.

private_link_name str: The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
resource_group_name str: The name of the resource group. The name is case insensitive.

privateLinkName String: The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getPrivateLink 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. E.g. "/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.Security.Outputs.PrivateEndpointConnectionResponse>: List of private endpoint connections associated with this private link. Each connection represents a private endpoint from a customer's virtual network.
PrivateLinkResources List<Pulumi.AzureNative.Security.Outputs.PrivateLinkResourceResponse>: List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.
ProvisioningState string: The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully.
SystemData Pulumi.AzureNative.Security.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags Dictionary<string, string>: Resource tags.

AzureApiVersion string: The Azure API version of the resource.
Id string: Fully qualified resource ID for the resource. E.g. "/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 []PrivateEndpointConnectionResponse: List of private endpoint connections associated with this private link. Each connection represents a private endpoint from a customer's virtual network.
PrivateLinkResources []PrivateLinkResourceResponse: List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.
ProvisioningState string: The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags map[string]string: Resource tags.

azureApiVersion String: The Azure API version of the resource.
id String: Fully qualified resource ID for the resource. E.g. "/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<PrivateEndpointConnectionResponse>: List of private endpoint connections associated with this private link. Each connection represents a private endpoint from a customer's virtual network.
privateLinkResources List<PrivateLinkResourceResponse>: List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.
provisioningState String: The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String,String>: Resource tags.

azureApiVersion string: The Azure API version of the resource.
id string: Fully qualified resource ID for the resource. E.g. "/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 PrivateEndpointConnectionResponse[]: List of private endpoint connections associated with this private link. Each connection represents a private endpoint from a customer's virtual network.
privateLinkResources PrivateLinkResourceResponse[]: List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.
provisioningState string: The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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. E.g. "/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[PrivateEndpointConnectionResponse]: List of private endpoint connections associated with this private link. Each connection represents a private endpoint from a customer's virtual network.
private_link_resources Sequence[PrivateLinkResourceResponse]: List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.
provisioning_state str: The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Mapping[str, str]: Resource tags.

azureApiVersion String: The Azure API version of the resource.
id String: Fully qualified resource ID for the resource. E.g. "/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 associated with this private link. Each connection represents a private endpoint from a customer's virtual network.
privateLinkResources List<Property Map>: List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.
provisioningState String: The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String>: Resource tags.

Supporting Types

PrivateEndpointConnectionResponse

GroupIds List<string>: The group ids for the private endpoint resource.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string: The name of the resource
PrivateLinkServiceConnectionState Pulumi.AzureNative.Security.Inputs.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.Security.Inputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint Pulumi.AzureNative.Security.Inputs.PrivateEndpointResponse: The private endpoint resource.

GroupIds []string: The group ids for the private endpoint resource.
Id string: Fully qualified resource ID for the resource. E.g. "/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: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint PrivateEndpointResponse: The private endpoint resource.

groupIds List<String>: The group ids for the private endpoint resource.
id String: Fully qualified resource ID for the resource. E.g. "/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: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse: The private endpoint resource.

groupIds string[]: The group ids for the private endpoint resource.
id string: Fully qualified resource ID for the resource. E.g. "/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: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse: The private endpoint resource.

group_ids Sequence[str]: The group ids for the private endpoint resource.
id str: Fully qualified resource ID for the resource. E.g. "/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: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
private_endpoint PrivateEndpointResponse: The private endpoint resource.

groupIds List<String>: The group ids for the private endpoint resource.
id String: Fully qualified resource ID for the resource. E.g. "/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: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint Property Map: The private endpoint resource.

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.

PrivateLinkResourceResponse

GroupId string: The private link resource group id.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string: The name of the resource
RequiredMembers List<string>: The private link resource required member names.
SystemData Pulumi.AzureNative.Security.Inputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
RequiredZoneNames List<string>: The private link resource private link DNS zone name.

GroupId string: The private link resource group id.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string: The name of the resource
RequiredMembers []string: The private link resource required member names.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
RequiredZoneNames []string: The private link resource private link DNS zone name.

groupId String: The private link resource group id.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String: The name of the resource
requiredMembers List<String>: The private link resource required member names.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
requiredZoneNames List<String>: The private link resource private link DNS zone name.

groupId string: The private link resource group id.
id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string: The name of the resource
requiredMembers string[]: The private link resource required member names.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
requiredZoneNames string[]: The private link resource private link DNS zone name.

group_id str: The private link resource group id.
id str: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str: The name of the resource
required_members Sequence[str]: The private link resource required member names.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
required_zone_names Sequence[str]: The private link resource private link DNS zone name.

groupId String: The private link resource group id.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String: The name of the resource
requiredMembers List<String>: The private link resource required member names.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
requiredZoneNames List<String>: The private link resource private link DNS zone name.

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.