Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. OpenIdConnectProvider
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.OpenIdConnectProvider

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    OpenId Connect Provider details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.

    Other available API versions: 2016-07-07, 2016-10-10, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.

    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 pulumi
import pulumi_azure_native as azure_native

open_id_connect_provider = azure_native.apimanagement.OpenIdConnectProvider("openIdConnectProvider",
    client_id="oidprovidertemplate3",
    client_secret="x",
    display_name="templateoidprovider3",
    metadata_endpoint="https://oidprovider-template3.net",
    opid="templateOpenIdConnect3",
    resource_group_name="rg1",
    service_name="apimService1",
    use_in_api_documentation=True,
    use_in_test_console=False)

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const openIdConnectProvider = new azure_native.apimanagement.OpenIdConnectProvider("openIdConnectProvider", {
    clientId: "oidprovidertemplate3",
    clientSecret: "x",
    displayName: "templateoidprovider3",
    metadataEndpoint: "https://oidprovider-template3.net",
    opid: "templateOpenIdConnect3",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    useInApiDocumentation: true,
    useInTestConsole: false,
});

    resources:
  openIdConnectProvider:
    type: azure-native:apimanagement:OpenIdConnectProvider
    properties:
      clientId: oidprovidertemplate3
      clientSecret: x
      displayName: templateoidprovider3
      metadataEndpoint: https://oidprovider-template3.net
      opid: templateOpenIdConnect3
      resourceGroupName: rg1
      serviceName: apimService1
      useInApiDocumentation: true
      useInTestConsole: false

    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,
                          client_id: Optional[str] = None,
                          display_name: Optional[str] = None,
                          metadata_endpoint: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          service_name: Optional[str] = None,
                          client_secret: Optional[str] = None,
                          description: Optional[str] = None,
                          opid: Optional[str] = None,
                          use_in_api_documentation: Optional[bool] = None,
                          use_in_test_console: Optional[bool] = 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-native: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 AzureNative.ApiManagement.OpenIdConnectProvider("openIdConnectProviderResource", new()
{
    ClientId = "string",
    DisplayName = "string",
    MetadataEndpoint = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    ClientSecret = "string",
    Description = "string",
    Opid = "string",
    UseInApiDocumentation = false,
    UseInTestConsole = false,
});

    example, err := apimanagement.NewOpenIdConnectProvider(ctx, "openIdConnectProviderResource", &apimanagement.OpenIdConnectProviderArgs{
	ClientId:              pulumi.String("string"),
	DisplayName:           pulumi.String("string"),
	MetadataEndpoint:      pulumi.String("string"),
	ResourceGroupName:     pulumi.String("string"),
	ServiceName:           pulumi.String("string"),
	ClientSecret:          pulumi.String("string"),
	Description:           pulumi.String("string"),
	Opid:                  pulumi.String("string"),
	UseInApiDocumentation: pulumi.Bool(false),
	UseInTestConsole:      pulumi.Bool(false),
})

    var openIdConnectProviderResource = new OpenIdConnectProvider("openIdConnectProviderResource", OpenIdConnectProviderArgs.builder()
    .clientId("string")
    .displayName("string")
    .metadataEndpoint("string")
    .resourceGroupName("string")
    .serviceName("string")
    .clientSecret("string")
    .description("string")
    .opid("string")
    .useInApiDocumentation(false)
    .useInTestConsole(false)
    .build());

    open_id_connect_provider_resource = azure_native.apimanagement.OpenIdConnectProvider("openIdConnectProviderResource",
    client_id="string",
    display_name="string",
    metadata_endpoint="string",
    resource_group_name="string",
    service_name="string",
    client_secret="string",
    description="string",
    opid="string",
    use_in_api_documentation=False,
    use_in_test_console=False)

    const openIdConnectProviderResource = new azure_native.apimanagement.OpenIdConnectProvider("openIdConnectProviderResource", {
    clientId: "string",
    displayName: "string",
    metadataEndpoint: "string",
    resourceGroupName: "string",
    serviceName: "string",
    clientSecret: "string",
    description: "string",
    opid: "string",
    useInApiDocumentation: false,
    useInTestConsole: false,
});

    type: azure-native:apimanagement:OpenIdConnectProvider
properties:
    clientId: string
    clientSecret: string
    description: string
    displayName: string
    metadataEndpoint: string
    opid: string
    resourceGroupName: string
    serviceName: string
    useInApiDocumentation: false
    useInTestConsole: false

    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:

    ClientId string
    Client ID of developer console which is the client application.
    DisplayName string
    User-friendly OpenID Connect Provider name.
    MetadataEndpoint string
    Metadata endpoint URI.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ClientSecret string
    Client Secret of developer console which is the client application.
    Description string
    User-friendly description of OpenID Connect Provider.
    Opid string
    Identifier of the OpenID Connect Provider.
    UseInApiDocumentation bool
    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.
    UseInTestConsole bool
    If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided.
    ClientId string
    Client ID of developer console which is the client application.
    DisplayName string
    User-friendly OpenID Connect Provider name.
    MetadataEndpoint string
    Metadata endpoint URI.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ClientSecret string
    Client Secret of developer console which is the client application.
    Description string
    User-friendly description of OpenID Connect Provider.
    Opid string
    Identifier of the OpenID Connect Provider.
    UseInApiDocumentation bool
    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.
    UseInTestConsole bool
    If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided.
    clientId String
    Client ID of developer console which is the client application.
    displayName String
    User-friendly OpenID Connect Provider name.
    metadataEndpoint String
    Metadata endpoint URI.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    clientSecret String
    Client Secret of developer console which is the client application.
    description String
    User-friendly description of OpenID Connect Provider.
    opid String
    Identifier of the OpenID Connect Provider.
    useInApiDocumentation Boolean
    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.
    useInTestConsole Boolean
    If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided.
    clientId string
    Client ID of developer console which is the client application.
    displayName string
    User-friendly OpenID Connect Provider name.
    metadataEndpoint string
    Metadata endpoint URI.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    clientSecret string
    Client Secret of developer console which is the client application.
    description string
    User-friendly description of OpenID Connect Provider.
    opid string
    Identifier of the OpenID Connect Provider.
    useInApiDocumentation boolean
    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.
    useInTestConsole boolean
    If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided.
    client_id str
    Client ID of developer console which is the client application.
    display_name str
    User-friendly OpenID Connect Provider name.
    metadata_endpoint str
    Metadata endpoint URI.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    client_secret str
    Client Secret of developer console which is the client application.
    description str
    User-friendly description of OpenID Connect Provider.
    opid str
    Identifier of the OpenID Connect Provider.
    use_in_api_documentation bool
    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.
    use_in_test_console bool
    If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided.
    clientId String
    Client ID of developer console which is the client application.
    displayName String
    User-friendly OpenID Connect Provider name.
    metadataEndpoint String
    Metadata endpoint URI.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    clientSecret String
    Client Secret of developer console which is the client application.
    description String
    User-friendly description of OpenID Connect Provider.
    opid String
    Identifier of the OpenID Connect Provider.
    useInApiDocumentation Boolean
    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.
    useInTestConsole Boolean
    If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided.

    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.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    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}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native