Set-AzureRmApiManagementOpenIdConnectProvider

Modifies an OpenID Connect provider.

Syntax

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

Description

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

Examples

Example 1: Change the client secret for a provider

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Set-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01" -ClientSecret "q2w3e43r45" -PassThru

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

Required Parameters

-Context

Specifies a PsApiManagementContext object.

Type:Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-ClientId

Specifies the client ID of the developer console.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ClientSecret

Specifies the client secret of the developer console.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DefaultProfile

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-MetadataEndpointUri

Specifies a metadata endpoint URI of the provider.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies a friendly name for the provider.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PassThru

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

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOpenIdConnectProvider