Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getOpenIdConnectProvider
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getOpenIdConnectProvider

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets specific OpenID Connect Provider without secrets.

Uses Azure REST API version 2022-08-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.

Using getOpenIdConnectProvider

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getOpenIdConnectProvider(args: GetOpenIdConnectProviderArgs, opts?: InvokeOptions): Promise<GetOpenIdConnectProviderResult>
function getOpenIdConnectProviderOutput(args: GetOpenIdConnectProviderOutputArgs, opts?: InvokeOptions): Output<GetOpenIdConnectProviderResult>
Copy
def get_open_id_connect_provider(opid: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 service_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetOpenIdConnectProviderResult
def get_open_id_connect_provider_output(opid: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 service_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetOpenIdConnectProviderResult]
Copy
func LookupOpenIdConnectProvider(ctx *Context, args *LookupOpenIdConnectProviderArgs, opts ...InvokeOption) (*LookupOpenIdConnectProviderResult, error)
func LookupOpenIdConnectProviderOutput(ctx *Context, args *LookupOpenIdConnectProviderOutputArgs, opts ...InvokeOption) LookupOpenIdConnectProviderResultOutput
Copy

> Note: This function is named LookupOpenIdConnectProvider in the Go SDK.

public static class GetOpenIdConnectProvider 
{
    public static Task<GetOpenIdConnectProviderResult> InvokeAsync(GetOpenIdConnectProviderArgs args, InvokeOptions? opts = null)
    public static Output<GetOpenIdConnectProviderResult> Invoke(GetOpenIdConnectProviderInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOpenIdConnectProviderResult> getOpenIdConnectProvider(GetOpenIdConnectProviderArgs args, InvokeOptions options)
public static Output<GetOpenIdConnectProviderResult> getOpenIdConnectProvider(GetOpenIdConnectProviderArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getOpenIdConnectProvider
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Opid
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the OpenID Connect Provider.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
Opid
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the OpenID Connect Provider.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
opid
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the OpenID Connect Provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
opid
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the OpenID Connect Provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
opid
This property is required.
Changes to this property will trigger replacement.
str
Identifier of the OpenID Connect Provider.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
opid
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the OpenID Connect Provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.

getOpenIdConnectProvider Result

The following output properties are available:

ClientId string
Client ID of developer console which is the client application.
DisplayName string
User-friendly OpenID Connect Provider name.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
MetadataEndpoint string
Metadata endpoint URI.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ClientSecret string
Client Secret of developer console which is the client application.
Description string
User-friendly description of 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.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
MetadataEndpoint string
Metadata endpoint URI.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ClientSecret string
Client Secret of developer console which is the client application.
Description string
User-friendly description of 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.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
metadataEndpoint String
Metadata endpoint URI.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
clientSecret String
Client Secret of developer console which is the client application.
description String
User-friendly description of 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.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
metadataEndpoint string
Metadata endpoint URI.
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
clientSecret string
Client Secret of developer console which is the client application.
description string
User-friendly description of 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.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
metadata_endpoint str
Metadata endpoint URI.
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
client_secret str
Client Secret of developer console which is the client application.
description str
User-friendly description of 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.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
metadataEndpoint String
Metadata endpoint URI.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
clientSecret String
Client Secret of developer console which is the client application.
description String
User-friendly description of 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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native