OpenIdConnectProvider

Manages an OpenID Connect Provider within a API Management Service.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleService = new Azure.ApiManagement.Service("exampleService", new Azure.ApiManagement.ServiceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            PublisherName = "My Company",
            PublisherEmail = "company@exmaple.com",
            SkuName = "Developer_1",
        });
        var exampleOpenIdConnectProvider = new Azure.ApiManagement.OpenIdConnectProvider("exampleOpenIdConnectProvider", new Azure.ApiManagement.OpenIdConnectProviderArgs
        {
            ApiManagementName = exampleService.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            ClientId = "00001111-2222-3333-4444-555566667777",
            DisplayName = "Example Provider",
            MetadataEndpoint = "https://example.com/example",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/apimanagement"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi/sdk/v2/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@exmaple.com"),
            SkuName:           pulumi.String("Developer_1"),
        })
        if err != nil {
            return err
        }
        _, err = apimanagement.NewOpenIdConnectProvider(ctx, "exampleOpenIdConnectProvider", &apimanagement.OpenIdConnectProviderArgs{
            ApiManagementName: exampleService.Name,
            ResourceGroupName: exampleResourceGroup.Name,
            ClientId:          pulumi.String("00001111-2222-3333-4444-555566667777"),
            DisplayName:       pulumi.String("Example Provider"),
            MetadataEndpoint:  pulumi.String("https://example.com/example"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

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

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

Create a OpenIdConnectProvider Resource

new OpenIdConnectProvider(name: string, args: OpenIdConnectProviderArgs, opts?: CustomResourceOptions);

def OpenIdConnectProvider(resource_name, opts=None, api_management_name=None, client_id=None, client_secret=None, description=None, display_name=None, metadata_endpoint=None, name=None, resource_group_name=None, __props__=None);

func NewOpenIdConnectProvider(ctx *Context, name string, args OpenIdConnectProviderArgs, opts ...ResourceOption) (*OpenIdConnectProvider, error)

public OpenIdConnectProvider(string name, OpenIdConnectProviderArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

OpenIdConnectProvider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

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.

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.

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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, api_management_name=None, client_id=None, client_secret=None, description=None, display_name=None, metadata_endpoint=None, name=None, resource_group_name=None, __props__=None);

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)

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.

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.

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.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud