Set-AzApiManagementOpenIdConnectProvider

Module:

Az.ApiManagement

Modifies an OpenID Connect provider.

Syntax

Set-AzApiManagementOpenIdConnectProvider
   -Context <PsApiManagementContext>
   -OpenIdConnectProviderId <String>
   [-Name <String>]
   [-MetadataEndpointUri <String>]
   [-ClientId <String>]
   [-ClientSecret <String>]
   [-Description <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzApiManagementOpenIdConnectProvider cmdlet modifies an OpenID Connect provider in Azure API Management.

Examples

Example 1: Change the client secret for a provider

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvider01" -ClientSecret <ClientSecret> -PassThru

This command modifies the provider that has the ID OICProvider01. The command specifies a client secret for the provider.

Example 2

Modifies an OpenID Connect provider. (autogenerated)

Set-AzApiManagementOpenIdConnectProvider -ClientId 'clientid' -ClientSecret <ClientSecret> -Context <PsApiManagementContext> -OpenIdConnectProviderId 'OICProvider01' -PassThru

Parameters

-ClientId

Specifies the client ID of the developer console.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ClientSecret

Specifies the client secret of the developer console.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Context

Specifies a PsApiManagementContext object.

Type:	PsApiManagementContext
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Specifies a description.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-MetadataEndpointUri

Specifies a metadata endpoint URI of the provider.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specifies a friendly name for the provider.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-OpenIdConnectProviderId

Specifies an ID for the provider that this cmdlet modifies. If you do not specify an ID, this cmdlet generates one.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

Indicates that this cmdlet returns the PsApiManagementOpenIdConnectProvider that this cmdlet modifies.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PsApiManagementContext

String

SwitchParameter

Outputs

PsApiManagementOpenIdConnectProvider

Related Links

• Get-AzApiManagementOpenIdConnectProvider
• New-AzApiManagementOpenIdConnectProvider
• Remove-AzApiManagementOpenIdConnectProvider