Class 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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

OpenIdConnectProvider

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ApiManagement

Assembly: Pulumi.Azure.dll

Syntax

public class OpenIdConnectProvider : CustomResource

Constructors

OpenIdConnectProvider(String, OpenIdConnectProviderArgs, CustomResourceOptions)

Create a OpenIdConnectProvider resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
OpenIdConnectProviderArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiManagementName

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.

Declaration

public Output<string> ApiManagementName { get; }

Property Value

Type	Description
Output<System.String>

ClientId

The Client ID used for the Client Application.

Declaration

public Output<string> ClientId { get; }

Property Value

Type	Description
Output<System.String>

ClientSecret

The Client Secret used for the Client Application.

Declaration

public Output<string> ClientSecret { get; }

Property Value

Type	Description
Output<System.String>

Description

A description of this OpenID Connect Provider.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

DisplayName

A user-friendly name for this OpenID Connect Provider.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

MetadataEndpoint

The URI of the Metadata endpoint.

Declaration

public Output<string> MetadataEndpoint { get; }

Property Value

Type	Description
Output<System.String>

Name

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.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, OpenIdConnectProviderState, CustomResourceOptions)

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

Declaration

public static OpenIdConnectProvider Get(string name, Input<string> id, OpenIdConnectProviderState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
OpenIdConnectProviderState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
OpenIdConnectProvider