Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. aadiam
  5. PrivateLinkForAzureAd
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.aadiam.PrivateLinkForAzureAd

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

PrivateLink Policy configuration object. API Version: 2020-03-01.

Example Usage

privateLinkPolicyCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var privateLinkForAzureAd = new AzureNative.AadIam.PrivateLinkForAzureAd("privateLinkForAzureAd", new()
    {
        AllTenants = false,
        Name = "myOrgPrivateLinkPolicy",
        OwnerTenantId = "950f8bca-bf4d-4a41-ad10-034e792a243d",
        PolicyName = "ddb1",
        ResourceGroup = "myOrgVnetRG",
        ResourceGroupName = "rg1",
        ResourceName = "myOrgVnetPrivateLink",
        SubscriptionId = "57849194-ea1f-470b-abda-d195b25634c1",
        Tenants = new[]
        {
            "3616657d-1c80-41ae-9d83-2a2776f2c9be",
            "727b6ef1-18ab-4627-ac95-3f9cd945ed87",
        },
    });

});
Copy
package main

import (
	aadiam "github.com/pulumi/pulumi-azure-native-sdk/aadiam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aadiam.NewprivateLinkForAzureAd(ctx, "privateLinkForAzureAd", &aadiam.privateLinkForAzureAdArgs{
			AllTenants:        pulumi.Bool(false),
			Name:              pulumi.String("myOrgPrivateLinkPolicy"),
			OwnerTenantId:     pulumi.String("950f8bca-bf4d-4a41-ad10-034e792a243d"),
			PolicyName:        pulumi.String("ddb1"),
			ResourceGroup:     pulumi.String("myOrgVnetRG"),
			ResourceGroupName: pulumi.String("rg1"),
			ResourceName:      pulumi.String("myOrgVnetPrivateLink"),
			SubscriptionId:    pulumi.String("57849194-ea1f-470b-abda-d195b25634c1"),
			Tenants: pulumi.StringArray{
				pulumi.String("3616657d-1c80-41ae-9d83-2a2776f2c9be"),
				pulumi.String("727b6ef1-18ab-4627-ac95-3f9cd945ed87"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.aadiam.privateLinkForAzureAd;
import com.pulumi.azurenative.aadiam.PrivateLinkForAzureAdArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var privateLinkForAzureAd = new PrivateLinkForAzureAd("privateLinkForAzureAd", PrivateLinkForAzureAdArgs.builder()        
            .allTenants(false)
            .name("myOrgPrivateLinkPolicy")
            .ownerTenantId("950f8bca-bf4d-4a41-ad10-034e792a243d")
            .policyName("ddb1")
            .resourceGroup("myOrgVnetRG")
            .resourceGroupName("rg1")
            .resourceName("myOrgVnetPrivateLink")
            .subscriptionId("57849194-ea1f-470b-abda-d195b25634c1")
            .tenants(            
                "3616657d-1c80-41ae-9d83-2a2776f2c9be",
                "727b6ef1-18ab-4627-ac95-3f9cd945ed87")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateLinkForAzureAd = new azure_native.aadiam.PrivateLinkForAzureAd("privateLinkForAzureAd", {
    allTenants: false,
    name: "myOrgPrivateLinkPolicy",
    ownerTenantId: "950f8bca-bf4d-4a41-ad10-034e792a243d",
    policyName: "ddb1",
    resourceGroup: "myOrgVnetRG",
    resourceGroupName: "rg1",
    resourceName: "myOrgVnetPrivateLink",
    subscriptionId: "57849194-ea1f-470b-abda-d195b25634c1",
    tenants: [
        "3616657d-1c80-41ae-9d83-2a2776f2c9be",
        "727b6ef1-18ab-4627-ac95-3f9cd945ed87",
    ],
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_link_for_azure_ad = azure_native.aadiam.PrivateLinkForAzureAd("privateLinkForAzureAd",
    all_tenants=False,
    name="myOrgPrivateLinkPolicy",
    owner_tenant_id="950f8bca-bf4d-4a41-ad10-034e792a243d",
    policy_name="ddb1",
    resource_group="myOrgVnetRG",
    resource_group_name="rg1",
    resource_name_="myOrgVnetPrivateLink",
    subscription_id="57849194-ea1f-470b-abda-d195b25634c1",
    tenants=[
        "3616657d-1c80-41ae-9d83-2a2776f2c9be",
        "727b6ef1-18ab-4627-ac95-3f9cd945ed87",
    ])
Copy
resources:
  privateLinkForAzureAd:
    type: azure-native:aadiam:privateLinkForAzureAd
    properties:
      allTenants: false
      name: myOrgPrivateLinkPolicy
      ownerTenantId: 950f8bca-bf4d-4a41-ad10-034e792a243d
      policyName: ddb1
      resourceGroup: myOrgVnetRG
      resourceGroupName: rg1
      resourceName: myOrgVnetPrivateLink
      subscriptionId: 57849194-ea1f-470b-abda-d195b25634c1
      tenants:
        - 3616657d-1c80-41ae-9d83-2a2776f2c9be
        - 727b6ef1-18ab-4627-ac95-3f9cd945ed87
Copy

privateLinkPolicyMinCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var privateLinkForAzureAd = new AzureNative.AadIam.PrivateLinkForAzureAd("privateLinkForAzureAd", new()
    {
        AllTenants = false,
        Name = "myOrgPrivateLinkPolicy",
        OwnerTenantId = "950f8bca-bf4d-4a41-ad10-034e792a243d",
        PolicyName = "ddb1",
        ResourceGroup = "myOrgVnetRG",
        ResourceGroupName = "rg1",
        ResourceName = "myOrgVnetPrivateLink",
        SubscriptionId = "57849194-ea1f-470b-abda-d195b25634c1",
        Tenants = new[]
        {
            "3616657d-1c80-41ae-9d83-2a2776f2c9be",
            "727b6ef1-18ab-4627-ac95-3f9cd945ed87",
        },
    });

});
Copy
package main

import (
	aadiam "github.com/pulumi/pulumi-azure-native-sdk/aadiam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aadiam.NewprivateLinkForAzureAd(ctx, "privateLinkForAzureAd", &aadiam.privateLinkForAzureAdArgs{
			AllTenants:        pulumi.Bool(false),
			Name:              pulumi.String("myOrgPrivateLinkPolicy"),
			OwnerTenantId:     pulumi.String("950f8bca-bf4d-4a41-ad10-034e792a243d"),
			PolicyName:        pulumi.String("ddb1"),
			ResourceGroup:     pulumi.String("myOrgVnetRG"),
			ResourceGroupName: pulumi.String("rg1"),
			ResourceName:      pulumi.String("myOrgVnetPrivateLink"),
			SubscriptionId:    pulumi.String("57849194-ea1f-470b-abda-d195b25634c1"),
			Tenants: pulumi.StringArray{
				pulumi.String("3616657d-1c80-41ae-9d83-2a2776f2c9be"),
				pulumi.String("727b6ef1-18ab-4627-ac95-3f9cd945ed87"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.aadiam.privateLinkForAzureAd;
import com.pulumi.azurenative.aadiam.PrivateLinkForAzureAdArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var privateLinkForAzureAd = new PrivateLinkForAzureAd("privateLinkForAzureAd", PrivateLinkForAzureAdArgs.builder()        
            .allTenants(false)
            .name("myOrgPrivateLinkPolicy")
            .ownerTenantId("950f8bca-bf4d-4a41-ad10-034e792a243d")
            .policyName("ddb1")
            .resourceGroup("myOrgVnetRG")
            .resourceGroupName("rg1")
            .resourceName("myOrgVnetPrivateLink")
            .subscriptionId("57849194-ea1f-470b-abda-d195b25634c1")
            .tenants(            
                "3616657d-1c80-41ae-9d83-2a2776f2c9be",
                "727b6ef1-18ab-4627-ac95-3f9cd945ed87")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateLinkForAzureAd = new azure_native.aadiam.PrivateLinkForAzureAd("privateLinkForAzureAd", {
    allTenants: false,
    name: "myOrgPrivateLinkPolicy",
    ownerTenantId: "950f8bca-bf4d-4a41-ad10-034e792a243d",
    policyName: "ddb1",
    resourceGroup: "myOrgVnetRG",
    resourceGroupName: "rg1",
    resourceName: "myOrgVnetPrivateLink",
    subscriptionId: "57849194-ea1f-470b-abda-d195b25634c1",
    tenants: [
        "3616657d-1c80-41ae-9d83-2a2776f2c9be",
        "727b6ef1-18ab-4627-ac95-3f9cd945ed87",
    ],
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_link_for_azure_ad = azure_native.aadiam.PrivateLinkForAzureAd("privateLinkForAzureAd",
    all_tenants=False,
    name="myOrgPrivateLinkPolicy",
    owner_tenant_id="950f8bca-bf4d-4a41-ad10-034e792a243d",
    policy_name="ddb1",
    resource_group="myOrgVnetRG",
    resource_group_name="rg1",
    resource_name_="myOrgVnetPrivateLink",
    subscription_id="57849194-ea1f-470b-abda-d195b25634c1",
    tenants=[
        "3616657d-1c80-41ae-9d83-2a2776f2c9be",
        "727b6ef1-18ab-4627-ac95-3f9cd945ed87",
    ])
Copy
resources:
  privateLinkForAzureAd:
    type: azure-native:aadiam:privateLinkForAzureAd
    properties:
      allTenants: false
      name: myOrgPrivateLinkPolicy
      ownerTenantId: 950f8bca-bf4d-4a41-ad10-034e792a243d
      policyName: ddb1
      resourceGroup: myOrgVnetRG
      resourceGroupName: rg1
      resourceName: myOrgVnetPrivateLink
      subscriptionId: 57849194-ea1f-470b-abda-d195b25634c1
      tenants:
        - 3616657d-1c80-41ae-9d83-2a2776f2c9be
        - 727b6ef1-18ab-4627-ac95-3f9cd945ed87
Copy

Create PrivateLinkForAzureAd Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PrivateLinkForAzureAd(name: string, args: PrivateLinkForAzureAdArgs, opts?: CustomResourceOptions);
@overload
def PrivateLinkForAzureAd(resource_name: str,
                          args: PrivateLinkForAzureAdArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def PrivateLinkForAzureAd(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          resource_group_name: Optional[str] = None,
                          all_tenants: Optional[bool] = None,
                          name: Optional[str] = None,
                          owner_tenant_id: Optional[str] = None,
                          policy_name: Optional[str] = None,
                          resource_group: Optional[str] = None,
                          resource_name_: Optional[str] = None,
                          subscription_id: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          tenants: Optional[Sequence[str]] = None)
func NewPrivateLinkForAzureAd(ctx *Context, name string, args PrivateLinkForAzureAdArgs, opts ...ResourceOption) (*PrivateLinkForAzureAd, error)
public PrivateLinkForAzureAd(string name, PrivateLinkForAzureAdArgs args, CustomResourceOptions? opts = null)
public PrivateLinkForAzureAd(String name, PrivateLinkForAzureAdArgs args)
public PrivateLinkForAzureAd(String name, PrivateLinkForAzureAdArgs args, CustomResourceOptions options)

type: azure-native:aadiam:privateLinkForAzureAd
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PrivateLinkForAzureAdArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PrivateLinkForAzureAdArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PrivateLinkForAzureAdArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PrivateLinkForAzureAdArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PrivateLinkForAzureAdArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var privateLinkForAzureAdResource = new AzureNative.Aadiam.PrivateLinkForAzureAd("privateLinkForAzureAdResource", new()
{
    ResourceGroupName = "string",
    AllTenants = false,
    Name = "string",
    OwnerTenantId = "string",
    PolicyName = "string",
    ResourceGroup = "string",
    ResourceName = "string",
    SubscriptionId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Tenants = new[]
    {
        "string",
    },
});
Copy
example, err := aadiam.NewPrivateLinkForAzureAd(ctx, "privateLinkForAzureAdResource", &aadiam.PrivateLinkForAzureAdArgs{
	ResourceGroupName: "string",
	AllTenants:        false,
	Name:              "string",
	OwnerTenantId:     "string",
	PolicyName:        "string",
	ResourceGroup:     "string",
	ResourceName:      "string",
	SubscriptionId:    "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
	Tenants: []string{
		"string",
	},
})
Copy
var privateLinkForAzureAdResource = new PrivateLinkForAzureAd("privateLinkForAzureAdResource", PrivateLinkForAzureAdArgs.builder()
    .resourceGroupName("string")
    .allTenants(false)
    .name("string")
    .ownerTenantId("string")
    .policyName("string")
    .resourceGroup("string")
    .resourceName("string")
    .subscriptionId("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .tenants("string")
    .build());
Copy
private_link_for_azure_ad_resource = azure_native.aadiam.PrivateLinkForAzureAd("privateLinkForAzureAdResource",
    resource_group_name=string,
    all_tenants=False,
    name=string,
    owner_tenant_id=string,
    policy_name=string,
    resource_group=string,
    resource_name_=string,
    subscription_id=string,
    tags={
        string: string,
    },
    tenants=[string])
Copy
const privateLinkForAzureAdResource = new azure_native.aadiam.PrivateLinkForAzureAd("privateLinkForAzureAdResource", {
    resourceGroupName: "string",
    allTenants: false,
    name: "string",
    ownerTenantId: "string",
    policyName: "string",
    resourceGroup: "string",
    resourceName: "string",
    subscriptionId: "string",
    tags: {
        string: "string",
    },
    tenants: ["string"],
});
Copy
type: azure-native:aadiam:privateLinkForAzureAd
properties:
    allTenants: false
    name: string
    ownerTenantId: string
    policyName: string
    resourceGroup: string
    resourceGroupName: string
    resourceName: string
    subscriptionId: string
    tags:
        string: string
    tenants:
        - string
Copy

PrivateLinkForAzureAd Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PrivateLinkForAzureAd resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
AllTenants bool
Flag indicating whether all tenants are allowed
Name string
Name of this resource.
OwnerTenantId string
Guid of the owner tenant
PolicyName Changes to this property will trigger replacement. string
The name of the private link policy in Azure AD.
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
AllTenants bool
Flag indicating whether all tenants are allowed
Name string
Name of this resource.
OwnerTenantId string
Guid of the owner tenant
PolicyName Changes to this property will trigger replacement. string
The name of the private link policy in Azure AD.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure resource group.
allTenants Boolean
Flag indicating whether all tenants are allowed
name String
Name of this resource.
ownerTenantId String
Guid of the owner tenant
policyName Changes to this property will trigger replacement. String
The name of the private link policy in Azure AD.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
allTenants boolean
Flag indicating whether all tenants are allowed
name string
Name of this resource.
ownerTenantId string
Guid of the owner tenant
policyName Changes to this property will trigger replacement. string
The name of the private link policy in Azure AD.
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.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of an Azure resource group.
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
policy_name Changes to this property will trigger replacement. str
The name of the private link policy in Azure AD.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure resource group.
allTenants Boolean
Flag indicating whether all tenants are allowed
name String
Name of this resource.
ownerTenantId String
Guid of the owner tenant
policyName Changes to this property will trigger replacement. String
The name of the private link policy in Azure AD.
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the PrivateLinkForAzureAd resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Type string
Type of this resource.
Id string
The provider-assigned unique ID for this managed resource.
Type string
Type of this resource.
id String
The provider-assigned unique ID for this managed resource.
type String
Type of this resource.
id string
The provider-assigned unique ID for this managed resource.
type string
Type of this resource.
id str
The provider-assigned unique ID for this managed resource.
type str
Type of this resource.
id String
The provider-assigned unique ID for this managed resource.
type String
Type of this resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:aadiam:privateLinkForAzureAd myOrgPrivateLinkPolicy /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.aadiam/privateLinkForAzureAd/{policyName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v1 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native