Update-AzFunctionAppSetting

関数アプリのアプリ設定を追加または更新します。

構文

Update-AzFunctionAppSetting
      -Name <String>
      -ResourceGroupName <String>
      -AppSetting <Hashtable>
      [-SubscriptionId <String>]
      [-Force]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzFunctionAppSetting
      -AppSetting <Hashtable>
      -InputObject <ISite>
      [-Force]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

説明

関数アプリのアプリ設定を追加または更新します。

例 1: 関数アプリに新しいアプリ設定を追加する。

Update-AzFunctionAppSetting -Name MyAppName -ResourceGroupName MyResourceGroupName -AppSetting @{"Name1" = "Value1"}

このコマンドは、関数アプリに新しいアプリ設定を追加します。

パラメーター

-AppSetting

キーと値を含むハッシュテーブルは、関数アプリで追加または更新されるアプリ設定を記述します。 例: @{"myappsetting"="123"}

Type:Hashtable
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Force

確認を求めずに関数アプリの設定を強制的に更新します。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

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

-Name

関数アプリの名前。

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

-ResourceGroupName

リソースが属しているリソース グループの名前。

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

-SubscriptionId

Azure サブスクリプション ID。

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

入力

ISite

出力

IStringDictionary

メモ

別名

複合パラメーターのプロパティ

以下で説明するパラメーターを作成するには、適切なプロパティを含むハッシュ テーブルを作成します。 ハッシュ テーブルの詳細については、Get-Help about_Hash_Tablesを実行します。

INPUTOBJECT <ISite>:

  • Location <String>: リソースの場所。
  • [Kind <String>]: リソースの種類。
  • [Tag <IResourceTags>]: リソース タグ。
    • [(Any) <String>]: これは、このオブジェクトにプロパティを追加できることを示します。
  • [ClientAffinityEnabled <Boolean?>]: true クライアント アフィニティを有効にする場合は 。 false セッション アフィニティ Cookie の送信を停止します。これにより、同じセッション内のクライアント要求が同じインスタンスにルーティングされます。 既定値は true です。
  • [ClientCertEnabled <Boolean?>]: true クライアント証明書認証 (TLS 相互認証) を有効にする場合は 。それ以外の場合 falseは 。 既定値は false です。
  • [ClientCertExclusionPath <String>]: クライアント証明書認証のコンマ区切り除外パス
  • [CloningInfoAppSettingsOverride <ICloningInfoAppSettingsOverrides>]: 複製されたアプリのアプリケーション設定のオーバーライド。 指定した場合、これらの設定はソース アプリから複製された設定をオーバーライドします。 それ以外の場合、ソース アプリのアプリケーション設定は保持されます。
    • [(Any) <String>]: これは、このオブジェクトにプロパティを追加できることを示します。
  • [CloningInfoCloneCustomHostName <Boolean?>]: true ソース アプリからカスタム ホスト名を複製する場合は 。それ以外の場合 falseは 。
  • [CloningInfoCloneSourceControl <Boolean?>]: true ソース アプリからソース管理を複製する場合は 。それ以外の場合 falseは 。
  • [CloningInfoConfigureLoadBalancing <Boolean?>]: true ソース アプリと移行先アプリの負荷分散を構成します。
  • [CloningInfoCorrelationId <String>]: 複製操作の関連付け ID。 この ID は、同じスナップショットを使用するために複数の複製操作を結び付けます。
  • [CloningInfoHostingEnvironment <String>]: App Service Environment。
  • [CloningInfoOverwrite <Boolean?>]: true 宛先アプリを上書きする場合は 。それ以外の場合 falseは 。
  • [CloningInfoSourceWebAppId <String>]: ソース アプリの ARM リソース ID。 アプリ リソース ID は、運用スロットの場合は /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}、他のスロットの場合は /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} の形式です。
  • [CloningInfoSourceWebAppLocation <String>]: ソース アプリの場所例: 米国西部または北ヨーロッパ
  • [CloningInfoTrafficManagerProfileId <String>]: 使用する Traffic Manager プロファイルの ARM リソース ID (存在する場合)。 Traffic Manager リソース ID は、/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName} の形式です。
  • [CloningInfoTrafficManagerProfileName <String>]: 作成する Traffic Manager プロファイルの名前。 これは、Traffic Manager プロファイルがまだ存在しない場合にのみ必要です。
  • [Config <ISiteConfig>]: アプリの構成。
    • [AcrUseManagedIdentityCred <Boolean?>]: ACR プルにマネージド ID Creds を使用するためのフラグ
    • [AcrUserManagedIdentityId <String>]: ユーザー マネージド ID を使用している場合、ユーザーマネージド ID ClientId
    • [ActionMinProcessExecutionTime <String>]: アクションを実行する前にプロセスを実行する必要がある最小時間
    • [ActionType <AutoHealActionType?>]: 実行する定義済みのアクション。
    • [AlwaysOn <Boolean?>]: true Always Onが有効な場合は 。それ以外の場合falseは 。
    • [ApiDefinitionUrl <String>]: API 定義の URL。
    • [ApiManagementConfigId <String>]: APIM-Api識別子。
    • [AppCommandLine <String>]: 起動するアプリのコマンド ライン。
    • [AppSetting <INameValuePair[]>]: アプリケーションの設定。
      • [Name <String>]: ペア名。
      • [Value <String>]: ペア値。
    • [AutoHealEnabled <Boolean?>]: true 自動修復が有効な場合は 。それ以外の場合 falseは 。
    • [AutoSwapSlotName <String>]: スロット名を自動スワップします。
    • [ConnectionString <IConnStringInfo[]>]: 接続文字列。
      • [ConnectionString <String>]: 接続文字列の値。
      • [Name <String>]: 接続文字列の名前。
      • [Type <ConnectionStringType?>]: データベースの種類。
    • [CorAllowedOrigin <String[]>]: クロスオリジン呼び出しを許可する必要がある配信元の一覧を取得または設定します (例: http://example.com:12345)。 すべてを許可するには "*" を使用します。
    • [CorSupportCredentials <Boolean?>]: 資格情報を持つ CORS 要求を許可するかどうかを取得または設定します。 詳細については、 https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials をご覧ください。
    • [CustomActionExe <String>]: 実行する実行可能ファイル。
    • [CustomActionParameter <String>]: 実行可能ファイルのパラメーター。
    • [DefaultDocument <String[]>]: 既定のドキュメント。
    • [DetailedErrorLoggingEnabled <Boolean?>]: true 詳細なエラー ログが有効な場合は 。それ以外の場合 falseは 。
    • [DocumentRoot <String>]: ドキュメント ルート。
    • [DynamicTagsJson <String>]: プッシュ登録エンドポイントのユーザー要求から評価される動的タグの一覧を含む JSON 文字列を取得または設定します。
    • [ExperimentRampUpRule <IRampUpRule[]>]: ランプアップ ルールの一覧。
      • [ActionHostName <String>]: トラフィックがリダイレクトされるスロットのホスト名 (決定した場合)。 例: myapp-stage.azurewebsites.net。
      • [ChangeDecisionCallbackUrl <String>]: カスタム決定アルゴリズムは、指定できる URL を TiPCallback サイト拡張機能で提供できます。 スキャフォールディングとコントラクトについては、「TiPCallback サイト拡張機能」を参照してください。 https://www.siteextensions.net/packages/TiPCallback/
      • [ChangeIntervalInMinute <Int32?>]: ReroutePercentage を再評価する間隔を分単位で指定します。
      • [ChangeStep <Double?>]: 自動ランプ アップ シナリオでは、これは、\nMinReroutePercentage または MaxReroutePercentageに達するまでのReroutePercentage追加/削除の手順です。 サイト メトリックは、.\nカスタム決定アルゴリズムで ChangeIntervalInMinutes指定された N 分ごとにチェックされます。TiPCallback サイト拡張機能では、この URL を で ChangeDecisionCallbackUrl指定できます。
      • [MaxReroutePercentage <Double?>]: ReroutePercentage を維持する上限を指定します。
      • [MinReroutePercentage <Double?>]: ReroutePercentage を維持する下限を指定します。
      • [Name <String>]: ルーティング規則の名前。 推奨される名前は、実験でトラフィックを受信するスロットをポイントすることです。
      • [ReroutePercentage <Double?>]: にリダイレクトされるトラフィックの ActionHostName割合。
    • [FtpsState <FtpsState?>]: FTP/FTPS サービスの状態
    • [HandlerMapping <IHandlerMapping[]>]: ハンドラー マッピング。
      • [Argument <String>]: スクリプト プロセッサに渡されるコマンド ライン引数。
      • [Extension <String>]: この拡張機能を持つ要求は、指定された FastCGI アプリケーションを使用して処理されます。
      • [ScriptProcessor <String>]: FastCGI アプリケーションへの絶対パス。
    • [HealthCheckPath <String>]: 正常性チェックパス
    • [Http20Enabled <Boolean?>]: Http20Enabled: クライアントが http2.0 経由で接続できるように Web サイトを構成します
    • [HttpLoggingEnabled <Boolean?>]: true HTTP ログが有効な場合は 。それ以外の場合 falseは 。
    • [IPSecurityRestriction <IIPSecurityRestriction[]>]: メインの IP セキュリティ制限。
      • [Action <String>]: この IP 範囲のアクセスを許可または拒否します。
      • [Description <String>]: IP 制限規則の説明。
      • [IPAddress <String>]: セキュリティ制限が有効な IP アドレス。 純粋な ipv4 アドレス (必須の SubnetMask プロパティ) または ipv4/mask (先頭のビット一致) などの CIDR 表記の形式を使用できます。 CIDR の場合、SubnetMask プロパティを指定することはできません。
      • [Name <String>]: IP 制限規則の名前。
      • [Priority <Int32?>]: IP 制限規則の優先順位。
      • [SubnetMask <String>]: 制限が有効な IP アドレスの範囲のサブネット マスク。
      • [SubnetTrafficTag <Int32?>]: (内部) サブネット トラフィック タグ
      • [Tag <IPFilterTag?>]: この IP フィルターの用途を定義します。 これは、プロキシでの IP フィルター処理をサポートするためです。
      • [VnetSubnetResourceId <String>]: 仮想ネットワーク リソース ID
      • [VnetTrafficTag <Int32?>]: (内部) Vnet トラフィック タグ
    • [IsPushEnabled <Boolean?>]: プッシュ エンドポイントが有効かどうかを示すフラグを取得または設定します。
    • [JavaContainer <String>]: Java コンテナー。
    • [JavaContainerVersion <String>]: Java コンテナーのバージョン。
    • [JavaVersion <String>]: Java バージョン。
    • [LimitMaxDiskSizeInMb <Int64?>]: 許容されるディスク サイズの最大使用量 (MB 単位)。
    • [LimitMaxMemoryInMb <Int64?>]: 許容される最大メモリ使用量 (MB 単位)。
    • [LimitMaxPercentageCpu <Double?>]: 最大許容 CPU 使用率。
    • [LinuxFxVersion <String>]: Linux App Framework とバージョン
    • [LoadBalancing <SiteLoadBalancing?>]: サイトの負荷分散。
    • [LocalMySqlEnabled <Boolean?>]: true ローカル MySQL を有効にする場合は 。それ以外の場合 falseは 。
    • [LogsDirectorySizeLimit <Int32?>]: HTTP ログのディレクトリ サイズの制限。
    • [MachineKeyDecryption <String>]: 暗号化解除に使用されるアルゴリズム。
    • [MachineKeyDecryptionKey <String>]: 復号化キー。
    • [MachineKeyValidation <String>]: MachineKey の検証。
    • [MachineKeyValidationKey <String>]: 検証キー。
    • [ManagedPipelineMode <ManagedPipelineMode?>]: マネージド パイプライン モード。
    • [ManagedServiceIdentityId <Int32?>]: マネージド サービス ID
    • [MinTlsVersion <SupportedTlsVersions?>]: MinTlsVersion: SSL 要求に必要な TLS の最小バージョンを構成します
    • [NetFrameworkVersion <String>]: バージョン.NET Framework。
    • [NodeVersion <String>]: Node.jsのバージョン。
    • [NumberOfWorker <Int32?>]: ワーカーの数。
    • [PhpVersion <String>]: PHP のバージョン。
    • [PowerShellVersion <String>]: PowerShell のバージョン。
    • [PreWarmedInstanceCount <Int32?>]: 事前に警告されたインスタンスの数。 この設定は、従量課金プランとエラスティック プランにのみ適用されます
    • [PublishingUsername <String>]: ユーザー名を公開しています。
    • [PushKind <String>]: リソースの種類。
    • [PythonVersion <String>]: Python のバージョン。
    • [RemoteDebuggingEnabled <Boolean?>]: true リモート デバッグが有効な場合は 。それ以外の場合 falseは 。
    • [RemoteDebuggingVersion <String>]: リモート デバッグのバージョン。
    • [RequestCount <Int32?>]: 要求数。
    • [RequestTimeInterval <String>]: 時間間隔。
    • [RequestTracingEnabled <Boolean?>]: true 要求トレースが有効な場合は 。それ以外の場合 falseは 。
    • [RequestTracingExpirationTime <DateTime?>]: トレースの有効期限を要求します。
    • [ScmIPSecurityRestriction <IIPSecurityRestriction[]>]: scm の IP セキュリティ制限。
    • [ScmIPSecurityRestrictionsUseMain <Boolean?>]: メインを使用する scm の IP セキュリティ制限。
    • [ScmType <ScmType?>]: SCM 型。
    • [SlowRequestCount <Int32?>]: 要求数。
    • [SlowRequestTimeInterval <String>]: 時間間隔。
    • [SlowRequestTimeTaken <String>]: 所要時間。
    • [TagWhitelistJson <String>]: プッシュ登録エンドポイントで使用するためにホワイトリストに登録されているタグの一覧を含む JSON 文字列を取得または設定します。
    • [TagsRequiringAuth <String>]: プッシュ登録エンドポイントでユーザー認証を使用する必要があるタグの一覧を含む JSON 文字列を取得または設定します。 タグは英数字と、'_'、'@'、'#'、'.'、':'、'-' で構成できます。 検証は、PushRequestHandler で実行する必要があります。
    • [TracingOption <String>]: トレース オプション。
    • [TriggerPrivateBytesInKb <Int32?>]: プライベート バイトに基づくルール。
    • [TriggerStatusCode <IStatusCodesBasedTrigger[]>]: 状態コードに基づくルール。
      • [Count <Int32?>]: 要求数。
      • [Status <Int32?>]: HTTP 状態コード。
      • [SubStatus <Int32?>]: 要求サブの状態。
      • [TimeInterval <String>]: 時間間隔。
      • [Win32Status <Int32?>]: Win32 エラー コード。
    • [Use32BitWorkerProcess <Boolean?>]: true 32 ビット ワーカー プロセスを使用する場合は 。それ以外の場合 falseは 。
    • [VirtualApplication <IVirtualApplication[]>]: 仮想アプリケーション。
      • [PhysicalPath <String>]: 物理パス。
      • [PreloadEnabled <Boolean?>]: true プリロードが有効な場合は 。それ以外の場合 falseは 。
      • [VirtualDirectory <IVirtualDirectory[]>]: 仮想アプリケーションの仮想ディレクトリ。
        • [PhysicalPath <String>]: 物理パス。
        • [VirtualPath <String>]: 仮想アプリケーションへのパス。
      • [VirtualPath <String>]: 仮想パス。
    • [VnetName <String>]: 名前Virtual Networkします。
    • [WebSocketsEnabled <Boolean?>]: true WebSocket が有効な場合は 。それ以外の場合 falseは 。
    • [WindowsFxVersion <String>]: Xenon App Framework とバージョン
    • [XManagedServiceIdentityId <Int32?>]: 明示的なマネージド サービス ID
  • [ContainerSize <Int32?>]: 関数コンテナーのサイズ。
  • [DailyMemoryTimeQuota <Int32?>]: 1 日に許可される最大メモリ時間クォータ (動的アプリにのみ適用されます)。
  • [Enabled <Boolean?>]: true アプリが有効な場合は 。それ以外の場合 falseは 。 この値を false に設定すると、アプリが無効になります (アプリはオフラインになります)。
  • [HostNameSslState <IHostNameSslState[]>]: ホスト名 SSL 状態は、アプリのホスト名の SSL バインドを管理するために使用されます。
    • [HostType <HostType?>]: ホスト名が標準ホスト名かリポジトリ ホスト名かを示します。
    • [Name <String>]:ホスト。
    • [SslState <SslState?>]: SSL の種類。
    • [Thumbprint <String>]: SSL 証明書の拇印。
    • [ToUpdate <Boolean?>]: を に true 設定して、既存のホスト名を更新します。
    • [VirtualIP <String>]: IP ベースの SSL が有効になっている場合にホスト名に割り当てられた仮想 IP アドレス。
  • [HostNamesDisabled <Boolean?>]: true アプリのパブリック ホスト名を無効にする場合は 。それ以外の場合 falseは 。 の場合 true、アプリには API 管理プロセス経由でのみアクセスできます。
  • [HostingEnvironmentProfileId <String>]: App Service Environmentのリソース ID。
  • [HttpsOnly <Boolean?>]: HttpsOnly: https 要求のみを受け入れるように Web サイトを構成します。 http 要求のリダイレクトに関する問題
  • [HyperV <Boolean?>]: Hyper-V サンドボックス。
  • [IdentityType <ManagedServiceIdentityType?>]: マネージド サービス ID の種類。
  • [IdentityUserAssignedIdentity <IManagedServiceIdentityUserAssignedIdentities>]: リソースに関連付けられているユーザー割り当て ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。
    • [(Any) <IComponents1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties>]: これは、このオブジェクトにプロパティを追加できることを示します。
  • [IsXenon <Boolean?>]: 廃止: Hyper-V サンドボックス。
  • [RedundancyMode <RedundancyMode?>]: サイト冗長モード
  • [Reserved <Boolean?>]: true 予約されている場合は 。それ以外の場合 falseは 。
  • [ScmSiteAlsoStopped <Boolean?>]: true アプリが停止したときに SCM (KUDU) サイトを停止する場合は 。それ以外の場合 falseは 。 既定値は、false です。
  • [ServerFarmId <String>]: 関連付けられているApp Service プランのリソース ID。"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}" という形式です。