Workbooks - Update

Referência

Serviço:: Application Insights

Versão da API:: 2021-08-01

Atualizações uma pasta de trabalho que já foi adicionada.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
resourceName	path	True	string	O nome do recurso de componente do Application Insights.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.
sourceId	query		string	ID de Recurso do Azure que buscará todas as pastas de trabalho vinculadas.

Corpo da solicitação

Nome	Tipo	Description
kind	SharedTypeKind	O tipo de pasta de trabalho. Somente o valor válido é compartilhado.
properties.category	string	Categoria de pasta de trabalho, conforme definido pelo usuário no momento da criação.
properties.description	string	A descrição da pasta de trabalho.
properties.displayName	string	O nome definido pelo usuário (nome de exibição) da pasta de trabalho.
properties.revision	string	A ID de revisão exclusiva para esta definição de pasta de trabalho
properties.serializedData	string	Configuração desta pasta de trabalho específica. Os dados de configuração são uma cadeia de caracteres que contém JSON válido
properties.tags	string[]	Uma lista de 0 ou mais marcas associadas a essa definição de pasta de trabalho
tags	object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	Workbook	A definição da pasta de trabalho foi atualizada.
201 Created	Workbook	A definição da pasta de trabalho foi atualizada.
Other Status Codes	WorkbookError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

WorkbookManagedUpdate

WorkbookUpdate

WorkbookManagedUpdate

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
  }
}

Código de status:: 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
  }
}

Código de status:: 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"
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
Identity	Identidade usada para BYOS
kind	O tipo de pasta de trabalho. Somente o valor válido é compartilhado.
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos).
SharedTypeKind	O tipo de pasta de trabalho. Somente o valor válido é compartilhado.
systemData	Metadados relativos à criação e à última modificação do recurso.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário
Workbook	Uma definição de pasta de trabalho do Application Insights.
WorkbookError	Resposta de erro.
WorkbookErrorDefinition	Definição de erro.
WorkbookInnerErrorTrace	Detalhes do erro
WorkbookUpdateParameters	Os parâmetros que podem ser fornecidos ao atualizar as propriedades da pasta de trabalho.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Identity

Identidade usada para BYOS

Nome	Tipo	Description
principalId	string	A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.
tenantId	string	A ID do locatário da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	Identidades User-Assigned O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.

kind

O tipo de pasta de trabalho. Somente o valor válido é compartilhado.

Nome	Tipo	Description
shared	string
user	string

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos).

Nome	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

SharedTypeKind

O tipo de pasta de trabalho. Somente o valor válido é compartilhado.

Nome	Tipo	Description
shared	string
user	string

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Description
clientId	string	A ID do cliente da identidade atribuída.
principalId	string	A ID da entidade de segurança da identidade atribuída.

Workbook

Uma definição de pasta de trabalho do Application Insights.

Nome	Tipo	Description
etag	object	Etag de recurso
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Identidade usada para BYOS
kind	kind	O tipo de pasta de trabalho. Somente o valor válido é compartilhado.
location	string	A localização geográfica em que o recurso reside
name	string	O nome do recurso
properties.category	string	Categoria de pasta de trabalho, conforme definido pelo usuário no momento da criação.
properties.description	string	A descrição da pasta de trabalho.
properties.displayName	string	O nome definido pelo usuário (nome de exibição) da pasta de trabalho.
properties.revision	string	A ID de revisão exclusiva para esta definição de pasta de trabalho
properties.serializedData	string	Configuração desta pasta de trabalho específica. Os dados de configuração são uma cadeia de caracteres que contém JSON válido
properties.sourceId	string	ResourceId para um recurso de origem.
properties.storageUri	string	A resourceId para a conta de armazenamento quando traga seu próprio armazenamento é usada
properties.tags	string[]	Sendo preterido, use o outro campo de marcas
properties.timeModified	string	Data e hora em UTC da última modificação feita nessa definição de pasta de trabalho.
properties.userId	string	ID de usuário exclusiva do usuário específico que possui essa pasta de trabalho.
properties.version	string	Formato de versão do esquema da pasta de trabalho, como 'Notebook/1.0', que deve corresponder à pasta de trabalho em serializedData
systemData	systemData	Metadados relativos à criação e à última modificação do recurso.
tags	object	Marcas de recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

WorkbookError

Resposta de erro.

Nome	Tipo	Description
error	WorkbookErrorDefinition	Os detalhes do erro.

WorkbookErrorDefinition

Definição de erro.

Nome	Tipo	Description
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
innererror	WorkbookInnerErrorTrace	Detalhes do erro interno.
message	string	Descrição do erro.

WorkbookInnerErrorTrace

Detalhes do erro

Nome	Tipo	Description
trace	string[]	rastreamento de erro detalhado

WorkbookUpdateParameters

Os parâmetros que podem ser fornecidos ao atualizar as propriedades da pasta de trabalho.

Nome	Tipo	Description
kind	SharedTypeKind	O tipo de pasta de trabalho. Somente o valor válido é compartilhado.
properties.category	string	Categoria de pasta de trabalho, conforme definido pelo usuário no momento da criação.
properties.description	string	A descrição da pasta de trabalho.
properties.displayName	string	O nome definido pelo usuário (nome de exibição) da pasta de trabalho.
properties.revision	string	A ID de revisão exclusiva para esta definição de pasta de trabalho
properties.serializedData	string	Configuração desta pasta de trabalho específica. Os dados de configuração são uma cadeia de caracteres que contém JSON válido
properties.tags	string[]	Uma lista de 0 ou mais marcas associadas a essa definição de pasta de trabalho
tags	object	Marcas de recurso.

Compartilhar via

Workbooks - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

WorkbookManagedUpdate

Solicitação de exemplo

Resposta de exemplo

WorkbookUpdate

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

Identity

kind

ManagedServiceIdentityType

SharedTypeKind

systemData

UserAssignedIdentity

Workbook

WorkbookError

WorkbookErrorDefinition

WorkbookInnerErrorTrace

WorkbookUpdateParameters

Recursos adicionais