Update-AzContainerAppAuthConfig

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

コンテナー アプリの AuthConfig を作成します。

構文

Update-AzContainerAppAuthConfig
      -ContainerAppName <String>
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-CookieExpirationConvention <String>]
      [-CookieExpirationTimeToExpiration <String>]
      [-ForwardProxyConvention <String>]
      [-ForwardProxyCustomHostHeaderName <String>]
      [-ForwardProxyCustomProtoHeaderName <String>]
      [-GlobalValidationExcludedPath <String[]>]
      [-GlobalValidationRedirectToProvider <String>]
      [-GlobalValidationUnauthenticatedClientAction <String>]
      [-HttpSettingRequireHttps]
      [-IdentityProvider <IIdentityProviders>]
      [-LoginAllowedExternalRedirectUrl <String[]>]
      [-LoginPreserveUrlFragmentsForLogin]
      [-NonceExpirationInterval <String>]
      [-NonceValidateNonce]
      [-PlatformEnabled]
      [-PlatformRuntimeVersion <String>]
      [-RouteApiPrefix <String>]
      [-RouteLogoutEndpoint <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzContainerAppAuthConfig
      -Name <String>
      -ContainerAppInputObject <IAppIdentity>
      [-CookieExpirationConvention <String>]
      [-CookieExpirationTimeToExpiration <String>]
      [-ForwardProxyConvention <String>]
      [-ForwardProxyCustomHostHeaderName <String>]
      [-ForwardProxyCustomProtoHeaderName <String>]
      [-GlobalValidationExcludedPath <String[]>]
      [-GlobalValidationRedirectToProvider <String>]
      [-GlobalValidationUnauthenticatedClientAction <String>]
      [-HttpSettingRequireHttps]
      [-IdentityProvider <IIdentityProviders>]
      [-LoginAllowedExternalRedirectUrl <String[]>]
      [-LoginPreserveUrlFragmentsForLogin]
      [-NonceExpirationInterval <String>]
      [-NonceValidateNonce]
      [-PlatformEnabled]
      [-PlatformRuntimeVersion <String>]
      [-RouteApiPrefix <String>]
      [-RouteLogoutEndpoint <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzContainerAppAuthConfig
      -InputObject <IAppIdentity>
      [-CookieExpirationConvention <String>]
      [-CookieExpirationTimeToExpiration <String>]
      [-ForwardProxyConvention <String>]
      [-ForwardProxyCustomHostHeaderName <String>]
      [-ForwardProxyCustomProtoHeaderName <String>]
      [-GlobalValidationExcludedPath <String[]>]
      [-GlobalValidationRedirectToProvider <String>]
      [-GlobalValidationUnauthenticatedClientAction <String>]
      [-HttpSettingRequireHttps]
      [-IdentityProvider <IIdentityProviders>]
      [-LoginAllowedExternalRedirectUrl <String[]>]
      [-LoginPreserveUrlFragmentsForLogin]
      [-NonceExpirationInterval <String>]
      [-NonceValidateNonce]
      [-PlatformEnabled]
      [-PlatformRuntimeVersion <String>]
      [-RouteApiPrefix <String>]
      [-RouteLogoutEndpoint <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

コンテナー アプリの AuthConfig を作成します。

例

例 1: コンテナー アプリの AuthConfig を作成します。

Update-AzContainerAppAuthConfig -Name current -ContainerAppName azps-containerapp-2 -ResourceGroupName azps_test_group_app -PlatformEnabled -GlobalValidationUnauthenticatedClientAction RedirectToLoginPage -IdentityProvider $identity

Name    PlatformEnabled ResourceGroupName
----    --------------- -----------------
current True            azps_test_group_app

コンテナー アプリの AuthConfig を作成します。

例 2: コンテナー アプリの AuthConfig を作成する。

$containerapp = Get-AzContainerApp -ResourceGroupName azps_test_group_app -Name azps-containerapp-2

Update-AzContainerAppAuthConfig -Name current -ContainerAppInputObject $containerapp -PlatformEnabled -GlobalValidationUnauthenticatedClientAction RedirectToLoginPage -IdentityProvider $identity

Name    PlatformEnabled ResourceGroupName
----    --------------- -----------------
current True            azps_test_group_app

コンテナー アプリの AuthConfig を作成します。

例 3: コンテナー アプリの AuthConfig を作成します。

$authconfig = Get-AzContainerAppAuthConfig -Name current -ContainerAppName azps-containerapp-2 -ResourceGroupName azps_test_group_app

Update-AzContainerAppAuthConfig -InputObject $authconfig -PlatformEnabled -GlobalValidationUnauthenticatedClientAction RedirectToLoginPage -IdentityProvider $identity

Name    PlatformEnabled ResourceGroupName
----    --------------- -----------------
current True            azps_test_group_app

コンテナー アプリの AuthConfig を作成します。

パラメーター

-Confirm

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

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

-ContainerAppInputObject

IDENTITY Parameter To construct, see NOTES section for CONTAINERAPPINPUTOBJECT properties and create a hash table.

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

-ContainerAppName

コンテナー アプリの名前。

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

-CookieExpirationConvention

セッション Cookie の有効期限を決定するときに使用される規則。

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

-CookieExpirationTimeToExpiration

セッション Cookie の有効期限が切れる要求の後の時間。

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

-DefaultProfile

DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

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

-ForwardProxyConvention

要求の URL を決定するために使用される規則。

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

-ForwardProxyCustomHostHeaderName

要求のホストを含むヘッダーの名前。

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

-ForwardProxyCustomProtoHeaderName

要求のスキームを含むヘッダーの名前。

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

-GlobalValidationExcludedPath

認証されていないフローがログイン ページにリダイレクトされないパス。

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

-GlobalValidationRedirectToProvider

複数のプロバイダーが構成されている場合に使用する既定の認証プロバイダー。この設定は、複数のプロバイダーが構成されていて、認証されていないクライアントアクションが "RedirectToLoginPage" に設定されている場合にのみ必要です。

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

-GlobalValidationUnauthenticatedClientAction

認証されていないクライアントがアプリにアクセスしようとしたときに実行するアクション。

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

-HttpSettingRequireHttps

<>HTTPS スキームを持たない認証/承認応答が許容される場合は false</code>、それ以外の場合<は true</code> をコード>化します。

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

-IdentityProvider

ContainerApp Service の認証/承認の構成に使用される各 ID プロバイダーの構成設定。 構築するには、IDENTITYPROVIDER プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

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

-InputObject

ID パラメーターを構築するには、INPUTOBJECT プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

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

-LoginAllowedExternalRedirectUrl

アプリのログインまたはログアウトの一環としてリダイレクトできる外部 URL。 URL のクエリ文字列部分は無視されることに注意してください。これは、通常、Windows ストア アプリケーション バックエンドでのみ必要な詳細設定です。現在の doメイン 内の URL は常に暗黙的に許可されることに注意してください。

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

-LoginPreserveUrlFragmentsForLogin

<ログイン>要求が行われた後に要求のフラグメントが保持される場合は true</code>、それ以外の場合<は false</code> をコード>化します。

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

-Name

コンテナー アプリの AuthConfig の名前。

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

-NonceExpirationInterval

nonce の有効期限が切れる要求の後の時間。

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

-NonceValidateNonce

<>ログイン フローの実行中に nonce を検証しない場合は false</code>、それ以外の場合<は true</code> をコード>化します。

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

-PlatformEnabled

<現在>のアプリに対して認証/承認機能が有効になっている場合は true</code>、それ以外の場合<は false</code> をコード>化します。

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

-PlatformRuntimeVersion

現在のアプリで使用されている認証/承認機能の RuntimeVersion。この値の設定は、認証/承認モジュールの特定の機能の動作を制御できます。

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

-ResourceGroupName

リソース グループの名前。 名前の大文字と小文字は区別されます。

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

-RouteApiPrefix

すべての認証/承認パスの前に置くプレフィックス。

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

-RouteLogoutEndpoint

ログアウト要求を行うエンドポイント。

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

-SubscriptionId

ターゲット サブスクリプションの ID。

型:String
配置:Named
規定値:(Get-AzContext).Subscription.Id
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

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

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

入力

IAppIdentity

出力

IAuthConfig