次の方法で共有

ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams interface

パッケージ:
@azure/servicefabric

省略可能なパラメーター。

Extends
RequestOptionsBase

プロパティ

applicationHealthPolicy

アプリケーションまたはその子の正常性を評価するために使用される正常性ポリシーについて説明します。 存在しない場合、正常性評価では、アプリケーション マニフェストまたは既定の正常性ポリシーの正常性ポリシーが使用されます。
eventsHealthStateFilter

正常性状態に基づいて返される HealthEvent オブジェクトのコレクションをフィルター処理できるようにします。 このパラメーターに指定できる値には、次のいずれかの正常性状態の整数値が含まれます。 フィルターに一致するイベントのみが返されます。 すべてのイベントは、集計された正常性状態を評価するために使用されます。 指定しない場合は、すべてのエントリが返されます。 状態の値はフラグ ベースの列挙体であるため、値は、ビットごとの 'OR' 演算子を使用して取得されるこれらの値の組み合わせにすることができます。 たとえば、指定された値が 6 の場合、HealthState 値が OK (2) および Warning (4) のすべてのイベントが返されます。

  • 既定値 - 既定値。 任意の HealthState と一致します。 値は 0 です。
  • なし - HealthState 値と一致しないフィルター。 特定の状態のコレクションに対する結果を返さないために使用されます。 値は 1 です。
  • Ok - HealthState 値 Ok の入力と一致するフィルター。 値は 2 です。
  • 警告 - HealthState 値 Warning の入力と一致するフィルター。 値は 4 です。
  • エラー - HealthState 値 Error の入力と一致するフィルター。 値は 8 です。
  • All - 任意の HealthState 値を持つ入力と一致するフィルター。 値は 65535 です。 既定値: 0。
excludeHealthStatistics

正常性統計をクエリ結果の一部として返す必要があるかどうかを示します。 既定では False です。 統計情報には、正常性状態 Ok、警告、およびエラーの子エンティティの数が表示されます。 既定値: false。
partitionsHealthStateFilter

正常性状態に基づいて、サービス正常性クエリの結果として返されるパーティションの正常性状態オブジェクトのフィルター処理を許可します。 このパラメーターに指定できる値には、次のいずれかの正常性状態の整数値が含まれます。 フィルターに一致するパーティションのみが返されます。 すべてのパーティションは、集計された正常性状態を評価するために使用されます。 指定しない場合は、すべてのエントリが返されます。 状態値はフラグ ベースの列挙体であるため、値はビットごとの 'OR' 演算子を使用して取得したこれらの値の組み合わせにすることができます。 たとえば、指定された値が 6 の場合、HealthState 値が OK (2) と Warning (4) のパーティションの正常性状態が返されます。

  • 既定値 - 既定値。 任意の HealthState と一致します。 値は 0 です。
  • なし - HealthState 値と一致しないフィルター。 特定の状態のコレクションに対する結果を返さないために使用されます。 値は 1 です。
  • Ok - HealthState 値 Ok の入力と一致するフィルター。 値は 2 です。
  • 警告 - HealthState 値 Warning の入力と一致するフィルター。 値は 4 です。
  • エラー - HealthState 値 Error の入力と一致するフィルター。 値は 8 です。
  • All - 任意の HealthState 値を持つ入力と一致するフィルター。 値は 65535 です。 既定値: 0。
timeoutParameter

操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求された操作が完了するまでクライアントが待機する期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値: 60。

継承されたプロパティ

abortSignal

要求を中止するために使用できるシグナル。
customHeaders

要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。
onUploadProgress

アップロードの進行状況時に発生するコールバック。
timeout

要求が自動的に終了するまでの時間 (ミリ秒)。

プロパティの詳細

applicationHealthPolicy

アプリケーションまたはその子の正常性を評価するために使用される正常性ポリシーについて説明します。 存在しない場合、正常性評価では、アプリケーション マニフェストまたは既定の正常性ポリシーの正常性ポリシーが使用されます。

applicationHealthPolicy?: ApplicationHealthPolicy

プロパティ値

ApplicationHealthPolicy

eventsHealthStateFilter

正常性状態に基づいて返される HealthEvent オブジェクトのコレクションをフィルター処理できるようにします。 このパラメーターに指定できる値には、次のいずれかの正常性状態の整数値が含まれます。 フィルターに一致するイベントのみが返されます。 すべてのイベントは、集計された正常性状態を評価するために使用されます。 指定しない場合は、すべてのエントリが返されます。 状態の値はフラグ ベースの列挙体であるため、値は、ビットごとの 'OR' 演算子を使用して取得されるこれらの値の組み合わせにすることができます。 たとえば、指定された値が 6 の場合、HealthState 値が OK (2) および Warning (4) のすべてのイベントが返されます。

  • 既定値 - 既定値。 任意の HealthState と一致します。 値は 0 です。
  • なし - HealthState 値と一致しないフィルター。 特定の状態のコレクションに対する結果を返さないために使用されます。 値は 1 です。
  • Ok - HealthState 値 Ok の入力と一致するフィルター。 値は 2 です。
  • 警告 - HealthState 値 Warning の入力と一致するフィルター。 値は 4 です。
  • エラー - HealthState 値 Error の入力と一致するフィルター。 値は 8 です。
  • All - 任意の HealthState 値を持つ入力と一致するフィルター。 値は 65535 です。 既定値: 0。
eventsHealthStateFilter?: number

プロパティ値

number

excludeHealthStatistics

正常性統計をクエリ結果の一部として返す必要があるかどうかを示します。 既定では False です。 統計情報には、正常性状態 Ok、警告、およびエラーの子エンティティの数が表示されます。 既定値: false。

excludeHealthStatistics?: boolean

プロパティ値

boolean

partitionsHealthStateFilter

正常性状態に基づいて、サービス正常性クエリの結果として返されるパーティションの正常性状態オブジェクトのフィルター処理を許可します。 このパラメーターに指定できる値には、次のいずれかの正常性状態の整数値が含まれます。 フィルターに一致するパーティションのみが返されます。 すべてのパーティションは、集計された正常性状態を評価するために使用されます。 指定しない場合は、すべてのエントリが返されます。 状態値はフラグ ベースの列挙体であるため、値はビットごとの 'OR' 演算子を使用して取得したこれらの値の組み合わせにすることができます。 たとえば、指定された値が 6 の場合、HealthState 値が OK (2) と Warning (4) のパーティションの正常性状態が返されます。

  • 既定値 - 既定値。 任意の HealthState と一致します。 値は 0 です。
  • なし - HealthState 値と一致しないフィルター。 特定の状態のコレクションに対する結果を返さないために使用されます。 値は 1 です。
  • Ok - HealthState 値 Ok の入力と一致するフィルター。 値は 2 です。
  • 警告 - HealthState 値 Warning の入力と一致するフィルター。 値は 4 です。
  • エラー - HealthState 値 Error の入力と一致するフィルター。 値は 8 です。
  • All - 任意の HealthState 値を持つ入力と一致するフィルター。 値は 65535 です。 既定値: 0。
partitionsHealthStateFilter?: number

プロパティ値

number

timeoutParameter

操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求された操作が完了するまでクライアントが待機する期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値: 60。

timeoutParameter?: number

プロパティ値

number

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

msRest.RequestOptionsBase.abortSignal から継承された

customHeaders

要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。

customHeaders?: {[key: string]: string}

プロパティ値

{[key: string]: string}

msRest.RequestOptionsBase.customHeaders から継承された

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

msRest.RequestOptionsBase.onDownloadProgress から継承された

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。

timeout?: number

プロパティ値

number

msRest.RequestOptionsBase.timeout から継承された