AlertsOperations interface

パッケージ:

@azure/arm-alertsmanagement

アラート操作を表すインターフェース。

プロパティ

changeState	アラートの状態を変更します。 スコープが削除されたリソースの場合は、削除リソースの親リソースとしてスコープを使用してください。 たとえば、アラート ID が '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' で、'vm1' が削除された場合、この特定のアラートの状態を変更する場合は、スコープの親リソースを使用します。 したがって、この例では、状態変更呼び出しは '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}' のようになります。
changeStateTenant	アラートの状態を変更します。
getAll	複数のパラメーター (時間範囲など) に基づいて結果をフィルタリングできる既存のアラートをすべて一覧表示します。 結果は、特定のフィールドに基づいて並べ替えることができ、デフォルトはlastModifiedDateTimeです。
getAllTenant	複数のパラメーター (時間範囲など) に基づいて結果をフィルタリングできる既存のアラートをすべて一覧表示します。 結果は、特定のフィールドに基づいて並べ替えることができ、デフォルトはlastModifiedDateTimeです。
getById	特定のアラートに関連する情報を取得します。 スコープが削除されたリソースの場合は、削除リソースの親リソースとしてスコープを使用してください。 たとえば、アラート ID が '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' で、'vm1' が削除されている場合、ID でアラートを取得する場合は、スコープの親リソースを使用します。 したがって、この例では、ID 呼び出しによるアラートの取得は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}' のようになります。
getByIdTenant	特定のアラートに関連する情報を取得します。
getEnrichments	アラートのエンリッチメントを取得します。 default という名前の 1 つのオブジェクトのコレクションを返します。
getHistory	モニター条件の変更 (発生した/解決済み)、アラートの状態の変更 (新規/確認済み/クローズ済み)、およびその特定のアラートに適用されたアクション ルールをキャプチャするアラートの履歴を取得します。 スコープが削除されたリソースの場合は、削除リソースの親リソースとしてスコープを使用してください。 たとえば、アラート ID が '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' で、'vm1' が削除された場合、この特定のアラートの履歴を取得する場合は、スコープの親リソースを使用します。 したがって、この例では、履歴の取得呼び出しは '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history' のようになります。
getHistoryTenant	モニター条件の変更 (発生した/解決済み)、アラートの状態の変更 (新規/確認済み/クローズ済み)、およびその特定のアラートに適用されたアクション ルールをキャプチャするアラートの履歴を取得します。
getSummary	さまざまなパラメーターでグループ化されたアラートの要約数を取得します (たとえば、"重大度" でグループ化すると、重大度ごとのアラートの数が返されます)。
metaData	識別子パラメーターの値に基づいてアラートのメタデータ情報を一覧表示します。

プロパティの詳細

changeState

アラートの状態を変更します。 スコープが削除されたリソースの場合は、削除リソースの親リソースとしてスコープを使用してください。 たとえば、アラート ID が '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' で、'vm1' が削除された場合、この特定のアラートの状態を変更する場合は、スコープの親リソースを使用します。 したがって、この例では、状態変更呼び出しは '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}' のようになります。

changeState: (scope: string, alertId: string, newState: string, options?: AlertsChangeStateOptionalParams) => Promise<Alert>

プロパティ値

(scope: string, alertId: string, newState: string, options?: AlertsChangeStateOptionalParams) => Promise<Alert>

changeStateTenant

アラートの状態を変更します。

changeStateTenant: (alertId: string, newState: string, options?: AlertsChangeStateTenantOptionalParams) => Promise<Alert>

プロパティ値

(alertId: string, newState: string, options?: AlertsChangeStateTenantOptionalParams) => Promise<Alert>

getAll

複数のパラメーター (時間範囲など) に基づいて結果をフィルタリングできる既存のアラートをすべて一覧表示します。 結果は、特定のフィールドに基づいて並べ替えることができ、デフォルトはlastModifiedDateTimeです。

getAll: (scope: string, options?: AlertsGetAllOptionalParams) => PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

プロパティ値

(scope: string, options?: AlertsGetAllOptionalParams) => PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

getAllTenant

複数のパラメーター (時間範囲など) に基づいて結果をフィルタリングできる既存のアラートをすべて一覧表示します。 結果は、特定のフィールドに基づいて並べ替えることができ、デフォルトはlastModifiedDateTimeです。

getAllTenant: (options?: AlertsGetAllTenantOptionalParams) => PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

プロパティ値

(options?: AlertsGetAllTenantOptionalParams) => PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

getById

特定のアラートに関連する情報を取得します。 スコープが削除されたリソースの場合は、削除リソースの親リソースとしてスコープを使用してください。 たとえば、アラート ID が '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' で、'vm1' が削除されている場合、ID でアラートを取得する場合は、スコープの親リソースを使用します。 したがって、この例では、ID 呼び出しによるアラートの取得は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}' のようになります。

getById: (scope: string, alertId: string, options?: AlertsGetByIdOptionalParams) => Promise<Alert>

プロパティ値

(scope: string, alertId: string, options?: AlertsGetByIdOptionalParams) => Promise<Alert>

getByIdTenant

特定のアラートに関連する情報を取得します。

getByIdTenant: (alertId: string, options?: AlertsGetByIdTenantOptionalParams) => Promise<Alert>

プロパティ値

(alertId: string, options?: AlertsGetByIdTenantOptionalParams) => Promise<Alert>

getEnrichments

アラートのエンリッチメントを取得します。 default という名前の 1 つのオブジェクトのコレクションを返します。

getEnrichments: (scope: string, alertId: string, options?: AlertsGetEnrichmentsOptionalParams) => PagedAsyncIterableIterator<AlertEnrichmentResponse, AlertEnrichmentResponse[], PageSettings>

プロパティ値

(scope: string, alertId: string, options?: AlertsGetEnrichmentsOptionalParams) => PagedAsyncIterableIterator<AlertEnrichmentResponse, AlertEnrichmentResponse[], PageSettings>

getHistory

モニター条件の変更 (発生した/解決済み)、アラートの状態の変更 (新規/確認済み/クローズ済み)、およびその特定のアラートに適用されたアクション ルールをキャプチャするアラートの履歴を取得します。 スコープが削除されたリソースの場合は、削除リソースの親リソースとしてスコープを使用してください。 たとえば、アラート ID が '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' で、'vm1' が削除された場合、この特定のアラートの履歴を取得する場合は、スコープの親リソースを使用します。 したがって、この例では、履歴の取得呼び出しは '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history' のようになります。

getHistory: (scope: string, alertId: string, options?: AlertsGetHistoryOptionalParams) => Promise<AlertModification>

プロパティ値

(scope: string, alertId: string, options?: AlertsGetHistoryOptionalParams) => Promise<AlertModification>

getHistoryTenant

モニター条件の変更 (発生した/解決済み)、アラートの状態の変更 (新規/確認済み/クローズ済み)、およびその特定のアラートに適用されたアクション ルールをキャプチャするアラートの履歴を取得します。

getHistoryTenant: (alertId: string, options?: AlertsGetHistoryTenantOptionalParams) => Promise<AlertModification>

プロパティ値

(alertId: string, options?: AlertsGetHistoryTenantOptionalParams) => Promise<AlertModification>

getSummary

さまざまなパラメーターでグループ化されたアラートの要約数を取得します (たとえば、"重大度" でグループ化すると、重大度ごとのアラートの数が返されます)。

getSummary: (scope: string, groupby: string, options?: AlertsGetSummaryOptionalParams) => Promise<AlertsSummary>

プロパティ値

(scope: string, groupby: string, options?: AlertsGetSummaryOptionalParams) => Promise<AlertsSummary>

metaData

識別子パラメーターの値に基づいてアラートのメタデータ情報を一覧表示します。

metaData: (identifier: string, options?: AlertsMetaDataOptionalParams) => Promise<AlertsMetaData>

プロパティ値

(identifier: string, options?: AlertsMetaDataOptionalParams) => Promise<AlertsMetaData>