Set-AzApiManagementOpenIdConnectProvider

モジュール:

Az.ApiManagement

OpenID Connect プロバイダーを変更します。

構文

Set-AzApiManagementOpenIdConnectProvider
   -Context <PsApiManagementContext>
   -OpenIdConnectProviderId <String>
   [-Name <String>]
   [-MetadataEndpointUri <String>]
   [-ClientId <String>]
   [-ClientSecret <String>]
   [-Description <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzApiManagementOpenIdConnectProvider コマンドレットは、Azure API Management の OpenID Connect プロバイダーを変更します。

例

例 1: プロバイダーのクライアント シークレットを変更する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvider01" -ClientSecret <ClientSecret> -PassThru

このコマンドは、ID OICProvider01 を持つプロバイダーを変更します。 このコマンドは、プロバイダーのクライアント シークレットを指定します。

例 2

OpenID Connect プロバイダーを変更します。 (自動生成)

Set-AzApiManagementOpenIdConnectProvider -ClientId 'clientid' -ClientSecret <ClientSecret> -Context <PsApiManagementContext> -OpenIdConnectProviderId 'OICProvider01' -PassThru

パラメーター

-ClientId

開発者コンソールのクライアント ID を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ClientSecret

開発者コンソールのクライアント シークレットを指定します。

型:	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

-Description

説明を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-MetadataEndpointUri

プロバイダーのメタデータ エンドポイント URI を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Name

プロバイダーのフレンドリ名を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-OpenIdConnectProviderId

このコマンドレットが変更するプロバイダーの ID を指定します。 ID を指定しない場合、このコマンドレットは ID を生成します。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-PassThru

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

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PsApiManagementContext

String

SwitchParameter

出力

PsApiManagementOpenIdConnectProvider

関連リンク

• Get-AzApiManagementOpenIdConnectProvider
• New-AzApiManagementOpenIdConnectProvider
• Remove-AzApiManagementOpenIdConnectProvider