Workbooks - Get

Referentie

Service:: Application Insights

API-versie:: 2021-08-01

Eén werkmap ophalen op basis van de resourceName.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
resourceName	path	True	string	De naam van de Application Insights-onderdeelresource.
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
canFetchContent	query		boolean	Vlag die aangeeft of de volledige inhoud voor elke toepasselijke werkmap moet worden geretourneerd. Als dit onwaar is, retourneert u alleen samenvattingsinhoud voor werkmappen.

Antwoorden

Name	Type	Description
200 OK	Workbook	Een werkmapdefinitie.
Other Status Codes	WorkbookError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

WorkbookGet

WorkbookGet1

WorkbookManagedGet

WorkbookGet

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
Identity	Identiteit die wordt gebruikt voor BYOS
kind	Het type werkmap. Alleen geldige waarde wordt gedeeld.
ManagedServiceIdentityType	Type beheerde service-identiteit (waarbij zowel systemAssigned als UserAssigned zijn toegestaan).
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
UserAssignedIdentity	Eigenschappen van door de gebruiker toegewezen identiteit
Workbook	Een Application Insights-werkmapdefinitie.
WorkbookError	Foutreactie.
WorkbookErrorDefinition	Foutdefinitie.
WorkbookInnerErrorTrace	Foutdetails

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Identity

Identiteit die wordt gebruikt voor BYOS

Name	Type	Description
principalId	string	De service-principal-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit.
tenantId	string	De tenant-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit.
type	ManagedServiceIdentityType	Type beheerde service-identiteit (waarbij zowel systemAssigned als UserAssigned zijn toegestaan).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned-identiteiten De set door de gebruiker toegewezen identiteiten die zijn gekoppeld aan de resource. De userAssignedIdentities-woordenlijstsleutels zijn ARM-resource-id's in de vorm: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De woordenlijstwaarden kunnen lege objecten ({}) in aanvragen zijn.

kind

Het type werkmap. Alleen geldige waarde wordt gedeeld.

Name	Type	Description
shared	string
user	string

ManagedServiceIdentityType

Type beheerde service-identiteit (waarbij zowel systemAssigned als UserAssigned zijn toegestaan).

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

UserAssignedIdentity

Eigenschappen van door de gebruiker toegewezen identiteit

Name	Type	Description
clientId	string	De client-id van de toegewezen identiteit.
principalId	string	De principal-id van de toegewezen identiteit.

Workbook

Een Application Insights-werkmapdefinitie.

Name	Type	Description
etag	object	Resource-etag
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Identiteit die wordt gebruikt voor BYOS
kind	kind	Het type werkmap. Alleen geldige waarde wordt gedeeld.
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.category	string	Werkmapcategorie, zoals gedefinieerd door de gebruiker tijdens het maken.
properties.description	string	De beschrijving van de werkmap.
properties.displayName	string	De door de gebruiker gedefinieerde naam (weergavenaam) van de werkmap.
properties.revision	string	De unieke revisie-id voor deze werkmapdefinitie
properties.serializedData	string	Configuratie van deze specifieke werkmap. Configuratiegegevens zijn een tekenreeks die geldige JSON bevat
properties.sourceId	string	ResourceId voor een bronresource.
properties.storageUri	string	De resourceId voor het opslagaccount wanneer Bring Your Own Storage wordt gebruikt
properties.tags	string[]	Als u wordt afgeschaft, gebruikt u het veld andere tags
properties.timeModified	string	Datum en tijd in UTC van de laatste wijziging die is aangebracht in deze werkmapdefinitie.
properties.userId	string	Unieke gebruikers-id van de specifieke gebruiker die eigenaar is van deze werkmap.
properties.version	string	Indeling van de werkmapschemaversie, zoals 'Notebook/1.0', die overeenkomt met de werkmap in serializedData
systemData	systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

WorkbookError

Foutreactie.

Name	Type	Description
error	WorkbookErrorDefinition	De foutdetails.

WorkbookErrorDefinition

Foutdefinitie.

Name	Type	Description
code	string	Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.
innererror	WorkbookInnerErrorTrace	Details van interne fouten.
message	string	Beschrijving van de fout.

WorkbookInnerErrorTrace

Foutdetails

Name	Type	Description
trace	string[]	gedetailleerde fouttracering

Delen via

Workbooks - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

WorkbookGet

Voorbeeldaanvraag

Voorbeeldrespons

WorkbookGet1

Voorbeeldaanvraag

Voorbeeldrespons

WorkbookManagedGet

Voorbeeldaanvraag

Voorbeeldrespons

Definities

createdByType

Identity

kind

ManagedServiceIdentityType

systemData

UserAssignedIdentity

Workbook

WorkbookError

WorkbookErrorDefinition

WorkbookInnerErrorTrace

Aanvullende resources