Query Pack Queries - Search
指定された検索プロパティに従って、Log Analytics QueryPack 内で定義されているクエリの一覧を検索します。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/search?api-version=2019-09-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/search?api-version=2019-09-01&$top={$top}&includeBody={includeBody}&$skipToken={$skipToken}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
query
|
path | True |
string |
Log Analytics QueryPack リソースの名前。 |
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
$skip
|
query |
string |
項目の次のページをフェッチするために使用される Base64 でエンコードされたトークン。 既定値は Null です。 |
|
$top
|
query |
integer int64 |
ページで返される最大アイテム数。 |
|
include
|
query |
boolean |
該当する各クエリの本文を返すかどうかを示すフラグ。 false の場合は、クエリ情報のみを返します。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
related |
関数の関連メタデータ項目。 |
|
tags |
object |
クエリに関連付けられているタグ。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Log Analytics QueryPack に含まれる 0 個以上のクエリを含むリスト。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
QuerySearch
要求のサンプル
POST https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/Microsoft.OperationalInsights/queryPacks/my-querypack/queries/search?api-version=2019-09-01&$top=3&includeBody=True
{
"related": {
"categories": [
"other",
"analytics"
]
},
"tags": {
"my-label": [
"label1"
]
}
}
応答のサンプル
{
"value": [
{
"id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/microsoft.operationalinsights/queryPacks/my-querypack/queries/4337bb16-d6fe-4ff7-97cf-59df25941476",
"name": "4337bb16-d6fe-4ff7-97cf-59df25941476",
"type": "microsoft.operationalinsights/queryPacks/queries",
"systemData": {
"createdBy": "string",
"createdByType": "application",
"createdAt": "2020-02-03T01:01:01.1075056Z",
"lastModifiedBy": "string",
"lastModifiedByType": "application",
"lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
},
"properties": {
"id": "4337bb16-d6fe-4ff7-97cf-59df25941476",
"timeCreated": "2019-08-15T10:29:56.1030254Z",
"author": "1809f206-263a-46f7-942d-4572c156b7e7",
"timeModified": "2019-08-15T10:29:56.1030254Z",
"displayName": "Heartbeat_1",
"description": "Thie query takes 10 entries of heartbeat 0",
"body": "Heartbeat | take 1",
"related": {
"categories": [
"other"
]
},
"tags": {
"my-label": [
"label1"
],
"my-other-label": [
"label2"
]
}
}
},
{
"id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/microsoft.operationalinsights/queryPacks/my-querypack/queries/bf015bf7-be70-49c2-8d52-4cce85c42ef1",
"name": "bf015bf7-be70-49c2-8d52-4cce85c42ef1",
"type": "microsoft.operationalinsights/queryPacks/queries",
"systemData": {
"createdBy": "string",
"createdByType": "application",
"createdAt": "2020-02-03T01:01:01.1075056Z",
"lastModifiedBy": "string",
"lastModifiedByType": "application",
"lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
},
"properties": {
"id": "bf015bf7-be70-49c2-8d52-4cce85c42ef1",
"timeCreated": "2019-08-15T10:30:26.7943629Z",
"author": "1809f206-263a-46f7-942d-4572c156b7e7",
"timeModified": "2019-08-15T10:30:26.7943629Z",
"displayName": "Heartbeat_2",
"description": "Thie query takes 10 entries of heartbeat 1",
"body": "Heartbeat | take 1",
"related": {
"categories": [
"analytics"
]
},
"tags": {
"my-label": [
"label1"
],
"my-other-label": [
"label2"
]
}
}
},
{
"id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/microsoft.operationalinsights/queryPacks/my-querypack/queries/8d91c6ca-9c56-49c6-b3ae-112a68871acd",
"name": "8d91c6ca-9c56-49c6-b3ae-112a68871acd",
"type": "microsoft.operationalinsights/queryPacks/queries",
"systemData": {
"createdBy": "string",
"createdByType": "application",
"createdAt": "2020-02-03T01:01:01.1075056Z",
"lastModifiedBy": "string",
"lastModifiedByType": "application",
"lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
},
"properties": {
"id": "8d91c6ca-9c56-49c6-b3ae-112a68871acd",
"timeCreated": "2019-08-15T10:30:29.4505584Z",
"author": "1809f206-263a-46f7-942d-4572c156b7e7",
"timeModified": "2019-08-15T10:30:29.4505584Z",
"displayName": "Heartbeat_3",
"description": "Thie query takes 10 entries of heartbeat 2",
"body": "Heartbeat | take 1",
"related": {
"categories": [
"other",
"analytics"
]
},
"tags": {
"my-label": [
"label1"
],
"my-other-label": [
"label2"
]
}
}
}
],
"nextLink": null
}
定義
名前 | 説明 |
---|---|
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Identity |
リソースを作成または変更する ID の種類 |
Log |
Log Analytics QueryPack-Query 定義。 |
Log |
Log Analytics QueryPack-Query リソースの一覧について説明します。 |
Log |
Log Analytics QueryPack-Query 検索プロパティを定義するプロパティ。 |
Related |
関数の関連メタデータ項目。 |
System |
システム データの読み取り専用 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
IdentityType
リソースを作成または変更する ID の種類
名前 | 型 | 説明 |
---|---|---|
application |
string |
|
key |
string |
|
managedIdentity |
string |
|
user |
string |
LogAnalyticsQueryPackQuery
Log Analytics QueryPack-Query 定義。
名前 | 型 | 説明 |
---|---|---|
id |
string |
Azure リソース ID |
name |
string |
Azure リソース名 |
properties.author |
string |
クエリを作成するユーザーのオブジェクト ID。 |
properties.body |
string |
クエリの本文。 |
properties.description |
string |
クエリの説明。 |
properties.displayName |
string |
クエリ パック内のクエリの一意の表示名。 |
properties.id |
string |
アプリケーションの一意の ID。 このフィールドは変更できません。 |
properties.properties |
object |
クエリに設定できる追加のプロパティ。 |
properties.related |
関数の関連メタデータ項目。 |
|
properties.tags |
object |
クエリに関連付けられているタグ。 |
properties.timeCreated |
string |
Log Analytics クエリの作成日 (ISO 8601 形式)。 |
properties.timeModified |
string |
Log Analytics クエリの最終更新日 (ISO 8601 形式)。 |
systemData |
システム データの読み取り専用 |
|
type |
string |
Azure リソースタイプ |
LogAnalyticsQueryPackQueryListResult
Log Analytics QueryPack-Query リソースの一覧について説明します。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
結果セットで返された QueryPack-Queries が多すぎる場合に、Log Analytics QueryPack 定義の次のセットを取得する URI。 |
value |
Log Analytics QueryPack クエリ定義の一覧。 |
LogAnalyticsQueryPackQuerySearchProperties
Log Analytics QueryPack-Query 検索プロパティを定義するプロパティ。
名前 | 型 | 説明 |
---|---|---|
related |
関数の関連メタデータ項目。 |
|
tags |
object |
クエリに関連付けられているタグ。 |
Related
関数の関連メタデータ項目。
名前 | 型 | 説明 |
---|---|---|
categories |
string[] |
関数の関連カテゴリ。 |
resourceTypes |
string[] |
関数の関連リソースの種類。 |
solutions |
string[] |
関数の関連する Log Analytics ソリューション。 |
SystemData
システム データの読み取り専用
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC) |
createdBy |
string |
リソースを作成した ID の識別子 |
createdByType |
リソースを作成した ID の種類 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID の識別子 |
lastModifiedByType |
リソースを最後に変更した ID の種類 |