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 "q2w3e43r45" -PassThru

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

例 2

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

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

パラメーター

-ClientId

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

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

-ClientSecret

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

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

-Description

説明を指定します。

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

-MetadataEndpointUri

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

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

-Name

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

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

-OpenIdConnectProviderId

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

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

-PassThru

このコマンドレットによって変更された PsApiManagementOpenIdConnectProvider が返されることを示します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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

String

SwitchParameter

出力

PsApiManagementOpenIdConnectProvider