Workbooks - List By Subscription
指定したサブスクリプションとカテゴリ内で定義されているすべてのブックを取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/workbooks?category={category}&api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/workbooks?category={category}&tags={tags}&canFetchContent={canFetchContent}&api-version=2021-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
category
|
query | True |
返すブックのカテゴリ。 |
|
can
|
query |
boolean |
該当する各ブックの完全なコンテンツを返すかどうかを示すフラグ。 false の場合は、ブックの概要コンテンツのみが返されます。 |
|
tags
|
query |
string[] |
返された各ブックにタグが表示されます。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
0 個以上のブック定義を含むリスト。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Workbooks |
Workbooks |
WorkbooksList2
要求のサンプル
応答のサンプル
{
"value": [],
"nextLink": null
}
WorkbooksListSub
要求のサンプル
応答のサンプル
{
"value": [
{
"id": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group/providers/Microsoft.Insights/workbooks/deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
"name": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
"type": "Microsoft.Insights/workbooks",
"location": "westus",
"tags": {},
"kind": "shared",
"properties": {
"displayName": "My Workbook 1",
"userId": "userId",
"sourceId": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group/providers/Microsoft.Web/sites/MyApp",
"serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
"version": "Notebook/1.0",
"category": "workbook",
"timeModified": "2020-10-20T22:00:26.4229554Z",
"storageUri": null,
"description": "Sample workbook",
"revision": "1e2f8435b98248febee70c64ac22e1bb"
}
},
{
"id": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group/providers/Microsoft.Insights/workbooks/c0deea5e-3344-40f2-96f8-6f8e1c3b5722",
"name": "c0deea5e-3344-40f2-96f8-6f8e1c3b5722",
"type": "Microsoft.Insights/workbooks",
"location": "westus",
"tags": {
"TagSample01": "sample01",
"TagSample02": "sample02"
},
"kind": "shared",
"properties": {
"displayName": "My Workbook 2",
"userId": "userId",
"sourceId": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group/providers/Microsoft.Web/sites/MyApp",
"serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
"version": "Notebook/1.0",
"category": "workbook",
"timeModified": "2020-10-20T22:00:26.4229554Z",
"storageUri": null,
"description": "Sample workbook",
"revision": "1e2f8435b98248febee70c64ac22e1bc"
}
}
],
"nextLink": null
}
定義
名前 | 説明 |
---|---|
Category |
返すブックのカテゴリ。 |
created |
リソースを作成した ID の種類。 |
Identity |
BYOS に使用される ID |
kind |
ブックの種類。 有効な値のみが共有されます。 |
Managed |
マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
User |
ユーザー割り当て ID プロパティ |
Workbook |
Application Insights ブックの定義。 |
Workbook |
エラー応答。 |
Workbook |
エラー定義。 |
Workbook |
エラーの詳細 |
Workbooks |
ブックの一覧の結果。 |
CategoryType
返すブックのカテゴリ。
名前 | 型 | 説明 |
---|---|---|
TSG |
string |
|
performance |
string |
|
retention |
string |
|
workbook |
string |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Identity
BYOS に使用される ID
名前 | 型 | 説明 |
---|---|---|
principalId |
string |
システム割り当て ID のサービス プリンシパル ID。 このプロパティは、システム割り当て ID に対してのみ提供されます。 |
tenantId |
string |
システム割り当て ID のテナント ID。 このプロパティは、システム割り当て ID に対してのみ提供されます。 |
type |
マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 |
|
userAssignedIdentities |
<string,
User |
User-Assigned ID |
kind
ブックの種類。 有効な値のみが共有されます。
名前 | 型 | 説明 |
---|---|---|
shared |
string |
|
user |
string |
ManagedServiceIdentityType
マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
名前 | 型 | 説明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned,UserAssigned |
string |
|
UserAssigned |
string |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
UserAssignedIdentity
ユーザー割り当て ID プロパティ
名前 | 型 | 説明 |
---|---|---|
clientId |
string |
割り当てられた ID のクライアント ID。 |
principalId |
string |
割り当てられた ID のプリンシパル ID。 |
Workbook
Application Insights ブックの定義。
名前 | 型 | 説明 |
---|---|---|
etag |
object |
リソース etag |
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
BYOS に使用される ID |
|
kind |
ブックの種類。 有効な値のみが共有されます。 |
|
location |
string |
リソースが保存されている地理的な場所 |
name |
string |
リソースの名前 |
properties.category |
string |
作成時にユーザーが定義したブック カテゴリ。 |
properties.description |
string |
ブックの説明。 |
properties.displayName |
string |
ブックのユーザー定義名 (表示名)。 |
properties.revision |
string |
このブック定義の一意のリビジョン ID |
properties.serializedData |
string |
この特定のブックの構成。 構成データは、有効な JSON を含む文字列です |
properties.sourceId |
string |
ソース リソースの ResourceId。 |
properties.storageUri |
string |
独自のストレージを持ち込むときにストレージ アカウントに対する resourceId が使用される |
properties.tags |
string[] |
非推奨の場合は、他のタグ フィールドを使用してください |
properties.timeModified |
string |
このブック定義に対して行われた最後の変更の日付と時刻 (UTC)。 |
properties.userId |
string |
このブックを所有する特定のユーザーの一意のユーザー ID。 |
properties.version |
string |
'Notebook/1.0' のようなブック スキーマのバージョン形式。serializedData のブックと一致する必要があります |
systemData |
リソースの作成と最後の変更に関連するメタデータ。 |
|
tags |
object |
リソース タグ。 |
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
WorkbookError
エラー応答。
名前 | 型 | 説明 |
---|---|---|
error |
エラーの詳細です。 |
WorkbookErrorDefinition
エラー定義。
名前 | 型 | 説明 |
---|---|---|
code |
string |
HTTP エラー コードのサブステータスとして機能するサービス固有のエラー コード。 |
innererror |
内部エラーの詳細。 |
|
message |
string |
エラーの説明。 |
WorkbookInnerErrorTrace
エラーの詳細
名前 | 型 | 説明 |
---|---|---|
trace |
string[] |
詳細なエラー トレース |
WorkbooksListResult
ブックの一覧の結果。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
|
value |
Workbook[] |
ブックの配列。 |