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

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.OpenIdConnectProvider

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Manages an OpenID Connect Provider within a API Management Service.

    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@exmaple.com",
    skuName: "Developer_1",
});
const exampleOpenIdConnectProvider = new azure.apimanagement.OpenIdConnectProvider("example", {
    name: "example-provider",
    apiManagementName: exampleService.name,
    resourceGroupName: example.name,
    clientId: "00001111-2222-3333-4444-555566667777",
    clientSecret: "00001111-423egvwdcsjx-00001111",
    displayName: "Example Provider",
    metadataEndpoint: "https://example.com/example",
});

    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@exmaple.com",
    sku_name="Developer_1")
example_open_id_connect_provider = azure.apimanagement.OpenIdConnectProvider("example",
    name="example-provider",
    api_management_name=example_service.name,
    resource_group_name=example.name,
    client_id="00001111-2222-3333-4444-555566667777",
    client_secret="00001111-423egvwdcsjx-00001111",
    display_name="Example Provider",
    metadata_endpoint="https://example.com/example")

    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@exmaple.com"),
			SkuName:           pulumi.String("Developer_1"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewOpenIdConnectProvider(ctx, "example", &apimanagement.OpenIdConnectProviderArgs{
			Name:              pulumi.String("example-provider"),
			ApiManagementName: exampleService.Name,
			ResourceGroupName: example.Name,
			ClientId:          pulumi.String("00001111-2222-3333-4444-555566667777"),
			ClientSecret:      pulumi.String("00001111-423egvwdcsjx-00001111"),
			DisplayName:       pulumi.String("Example Provider"),
			MetadataEndpoint:  pulumi.String("https://example.com/example"),
		})
		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@exmaple.com",
        SkuName = "Developer_1",
    });

    var exampleOpenIdConnectProvider = new Azure.ApiManagement.OpenIdConnectProvider("example", new()
    {
        Name = "example-provider",
        ApiManagementName = exampleService.Name,
        ResourceGroupName = example.Name,
        ClientId = "00001111-2222-3333-4444-555566667777",
        ClientSecret = "00001111-423egvwdcsjx-00001111",
        DisplayName = "Example Provider",
        MetadataEndpoint = "https://example.com/example",
    });

});

    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.OpenIdConnectProvider;
import com.pulumi.azure.apimanagement.OpenIdConnectProviderArgs;
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@exmaple.com")
            .skuName("Developer_1")
            .build());

        var exampleOpenIdConnectProvider = new OpenIdConnectProvider("exampleOpenIdConnectProvider", OpenIdConnectProviderArgs.builder()
            .name("example-provider")
            .apiManagementName(exampleService.name())
            .resourceGroupName(example.name())
            .clientId("00001111-2222-3333-4444-555566667777")
            .clientSecret("00001111-423egvwdcsjx-00001111")
            .displayName("Example Provider")
            .metadataEndpoint("https://example.com/example")
            .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@exmaple.com
      skuName: Developer_1
  exampleOpenIdConnectProvider:
    type: azure:apimanagement:OpenIdConnectProvider
    name: example
    properties:
      name: example-provider
      apiManagementName: ${exampleService.name}
      resourceGroupName: ${example.name}
      clientId: 00001111-2222-3333-4444-555566667777
      clientSecret: 00001111-423egvwdcsjx-00001111
      displayName: Example Provider
      metadataEndpoint: https://example.com/example

    Create OpenIdConnectProvider Resource

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

    Constructor syntax

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

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

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

    example, err := apimanagement.NewOpenIdConnectProvider(ctx, "openIdConnectProviderResource", &apimanagement.OpenIdConnectProviderArgs{
	ApiManagementName: pulumi.String("string"),
	ClientId:          pulumi.String("string"),
	ClientSecret:      pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	MetadataEndpoint:  pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Description:       pulumi.String("string"),
	Name:              pulumi.String("string"),
})

    var openIdConnectProviderResource = new OpenIdConnectProvider("openIdConnectProviderResource", OpenIdConnectProviderArgs.builder()
    .apiManagementName("string")
    .clientId("string")
    .clientSecret("string")
    .displayName("string")
    .metadataEndpoint("string")
    .resourceGroupName("string")
    .description("string")
    .name("string")
    .build());

    open_id_connect_provider_resource = azure.apimanagement.OpenIdConnectProvider("openIdConnectProviderResource",
    api_management_name="string",
    client_id="string",
    client_secret="string",
    display_name="string",
    metadata_endpoint="string",
    resource_group_name="string",
    description="string",
    name="string")

    const openIdConnectProviderResource = new azure.apimanagement.OpenIdConnectProvider("openIdConnectProviderResource", {
    apiManagementName: "string",
    clientId: "string",
    clientSecret: "string",
    displayName: "string",
    metadataEndpoint: "string",
    resourceGroupName: "string",
    description: "string",
    name: "string",
});

    type: azure:apimanagement:OpenIdConnectProvider
properties:
    apiManagementName: string
    clientId: string
    clientSecret: string
    description: string
    displayName: string
    metadataEndpoint: string
    name: string
    resourceGroupName: string

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

    ApiManagementName string
    The name of the API Management Service in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    ClientId string
    The Client ID used for the Client Application.
    ClientSecret string
    The Client Secret used for the Client Application.
    DisplayName string
    A user-friendly name for this OpenID Connect Provider.
    MetadataEndpoint string
    The URI of the Metadata endpoint.
    ResourceGroupName string
    The name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    Description string
    A description of this OpenID Connect Provider.
    Name string
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
    ApiManagementName string
    The name of the API Management Service in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    ClientId string
    The Client ID used for the Client Application.
    ClientSecret string
    The Client Secret used for the Client Application.
    DisplayName string
    A user-friendly name for this OpenID Connect Provider.
    MetadataEndpoint string
    The URI of the Metadata endpoint.
    ResourceGroupName string
    The name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    Description string
    A description of this OpenID Connect Provider.
    Name string
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
    apiManagementName String
    The name of the API Management Service in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    clientId String
    The Client ID used for the Client Application.
    clientSecret String
    The Client Secret used for the Client Application.
    displayName String
    A user-friendly name for this OpenID Connect Provider.
    metadataEndpoint String
    The URI of the Metadata endpoint.
    resourceGroupName String
    The name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    description String
    A description of this OpenID Connect Provider.
    name String
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
    apiManagementName string
    The name of the API Management Service in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    clientId string
    The Client ID used for the Client Application.
    clientSecret string
    The Client Secret used for the Client Application.
    displayName string
    A user-friendly name for this OpenID Connect Provider.
    metadataEndpoint string
    The URI of the Metadata endpoint.
    resourceGroupName string
    The name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    description string
    A description of this OpenID Connect Provider.
    name string
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
    api_management_name str
    The name of the API Management Service in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    client_id str
    The Client ID used for the Client Application.
    client_secret str
    The Client Secret used for the Client Application.
    display_name str
    A user-friendly name for this OpenID Connect Provider.
    metadata_endpoint str
    The URI of the Metadata endpoint.
    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.
    description str
    A description of this OpenID Connect Provider.
    name str
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
    apiManagementName String
    The name of the API Management Service in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    clientId String
    The Client ID used for the Client Application.
    clientSecret String
    The Client Secret used for the Client Application.
    displayName String
    A user-friendly name for this OpenID Connect Provider.
    metadataEndpoint String
    The URI of the Metadata endpoint.
    resourceGroupName String
    The name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    description String
    A description of this OpenID Connect Provider.
    name String
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.

    Outputs

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

    Get an existing OpenIdConnectProvider 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?: OpenIdConnectProviderState, opts?: CustomResourceOptions): OpenIdConnectProvider
    @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,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        metadata_endpoint: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None) -> OpenIdConnectProvider
    func GetOpenIdConnectProvider(ctx *Context, name string, id IDInput, state *OpenIdConnectProviderState, opts ...ResourceOption) (*OpenIdConnectProvider, error)
    public static OpenIdConnectProvider Get(string name, Input<string> id, OpenIdConnectProviderState? state, CustomResourceOptions? opts = null)
    public static OpenIdConnectProvider get(String name, Output<String> id, OpenIdConnectProviderState state, CustomResourceOptions options)
    resources:  _:    type: azure:apimanagement:OpenIdConnectProvider    get:      id: ${id}
    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 in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    ClientId string
    The Client ID used for the Client Application.
    ClientSecret string
    The Client Secret used for the Client Application.
    Description string
    A description of this OpenID Connect Provider.
    DisplayName string
    A user-friendly name for this OpenID Connect Provider.
    MetadataEndpoint string
    The URI of the Metadata endpoint.
    Name string
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
    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 in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    ClientId string
    The Client ID used for the Client Application.
    ClientSecret string
    The Client Secret used for the Client Application.
    Description string
    A description of this OpenID Connect Provider.
    DisplayName string
    A user-friendly name for this OpenID Connect Provider.
    MetadataEndpoint string
    The URI of the Metadata endpoint.
    Name string
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
    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 in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    clientId String
    The Client ID used for the Client Application.
    clientSecret String
    The Client Secret used for the Client Application.
    description String
    A description of this OpenID Connect Provider.
    displayName String
    A user-friendly name for this OpenID Connect Provider.
    metadataEndpoint String
    The URI of the Metadata endpoint.
    name String
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
    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 in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    clientId string
    The Client ID used for the Client Application.
    clientSecret string
    The Client Secret used for the Client Application.
    description string
    A description of this OpenID Connect Provider.
    displayName string
    A user-friendly name for this OpenID Connect Provider.
    metadataEndpoint string
    The URI of the Metadata endpoint.
    name string
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
    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 in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    client_id str
    The Client ID used for the Client Application.
    client_secret str
    The Client Secret used for the Client Application.
    description str
    A description of this OpenID Connect Provider.
    display_name str
    A user-friendly name for this OpenID Connect Provider.
    metadata_endpoint str
    The URI of the Metadata endpoint.
    name str
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
    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 in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
    clientId String
    The Client ID used for the Client Application.
    clientSecret String
    The Client Secret used for the Client Application.
    description String
    A description of this OpenID Connect Provider.
    displayName String
    A user-friendly name for this OpenID Connect Provider.
    metadataEndpoint String
    The URI of the Metadata endpoint.
    name String
    the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
    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 OpenID Connect Providers can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/openIdConnectProvider:OpenIdConnectProvider example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/openidConnectProviders/provider1

    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.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure