OpenIdConnectProviderArgs

data class OpenIdConnectProviderArgs(val clientId: Output<String>? = null, val clientSecret: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val metadataEndpoint: Output<String>? = null, val opid: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val useInApiDocumentation: Output<Boolean>? = null, val useInTestConsole: Output<Boolean>? = null) : ConvertibleToJava<OpenIdConnectProviderArgs>

OpenId Connect Provider details. Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-08-01. Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

ApiManagementCreateOpenIdConnectProvider

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var openIdConnectProvider = new AzureNative.ApiManagement.OpenIdConnectProvider("openIdConnectProvider", new()
{
ClientId = "oidprovidertemplate3",
ClientSecret = "x",
DisplayName = "templateoidprovider3",
MetadataEndpoint = "https://oidprovider-template3.net",
Opid = "templateOpenIdConnect3",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
UseInApiDocumentation = true,
UseInTestConsole = false,
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewOpenIdConnectProvider(ctx, "openIdConnectProvider", &apimanagement.OpenIdConnectProviderArgs{
ClientId: pulumi.String("oidprovidertemplate3"),
ClientSecret: pulumi.String("x"),
DisplayName: pulumi.String("templateoidprovider3"),
MetadataEndpoint: pulumi.String("https://oidprovider-template3.net"),
Opid: pulumi.String("templateOpenIdConnect3"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
UseInApiDocumentation: pulumi.Bool(true),
UseInTestConsole: pulumi.Bool(false),
})
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.azurenative.apimanagement.OpenIdConnectProvider;
import com.pulumi.azurenative.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 openIdConnectProvider = new OpenIdConnectProvider("openIdConnectProvider", OpenIdConnectProviderArgs.builder()
.clientId("oidprovidertemplate3")
.clientSecret("x")
.displayName("templateoidprovider3")
.metadataEndpoint("https://oidprovider-template3.net")
.opid("templateOpenIdConnect3")
.resourceGroupName("rg1")
.serviceName("apimService1")
.useInApiDocumentation(true)
.useInTestConsole(false)
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:OpenIdConnectProvider templateOpenIdConnect3 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}

Constructors

Link copied to clipboard
constructor(clientId: Output<String>? = null, clientSecret: Output<String>? = null, description: Output<String>? = null, displayName: Output<String>? = null, metadataEndpoint: Output<String>? = null, opid: Output<String>? = null, resourceGroupName: Output<String>? = null, serviceName: Output<String>? = null, useInApiDocumentation: Output<Boolean>? = null, useInTestConsole: Output<Boolean>? = null)

Properties

Link copied to clipboard
val clientId: Output<String>? = null

Client ID of developer console which is the client application.

Link copied to clipboard
val clientSecret: Output<String>? = null

Client Secret of developer console which is the client application.

Link copied to clipboard
val description: Output<String>? = null

User-friendly description of OpenID Connect Provider.

Link copied to clipboard
val displayName: Output<String>? = null

User-friendly OpenID Connect Provider name.

Link copied to clipboard
val metadataEndpoint: Output<String>? = null

Metadata endpoint URI.

Link copied to clipboard
val opid: Output<String>? = null

Identifier of the OpenID Connect Provider.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val serviceName: Output<String>? = null

The name of the API Management service.

Link copied to clipboard
val useInApiDocumentation: Output<Boolean>? = null

If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided.

Link copied to clipboard
val useInTestConsole: Output<Boolean>? = null

If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided.

Functions

Link copied to clipboard
open override fun toJava(): OpenIdConnectProviderArgs