Workbooks - Get

Referenz

Dienst:: Application Insights

API-Version:: 2021-08-01

Rufen Sie eine einzelne Arbeitsmappe nach ihrem ResourceName ab.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string	Der Name der Application Insights-Komponentenressource.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
canFetchContent	query		boolean	Flag, das angibt, ob der vollständige Inhalt für jede anwendbare Arbeitsmappe zurückgegeben werden soll. Wenn false, gibt nur Zusammenfassungsinhalt für Arbeitsmappen zurück.

Antworten

Name	Typ	Beschreibung
200 OK	Workbook	Eine Arbeitsmappendefinition.
Other Status Codes	WorkbookError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

WorkbookGet

WorkbookGet1

WorkbookManagedGet

WorkbookGet

Beispielanforderung

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

import com.azure.core.util.Context;

/** Samples for Workbooks GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-08-01/examples/WorkbookGet.json
     */
    /**
     * Sample code: WorkbookGet.
     *
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void workbookGet(com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        manager
            .workbooks()
            .getByResourceGroupWithResponse(
                "my-resource-group", "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", 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/WorkbookGet.json
func ExampleWorkbooksClient_Get() {
	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)
	}
	res, err := client.Get(ctx,
		"my-resource-group",
		"deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
		&armapplicationinsights.WorkbooksClientGetOptions{CanFetchContent: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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

Beispiel für eine Antwort

Statuscode:: 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",
  "kind": "shared",
  "properties": {
    "displayName": "My New Workbook",
    "userId": "userId",
    "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": "2021-08-24T06:56:31.6301521Z",
    "storageUri": null,
    "description": "Sample workbook",
    "revision": "1e2f8435b98248febee70c64ac22e1bb"
  },
  "tags": {
    "TagSample01": "sample01",
    "TagSample02": "sample02"
  }
}

WorkbookGet1

Beispielanforderung

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

import com.azure.core.util.Context;

/** Samples for Workbooks GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-08-01/examples/WorkbookGet1.json
     */
    /**
     * Sample code: WorkbookGet1.
     *
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void workbookGet1(com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        manager
            .workbooks()
            .getByResourceGroupWithResponse(
                "my-resource-group", "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", 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

Beispiel für eine Antwort

Statuscode:: 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",
  "kind": "shared",
  "properties": {
    "displayName": "My New Workbook",
    "userId": "userId",
    "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": "2021-08-24T06:56:31.6301521Z",
    "storageUri": null
  },
  "tags": {
    "TagSample01": "sample01",
    "TagSample02": "sample02"
  }
}

WorkbookManagedGet

Beispielanforderung

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

import com.azure.core.util.Context;

/** Samples for Workbooks GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-08-01/examples/WorkbookManagedGet.json
     */
    /**
     * Sample code: WorkbookManagedGet.
     *
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void workbookManagedGet(
        com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        manager
            .workbooks()
            .getByResourceGroupWithResponse(
                "my-resource-group", "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", 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

Beispiel für eine Antwort

Statuscode:: 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",
  "kind": "shared",
  "properties": {
    "displayName": "azuremon",
    "serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":{\"json\":\"testing1\"},\"showPin\":false,\"name\":\"text - 0\"}],\"isLocked\":true,\"fallbackResourceIds\":[\"Azure Monitor\"]}",
    "version": "Notebook/1.0",
    "category": "workbook",
    "userId": "51d1409c-d725-4550-ac03-98c0bef9ef07",
    "sourceId": "azure monitor",
    "timeModified": "2020-09-04T09:07:17.735638Z",
    "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"
  }
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Identity	Für BYOS verwendete Identität
kind	Die Art der Arbeitsmappe. Es wird nur ein gültiger Wert freigegeben.
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei sowohl der SystemAssigned- als auch der UserAssigned-Typ zulässig sind).
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UserAssignedIdentity	Benutzerseitig zugewiesene Identitätseigenschaften
Workbook	Eine Application Insights-Arbeitsmappendefinition.
WorkbookError	Fehlerantwort.
WorkbookErrorDefinition	Fehlerdefinition.
WorkbookInnerErrorTrace	Fehlerdetails

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

Identity

Für BYOS verwendete Identität

Name	Typ	Beschreibung
principalId	string	Die Dienstprinzipal-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei sowohl der SystemAssigned- als auch der UserAssigned-Typ zulässig sind).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identitäten Der Satz von benutzerseitig zugewiesenen Identitäten, die der Ressource zugeordnet sind. Bei den userAssignedIdentities-Wörterbuchschlüsseln handelt es sich um ARM-Ressourcen-IDs im Format :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

kind

Die Art der Arbeitsmappe. Es wird nur ein gültiger Wert freigegeben.

Name	Typ	Beschreibung
shared	string
user	string

ManagedServiceIdentityType

Typ der verwalteten Dienstidentität (wobei sowohl der SystemAssigned- als auch der UserAssigned-Typ zulässig sind).

Name	Typ	Beschreibung
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserAssignedIdentity

Benutzerseitig zugewiesene Identitätseigenschaften

Name	Typ	Beschreibung
clientId	string	Die Client-ID der zugewiesenen Identität.
principalId	string	Die Prinzipal-ID der zugewiesenen Identität.

Workbook

Eine Application Insights-Arbeitsmappendefinition.

Name	Typ	Beschreibung
etag	object	Ressourcen-etag
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Für BYOS verwendete Identität
kind	kind	Die Art der Arbeitsmappe. Es wird nur ein gültiger Wert freigegeben.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.category	string	Arbeitsmappenkategorie, wie sie vom Benutzer zum Zeitpunkt der Erstellung definiert wurde.
properties.description	string	Die Beschreibung der Arbeitsmappe.
properties.displayName	string	Der benutzerdefinierte Name (Anzeigename) der Arbeitsmappe.
properties.revision	string	Die eindeutige Revisions-ID für diese Arbeitsmappendefinition
properties.serializedData	string	Konfiguration dieser bestimmten Arbeitsmappe. Konfigurationsdaten sind eine Zeichenfolge, die gültige JSON-Daten enthält.
properties.sourceId	string	ResourceId für eine Quellressource.
properties.storageUri	string	Die resourceId für das Speicherkonto, wenn "Bring Your Own Storage" verwendet wird
properties.tags	string[]	Wenn Sie veraltet sind, verwenden Sie das Feld "Andere Tags".
properties.timeModified	string	Datum und Uhrzeit in UTC der letzten Änderung, die an dieser Arbeitsmappendefinition vorgenommen wurde.
properties.userId	string	Eindeutige Benutzer-ID des bestimmten Benutzers, der besitzer dieser Arbeitsmappe ist.
properties.version	string	Format der Arbeitsmappenschemaversion, z. B. "Notebook/1.0", das mit der Arbeitsmappe in serializedData übereinstimmen sollte
systemData	systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

WorkbookError

Fehlerantwort.

Name	Typ	Beschreibung
error	WorkbookErrorDefinition	Die Fehlerdetails.

WorkbookErrorDefinition

Fehlerdefinition.

Name	Typ	Beschreibung
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
innererror	WorkbookInnerErrorTrace	Interne Fehlerdetails.
message	string	Beschreibung des Fehlers

WorkbookInnerErrorTrace

Fehlerdetails

Name	Typ	Beschreibung
trace	string[]	Detaillierte Fehlerablaufverfolgung

Freigeben über

Workbooks - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

WorkbookGet

Beispielanforderung

Beispiel für eine Antwort

WorkbookGet1

Beispielanforderung

Beispiel für eine Antwort

WorkbookManagedGet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

Identity

kind

ManagedServiceIdentityType

systemData

UserAssignedIdentity

Workbook

WorkbookError

WorkbookErrorDefinition

WorkbookInnerErrorTrace

Zusätzliche Ressourcen