Watchlists - Get

參考

服務:: Sentinel

API 版本:: 2024-09-01

取得監看清單，而不取得其關注清單專案。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
watchlistAlias	path	True	string	關注清單別名
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	工作區的名稱。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	Watchlist	還行
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get a watchlist.

範例要求

HTTP

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

範例回覆

狀態碼:: 200

{
  "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": "watchlist.csv",
    "sourceType": "Local",
    "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"
  }
}

定義

名稱	Description
CloudError	錯誤回應結構。
CloudErrorBody	錯誤詳細數據。
createdByType	建立資源的身分識別類型。
ProvisioningState	描述布建狀態
sourceType	關注清單的sourceType
systemData	與建立和上次修改資源相關的元數據。
UserInfo	做出某些動作的用戶資訊
Watchlist	代表 Azure Security Insights 中的監看清單。

CloudError

Object

錯誤回應結構。

名稱	類型	Description
error	CloudErrorBody	錯誤數據

CloudErrorBody

Object

錯誤詳細數據。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

ProvisioningState

列舉型別

描述布建狀態

值	Description
Canceled	已取消的布建狀態。
Deleting	刪除布建狀態。
Failed	失敗的布建狀態。
InProgress	InProgress 布建狀態。
New	新增布建狀態。
Succeeded	成功布建狀態。
Uploading	上傳布建狀態。

sourceType

列舉型別

關注清單的sourceType

值	Description
AzureStorage	來自 Azure 記憶體的來源。
Local	本機檔案的來源。

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UserInfo

Object

做出某些動作的用戶資訊

名稱	類型	Description
email	string	用戶的電子郵件。
name	string	用戶的名稱。
objectId	string (uuid)	用戶的物件識別碼。

Watchlist

Object

代表 Azure Security Insights 中的監看清單。

名稱	類型	Description
etag	string	Azure 資源的 Etag
id	string (arm-id)	資源的完整資源標識碼。例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.contentType	string	原始內容的內容類型。範例：text/csv 或 text/tsv
properties.created	string (date-time)	建立監看清單的時間
properties.createdBy	UserInfo	描述建立關注清單的使用者
properties.defaultDuration	string (duration)	關注清單的預設持續時間（以 ISO 8601 持續時間格式表示）
properties.description	string	關注清單的描述
properties.displayName	string	關注清單的顯示名稱
properties.isDeleted	boolean	旗標，指出是否刪除監看清單
properties.itemsSearchKey	string	使用監看清單與其他數據聯結時，搜尋索引鍵可用來優化查詢效能。例如，啟用IP位址為指定 SearchKey 欄位的數據行，然後在依IP位址聯結至其他事件數據時，使用此字位作為索引鍵欄位。
properties.labels	string[]	此關注清單的相關標籤清單
properties.numberOfLinesToSkip	integer (int32)	要略過標頭之前 csv/tsv 內容中的行數
properties.provider	string	關注清單的提供者
properties.provisioningState	ProvisioningState	描述布建狀態
properties.rawContent	string	原始內容，表示要建立的監看清單專案。如果是 csv/tsv 內容類型，則會是端點所剖析的檔案內容
properties.source	string	監看清單的檔名，稱為「來源」
properties.sourceType	sourceType	關注清單的sourceType
properties.tenantId	string	關注清單所屬的tenantId
properties.updated	string (date-time)	上次更新監看清單的時間
properties.updatedBy	UserInfo	描述更新關注清單的使用者
properties.uploadStatus	string	Watchlist 上傳的狀態：新增、輸入或完成。附注：當監看清單上傳狀態為 InProgress 時，無法刪除監看清單
properties.watchlistAlias	string	關注清單的別名
properties.watchlistId	string	關注清單的識別碼（Guid）
properties.watchlistType	string	關注清單的類型
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

共用方式為

Watchlists - Get

URI 參數

回應

安全性

azure_auth

範圍

範例

Get a watchlist.

範例要求

範例回覆

定義

CloudError

CloudErrorBody

createdByType

ProvisioningState

sourceType

systemData

UserInfo

Watchlist

其他資源