Bookmarks - Get

リファレンス

Service:: Sentinel

API Version:: 2024-03-01

ブックマークを取得します。

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

URI パラメーター

名前	/	必須	型	説明
bookmarkId	path	True	string	[ブックマーク ID]
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
workspaceName	path	True	string	ワークスペースの名前。 Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	Bookmark	OK、操作が正常に完了しました
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

例

Get a bookmark.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5?api-version=2024-03-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "type": "Microsoft.SecurityInsights/bookmarks",
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "displayName": "My bookmark",
    "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"
    },
    "updated": "2019-01-01T13:15:30Z",
    "created": "2019-01-01T13:15:30Z",
    "notes": "Found a suspicious activity",
    "labels": [
      "Tag1",
      "Tag2"
    ],
    "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)",
    "queryResult": "Security Event query result",
    "incidentInfo": {
      "incidentId": "DDA55F97-170B-40B9-B8ED-CBFD05481E7D",
      "severity": "Low",
      "title": "New case 1",
      "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0018"
    }
  }
}

定義

名前	説明
Bookmark	Azure Security Insights のブックマークを表します。
CloudError	エラー応答の構造。
CloudErrorBody	エラーの詳細。
createdByType	リソースを作成した ID の種類。
IncidentInfo	ブックマークの関連インシデント情報について説明します
IncidentSeverity	インシデントの重大度
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserInfo	何らかのアクションを行ったユーザー情報

Bookmark

Azure Security Insights のブックマークを表します。

名前	型	説明
etag	string	Azure リソースの Etag
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.created	string	ブックマークが作成された時刻
properties.createdBy	UserInfo	ブックマークを作成したユーザーについて説明します
properties.displayName	string	ブックマークの表示名
properties.eventTime	string	ブックマークイベントの時刻
properties.incidentInfo	IncidentInfo	ブックマークに関連するインシデントについて説明します
properties.labels	string[]	このブックマークに関連するラベルの一覧
properties.notes	string	ブックマークのメモ
properties.query	string	ブックマークのクエリ。
properties.queryEndTime	string	クエリの終了時刻
properties.queryResult	string	ブックマークのクエリ結果。
properties.queryStartTime	string	クエリの開始時刻
properties.updated	string	ブックマークが最後に更新された時刻
properties.updatedBy	UserInfo	ブックマークを更新したユーザーについて説明します
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

CloudError

エラー応答の構造。

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

CloudErrorBody

エラーの詳細。

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

createdByType

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

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

IncidentInfo

ブックマークの関連インシデント情報について説明します

名前	型	説明
incidentId	string	インシデント ID
relationName	string	リレーション名
severity	IncidentSeverity	インシデントの重大度
title	string	インシデントのタイトル

IncidentSeverity

インシデントの重大度

名前	型	説明
High	string	重要度レベル高
Informational	string	情報の重要度
Low	string	重大度: 低
Medium	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。