Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. IdentityProviderAad

We recommend using Azure Native.

Azure Classic v5.57.0 published on Tuesday, Nov 28, 2023 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.IdentityProviderAad

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.57.0 published on Tuesday, Nov 28, 2023 by Pulumi
pulumi/pulumi-azure

    Manages an API Management AAD Identity Provider.

    Example Usage

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

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

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

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

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.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, "exampleIdentityProviderAad", &apimanagement.IdentityProviderAadArgs{
			ResourceGroupName: exampleResourceGroup.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
	})
}

    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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

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

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

    }
}

    import pulumi
import pulumi_azure as azure

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

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

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

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

    Create IdentityProviderAad Resource

    new IdentityProviderAad(name: string, args: IdentityProviderAadArgs, opts?: CustomResourceOptions);
    @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,
                        signin_tenant: Optional[str] = None)
@overload
def IdentityProviderAad(resource_name: str,
                        args: IdentityProviderAadArgs,
                        opts: Optional[ResourceOptions] = 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.
    name string
    The unique name of the resource.
    args IdentityProviderAadArgs
    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 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 string
    The unique name of the resource.
    args IdentityProviderAadArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityProviderAadArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityProviderAadArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The IdentityProviderAad resource accepts the following input properties:

    AllowedTenants List<string>

    List of allowed AAD Tenants.

    ApiManagementName 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.

    ClientSecret string

    Client secret of the Application in the AAD Identity Provider.

    ResourceGroupName 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 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.

    ClientSecret string

    Client secret of the Application in the AAD Identity Provider.

    ResourceGroupName 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 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.

    clientSecret String

    Client secret of the Application in the AAD Identity Provider.

    resourceGroupName 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 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.

    clientSecret string

    Client secret of the Application in the AAD Identity Provider.

    resourceGroupName 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 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_secret str

    Client secret of the Application in the AAD Identity Provider.

    resource_group_name 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 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.

    clientSecret String

    Client secret of the Application in the AAD Identity Provider.

    resourceGroupName 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

    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_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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 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.

    ClientSecret string

    Client secret of the Application in the AAD Identity Provider.

    ResourceGroupName 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 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.

    ClientSecret string

    Client secret of the Application in the AAD Identity Provider.

    ResourceGroupName 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 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.

    clientSecret String

    Client secret of the Application in the AAD Identity Provider.

    resourceGroupName 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 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.

    clientSecret string

    Client secret of the Application in the AAD Identity Provider.

    resourceGroupName 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 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_secret str

    Client secret of the Application in the AAD Identity Provider.

    resource_group_name 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 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.

    clientSecret String

    Client secret of the Application in the AAD Identity Provider.

    resourceGroupName 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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.57.0 published on Tuesday, Nov 28, 2023 by Pulumi
    pulumi/pulumi-azure