Modifier

Partager via

Set-AzApiManagementIdentityProvider

  • Reference
Module:
Az.ApiManagement

Updates the Configuration of an existing Identity Provider.

Syntax

Set-AzApiManagementIdentityProvider
   -Context <PsApiManagementContext>
   -Type <PsApiManagementIdentityProviderType>
   [-ClientId <String>]
   [-ClientSecret <String>]
   [-AllowedTenants <String[]>]
   [-Authority <String>]
   [-SignupPolicyName <String>]
   [-SigninPolicyName <String>]
   [-ProfileEditingPolicyName <String>]
   [-PasswordResetPolicyName <String>]
   [-SigninTenant <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzApiManagementIdentityProvider
   -InputObject <PsApiManagementIdentityProvider>
   [-ClientId <String>]
   [-ClientSecret <String>]
   [-AllowedTenants <String[]>]
   [-Authority <String>]
   [-SignupPolicyName <String>]
   [-SigninPolicyName <String>]
   [-ProfileEditingPolicyName <String>]
   [-PasswordResetPolicyName <String>]
   [-SigninTenant <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Updates the Configuration of an existing Identity Provider.

Examples

Example 1: Update the facebook Identity Provider

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementIdentityProvider -Context $apimContext -Type Facebook -ClientSecret "updatedSecret" -PassThru

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

Example 2

Updates the Configuration of an existing Identity Provider. (autogenerated)

Set-AzApiManagementIdentityProvider -AllowedTenants 'samirtestbc.onmicrosoft.com' -Authority <String> -ClientId 'clientid' -ClientSecret 'updatedSecret' -Context <PsApiManagementContext> -PasswordResetPolicyName <String> -ProfileEditingPolicyName <String> -SigninPolicyName <String> -SignupPolicyName B2C_1_signup-policy -Type Facebook

Parameters

-AllowedTenants

List of allowed Azure Active Directory Tenants.

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

-Authority

OpenID Connect discovery endpoint hostname for AAD or AAD B2C. This parameter is optional.

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

-ClientId

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.

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

-ClientSecret

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.

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

Instance of PsApiManagementContext. This parameter is required.

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

-InputObject

Instance of PsApiManagementIdentityProvider. This parameter is required.

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

-PassThru

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

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

-PasswordResetPolicyName

Password Reset Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional.

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

-ProfileEditingPolicyName

Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional.

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

-SigninPolicyName

Signin Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional.

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

-SigninTenant

Signin Tenant to override in AAD B2C instead of the common Tenant

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

-SignupPolicyName

Signup Policy Name. Only applies to AAD B2C Identity Provider. This parameter is optional.

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

-Type

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

Type:PsApiManagementIdentityProviderType
Accepted values:Facebook, Google, Microsoft, Twitter, Aad, AadB2C
Position:Named
Default value:None
Required:True
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

PsApiManagementIdentityProviderType

String

String[]

SwitchParameter

Outputs

PsApiManagementIdentityProvider