Set-AzApiManagementIdentityProvider

  • リファレンス
モジュール:
Az.ApiManagement

既存の ID プロバイダーの構成を更新します。

構文

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>]

説明

既存の ID プロバイダーの構成を更新します。

例

例 1: facebook ID プロバイダーを更新する

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

このコマンドレットは、Facebook ID プロバイダーのクライアント シークレットを更新します。

例 2

既存の ID プロバイダーの構成を更新します。 (自動生成)

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

パラメーター

-AllowedTenants

許可されている Azure Active Directory テナントの一覧。

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

-Authority

AAD または AAD B2C の OpenID Connect 検出エンドポイントのホスト名。 このパラメーターは省略可能です。

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

-ClientId

外部 ID プロバイダー内のアプリケーションのクライアント ID。 Facebook ログインのアプリ ID、Google ログインのクライアント ID、Microsoft のアプリ ID です。

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

-ClientSecret

外部 ID プロバイダー内のアプリケーションのクライアント シークレット。ログイン要求の認証に使用されます。 たとえば、Facebook ログイン用のアプリ シークレット、Google ログイン用の API キー、Microsoft の公開キーなどです。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-Context

PsApiManagementContext のインスタンス。 このパラメーターは必須です。

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

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

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

-InputObject

PsApiManagementIdentityProvider のインスタンス。 このパラメーターは必須です。

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

-PassThru

このコマンドレットが変更した PsApiManagementIdentityProvider をこのコマンドレットが返したことを示します。

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

-PasswordResetPolicyName

パスワード リセット ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 このパラメーターは省略可能です。

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

-ProfileEditingPolicyName

プロファイル編集ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 このパラメーターは省略可能です。

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

-SigninPolicyName

サインイン ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 このパラメーターは省略可能です。

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

-SigninTenant

テナントではなく common AAD B2C でオーバーライドするサインイン テナント

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

-SignupPolicyName

サインアップ ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 このパラメーターは省略可能です。

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

-Type

既存の ID プロバイダーの識別子。 このパラメーターは必須です。

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

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

PsApiManagementContext

PsApiManagementIdentityProviderType

String

String[]

SwitchParameter

出力

PsApiManagementIdentityProvider