Set-AzApiManagementIdentityProvider
既存の 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 テナントの一覧。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Authority
AAD または AAD B2C の OpenID Connect 検出エンドポイントのホスト名。 このパラメーターは省略可能です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ClientId
外部 ID プロバイダー内のアプリケーションのクライアント ID。 Facebook ログインのアプリ ID、Google ログインのクライアント ID、Microsoft のアプリ ID です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ClientSecret
外部 ID プロバイダー内のアプリケーションのクライアント シークレット。ログイン要求の認証に使用されます。 たとえば、Facebook ログイン用のアプリ シークレット、Google ログイン用の API キー、Microsoft の公開キーなどです。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Context
PsApiManagementContext のインスタンス。 このパラメーターは必須です。
型: | PsApiManagementContext |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-InputObject
PsApiManagementIdentityProvider のインスタンス。 このパラメーターは必須です。
型: | PsApiManagementIdentityProvider |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-PassThru
このコマンドレットが変更した PsApiManagementIdentityProvider を返します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-PasswordResetPolicyName
パスワード リセット ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 このパラメーターは省略可能です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ProfileEditingPolicyName
プロファイル編集ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 このパラメーターは省略可能です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-SigninPolicyName
サインイン ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 このパラメーターは省略可能です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-SigninTenant
common
テナントの代わりに AAD B2C でオーバーライドするサインイン テナント
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-SignupPolicyName
サインアップ ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 このパラメーターは省略可能です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Type
既存の ID プロバイダーの識別子。 このパラメーターは必須です。
型: | PsApiManagementIdentityProviderType |
指定可能な値: | Facebook, Google, Microsoft, Twitter, Aad, AadB2C |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
PsApiManagementIdentityProviderType
String[]
出力
PsApiManagementIdentityProvider
関連リンク
Azure PowerShell