Workbooks - Update

Referens

Tjänst:: Application Insights

API-version:: 2021-08-01

Uppdateringar en arbetsbok som redan har lagts till.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
resourceName	path	True	string	Namnet på Application Insights-komponentresursen.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
sourceId	query		string	Azure-resurs-ID som hämtar alla länkade arbetsböcker.

Begärandetext

Name	Typ	Description
kind	SharedTypeKind	Den här typen av arbetsbok. Endast giltigt värde delas.
properties.category	string	Arbetsbokskategori, enligt definitionen av användaren när den skapades.
properties.description	string	Beskrivningen av arbetsboken.
properties.displayName	string	Arbetsbokens användardefinierade namn (visningsnamn).
properties.revision	string	Det unika revisions-ID:t för den här arbetsboksdefinitionen
properties.serializedData	string	Konfiguration av den här arbetsboken. Konfigurationsdata är en sträng som innehåller giltig JSON
properties.tags	string[]	En lista med 0 eller fler taggar som är associerade med den här arbetsboksdefinitionen
tags	object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	Workbook	Arbetsbokens definition har uppdaterats.
201 Created	Workbook	Arbetsbokens definition har uppdaterats.
Other Status Codes	WorkbookError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

WorkbookManagedUpdate

WorkbookUpdate

WorkbookManagedUpdate

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
  }
}

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
  }
}

Statuskod:: 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"
  }
}

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
Identity	Identitet som används för BYOS
kind	Den här typen av arbetsbok. Endast giltigt värde delas.
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både systemtilldelade och användartilldelade typer tillåts).
SharedTypeKind	Den här typen av arbetsbok. Endast giltigt värde delas.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserAssignedIdentity	Egenskaper för användartilldelad identitet
Workbook	En Application Insights-arbetsboksdefinition.
WorkbookError	Felsvar.
WorkbookErrorDefinition	Feldefinition.
WorkbookInnerErrorTrace	Felinformation
WorkbookUpdateParameters	De parametrar som kan anges när du uppdaterar egenskaper för arbetsboken.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Identity

Identitet som används för BYOS

Name	Typ	Description
principalId	string	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string	Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både systemtilldelade och användartilldelade typer tillåts).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identiteter Den uppsättning användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

kind

Den här typen av arbetsbok. Endast giltigt värde delas.

Name	Typ	Description
shared	string
user	string

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både systemtilldelade och användartilldelade typer tillåts).

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

SharedTypeKind

Den här typen av arbetsbok. Endast giltigt värde delas.

Name	Typ	Description
shared	string
user	string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserAssignedIdentity

Egenskaper för användartilldelad identitet

Name	Typ	Description
clientId	string	Klient-ID för den tilldelade identiteten.
principalId	string	Huvud-ID för den tilldelade identiteten.

Workbook

En Application Insights-arbetsboksdefinition.

Name	Typ	Description
etag	object	Resurs-etag
id	string	Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Identitet som används för BYOS
kind	kind	Den här typen av arbetsbok. Endast giltigt värde delas.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.category	string	Arbetsbokskategori, enligt definitionen av användaren när den skapades.
properties.description	string	Beskrivningen av arbetsboken.
properties.displayName	string	Arbetsbokens användardefinierade namn (visningsnamn).
properties.revision	string	Det unika revisions-ID:t för den här arbetsboksdefinitionen
properties.serializedData	string	Konfiguration av den här arbetsboken. Konfigurationsdata är en sträng som innehåller giltig JSON
properties.sourceId	string	ResourceId för en källresurs.
properties.storageUri	string	ResourceId till lagringskontot när Bring Your Own Storage används
properties.tags	string[]	Använd fältet andra taggar när du är inaktuell
properties.timeModified	string	Datum och tid i UTC för den senaste ändringen som gjordes i den här arbetsboksdefinitionen.
properties.userId	string	Unikt användar-ID för den specifika användare som äger arbetsboken.
properties.version	string	Versionsformat för arbetsboksschema, till exempel Notebook/1.0, som ska matcha arbetsboken i serializedData
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

WorkbookError

Felsvar.

Name	Typ	Description
error	WorkbookErrorDefinition	Felinformationen.

WorkbookErrorDefinition

Feldefinition.

Name	Typ	Description
code	string	Tjänstspecifik felkod som fungerar som understatus för HTTP-felkoden.
innererror	WorkbookInnerErrorTrace	Intern felinformation.
message	string	Beskrivning av felet.

WorkbookInnerErrorTrace

Felinformation

Name	Typ	Description
trace	string[]	detaljerad felspårning

WorkbookUpdateParameters

De parametrar som kan anges när du uppdaterar egenskaper för arbetsboken.

Name	Typ	Description
kind	SharedTypeKind	Den här typen av arbetsbok. Endast giltigt värde delas.
properties.category	string	Arbetsbokskategori, enligt definitionen av användaren när den skapades.
properties.description	string	Beskrivningen av arbetsboken.
properties.displayName	string	Arbetsbokens användardefinierade namn (visningsnamn).
properties.revision	string	Det unika revisions-ID:t för den här arbetsboksdefinitionen
properties.serializedData	string	Konfiguration av den här arbetsboken. Konfigurationsdata är en sträng som innehåller giltig JSON
properties.tags	string[]	En lista med 0 eller fler taggar som är associerade med den här arbetsboksdefinitionen
tags	object	Resurstaggar.

Dela via

Workbooks - Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

WorkbookManagedUpdate

Exempelbegäran

Exempelsvar

WorkbookUpdate

Exempelbegäran

Exempelsvar

Definitioner

createdByType

Identity

kind

ManagedServiceIdentityType

SharedTypeKind

systemData

UserAssignedIdentity

Workbook

WorkbookError

WorkbookErrorDefinition

WorkbookInnerErrorTrace

WorkbookUpdateParameters

Ytterligare resurser