Set-EntraIdentityProvider
ディレクトリに構成されている既存の ID プロバイダーのプロパティを更新します。
構文
Default (既定)
Set-EntraIdentityProvider
-IdentityProviderBaseId <String>
[-Type <String>]
[-ClientSecret <String>]
[-ClientId <String>]
[-Name <String>]
[<CommonParameters>]
説明
Set-EntraIdentityProvider コマンドレットは、既存の ID プロバイダーのプロパティを更新するために使用されます。
ID プロバイダーの型は変更できません。
職場または学校アカウントを使用する委任されたシナリオでは、サインインしているユーザーは、必要なアクセス許可を持つMicrosoft Entra ロールまたはカスタム ロールを持っている必要があります。 この操作は、次の最小特権ロールでサポートされています。
- 外部 ID プロバイダー管理者
例
例 1: ID プロバイダーのクライアント ID を更新する
Connect-Entra -Scopes 'IdentityProvider.ReadWrite.All'
Set-EntraIdentityProvider -IdentityProviderBaseId 'Google-OAuth' -ClientId 'NewClientID'
次の使用例は、指定した ID プロバイダーのクライアント ID を更新します。
-
-Idパラメーターは、ID プロバイダーの一意識別子を指定します。 -
-ClientIdパラメーターは、アプリケーションの ID プロバイダーへのアプリケーションの登録時に取得される、アプリケーションのクライアント識別子を指定します。
例 2: ID プロバイダーのクライアント シークレットを更新する
Connect-Entra -Scopes 'IdentityProvider.ReadWrite.All'
Set-EntraIdentityProvider -IdentityProviderBaseId 'Google-OAuth' -ClientSecret 'NewClientSecret'
次の使用例は、指定した ID プロバイダーのクライアント シークレットを更新します。
-
-Idパラメーターは、ID プロバイダーの一意識別子を指定します。 -
-ClientSecretパラメーターは、ID プロバイダーへの登録時に取得されるアプリケーションのクライアント シークレットを指定します。
例 3: ID プロバイダーの表示名を更新する
Connect-Entra -Scopes 'IdentityProvider.ReadWrite.All'
Set-EntraIdentityProvider -IdentityProviderBaseId 'Google-OAuth' -Name 'NewGoogleName'
次の使用例は、指定した ID プロバイダーの表示名を更新します。
-
-Idパラメーターは、ID プロバイダーの一意識別子を指定します。 -
-Nameパラメーターは、ID プロバイダーの表示名を指定します。
パラメーター
-ClientId
アプリケーションの ID プロバイダーへのアプリケーションの登録中に取得される、アプリケーションのクライアント識別子。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ClientSecret
ID プロバイダーへの登録中に取得されたアプリケーションのクライアント シークレットは書き込み専用です。 読み取り操作を行うと、**** が返されます。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IdentityProviderBaseId
ID プロバイダーの一意識別子。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Id |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Name
ID プロバイダーの表示名。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Type
ID プロバイダーの型。 Microsoft、Google、Facebook、Amazon、LinkedInのいずれかの値を指定する必要があります。
B2B シナリオの場合、使用可能な値: Google、Facebook。 B2C シナリオの場合、可能な値: Microsoft、Google、Amazon、LinkedIn、Facebook、GitHub、Twitter、Weibo、QQ、WeChat。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。