OpenidConnectProviderContract interface

Package:

@azure/arm-apimanagement

OpenId Connect Provider details.

Extends

ProxyResource

Properties

clientId	Client ID of developer console which is the client application.
clientSecret	Client Secret of developer console which is the client application.
description	User-friendly description of OpenID Connect Provider.
displayName	User-friendly OpenID Connect Provider name.
metadataEndpoint	Metadata endpoint URI.
useInApiDocumentation	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	If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

clientId

Client ID of developer console which is the client application.

clientId?: string

Property Value

string

clientSecret

Client Secret of developer console which is the client application.

clientSecret?: string

Property Value

string

description

User-friendly description of OpenID Connect Provider.

description?: string

Property Value

string

displayName

User-friendly OpenID Connect Provider name.

displayName?: string

Property Value

string

metadataEndpoint

Metadata endpoint URI.

metadataEndpoint?: string

Property Value

string

useInApiDocumentation

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.

useInApiDocumentation?: boolean

Property Value

boolean

useInTestConsole

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

useInTestConsole?: boolean

Property Value

boolean

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type