azure-native.aadiam.PrivateLinkForAzureAd
Explore with Pulumi AI
PrivateLink Policy configuration object. Azure REST API version: 2020-03-01. Prior API version in Azure Native 1.x: 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",
        },
    });
});
package main
import (
	aadiam "github.com/pulumi/pulumi-azure-native-sdk/aadiam/v2"
	"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
	})
}
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());
    }
}
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",
    ],
});
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",
    ])
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
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",
        },
    });
});
package main
import (
	aadiam "github.com/pulumi/pulumi-azure-native-sdk/aadiam/v2"
	"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
	})
}
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());
    }
}
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",
    ],
});
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",
    ])
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
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 string
- The unique name of the resource.
- args PrivateLinkForAzureAdArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args PrivateLinkForAzureAdArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivateLinkForAzureAdArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
    },
});
example, err := aadiam.NewPrivateLinkForAzureAd(ctx, "privateLinkForAzureAdResource", &aadiam.PrivateLinkForAzureAdArgs{
	ResourceGroupName: pulumi.String("string"),
	AllTenants:        pulumi.Bool(false),
	Name:              pulumi.String("string"),
	OwnerTenantId:     pulumi.String("string"),
	PolicyName:        pulumi.String("string"),
	ResourceGroup:     pulumi.String("string"),
	ResourceName:      pulumi.String("string"),
	SubscriptionId:    pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tenants: pulumi.StringArray{
		pulumi.String("string"),
	},
})
var privateLinkForAzureAdResource = new PrivateLinkForAzureAd("privateLinkForAzureAdResource", PrivateLinkForAzureAdArgs.builder()
    .resourceGroupName("string")
    .allTenants(false)
    .name("string")
    .ownerTenantId("string")
    .policyName("string")
    .resourceGroup("string")
    .resourceName("string")
    .subscriptionId("string")
    .tags(Map.of("string", "string"))
    .tenants("string")
    .build());
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"])
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"],
});
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
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:
- ResourceGroup stringName 
- Name of an Azure resource group.
- AllTenants bool
- Flag indicating whether all tenants are allowed
- Name string
- Name of this resource.
- OwnerTenant stringId 
- Guid of the owner tenant
- PolicyName 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
- Dictionary<string, string>
- Resource tags.
- Tenants List<string>
- The list of tenantIds.
- ResourceGroup stringName 
- Name of an Azure resource group.
- AllTenants bool
- Flag indicating whether all tenants are allowed
- Name string
- Name of this resource.
- OwnerTenant stringId 
- Guid of the owner tenant
- PolicyName 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
- map[string]string
- Resource tags.
- Tenants []string
- The list of tenantIds.
- resourceGroup StringName 
- Name of an Azure resource group.
- allTenants Boolean
- Flag indicating whether all tenants are allowed
- name String
- Name of this resource.
- ownerTenant StringId 
- Guid of the owner tenant
- policyName 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
- Map<String,String>
- Resource tags.
- tenants List<String>
- The list of tenantIds.
- resourceGroup stringName 
- Name of an Azure resource group.
- allTenants boolean
- Flag indicating whether all tenants are allowed
- name string
- Name of this resource.
- ownerTenant stringId 
- Guid of the owner tenant
- policyName 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
- {[key: string]: string}
- Resource tags.
- tenants string[]
- The list of tenantIds.
- resource_group_ strname 
- Name of an Azure resource group.
- all_tenants bool
- Flag indicating whether all tenants are allowed
- name str
- Name of this resource.
- owner_tenant_ strid 
- Guid of the owner tenant
- policy_name 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
- Mapping[str, str]
- Resource tags.
- tenants Sequence[str]
- The list of tenantIds.
- resourceGroup StringName 
- Name of an Azure resource group.
- allTenants Boolean
- Flag indicating whether all tenants are allowed
- name String
- Name of this resource.
- ownerTenant StringId 
- Guid of the owner tenant
- policyName 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
- 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:
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} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0