Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. apimanagement
  5. OpenIdConnectProvider
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.OpenIdConnectProvider

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

OpenId Connect Provider details. API Version: 2020-12-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",
    });

});
Copy
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement"
	"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"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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")
            .build());

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

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)
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 This property is required. string
The unique name of the resource.
args This property is required. OpenIdConnectProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. OpenIdConnectProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OpenIdConnectProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
example, err := apimanagement.NewOpenIdConnectProvider(ctx, "openIdConnectProviderResource", &apimanagement.OpenIdConnectProviderArgs{
	ClientId:          "string",
	DisplayName:       "string",
	MetadataEndpoint:  "string",
	ResourceGroupName: "string",
	ServiceName:       "string",
	ClientSecret:      "string",
	Description:       "string",
	Opid:              "string",
})
Copy
var openIdConnectProviderResource = new OpenIdConnectProvider("openIdConnectProviderResource", OpenIdConnectProviderArgs.builder()
    .clientId("string")
    .displayName("string")
    .metadataEndpoint("string")
    .resourceGroupName("string")
    .serviceName("string")
    .clientSecret("string")
    .description("string")
    .opid("string")
    .build());
Copy
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)
Copy
const openIdConnectProviderResource = new azure_native.apimanagement.OpenIdConnectProvider("openIdConnectProviderResource", {
    clientId: "string",
    displayName: "string",
    metadataEndpoint: "string",
    resourceGroupName: "string",
    serviceName: "string",
    clientSecret: "string",
    description: "string",
    opid: "string",
});
Copy
type: azure-native:apimanagement:OpenIdConnectProvider
properties:
    clientId: string
    clientSecret: string
    description: string
    displayName: string
    metadataEndpoint: string
    opid: string
    resourceGroupName: string
    serviceName: string
Copy

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 This property is required. string
Client ID of developer console which is the client application.
DisplayName This property is required. string
User-friendly OpenID Connect Provider name.
MetadataEndpoint This property is required. string
Metadata endpoint URI.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ServiceName
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. string
Identifier of the OpenID Connect Provider.
ClientId This property is required. string
Client ID of developer console which is the client application.
DisplayName This property is required. string
User-friendly OpenID Connect Provider name.
MetadataEndpoint This property is required. string
Metadata endpoint URI.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ServiceName
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. string
Identifier of the OpenID Connect Provider.
clientId This property is required. String
Client ID of developer console which is the client application.
displayName This property is required. String
User-friendly OpenID Connect Provider name.
metadataEndpoint This property is required. String
Metadata endpoint URI.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
serviceName
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. String
Identifier of the OpenID Connect Provider.
clientId This property is required. string
Client ID of developer console which is the client application.
displayName This property is required. string
User-friendly OpenID Connect Provider name.
metadataEndpoint This property is required. string
Metadata endpoint URI.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
serviceName
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. string
Identifier of the OpenID Connect Provider.
client_id This property is required. str
Client ID of developer console which is the client application.
display_name This property is required. str
User-friendly OpenID Connect Provider name.
metadata_endpoint This property is required. str
Metadata endpoint URI.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
service_name
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. str
Identifier of the OpenID Connect Provider.
clientId This property is required. String
Client ID of developer console which is the client application.
displayName This property is required. String
User-friendly OpenID Connect Provider name.
metadataEndpoint This property is required. String
Metadata endpoint URI.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
serviceName
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. String
Identifier of the OpenID Connect Provider.

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
Resource name.
Type string
Resource type for API Management resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
Type string
Resource type for API Management resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
type String
Resource type for API Management resource.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name.
type string
Resource type for API Management resource.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name.
type str
Resource type for API Management resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
type String
Resource type for API Management resource.

Import

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

$ pulumi import azure-native:apimanagement:OpenIdConnectProvider templateOpenIdConnect3 /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3
Copy

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

Package Details

Repository
azure-native-v1 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native