azure-native-v2.apimanagement.OpenIdConnectProvider
Explore with Pulumi AI
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-10-10, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
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
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",
UseInApiDocumentation = false,
UseInTestConsole = false,
});
example, err := apimanagement.NewOpenIdConnectProvider(ctx, "openIdConnectProviderResource", &apimanagement.OpenIdConnectProviderArgs{
ClientId: "string",
DisplayName: "string",
MetadataEndpoint: "string",
ResourceGroupName: "string",
ServiceName: "string",
ClientSecret: "string",
Description: "string",
Opid: "string",
UseInApiDocumentation: false,
UseInTestConsole: 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:
- Client
Id This property is required. string - Client ID of developer console which is the client application.
- Display
Name This property is required. string - User-friendly OpenID Connect Provider name.
- Metadata
Endpoint This property is required. string - Metadata endpoint URI.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Service
Name This property is required. Changes to this property will trigger replacement.
- The name of the API Management service.
- Client
Secret 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.
- Identifier of the OpenID Connect Provider.
- Use
In boolApi Documentation - 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 boolTest Console - 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 This property is required. string - Client ID of developer console which is the client application.
- Display
Name This property is required. string - User-friendly OpenID Connect Provider name.
- Metadata
Endpoint This property is required. string - Metadata endpoint URI.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Service
Name This property is required. Changes to this property will trigger replacement.
- The name of the API Management service.
- Client
Secret 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.
- Identifier of the OpenID Connect Provider.
- Use
In boolApi Documentation - 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 boolTest Console - 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 This property is required. String - Client ID of developer console which is the client application.
- display
Name This property is required. String - User-friendly OpenID Connect Provider name.
- metadata
Endpoint This property is required. String - Metadata endpoint URI.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- service
Name This property is required. Changes to this property will trigger replacement.
- The name of the API Management service.
- client
Secret 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.
- Identifier of the OpenID Connect Provider.
- use
In BooleanApi Documentation - 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 BooleanTest Console - 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 This property is required. string - Client ID of developer console which is the client application.
- display
Name This property is required. string - User-friendly OpenID Connect Provider name.
- metadata
Endpoint This property is required. string - Metadata endpoint URI.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- service
Name This property is required. Changes to this property will trigger replacement.
- The name of the API Management service.
- client
Secret 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.
- Identifier of the OpenID Connect Provider.
- use
In booleanApi Documentation - 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 booleanTest Console - 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 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.
- The name of the resource group. The name is case insensitive.
- service_
name This property is required. Changes to this property will trigger replacement.
- 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.
- Identifier of the OpenID Connect Provider.
- use_
in_ boolapi_ documentation - 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_ booltest_ console - 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 This property is required. String - Client ID of developer console which is the client application.
- display
Name This property is required. String - User-friendly OpenID Connect Provider name.
- metadata
Endpoint This property is required. String - Metadata endpoint URI.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- service
Name This property is required. Changes to this property will trigger replacement.
- The name of the API Management service.
- client
Secret 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.
- Identifier of the OpenID Connect Provider.
- use
In BooleanApi Documentation - 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 BooleanTest Console - 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:
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-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0