Compartir a través de


Workbooks - Get

Obtenga un único libro por su resourceName.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

resourceName
path True

string

Nombre del recurso de componente de Application Insights.

subscriptionId
path True

string

minLength: 1

Identificador de la suscripción de destino.

api-version
query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

canFetchContent
query

boolean

Marca que indica si se va a devolver o no el contenido completo de cada libro aplicable. Si es false, solo se devuelve el contenido de resumen de los libros.

Respuestas

Nombre Tipo Description
200 OK

Workbook

Una definición de libro.

Other Status Codes

WorkbookError

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

WorkbookGet
WorkbookGet1
WorkbookManagedGet

WorkbookGet

Solicitud de ejemplo

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
createdByType

Tipo de identidad que creó el recurso.

Identity

Identidad usada para BYOS

kind

El tipo de libro. Solo se comparte el valor válido.

ManagedServiceIdentityType

Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).

systemData

Metadatos relativos a la creación y última modificación del recurso.

UserAssignedIdentity

Propiedades de identidad asignadas por el usuario

Workbook

Una definición de libro de Application Insights.

WorkbookError

Respuesta de error.

WorkbookErrorDefinition

Definición de error.

WorkbookInnerErrorTrace

Detalles del error

createdByType

Tipo de identidad que creó el recurso.

Valor Description
Application
Key
ManagedIdentity
User

Identity

Identidad usada para BYOS

Nombre Tipo Description
principalId

string (uuid)

Identificador de entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.

tenantId

string (uuid)

Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.

type

ManagedServiceIdentityType

Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).

userAssignedIdentities

<string,  UserAssignedIdentity>

identidades de User-Assigned
Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.

kind

El tipo de libro. Solo se comparte el valor válido.

Valor Description
shared
user

ManagedServiceIdentityType

Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).

Valor Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

systemData

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string (date-time)

Marca de tiempo de creación de recursos (UTC).

createdBy

string

Identidad que creó el recurso.

createdByType

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt

string (date-time)

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy

string

Identidad que modificó por última vez el recurso.

lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentity

Propiedades de identidad asignadas por el usuario

Nombre Tipo Description
clientId

string (uuid)

Identificador de cliente de la identidad asignada.

principalId

string (uuid)

Identificador de entidad de seguridad de la identidad asignada.

Workbook

Una definición de libro de Application Insights.

Nombre Tipo Description
etag

object

Etag de recursos

id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Identidad usada para BYOS

kind

kind

El tipo de libro. Solo se comparte el valor válido.

location

string

Ubicación geográfica donde reside el recurso

name

string

Nombre del recurso

properties.category

string

Categoría del libro, según lo definido por el usuario en el momento de la creación.

properties.description

string

Descripción del libro.

properties.displayName

string

Nombre definido por el usuario (nombre para mostrar) del libro.

properties.revision

string

Identificador de revisión único para esta definición de libro

properties.serializedData

string

Configuración de este libro en particular. Los datos de configuración son una cadena que contiene JSON válido

properties.sourceId

string

ResourceId para un recurso de origen.

properties.storageUri

string

ResourceId a la cuenta de almacenamiento cuando se usa bring your own storage

properties.tags

string[]

En desuso, use el otro campo de etiquetas.

properties.timeModified

string (date-time)

Fecha y hora en UTC de la última modificación que se realizó en esta definición de libro.

properties.userId

string

Identificador de usuario único del usuario específico que posee este libro.

properties.version

string

Formato de versión del esquema del libro, como "Notebook/1.0", que debe coincidir con el libro en serializedData

systemData

systemData

Metadatos relativos a la creación y última modificación del recurso.

tags

object

Etiquetas de recursos.

type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WorkbookError

Respuesta de error.

Nombre Tipo Description
error

WorkbookErrorDefinition

Detalles del error.

WorkbookErrorDefinition

Definición de error.

Nombre Tipo Description
code

string

Código de error específico del servicio que actúa como subestado para el código de error HTTP.

innererror

WorkbookInnerErrorTrace

Detalles internos del error.

message

string

Descripción del error.

WorkbookInnerErrorTrace

Detalles del error

Nombre Tipo Description
trace

string[]

seguimiento detallado de errores