Workbooks - List By Subscription

リファレンス

サービス:: Application Insights

API バージョン:: 2021-08-01

指定したサブスクリプションとカテゴリ内で定義されているすべてのブックを取得します。

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 パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
category	query	True	CategoryType	返されるブックのカテゴリ。
canFetchContent	query		boolean	該当する各ブックの完全なコンテンツを返すかどうかを示すフラグ。 false の場合は、ブックの概要コンテンツのみを返します。
tags	query		string[]	返された各ブックにタグが表示されます。

応答

名前	型	説明
200 OK	WorkbooksListResult	0 個以上のブック定義を含むリスト。
Other Status Codes	WorkbookError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

WorkbooksList2

WorkbooksListSub

WorkbooksList2

要求のサンプル

GET https://management.azure.com/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/providers/Microsoft.Insights/workbooks?category=workbook&api-version=2021-08-01

import com.azure.core.util.Context;
import com.azure.resourcemanager.applicationinsights.models.CategoryType;

/** Samples for Workbooks List. */
public final class Main {
    /*
     * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-08-01/examples/WorkbooksList2.json
     */
    /**
     * Sample code: WorkbooksList2.
     *
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void workbooksList2(
        com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        manager.workbooks().list(CategoryType.WORKBOOK, null, null, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapplicationinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/applicationinsights/armapplicationinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-08-01/examples/WorkbooksList2.json
func ExampleWorkbooksClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armapplicationinsights.NewWorkbooksClient("6b643656-33eb-422f-aee8-3ac145d124af", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(armapplicationinsights.CategoryTypeWorkbook,
		&armapplicationinsights.WorkbooksClientListBySubscriptionOptions{Tags: []string{},
			CanFetchContent: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "value": [],
  "nextLink": null
}

WorkbooksListSub

要求のサンプル

GET https://management.azure.com/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/providers/Microsoft.Insights/workbooks?category=workbook&api-version=2021-08-01

import com.azure.core.util.Context;
import com.azure.resourcemanager.applicationinsights.models.CategoryType;

/** Samples for Workbooks List. */
public final class Main {
    /*
     * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-08-01/examples/WorkbooksListSub.json
     */
    /**
     * Sample code: WorkbooksListSub.
     *
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void workbooksListSub(
        com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        manager.workbooks().list(CategoryType.WORKBOOK, null, null, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "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
}

定義

名前	説明
CategoryType	返されるブックのカテゴリ。
createdByType	リソースを作成した ID の種類。
Identity	BYOS に使用される ID
kind	ブックの種類。有効な値のみが共有されます。
ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentity	ユーザー割り当て ID プロパティ
Workbook	Application Insights ブックの定義。
WorkbookError	エラー応答。
WorkbookErrorDefinition	エラー定義。
WorkbookInnerErrorTrace	エラーの詳細
WorkbooksListResult	ブックの一覧の結果。

CategoryType

列挙

返されるブックのカテゴリ。

値	説明
TSG
performance
retention
workbook

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

Identity

Object

BYOS に使用される ID

名前	型	説明
principalId	string (uuid)	システム割り当て ID のサービスプリンシパル ID。このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string (uuid)	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID にのみ提供されます。
type	ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned ID リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリキーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。

kind

列挙

ブックの種類。有効な値のみが共有されます。

値	説明
shared
user

ManagedServiceIdentityType

列挙

マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

値	説明
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

systemData

Object

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

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

UserAssignedIdentity

Object

ユーザー割り当て ID プロパティ

名前	型	説明
clientId	string (uuid)	割り当てられた ID のクライアント ID。
principalId	string (uuid)	割り当てられた ID のプリンシパル ID。

Workbook

Object

Application Insights ブックの定義。

名前	型	説明
etag	object	リソース etag
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	BYOS に使用される ID
kind	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 (date-time)	このブック定義に対して最後に変更された日付と時刻 (UTC)。
properties.userId	string	このブックを所有する特定のユーザーの一意のユーザー ID。
properties.version	string	'Notebook/1.0' のようなブックスキーマのバージョン形式。serializedData 内のブックと一致する必要があります
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
tags	object	リソースタグ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

WorkbookError

Object

エラー応答。

名前	型	説明
error	WorkbookErrorDefinition	エラーの詳細。

WorkbookErrorDefinition

Object

エラー定義。

名前	型	説明
code	string	HTTP エラーコードのサブステータスとして機能するサービス固有のエラーコード。
innererror	WorkbookInnerErrorTrace	内部エラーの詳細。
message	string	エラーの説明。

WorkbookInnerErrorTrace

Object

エラーの詳細

名前	型	説明
trace	string[]	詳細なエラートレース

WorkbooksListResult

Object

ブックの一覧の結果。

名前	型	説明
nextLink	string
value	Workbook[]	ブックの配列。

次の方法で共有

Workbooks - List By Subscription

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

WorkbooksList2

要求のサンプル

応答のサンプル

WorkbooksListSub

要求のサンプル

応答のサンプル

定義

CategoryType

createdByType

Identity

kind

ManagedServiceIdentityType

systemData

UserAssignedIdentity

Workbook

WorkbookError

WorkbookErrorDefinition

WorkbookInnerErrorTrace

WorkbooksListResult