< Back

Set-AzureRmApiManagementOpenIdConnectProvider

Tue Jan 29, 2019 9:30 pm

NAME Set-AzureRmApiManagementOpenIdConnectProvider



SYNOPSIS

Modifies an OpenID Connect provider.





SYNTAX

Set-AzureRmApiManagementOpenIdConnectProvider [-ClientId <String>] [-ClientSecret <String>] -Context <PsApiManagementContext> [-DefaultProfile

<IAzureContextContainer>] [-Description <String>] [-MetadataEndpointUri <String>] [-Name <String>] -OpenIdConnectProviderId <String> [-PassThru]

[<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-ClientId <String>

Specifies the client ID of the developer console.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ClientSecret <String>

Specifies the client secret of the developer console.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Context <PsApiManagementContext>

Specifies a PsApiManagementContext object.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Description <String>

Specifies a description.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-MetadataEndpointUri <String>

Specifies a metadata endpoint URI of the provider.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

Specifies a friendly name for the provider.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-OpenIdConnectProviderId <String>

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



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

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







NOTES









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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ctprovider

Get-AzureRmApiManagementOpenIdConnectProvider

New-AzureRmApiManagementOpenIdConnectProvider

Remove-AzureRmApiManagementOpenIdConnectProvider