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

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.IdentityProviderMicrosoft

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an API Management Microsoft 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 exampleIdentityProviderMicrosoft = new azure.apimanagement.IdentityProviderMicrosoft("example", {
    resourceGroupName: example.name,
    apiManagementName: exampleService.name,
    clientId: "00000000-0000-0000-0000-000000000000",
    clientSecret: "00000000000000000000000000000000",
});

    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_microsoft = azure.apimanagement.IdentityProviderMicrosoft("example",
    resource_group_name=example.name,
    api_management_name=example_service.name,
    client_id="00000000-0000-0000-0000-000000000000",
    client_secret="00000000000000000000000000000000")

    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.NewIdentityProviderMicrosoft(ctx, "example", &apimanagement.IdentityProviderMicrosoftArgs{
			ResourceGroupName: example.Name,
			ApiManagementName: exampleService.Name,
			ClientId:          pulumi.String("00000000-0000-0000-0000-000000000000"),
			ClientSecret:      pulumi.String("00000000000000000000000000000000"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 exampleIdentityProviderMicrosoft = new Azure.ApiManagement.IdentityProviderMicrosoft("example", new()
    {
        ResourceGroupName = example.Name,
        ApiManagementName = exampleService.Name,
        ClientId = "00000000-0000-0000-0000-000000000000",
        ClientSecret = "00000000000000000000000000000000",
    });

});

    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.IdentityProviderMicrosoft;
import com.pulumi.azure.apimanagement.IdentityProviderMicrosoftArgs;
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 exampleIdentityProviderMicrosoft = new IdentityProviderMicrosoft("exampleIdentityProviderMicrosoft", IdentityProviderMicrosoftArgs.builder()
            .resourceGroupName(example.name())
            .apiManagementName(exampleService.name())
            .clientId("00000000-0000-0000-0000-000000000000")
            .clientSecret("00000000000000000000000000000000")
            .build());

    }
}

    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
  exampleIdentityProviderMicrosoft:
    type: azure:apimanagement:IdentityProviderMicrosoft
    name: example
    properties:
      resourceGroupName: ${example.name}
      apiManagementName: ${exampleService.name}
      clientId: 00000000-0000-0000-0000-000000000000
      clientSecret: '00000000000000000000000000000000'

    Create IdentityProviderMicrosoft Resource

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

    Constructor syntax

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

@overload
def IdentityProviderMicrosoft(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              api_management_name: Optional[str] = None,
                              client_id: Optional[str] = None,
                              client_secret: Optional[str] = None,
                              resource_group_name: Optional[str] = None)
    func NewIdentityProviderMicrosoft(ctx *Context, name string, args IdentityProviderMicrosoftArgs, opts ...ResourceOption) (*IdentityProviderMicrosoft, error)
    public IdentityProviderMicrosoft(string name, IdentityProviderMicrosoftArgs args, CustomResourceOptions? opts = null)
    public IdentityProviderMicrosoft(String name, IdentityProviderMicrosoftArgs args)
public IdentityProviderMicrosoft(String name, IdentityProviderMicrosoftArgs args, CustomResourceOptions options)

    type: azure:apimanagement:IdentityProviderMicrosoft
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 IdentityProviderMicrosoftArgs
    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 IdentityProviderMicrosoftArgs
    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 IdentityProviderMicrosoftArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityProviderMicrosoftArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityProviderMicrosoftArgs
    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 identityProviderMicrosoftResource = new Azure.ApiManagement.IdentityProviderMicrosoft("identityProviderMicrosoftResource", new()
{
    ApiManagementName = "string",
    ClientId = "string",
    ClientSecret = "string",
    ResourceGroupName = "string",
});

    example, err := apimanagement.NewIdentityProviderMicrosoft(ctx, "identityProviderMicrosoftResource", &apimanagement.IdentityProviderMicrosoftArgs{
	ApiManagementName: pulumi.String("string"),
	ClientId:          pulumi.String("string"),
	ClientSecret:      pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
})

    var identityProviderMicrosoftResource = new IdentityProviderMicrosoft("identityProviderMicrosoftResource", IdentityProviderMicrosoftArgs.builder()
    .apiManagementName("string")
    .clientId("string")
    .clientSecret("string")
    .resourceGroupName("string")
    .build());

    identity_provider_microsoft_resource = azure.apimanagement.IdentityProviderMicrosoft("identityProviderMicrosoftResource",
    api_management_name="string",
    client_id="string",
    client_secret="string",
    resource_group_name="string")

    const identityProviderMicrosoftResource = new azure.apimanagement.IdentityProviderMicrosoft("identityProviderMicrosoftResource", {
    apiManagementName: "string",
    clientId: "string",
    clientSecret: "string",
    resourceGroupName: "string",
});

    type: azure:apimanagement:IdentityProviderMicrosoft
properties:
    apiManagementName: string
    clientId: string
    clientSecret: string
    resourceGroupName: string

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

    ApiManagementName string
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    ClientId string
    Client Id of the Azure AD Application.
    ClientSecret string
    Client secret of the Azure AD Application.
    ResourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    ApiManagementName string
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    ClientId string
    Client Id of the Azure AD Application.
    ClientSecret string
    Client secret of the Azure AD Application.
    ResourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    apiManagementName String
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    clientId String
    Client Id of the Azure AD Application.
    clientSecret String
    Client secret of the Azure AD Application.
    resourceGroupName String
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    apiManagementName string
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    clientId string
    Client Id of the Azure AD Application.
    clientSecret string
    Client secret of the Azure AD Application.
    resourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    api_management_name str
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    client_id str
    Client Id of the Azure AD Application.
    client_secret str
    Client secret of the Azure AD Application.
    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.
    apiManagementName String
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    clientId String
    Client Id of the Azure AD Application.
    clientSecret String
    Client secret of the Azure AD Application.
    resourceGroupName String
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IdentityProviderMicrosoft 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 IdentityProviderMicrosoft Resource

    Get an existing IdentityProviderMicrosoft 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?: IdentityProviderMicrosoftState, opts?: CustomResourceOptions): IdentityProviderMicrosoft
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_name: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        resource_group_name: Optional[str] = None) -> IdentityProviderMicrosoft
    func GetIdentityProviderMicrosoft(ctx *Context, name string, id IDInput, state *IdentityProviderMicrosoftState, opts ...ResourceOption) (*IdentityProviderMicrosoft, error)
    public static IdentityProviderMicrosoft Get(string name, Input<string> id, IdentityProviderMicrosoftState? state, CustomResourceOptions? opts = null)
    public static IdentityProviderMicrosoft get(String name, Output<String> id, IdentityProviderMicrosoftState 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:
    ApiManagementName string
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    ClientId string
    Client Id of the Azure AD Application.
    ClientSecret string
    Client secret of the Azure AD Application.
    ResourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    ApiManagementName string
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    ClientId string
    Client Id of the Azure AD Application.
    ClientSecret string
    Client secret of the Azure AD Application.
    ResourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    apiManagementName String
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    clientId String
    Client Id of the Azure AD Application.
    clientSecret String
    Client secret of the Azure AD Application.
    resourceGroupName String
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    apiManagementName string
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    clientId string
    Client Id of the Azure AD Application.
    clientSecret string
    Client secret of the Azure AD Application.
    resourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    api_management_name str
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    client_id str
    Client Id of the Azure AD Application.
    client_secret str
    Client secret of the Azure AD Application.
    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.
    apiManagementName String
    The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.
    clientId String
    Client Id of the Azure AD Application.
    clientSecret String
    Client secret of the Azure AD Application.
    resourceGroupName String
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

    Import

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

    $ pulumi import azure:apimanagement/identityProviderMicrosoft:IdentityProviderMicrosoft example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/identityProviders/microsoft

    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.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure