Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. IdentityProviderAad

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.IdentityProviderAad

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an API Management AAD Identity Provider.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleService = new azure.apimanagement.Service("example", {
    name: "example-apim",
    location: example.location,
    resourceGroupName: example.name,
    publisherName: "My Company",
    publisherEmail: "company@mycompany.io",
    skuName: "Developer_1",
});
const exampleIdentityProviderAad = new azure.apimanagement.IdentityProviderAad("example", {
    resourceGroupName: example.name,
    apiManagementName: exampleService.name,
    clientId: "00000000-0000-0000-0000-000000000000",
    clientSecret: "00000000000000000000000000000000",
    allowedTenants: ["00000000-0000-0000-0000-000000000000"],
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_service = azure.apimanagement.Service("example",
    name="example-apim",
    location=example.location,
    resource_group_name=example.name,
    publisher_name="My Company",
    publisher_email="company@mycompany.io",
    sku_name="Developer_1")
example_identity_provider_aad = azure.apimanagement.IdentityProviderAad("example",
    resource_group_name=example.name,
    api_management_name=example_service.name,
    client_id="00000000-0000-0000-0000-000000000000",
    client_secret="00000000000000000000000000000000",
    allowed_tenants=["00000000-0000-0000-0000-000000000000"])
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
			Name:              pulumi.String("example-apim"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			PublisherName:     pulumi.String("My Company"),
			PublisherEmail:    pulumi.String("company@mycompany.io"),
			SkuName:           pulumi.String("Developer_1"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewIdentityProviderAad(ctx, "example", &apimanagement.IdentityProviderAadArgs{
			ResourceGroupName: example.Name,
			ApiManagementName: exampleService.Name,
			ClientId:          pulumi.String("00000000-0000-0000-0000-000000000000"),
			ClientSecret:      pulumi.String("00000000000000000000000000000000"),
			AllowedTenants: pulumi.StringArray{
				pulumi.String("00000000-0000-0000-0000-000000000000"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleService = new Azure.ApiManagement.Service("example", new()
    {
        Name = "example-apim",
        Location = example.Location,
        ResourceGroupName = example.Name,
        PublisherName = "My Company",
        PublisherEmail = "company@mycompany.io",
        SkuName = "Developer_1",
    });

    var exampleIdentityProviderAad = new Azure.ApiManagement.IdentityProviderAad("example", new()
    {
        ResourceGroupName = example.Name,
        ApiManagementName = exampleService.Name,
        ClientId = "00000000-0000-0000-0000-000000000000",
        ClientSecret = "00000000000000000000000000000000",
        AllowedTenants = new[]
        {
            "00000000-0000-0000-0000-000000000000",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.IdentityProviderAad;
import com.pulumi.azure.apimanagement.IdentityProviderAadArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-apim")
            .location(example.location())
            .resourceGroupName(example.name())
            .publisherName("My Company")
            .publisherEmail("company@mycompany.io")
            .skuName("Developer_1")
            .build());

        var exampleIdentityProviderAad = new IdentityProviderAad("exampleIdentityProviderAad", IdentityProviderAadArgs.builder()
            .resourceGroupName(example.name())
            .apiManagementName(exampleService.name())
            .clientId("00000000-0000-0000-0000-000000000000")
            .clientSecret("00000000000000000000000000000000")
            .allowedTenants("00000000-0000-0000-0000-000000000000")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    name: example
    properties:
      name: example-apim
      location: ${example.location}
      resourceGroupName: ${example.name}
      publisherName: My Company
      publisherEmail: company@mycompany.io
      skuName: Developer_1
  exampleIdentityProviderAad:
    type: azure:apimanagement:IdentityProviderAad
    name: example
    properties:
      resourceGroupName: ${example.name}
      apiManagementName: ${exampleService.name}
      clientId: 00000000-0000-0000-0000-000000000000
      clientSecret: '00000000000000000000000000000000'
      allowedTenants:
        - 00000000-0000-0000-0000-000000000000
Copy

Create IdentityProviderAad Resource

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

Constructor syntax

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

@overload
def IdentityProviderAad(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        allowed_tenants: Optional[Sequence[str]] = None,
                        api_management_name: Optional[str] = None,
                        client_id: Optional[str] = None,
                        client_secret: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        client_library: Optional[str] = None,
                        signin_tenant: Optional[str] = None)
func NewIdentityProviderAad(ctx *Context, name string, args IdentityProviderAadArgs, opts ...ResourceOption) (*IdentityProviderAad, error)
public IdentityProviderAad(string name, IdentityProviderAadArgs args, CustomResourceOptions? opts = null)
public IdentityProviderAad(String name, IdentityProviderAadArgs args)
public IdentityProviderAad(String name, IdentityProviderAadArgs args, CustomResourceOptions options)

type: azure:apimanagement:IdentityProviderAad
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. IdentityProviderAadArgs
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. IdentityProviderAadArgs
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. IdentityProviderAadArgs
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. IdentityProviderAadArgs
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. IdentityProviderAadArgs
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 identityProviderAadResource = new Azure.ApiManagement.IdentityProviderAad("identityProviderAadResource", new()
{
    AllowedTenants = new[]
    {
        "string",
    },
    ApiManagementName = "string",
    ClientId = "string",
    ClientSecret = "string",
    ResourceGroupName = "string",
    ClientLibrary = "string",
    SigninTenant = "string",
});
Copy
example, err := apimanagement.NewIdentityProviderAad(ctx, "identityProviderAadResource", &apimanagement.IdentityProviderAadArgs{
	AllowedTenants: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiManagementName: pulumi.String("string"),
	ClientId:          pulumi.String("string"),
	ClientSecret:      pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ClientLibrary:     pulumi.String("string"),
	SigninTenant:      pulumi.String("string"),
})
Copy
var identityProviderAadResource = new IdentityProviderAad("identityProviderAadResource", IdentityProviderAadArgs.builder()
    .allowedTenants("string")
    .apiManagementName("string")
    .clientId("string")
    .clientSecret("string")
    .resourceGroupName("string")
    .clientLibrary("string")
    .signinTenant("string")
    .build());
Copy
identity_provider_aad_resource = azure.apimanagement.IdentityProviderAad("identityProviderAadResource",
    allowed_tenants=["string"],
    api_management_name="string",
    client_id="string",
    client_secret="string",
    resource_group_name="string",
    client_library="string",
    signin_tenant="string")
Copy
const identityProviderAadResource = new azure.apimanagement.IdentityProviderAad("identityProviderAadResource", {
    allowedTenants: ["string"],
    apiManagementName: "string",
    clientId: "string",
    clientSecret: "string",
    resourceGroupName: "string",
    clientLibrary: "string",
    signinTenant: "string",
});
Copy
type: azure:apimanagement:IdentityProviderAad
properties:
    allowedTenants:
        - string
    apiManagementName: string
    clientId: string
    clientLibrary: string
    clientSecret: string
    resourceGroupName: string
    signinTenant: string
Copy

IdentityProviderAad 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 IdentityProviderAad resource accepts the following input properties:

AllowedTenants This property is required. List<string>
List of allowed AAD Tenants.
ApiManagementName
This property is required.
Changes to this property will trigger replacement.
string
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
ClientId This property is required. string
Client Id of the Application in the AAD Identity Provider.
ClientSecret This property is required. string
Client secret of the Application in the AAD Identity Provider.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
ClientLibrary string
The client library to be used in the AAD Identity Provider.
SigninTenant string
The AAD Tenant to use instead of Common when logging into Active Directory.
AllowedTenants This property is required. []string
List of allowed AAD Tenants.
ApiManagementName
This property is required.
Changes to this property will trigger replacement.
string
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
ClientId This property is required. string
Client Id of the Application in the AAD Identity Provider.
ClientSecret This property is required. string
Client secret of the Application in the AAD Identity Provider.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
ClientLibrary string
The client library to be used in the AAD Identity Provider.
SigninTenant string
The AAD Tenant to use instead of Common when logging into Active Directory.
allowedTenants This property is required. List<String>
List of allowed AAD Tenants.
apiManagementName
This property is required.
Changes to this property will trigger replacement.
String
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
clientId This property is required. String
Client Id of the Application in the AAD Identity Provider.
clientSecret This property is required. String
Client secret of the Application in the AAD Identity Provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
clientLibrary String
The client library to be used in the AAD Identity Provider.
signinTenant String
The AAD Tenant to use instead of Common when logging into Active Directory.
allowedTenants This property is required. string[]
List of allowed AAD Tenants.
apiManagementName
This property is required.
Changes to this property will trigger replacement.
string
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
clientId This property is required. string
Client Id of the Application in the AAD Identity Provider.
clientSecret This property is required. string
Client secret of the Application in the AAD Identity Provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
clientLibrary string
The client library to be used in the AAD Identity Provider.
signinTenant string
The AAD Tenant to use instead of Common when logging into Active Directory.
allowed_tenants This property is required. Sequence[str]
List of allowed AAD Tenants.
api_management_name
This property is required.
Changes to this property will trigger replacement.
str
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
client_id This property is required. str
Client Id of the Application in the AAD Identity Provider.
client_secret This property is required. str
Client secret of the Application in the AAD Identity Provider.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
client_library str
The client library to be used in the AAD Identity Provider.
signin_tenant str
The AAD Tenant to use instead of Common when logging into Active Directory.
allowedTenants This property is required. List<String>
List of allowed AAD Tenants.
apiManagementName
This property is required.
Changes to this property will trigger replacement.
String
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
clientId This property is required. String
Client Id of the Application in the AAD Identity Provider.
clientSecret This property is required. String
Client secret of the Application in the AAD Identity Provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
clientLibrary String
The client library to be used in the AAD Identity Provider.
signinTenant String
The AAD Tenant to use instead of Common when logging into Active Directory.

Outputs

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

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

Look up Existing IdentityProviderAad Resource

Get an existing IdentityProviderAad resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IdentityProviderAadState, opts?: CustomResourceOptions): IdentityProviderAad
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_tenants: Optional[Sequence[str]] = None,
        api_management_name: Optional[str] = None,
        client_id: Optional[str] = None,
        client_library: Optional[str] = None,
        client_secret: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        signin_tenant: Optional[str] = None) -> IdentityProviderAad
func GetIdentityProviderAad(ctx *Context, name string, id IDInput, state *IdentityProviderAadState, opts ...ResourceOption) (*IdentityProviderAad, error)
public static IdentityProviderAad Get(string name, Input<string> id, IdentityProviderAadState? state, CustomResourceOptions? opts = null)
public static IdentityProviderAad get(String name, Output<String> id, IdentityProviderAadState state, CustomResourceOptions options)
resources:  _:    type: azure:apimanagement:IdentityProviderAad    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AllowedTenants List<string>
List of allowed AAD Tenants.
ApiManagementName Changes to this property will trigger replacement. string
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
ClientId string
Client Id of the Application in the AAD Identity Provider.
ClientLibrary string
The client library to be used in the AAD Identity Provider.
ClientSecret string
Client secret of the Application in the AAD Identity Provider.
ResourceGroupName Changes to this property will trigger replacement. string
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
SigninTenant string
The AAD Tenant to use instead of Common when logging into Active Directory.
AllowedTenants []string
List of allowed AAD Tenants.
ApiManagementName Changes to this property will trigger replacement. string
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
ClientId string
Client Id of the Application in the AAD Identity Provider.
ClientLibrary string
The client library to be used in the AAD Identity Provider.
ClientSecret string
Client secret of the Application in the AAD Identity Provider.
ResourceGroupName Changes to this property will trigger replacement. string
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
SigninTenant string
The AAD Tenant to use instead of Common when logging into Active Directory.
allowedTenants List<String>
List of allowed AAD Tenants.
apiManagementName Changes to this property will trigger replacement. String
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
clientId String
Client Id of the Application in the AAD Identity Provider.
clientLibrary String
The client library to be used in the AAD Identity Provider.
clientSecret String
Client secret of the Application in the AAD Identity Provider.
resourceGroupName Changes to this property will trigger replacement. String
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
signinTenant String
The AAD Tenant to use instead of Common when logging into Active Directory.
allowedTenants string[]
List of allowed AAD Tenants.
apiManagementName Changes to this property will trigger replacement. string
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
clientId string
Client Id of the Application in the AAD Identity Provider.
clientLibrary string
The client library to be used in the AAD Identity Provider.
clientSecret string
Client secret of the Application in the AAD Identity Provider.
resourceGroupName Changes to this property will trigger replacement. string
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
signinTenant string
The AAD Tenant to use instead of Common when logging into Active Directory.
allowed_tenants Sequence[str]
List of allowed AAD Tenants.
api_management_name Changes to this property will trigger replacement. str
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
client_id str
Client Id of the Application in the AAD Identity Provider.
client_library str
The client library to be used in the AAD Identity Provider.
client_secret str
Client secret of the Application in the AAD Identity Provider.
resource_group_name Changes to this property will trigger replacement. str
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
signin_tenant str
The AAD Tenant to use instead of Common when logging into Active Directory.
allowedTenants List<String>
List of allowed AAD Tenants.
apiManagementName Changes to this property will trigger replacement. String
The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
clientId String
Client Id of the Application in the AAD Identity Provider.
clientLibrary String
The client library to be used in the AAD Identity Provider.
clientSecret String
Client secret of the Application in the AAD Identity Provider.
resourceGroupName Changes to this property will trigger replacement. String
The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
signinTenant String
The AAD Tenant to use instead of Common when logging into Active Directory.

Import

API Management AAD Identity Provider can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/identityProviderAad:IdentityProviderAad example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/identityProviders/aad
Copy

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure