AlertsGetAllTenantOptionalParams interface

パッケージ:

@azure/arm-alertsmanagement

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

Extends

OperationOptions

プロパティ

alertRule	特定のアラートルールでフィルタリングします。 デフォルト値は、すべて選択することです。
alertState	アラートインスタンスの状態でフィルタリングします。 デフォルト値は、すべて選択することです。
customTimeRange	<start-time>/<end-time> (ISO-8601 形式) の形式でカスタム時間範囲でフィルター処理します。 許容値は、クエリ時から 30 日以内です。 timeRange または customTimeRange のいずれかを使用できますが、両方を使用することはできません。 デフォルトは none です。
includeContext	モニター・サービスに固有のコンテキスト・データを持つコンテキストを含めます。 デフォルト値はfalseです。
includeEgressConfig	ポータルにコンテンツを表示するために使用される出力設定を含めます。 デフォルト値は 'false' です。
monitorCondition	モニター条件 (「起動済み」または [解決済み] のいずれか) でフィルタリングします。 デフォルト値は、すべて選択することです。
monitorService	アラート・インスタンスを生成するモニター・サービスでフィルタリングします。 デフォルト値は select all です。
pageCount	応答でページごとに返されるアラートの数を決定します。 許容値は 1 から 250 の間です。 "includeContent" フィルターが選択されている場合、許可される最大値は 25 です。 既定値は 25 です。
select	このフィルターでは、重要なセクションの一部となるフィールド(カンマ区切り)を選択できます。 これにより、コンテンツ全体を取得するのではなく、必要なフィールドのみを投影できます。 デフォルトでは、essentials セクションのすべてのフィールドが取得されます。
severity	重大度でフィルター処理します。 デフォルト値は select all です。
smartGroupId	スマート グループ ID でアラート リストをフィルタリングします。デフォルト値は none です。
sortBy	入力フィールドでクエリ結果を並べ替えます。デフォルト値は「lastModifiedDateTime」です。
sortOrder	クエリ結果の順序を昇順または降順で並べ替えます。 デフォルト値は、時間フィールドの場合は 'desc'、その他のフィールドの場合は 'asc' です。
targetResource	ターゲット・リソース(完全なARM ID)でフィルタリングデフォルト値は「すべて選択」です。
targetResourceGroup	ターゲット・リソース・グループ名でフィルター処理します。 デフォルト値は select all です。
targetResourceType	ターゲット・リソース・タイプでフィルタリングします。 デフォルト値は select all です。
timeRange	以下の値で時間範囲でフィルタリングします。 デフォルト値は 1 日です。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
onResponse	要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
requestOptions	この操作の HTTP 要求を作成および送信するときに使用されるオプション。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

alertRule

特定のアラートルールでフィルタリングします。 デフォルト値は、すべて選択することです。

alertRule?: string

プロパティ値

string

alertState

アラートインスタンスの状態でフィルタリングします。 デフォルト値は、すべて選択することです。

alertState?: string

プロパティ値

string

customTimeRange

<start-time>/<end-time> (ISO-8601 形式) の形式でカスタム時間範囲でフィルター処理します。 許容値は、クエリ時から 30 日以内です。 timeRange または customTimeRange のいずれかを使用できますが、両方を使用することはできません。 デフォルトは none です。

customTimeRange?: string

プロパティ値

string

includeContext

モニター・サービスに固有のコンテキスト・データを持つコンテキストを含めます。 デフォルト値はfalseです。

includeContext?: boolean

プロパティ値

boolean

includeEgressConfig

ポータルにコンテンツを表示するために使用される出力設定を含めます。 デフォルト値は 'false' です。

includeEgressConfig?: boolean

プロパティ値

boolean

monitorCondition

モニター条件 (「起動済み」または [解決済み] のいずれか) でフィルタリングします。 デフォルト値は、すべて選択することです。

monitorCondition?: string

プロパティ値

string

monitorService

アラート・インスタンスを生成するモニター・サービスでフィルタリングします。 デフォルト値は select all です。

monitorService?: string

プロパティ値

string

pageCount

応答でページごとに返されるアラートの数を決定します。 許容値は 1 から 250 の間です。 "includeContent" フィルターが選択されている場合、許可される最大値は 25 です。 既定値は 25 です。

pageCount?: number

プロパティ値

number

select

このフィルターでは、重要なセクションの一部となるフィールド(カンマ区切り)を選択できます。 これにより、コンテンツ全体を取得するのではなく、必要なフィールドのみを投影できます。 デフォルトでは、essentials セクションのすべてのフィールドが取得されます。

select?: string

プロパティ値

string

severity

重大度でフィルター処理します。 デフォルト値は select all です。

severity?: string

プロパティ値

string

smartGroupId

スマート グループ ID でアラート リストをフィルタリングします。デフォルト値は none です。

smartGroupId?: string

プロパティ値

string

sortBy

入力フィールドでクエリ結果を並べ替えます。デフォルト値は「lastModifiedDateTime」です。

sortBy?: string

プロパティ値

string

sortOrder

クエリ結果の順序を昇順または降順で並べ替えます。 デフォルト値は、時間フィールドの場合は 'desc'、その他のフィールドの場合は 'asc' です。

sortOrder?: string

プロパティ値

string

targetResource

ターゲット・リソース(完全なARM ID)でフィルタリングデフォルト値は「すべて選択」です。

targetResource?: string

プロパティ値

string

targetResourceGroup

ターゲット・リソース・グループ名でフィルター処理します。 デフォルト値は select all です。

targetResourceGroup?: string

プロパティ値

string

targetResourceType

ターゲット・リソース・タイプでフィルタリングします。 デフォルト値は select all です。

targetResourceType?: string

プロパティ値

string

timeRange

以下の値で時間範囲でフィルタリングします。 デフォルト値は 1 日です。

timeRange?: string

プロパティ値

string

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

abortSignal

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

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

OperationOptions.abortSignal から継承された

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

RawResponseCallback

OperationOptions.onResponse から継承された

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationRequestOptions

OperationOptions.requestOptions から継承された

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

OperationOptions.tracingOptions から継承された