Pastas de trabalho do Microsoft.Insights

Artigo
08/15/2024

Definição de recursos do bíceps

O tipo de recurso pastas de trabalho pode ser implantado com operações que visam:

Grupos de recursos - Consulte comandos de implantação de grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Insights/workbooks, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Insights/workbooks@2023-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'shared'
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    category: 'string'
    description: 'string'
    displayName: 'string'
    serializedData: 'string'
    sourceId: 'string'
    storageUri: 'string'
    tags: [
      'string'
    ]
    version: 'string'
  }
}

Valores de propriedade

pastas de trabalho

Designação	Descrição	Valor
Designação	O nome do recurso	string (obrigatório)
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Etiquetas	Tags de recursos.	Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo	O tipo de pasta de trabalho. Apenas o valor válido é compartilhado.	'compartilhado'
etag	Etag de recursos	string
identidade	Identidade usada para BYOS	WorkbookResourceIdentity
propriedades	Metadados que descrevem uma pasta de trabalho para um recurso do Azure.	WorkbookProperties

WorkbookResourceIdentity

Designação	Descrição	Valor
tipo	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).	'Nenhuma' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obrigatório)
userAssignedIdentities	O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.	UserAssignedIdentities

UserAssignedIdentities

Designação	Descrição	Valor
{propriedade personalizada}		UserAssignedIdentity

UserAssignedIdentity

Este objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

Propriedades da pasta de trabalho

Designação	Descrição	Valor
categoria	Categoria da pasta de trabalho, conforme definido pelo usuário no momento da criação.	string (obrigatório)
Descrição	A descrição da pasta de trabalho.	string
displayName	O nome definido pelo usuário (nome para exibição) da pasta de trabalho.	string (obrigatório)
serializedData	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	string (obrigatório)
fonteId	ResourceId para um recurso de origem.	string
storageUri	O resourceId para a conta de armazenamento quando trazer seu próprio armazenamento é usado	string
Etiquetas	Sendo preterido, use o campo de outras tags	string[]
Versão	Formato de versão do esquema da pasta de trabalho, como 'Notebook/1.0', que deve corresponder à pasta de trabalho em serializedData	string

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
pasta de trabalho do kit de ferramentas FinOps	Este modelo cria uma nova pasta de trabalho do Azure Monitor para governança.
Pasta de trabalho de otimização de custos	Este modelo cria uma nova pasta de trabalho do Azure Monitor para otimização de custos com base no Well-Architected Framework.

Definição de recurso de modelo ARM

O tipo de recurso pastas de trabalho pode ser implantado com operações que visam:

Grupos de recursos - Consulte comandos de implantação de grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Insights/workbooks, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Insights/workbooks",
  "apiVersion": "2023-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "shared",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "category": "string",
    "description": "string",
    "displayName": "string",
    "serializedData": "string",
    "sourceId": "string",
    "storageUri": "string",
    "tags": [ "string" ],
    "version": "string"
  }
}

Valores de propriedade

pastas de trabalho

Designação	Descrição	Valor
tipo	O tipo de recurso	'Microsoft.Insights/pastas de trabalho'
apiVersion	A versão da api de recursos	'2023-06-01'
Designação	O nome do recurso	string (obrigatório)
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Etiquetas	Tags de recursos.	Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo	O tipo de pasta de trabalho. Apenas o valor válido é compartilhado.	'compartilhado'
etag	Etag de recursos	string
identidade	Identidade usada para BYOS	WorkbookResourceIdentity
propriedades	Metadados que descrevem uma pasta de trabalho para um recurso do Azure.	WorkbookProperties

WorkbookResourceIdentity

Designação	Descrição	Valor
tipo	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).	'Nenhuma' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obrigatório)
userAssignedIdentities	O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.	UserAssignedIdentities

UserAssignedIdentities

Designação	Descrição	Valor
{propriedade personalizada}		UserAssignedIdentity

UserAssignedIdentity

Este objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

Propriedades da pasta de trabalho

Designação	Descrição	Valor
categoria	Categoria da pasta de trabalho, conforme definido pelo usuário no momento da criação.	string (obrigatório)
Descrição	A descrição da pasta de trabalho.	string
displayName	O nome definido pelo usuário (nome para exibição) da pasta de trabalho.	string (obrigatório)
serializedData	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	string (obrigatório)
fonteId	ResourceId para um recurso de origem.	string
storageUri	O resourceId para a conta de armazenamento quando trazer seu próprio armazenamento é usado	string
Etiquetas	Sendo preterido, use o campo de outras tags	string[]
Versão	Formato de versão do esquema da pasta de trabalho, como 'Notebook/1.0', que deve corresponder à pasta de trabalho em serializedData	string

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
pasta de trabalho do kit de ferramentas FinOps	Este modelo cria uma nova pasta de trabalho do Azure Monitor para governança.
Pasta de trabalho de otimização de custos	Este modelo cria uma nova pasta de trabalho do Azure Monitor para otimização de custos com base no Well-Architected Framework.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso pastas de trabalho pode ser implantado com operações que visam:

Grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Insights/workbooks, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/workbooks@2023-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      category = "string"
      description = "string"
      displayName = "string"
      serializedData = "string"
      sourceId = "string"
      storageUri = "string"
      tags = [
        "string"
      ]
      version = "string"
    }
    kind = "shared"
    etag = "string"
  })
}

Valores de propriedade

pastas de trabalho

Designação	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Insights/workbooks@2023-06-01"
Designação	O nome do recurso	string (obrigatório)
Localização	A geolocalização onde o recurso vive	string (obrigatório)
parent_id	Para implantar em um grupo de recursos, use a ID desse grupo de recursos.	string (obrigatório)
Etiquetas	Tags de recursos.	Dicionário de nomes e valores de tags.
tipo	O tipo de pasta de trabalho. Apenas o valor válido é compartilhado.	"Partilhado"
etag	Etag de recursos	string
identidade	Identidade usada para BYOS	WorkbookResourceIdentity
propriedades	Metadados que descrevem uma pasta de trabalho para um recurso do Azure.	WorkbookProperties

WorkbookResourceIdentity

Designação	Descrição	Valor
tipo	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).	"SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (obrigatório)
identity_ids	O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.	Matriz de IDs de identidade do usuário.

UserAssignedIdentities

Designação	Descrição	Valor
{propriedade personalizada}		UserAssignedIdentity

UserAssignedIdentity

Este objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

Propriedades da pasta de trabalho

Designação	Descrição	Valor
categoria	Categoria da pasta de trabalho, conforme definido pelo usuário no momento da criação.	string (obrigatório)
Descrição	A descrição da pasta de trabalho.	string
displayName	O nome definido pelo usuário (nome para exibição) da pasta de trabalho.	string (obrigatório)
serializedData	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	string (obrigatório)
fonteId	ResourceId para um recurso de origem.	string
storageUri	O resourceId para a conta de armazenamento quando trazer seu próprio armazenamento é usado	string
Etiquetas	Sendo preterido, use o campo de outras tags	string[]
Versão	Formato de versão do esquema da pasta de trabalho, como 'Notebook/1.0', que deve corresponder à pasta de trabalho em serializedData	string

Partilhar via

Pastas de trabalho do Microsoft.Insights

Definição de recursos do bíceps

Formato do recurso

Valores de propriedade

pastas de trabalho

WorkbookResourceIdentity

UserAssignedIdentities

UserAssignedIdentity

Propriedades da pasta de trabalho

Modelos de início rápido

Definição de recurso de modelo ARM

Formato do recurso

Valores de propriedade

pastas de trabalho

WorkbookResourceIdentity

UserAssignedIdentities

UserAssignedIdentity

Propriedades da pasta de trabalho

Modelos de início rápido

Definição de recursos Terraform (provedor AzAPI)

Formato do recurso

Valores de propriedade

pastas de trabalho

WorkbookResourceIdentity

UserAssignedIdentities

UserAssignedIdentity

Propriedades da pasta de trabalho

Comentários

Recursos adicionais