Watchlists - List

リファレンス

サービス:: Sentinel

API バージョン:: 2024-03-01

ウォッチリストアイテムなしで、すべてのウォッチリストを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists?api-version=2024-03-01

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists?api-version=2024-03-01&$skipToken={$skipToken}

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
workspaceName	path	True	string	ワークスペースの名前。正規表現パターン: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	この操作に使用する API バージョン。
$skipToken	query		string	Skiptoken は、前の操作で部分的な結果が返された場合にのみ使用されます。前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skiptoken パラメーターが含まれます。省略可能。

応答

名前	型	説明
200 OK	WatchlistList	OK
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Get all watchlists.

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists?api-version=2024-03-01

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset",
      "name": "highValueAsset",
      "type": "Microsoft.SecurityInsights/Watchlists",
      "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
      "properties": {
        "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
        "displayName": "High Value Assets Watchlist",
        "provider": "Microsoft",
        "source": "Local file",
        "created": "2020-09-28T00:26:54.7746089+00:00",
        "updated": "2020-09-28T00:26:57+00:00",
        "createdBy": {
          "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
          "email": "john@contoso.com",
          "name": "john doe"
        },
        "updatedBy": {
          "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
          "email": "john@contoso.com",
          "name": "john doe"
        },
        "description": "Watchlist from CSV content",
        "watchlistType": "watchlist",
        "watchlistAlias": "highValueAsset",
        "itemsSearchKey": "header1",
        "isDeleted": false,
        "labels": [
          "Tag1",
          "Tag2"
        ],
        "defaultDuration": "P1279DT12H30M5S",
        "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
      }
    }
  ]
}

定義

名前	説明
CloudError	エラー応答の構造。
CloudErrorBody	エラーの詳細。
createdByType	リソースを作成した ID の種類。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserInfo	何らかのアクションを行ったユーザー情報
Watchlist	Azure Security Insights のウォッチリストを表します。
WatchlistList	すべてのウォッチリストを一覧表示します。

CloudError

エラー応答の構造。

名前	型	説明
error	CloudErrorBody	エラーデータ

CloudErrorBody

エラーの詳細。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムによって使用されることを意図しています。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserInfo

何らかのアクションを行ったユーザー情報

名前	型	説明
email	string	ユーザーの電子メール。
name	string	ユーザーの名前です。
objectId	string	ユーザーのオブジェクト ID。

Watchlist

Azure Security Insights のウォッチリストを表します。

名前	型	説明
etag	string	Azure リソースの Etag
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.contentType	string	生コンテンツのコンテンツタイプ。現時点では、text/csv のみが有効です
properties.created	string	ウォッチリストが作成された時刻
properties.createdBy	UserInfo	ウォッチリストを作成したユーザーについて説明します
properties.defaultDuration	string	ウォッチリストの既定の期間 (ISO 8601 期間形式)
properties.description	string	ウォッチリストの説明
properties.displayName	string	ウォッチリストの表示名
properties.isDeleted	boolean	ウォッチリストが削除されたかどうかを示すフラグ
properties.itemsSearchKey	string	検索キーは、他のデータとの結合にウォッチリストを使用する場合に、クエリのパフォーマンスを最適化するために使用されます。たとえば、IP アドレスを持つ列を指定された SearchKey フィールドに設定し、IP アドレスによって他のイベントデータに結合するときに、このフィールドをキーフィールドとして使用します。
properties.labels	string[]	このウォッチリストに関連するラベルの一覧
properties.numberOfLinesToSkip	integer	ヘッダーの前にスキップする csv コンテンツ内の行数
properties.provider	string	ウォッチリストのプロバイダー
properties.rawContent	string	作成するアイテムをウォッチリストするために表す生コンテンツ。例: この行は、header1,header2 value1,value2 をスキップします
properties.source	string	ウォッチリストのソース。 "ローカルファイル" と "リモートストレージ" のみを受け入れます。また、要求に含まれている必要があります。
properties.tenantId	string	ウォッチリストが属する tenantId
properties.updated	string	ウォッチリストが最後に更新された時刻
properties.updatedBy	UserInfo	ウォッチリストを更新したユーザーについて説明します
properties.uploadStatus	string	ウォッチリストアップロードの状態: 新規、InProgress、または Complete。注 : ウォッチリストのアップロード状態が InProgress の場合、ウォッチリストは削除できません
properties.watchlistAlias	string	ウォッチリストのエイリアス
properties.watchlistId	string	ウォッチリストの ID (Guid)
properties.watchlistType	string	ウォッチリストの種類
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

WatchlistList

すべてのウォッチリストを一覧表示します。

名前	型	説明
nextLink	string	ウォッチリストの次のセットをフェッチする URL。
value	Watchlist[]	ウォッチリストの配列。

次の方法で共有