你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Workbooks - Update

参考

服务:: Application Insights

API 版本:: 2021-08-01

汇报已添加的工作簿。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}?api-version=2021-08-01

具有可选参数:

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}?sourceId={sourceId}&api-version=2021-08-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
resourceName	path	True	string	Application Insights 组件资源的名称。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。
sourceId	query		string	将提取所有链接工作簿的 Azure 资源 ID。

请求正文

名称	类型	说明
kind	SharedTypeKind	工作簿的种类。仅共享有效值。
properties.category	string	工作簿类别，由用户在创建时定义。
properties.description	string	工作簿的说明。
properties.displayName	string	用户定义的名称 (工作簿的显示名称) 。
properties.revision	string	此工作簿定义的唯一修订 ID
properties.serializedData	string	此特定工作簿的配置。配置数据是包含有效 JSON 的字符串
properties.tags	string[]	与此工作簿定义关联的 0 个或更多标记的列表
tags	object	资源标记。

响应

名称	类型	说明
200 OK	Workbook	工作簿定义已更新。
201 Created	Workbook	工作簿定义已更新。
Other Status Codes	WorkbookError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

WorkbookManagedUpdate

WorkbookUpdate

WorkbookManagedUpdate

示例请求

PATCH https://management.azure.com/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/Microsoft.Insights/workbooks/deadb33f-5e0d-4064-8ebb-1a4ed0313eb2?sourceId=/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group&api-version=2021-08-01

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

/** Samples for Workbooks Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-08-01/examples/WorkbookManagedUpdate.json
     */
    /**
     * Sample code: WorkbookManagedUpdate.
     *
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void workbookManagedUpdate(
        com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        Workbook resource =
            manager
                .workbooks()
                .getByResourceGroupWithResponse(
                    "my-resource-group", "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", null, Context.NONE)
                .getValue();
        resource
            .update()
            .withSourceId("/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group")
            .apply();
    }
}

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/azcore/to"
	"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/WorkbookManagedUpdate.json
func ExampleWorkbooksClient_Update() {
	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)
	}
	_, err = client.Update(ctx,
		"my-resource-group",
		"deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
		&armapplicationinsights.WorkbooksClientUpdateOptions{SourceID: to.Ptr("/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group"),
			WorkbookUpdateParameters: nil,
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

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

示例响应

状态代码:: 200

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myid": {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "principalId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "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": {
    "TagSample01": "sample01",
    "TagSample02": "sample02",
    "hidden-title": "Sample workbook"
  },
  "kind": "shared",
  "properties": {
    "displayName": "Sample workbook",
    "serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":{\"json\":\"test\"},\"name\":\"text - 0\"}],\"isLocked\":false,\"fallbackResourceIds\":[\"/subscriptions/8980832b-9589-4ac2-b322-a6ae6a97f02b/resourceGroups/my-resource-group\"]}",
    "version": "Notebook/1.0",
    "category": "workbook",
    "userId": "70d90f65-8a70-4e42-b8d5-863725e0a90f",
    "sourceId": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group",
    "timeModified": "2020-10-20T22:15:08.1875458Z",
    "description": "Sample workbook",
    "revision": "1e2f8435b98248febee70c64ac22e1bb",
    "storageUri": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/mystorage/blobServices/default/containers/mycontainer"
  }
}

状态代码:: 201

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myid": {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "principalId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "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": {
    "TagSample01": "sample01",
    "TagSample02": "sample02",
    "hidden-title": "Sample workbook"
  },
  "kind": "shared",
  "properties": {
    "displayName": "Sample workbook",
    "serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":{\"json\":\"test\"},\"name\":\"text - 0\"}],\"isLocked\":false,\"fallbackResourceIds\":[\"/subscriptions/8980832b-9589-4ac2-b322-a6ae6a97f02b/resourceGroups/my-resource-group\"]}",
    "version": "Notebook/1.0",
    "category": "workbook",
    "userId": "70d90f65-8a70-4e42-b8d5-863725e0a90f",
    "sourceId": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group",
    "timeModified": "2020-10-20T22:15:08.1875458Z",
    "description": "Sample workbook",
    "revision": "1e2f8435b98248febee70c64ac22e1bb",
    "storageUri": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/mystorage/blobServices/default/containers/mycontainer"
  }
}

WorkbookUpdate

示例请求

PATCH https://management.azure.com/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/Microsoft.Insights/workbooks/deadb33f-5e0d-4064-8ebb-1a4ed0313eb2?sourceId=/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/Microsoft.Web/sites/MyApp&api-version=2021-08-01

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

/** Samples for Workbooks Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-08-01/examples/WorkbookUpdate.json
     */
    /**
     * Sample code: WorkbookUpdate.
     *
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void workbookUpdate(
        com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        Workbook resource =
            manager
                .workbooks()
                .getByResourceGroupWithResponse(
                    "my-resource-group", "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", null, Context.NONE)
                .getValue();
        resource
            .update()
            .withSourceId(
                "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/Microsoft.Web/sites/MyApp")
            .apply();
    }
}

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

示例响应

状态代码:: 200

{
  "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": {
    "TagSample01": "sample01",
    "TagSample02": "sample02"
  },
  "kind": "shared",
  "properties": {
    "displayName": "Sample workbook",
    "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}",
    "userId": "userId",
    "sourceId": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/Microsoft.Web/sites/MyApp",
    "version": "Notebook/1.0",
    "category": "workbook",
    "timeModified": "2020-10-20T22:00:26.4229554Z",
    "storageUri": null,
    "description": "Sample workbook",
    "revision": "1e2f8435b98248febee70c64ac22e1bb"
  }
}

状态代码:: 201

{
  "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": {
    "TagSample01": "sample01",
    "TagSample02": "sample02"
  },
  "kind": "shared",
  "properties": {
    "displayName": "Sample workbook",
    "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}",
    "userId": "userId",
    "sourceId": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/Microsoft.Web/sites/MyApp",
    "version": "Notebook/1.0",
    "category": "workbook",
    "timeModified": "2020-10-20T22:00:26.4229554Z",
    "storageUri": null,
    "description": "Sample workbook",
    "revision": "1e2f8435b98248febee70c64ac22e1bb"
  }
}

定义

名称	说明
createdByType	创建资源的标识类型。
Identity	用于 BYOS 的标识
kind	工作簿的种类。仅共享有效值。
ManagedServiceIdentityType	托管服务标识的类型 (其中允许 systemAssigned 和 UserAssigned 类型) 。
SharedTypeKind	工作簿的种类。仅共享有效值。
systemData	与资源的创建和上次修改相关的元数据。
UserAssignedIdentity	用户分配的标识属性
Workbook	Application Insights 工作簿定义。
WorkbookError	错误响应。
WorkbookErrorDefinition	错误定义。
WorkbookInnerErrorTrace	错误详细信息
WorkbookUpdateParameters	更新工作簿属性属性时可以提供的参数。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

Identity

用于 BYOS 的标识

名称	类型	说明
principalId	string	系统分配的标识的服务主体 ID。仅为系统分配的标识提供此属性。
tenantId	string	系统分配的标识的租户 ID。仅为系统分配的标识提供此属性。
type	ManagedServiceIdentityType	托管服务标识的类型 (其中允许 systemAssigned 和 UserAssigned 类型) 。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 标识与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将是采用以下格式的 ARM 资源 ID：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。字典值可以是请求中 ({}) 的空对象。

kind

工作簿的种类。仅共享有效值。

名称	类型	说明
shared	string
user	string

ManagedServiceIdentityType

托管服务标识的类型 (其中允许 systemAssigned 和 UserAssigned 类型) 。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

SharedTypeKind

工作簿的种类。仅共享有效值。

名称	类型	说明
shared	string
user	string

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

UserAssignedIdentity

用户分配的标识属性

名称	类型	说明
clientId	string	分配的标识的客户端 ID。
principalId	string	已分配标识的主体 ID。

Workbook

Application Insights 工作簿定义。

名称	类型	说明
etag	object	资源 etag
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	用于 BYOS 的标识
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	对此工作簿定义进行的上次修改的 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

错误响应。

名称	类型	说明
error	WorkbookErrorDefinition	错误详细信息。

WorkbookErrorDefinition

错误定义。

名称	类型	说明
code	string	服务特定的错误代码，用作 HTTP 错误代码的子状态。
innererror	WorkbookInnerErrorTrace	内部错误详细信息。
message	string	错误的说明。

WorkbookInnerErrorTrace

错误详细信息

名称	类型	说明
trace	string[]	详细的错误跟踪

WorkbookUpdateParameters

更新工作簿属性属性时可以提供的参数。

名称	类型	说明
kind	SharedTypeKind	工作簿的种类。仅共享有效值。
properties.category	string	工作簿类别，由用户在创建时定义。
properties.description	string	工作簿的说明。
properties.displayName	string	用户定义的名称 (工作簿的显示名称) 。
properties.revision	string	此工作簿定义的唯一修订 ID
properties.serializedData	string	此特定工作簿的配置。配置数据是包含有效 JSON 的字符串
properties.tags	string[]	与此工作簿定义关联的 0 个或更多标记的列表
tags	object	资源标记。

通过

Workbooks - Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

WorkbookManagedUpdate

示例请求

示例响应

WorkbookUpdate

示例请求

示例响应

定义

createdByType

Identity

kind

ManagedServiceIdentityType

SharedTypeKind

systemData

UserAssignedIdentity

Workbook

WorkbookError

WorkbookErrorDefinition

WorkbookInnerErrorTrace

WorkbookUpdateParameters

其他资源