Set-AzureRmApiManagementIdentityProvider

NAME Set-AzureRmApiManagementIdentityProvider



SYNOPSIS

Updates the Configuration of an existing Identity Provider.





SYNTAX

Set-AzureRmApiManagementIdentityProvider [-AllowedTenants <String[]>] [-ClientId <String>] [-ClientSecret <String>] -Context

<PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-PassThru] -Type {Facebook | Google | Microsoft | Twitter | Aad} [-Confirm]

[-WhatIf] [<CommonParameters>]





DESCRIPTION

Updates the Configuration of an existing Identity Provider.





PARAMETERS

-AllowedTenants <String[]>

List of allowed Azure Active Directory Tenants.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ClientId <String>

Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for

Microsoft.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ClientSecret <String>

Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook

login, API Key for Google login, Public Key for Microsoft.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Context <PsApiManagementContext>

Instance of PsApiManagementContext. This parameter is required.



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



-PassThru [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Type <PsApiManagementIdentityProviderType>

Identifier of an existing Identity Provider. This parameter is required.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

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.PsApiManagementIdentityProvider







NOTES









Example 1



PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\> Set-AzureRmApiManagementIdentityProvider -Context $apimContext -Type Facebook -ClientSecret "updatedSecret" -PassThru



The cmdlet updates the Client Secret of the Facebook Identity Provider;







RELATED LINKS

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

New-AzureRmApiManagementIdentityProvider

Get-AzureRmApiManagementIdentityProvider

Remove-AzureRmApiManagementIdentityProvider