1. Packages
  2. Azure Native v2
  3. API Docs
  4. aadiam
  5. getPrivateLinkForAzureAd
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.aadiam.getPrivateLinkForAzureAd

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets a private link policy with a given name. Azure REST API version: 2020-03-01.

Using getPrivateLinkForAzureAd

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 getPrivateLinkForAzureAd(args: GetPrivateLinkForAzureAdArgs, opts?: InvokeOptions): Promise<GetPrivateLinkForAzureAdResult>
function getPrivateLinkForAzureAdOutput(args: GetPrivateLinkForAzureAdOutputArgs, opts?: InvokeOptions): Output<GetPrivateLinkForAzureAdResult>
Copy
def get_private_link_for_azure_ad(policy_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetPrivateLinkForAzureAdResult
def get_private_link_for_azure_ad_output(policy_name: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetPrivateLinkForAzureAdResult]
Copy
func LookupPrivateLinkForAzureAd(ctx *Context, args *LookupPrivateLinkForAzureAdArgs, opts ...InvokeOption) (*LookupPrivateLinkForAzureAdResult, error)
func LookupPrivateLinkForAzureAdOutput(ctx *Context, args *LookupPrivateLinkForAzureAdOutputArgs, opts ...InvokeOption) LookupPrivateLinkForAzureAdResultOutput
Copy

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

public static class GetPrivateLinkForAzureAd 
{
    public static Task<GetPrivateLinkForAzureAdResult> InvokeAsync(GetPrivateLinkForAzureAdArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateLinkForAzureAdResult> Invoke(GetPrivateLinkForAzureAdInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPrivateLinkForAzureAdResult> getPrivateLinkForAzureAd(GetPrivateLinkForAzureAdArgs args, InvokeOptions options)
public static Output<GetPrivateLinkForAzureAdResult> getPrivateLinkForAzureAd(GetPrivateLinkForAzureAdArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:aadiam:getPrivateLinkForAzureAd
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private link policy in Azure AD.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
PolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private link policy in Azure AD.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
policyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private link policy in Azure AD.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure resource group.
policyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private link policy in Azure AD.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
policy_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the private link policy in Azure AD.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of an Azure resource group.
policyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private link policy in Azure AD.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure resource group.

getPrivateLinkForAzureAd Result

The following output properties are available:

Id string
String Id used to locate any resource on Azure.
Type string
Type of this resource.
AllTenants bool
Flag indicating whether all tenants are allowed
Name string
Name of this resource.
OwnerTenantId string
Guid of the owner tenant
ResourceGroup string
Name of the resource group
ResourceName string
Name of the private link policy resource
SubscriptionId string
Subscription Identifier
Tags Dictionary<string, string>
Resource tags.
Tenants List<string>
The list of tenantIds.
Id string
String Id used to locate any resource on Azure.
Type string
Type of this resource.
AllTenants bool
Flag indicating whether all tenants are allowed
Name string
Name of this resource.
OwnerTenantId string
Guid of the owner tenant
ResourceGroup string
Name of the resource group
ResourceName string
Name of the private link policy resource
SubscriptionId string
Subscription Identifier
Tags map[string]string
Resource tags.
Tenants []string
The list of tenantIds.
id String
String Id used to locate any resource on Azure.
type String
Type of this resource.
allTenants Boolean
Flag indicating whether all tenants are allowed
name String
Name of this resource.
ownerTenantId String
Guid of the owner tenant
resourceGroup String
Name of the resource group
resourceName String
Name of the private link policy resource
subscriptionId String
Subscription Identifier
tags Map<String,String>
Resource tags.
tenants List<String>
The list of tenantIds.
id string
String Id used to locate any resource on Azure.
type string
Type of this resource.
allTenants boolean
Flag indicating whether all tenants are allowed
name string
Name of this resource.
ownerTenantId string
Guid of the owner tenant
resourceGroup string
Name of the resource group
resourceName string
Name of the private link policy resource
subscriptionId string
Subscription Identifier
tags {[key: string]: string}
Resource tags.
tenants string[]
The list of tenantIds.
id str
String Id used to locate any resource on Azure.
type str
Type of this resource.
all_tenants bool
Flag indicating whether all tenants are allowed
name str
Name of this resource.
owner_tenant_id str
Guid of the owner tenant
resource_group str
Name of the resource group
resource_name str
Name of the private link policy resource
subscription_id str
Subscription Identifier
tags Mapping[str, str]
Resource tags.
tenants Sequence[str]
The list of tenantIds.
id String
String Id used to locate any resource on Azure.
type String
Type of this resource.
allTenants Boolean
Flag indicating whether all tenants are allowed
name String
Name of this resource.
ownerTenantId String
Guid of the owner tenant
resourceGroup String
Name of the resource group
resourceName String
Name of the private link policy resource
subscriptionId String
Subscription Identifier
tags Map<String>
Resource tags.
tenants List<String>
The list of tenantIds.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi