uip または設定

uip or settings テナント レベルの Orchestrator の設定の読み取りと書き込みを行います。設定は、ドット付きのプレフィックス (Abp.Timing.*、 Alerts.Email.*、 Auth.*、 Scalability.*、 Triggers.*など) で整理されたキーと値のペアです。settings list を使用してキーを検出し、settings get/update を使用して 1 つの値を読み取ったり変更したり、構造化された実行設定の構成 (表示名と許可された値) をsettings executionしたり、settings timezones を使用して有効なタイムゾーン ID を一覧表示したりします。

概要

uip or settings <verb> [options]

動詞

動詞	目的
list	テナントの設定を一覧表示します。
get	1つの設定をキーで読み取ります。
update	1つの設定をキーで書きます。
execution	実行設定の構成を取得します (グローバル スコープまたはロボット スコープ)。
timezones	利用可能なタイムゾーン ID のリストを表示します。

すべての動詞は 、グローバル オプション (--output、 --output-filter、 --log-level、 --log-file) に従います。終了コードは 標準コントラクトに従います。

一般的な設定キー

以下のカテゴリは網羅的ではありません— settings list を使用してすべてを発見してください。

• 全般: [ Abp.Timing.TimeZone (タイムゾーン ID — 有効な ID を一覧表示するには settings timezones を実行)、 Abp.Localization.DefaultLanguageName (例: en、 fr、 de)。
• メール アラート: Alerts.Email.Enabled、Abp.Net.Mail.Smtp.Host、.Port、.UserName、.Password、.EnableSsl、.UseDefaultCredentials、Abp.Net.Mail.DefaultFromAddress
• ロボットのセキュリティ: Auth.Robot.EnforceAuthenticationToken、 Auth.UnattendedRobot.ForceClientCredentials、 AttendedRobot.RunDisconnectedHours (整数、 0 無効化)
• デプロイ: DeploymentUrl、 NuGet.Packages.ApiKey、 Deployment.Libraries.Url、 NuGet.Activities.ApiKey、 Deployment.Processes.AuthenticationType (Secure/apiKey)
• スケーラビリティ: Scalability.SignalR.Enabled、 Scalability.SignalR.Transport (ビットマスク: 1 WebSockets、 2 SSE、 4 LongPolling、 7 すべて)、 Scalability.Heartbeat.PeriodSeconds (既定 30)、 Scalability.Heartbeat.FailureThreshold (既定 4)。
• トリガー: Triggers.DisableWhenFailedCount (既定 10)、 Triggers.DisableWhenFailingSinceDays (既定 1)、 Triggers.JobsCountStrategy (PERPROCESS/PERTRIGGER)、 QueueTrigger.ActivationFrequencyInMinutes (既定 30)、 ConnectedTriggers.AutoDisableJobFailuresThreshold (既定 5)
• キュー: inProgressMaxNumberOfMinutes (デフォルト 1440 = 24 時間)。
• ジョブ: Jobs.TerminatingJobsTimeout (既定の 1440 分 = 24 時間)。

UIP または設定リスト

テナントの設定を一覧表示します。必要に応じて、スコープでフィルター処理します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--scope	ENUM	—	Application、 Tenant、 User、 All。
-l	--limit	Number	100	ページ サイズ
—	--offset	Number	0	カウントをスキップします。

例

uip or settings list
uip or settings list --scope Tenant --limit 200
uip or settings list --output-filter 'Data[].name'

データシェイプ(--output json)

{
  "Code": "SettingsList",
  "Data": [
    { "name": "Abp.Timing.TimeZone", "value": "UTC", "id": "Abp.Timing.TimeZone" },
    { "name": "Alerts.Email.Enabled", "value": "true", "id": "Alerts.Email.Enabled" }
  ]
}

uip または設定 get

1つの設定をキーで読み取ります。

引数

名前	Required	目的
<key>	○	設定キー( Abp.Timing.TimeZoneなど)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or settings get Abp.Timing.TimeZone
uip or settings get Alerts.Email.Enabled --output-filter 'Data.Value'

データシェイプ(--output json)

{
  "Code": "SettingsGet",
  "Data": {
    "Key": "Abp.Timing.TimeZone",
    "Value": "UTC"
  }
}

UIP または設定の更新

1つの設定をキーで書きます。

引数

名前	Required	目的
<key>	○	設定キー。
<value>	○	新しい値 (文字列、サーバー側の検証が適用されます)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or settings update Abp.Timing.TimeZone Europe/Bucharest
uip or settings update Alerts.Email.Enabled true

データシェイプ(--output json)

{
  "Code": "SettingsUpdated",
  "Data": {
    "Key": "Abp.Timing.TimeZone",
    "Value": "Europe/Bucharest",
    "Status": "Updated successfully"
  }
}

UIP または設定の実行

グローバル (0) スコープまたはロボット (1) スコープの構造化された実行設定の設定を取得します。各エントリには、表示名、値の種類 (Boolean、 MultipleChoiceなど)、既定値、および選択肢の種類の場合は許可された値のリストが含まれます。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--scope	0 OR 1	0	設定範囲: グローバル (0) または Robot (1)

例

# Global execution settings
uip or settings execution

# Robot-scoped execution settings
uip or settings execution --scope 1

# Just the keys and their allowed values
uip or settings execution \
    --output-filter 'Data._configuration[].{k:key, vals:possibleValues}'

データシェイプ(--output json)

{
  "Code": "ExecutionSettings",
  "Data": {
    "scope": "Global",
    "_configuration": [
      {
        "key": "TracingLevel",
        "displayName": "Logging Level",
        "valueType": "MultipleChoice",
        "defaultValue": "Information",
        "possibleValues": [
          "Verbose", "Trace", "Information", "Warning", "Error", "Critical", "Off"
        ]
      },
      {
        "key": "LoginToConsole",
        "displayName": "Login To Console",
        "valueType": "Boolean",
        "defaultValue": "true",
        "possibleValues": []
      }
    ]
  }
}

UIP または設定のタイムゾーン

Orchestrator によって認識されるタイムゾーン ID を一覧表示します。これらは、uip or calendarsの Abp.Timing.TimeZone と --time-zone の有効な値です。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or settings timezones
uip or settings timezones --output-filter 'Data[].value'

データシェイプ(--output json)

{
  "Code": "TimezoneList",
  "Data": [
    { "name": "(UTC) Coordinated Universal Time", "value": "UTC" },
    { "name": "(UTC+02:00) Bucharest", "value": "GTB Standard Time" }
  ]
}

関連コマンド

• uip or calendars — --time-zone値は settings timezonesから取得されます。
• uip or audit-logs — --component Settingsでフィルタリングして、設定の変更を表示します。

参照

• グローバルオプション — --output、 --output-filter、 --log-level、 --log-file。
• 終了コード — 標準の終了コード限月。