Grafana - Get

Referencia

Servicio:: Managed Grafana

Versión de la API:: 2024-10-01

Obtenga las propiedades de un área de trabajo específica para el recurso de Grafana.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}?api-version=2024-10-01

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.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
workspaceName	path	True	string pattern: ^[a-zA-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]$	Nombre del área de trabajo de Azure Managed Grafana.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ManagedGrafana	De acuerdo. Devuelve las propiedades del área de trabajo necesaria para el recurso de Grafana.
Other Status Codes	ErrorResponse	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores.

Ejemplos

Grafana_Get

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Dashboard/grafana/myWorkspace?api-version=2024-10-01

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace",
  "name": "myWorkspace",
  "type": "Microsoft.Dashboard/grafana",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "grafanaVersion": "9.4.5",
    "endpoint": "https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com",
    "zoneRedundancy": "Enabled",
    "apiKey": "Enabled",
    "deterministicOutboundIP": "Enabled",
    "outboundIPs": [
      "192.168.0.1",
      "192.168.0.2"
    ],
    "publicNetworkAccess": "Enabled",
    "autoGeneratedDomainNameLabelScope": "TenantReuse",
    "grafanaConfigurations": {
      "smtp": {
        "enabled": true,
        "host": "smtp.sendemail.com:587",
        "user": "username",
        "fromAddress": "test@sendemail.com",
        "fromName": "emailsender",
        "startTLSPolicy": "OpportunisticStartTLS",
        "skipVerify": true
      },
      "snapshots": {
        "externalEnabled": true
      },
      "users": {
        "viewersCanEdit": true
      },
      "security": {
        "csrfAlwaysCheck": false
      }
    },
    "grafanaIntegrations": {
      "azureMonitorWorkspaceIntegrations": [
        {
          "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace"
        }
      ]
    },
    "enterpriseConfigurations": {
      "marketplacePlanId": "myPlanId",
      "marketplaceAutoRenew": "Enabled"
    },
    "grafanaPlugins": {
      "sample-plugin-id": {
        "pluginId": "sample-plugin-id"
      }
    },
    "grafanaMajorVersion": "9"
  },
  "tags": {
    "Environment": "Dev"
  },
  "location": "West US",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
  }
}

Definiciones

Nombre	Description
ApiKey
AutoGeneratedDomainNameLabelScope	Ámbito del cálculo hash de nombre determinista dns
AzureMonitorWorkspaceIntegration	Integraciones para el área de trabajo de Azure Monitor.
createdByType	Tipo de identidad que creó el recurso.
DeterministicOutboundIP
EnterpriseConfigurations	Configuración empresarial de una instancia de Grafana
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GrafanaConfigurations	Configuraciones de servidor de una instancia de Grafana
GrafanaIntegrations	GrafanaIntegrations es una experiencia de observabilidad agrupada (por ejemplo, origen de datos preconfigurado, paneles personalizados de Grafana, valores predeterminados de alerta) para escenarios comunes de supervisión.
GrafanaPlugin	Complemento de Grafana
ManagedGrafana	Tipo de recurso grafana.
ManagedGrafanaProperties	Propiedades específicas del recurso de grafana.
ManagedServiceIdentity	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)
ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
MarketplaceAutoRenew	Configuración AutoRenew de la suscripción Enterprise
PrivateEndpoint	El recurso Punto de conexión privado.
PrivateEndpointConnection	El recurso Conexión de punto de conexión privado.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento actual.
PrivateEndpointServiceConnectionStatus	Estado de conexión del punto de conexión privado.
PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
ProvisioningState
PublicNetworkAccess	Indique el estado para habilitar o deshabilitar el tráfico a través de la interfaz pública.
ResourceSku
Security	Configuración de seguridad de Grafana
Smtp	Configuración del servidor de correo electrónico. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp
Snapshots	Configuración de instantáneas de Grafana
StartTLSPolicy	Valor StartTLSPolicy de la configuración SMTP https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy
systemData	Metadatos relativos a la creación y última modificación del recurso.
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario
Users	Configuración de usuarios de Grafana
ZoneRedundancy

ApiKey

Enumeración

Valor	Description
Disabled
Enabled

AutoGeneratedDomainNameLabelScope

Enumeración

Ámbito del cálculo hash de nombre determinista dns

Valor	Description
TenantReuse

AzureMonitorWorkspaceIntegration

Object

Integraciones para el área de trabajo de Azure Monitor.

Nombre	Tipo	Description
azureMonitorWorkspaceResourceId	string	Identificador de recurso del área de trabajo de Azure Monitor conectada.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DeterministicOutboundIP

Enumeración

Valor	Description
Disabled
Enabled

EnterpriseConfigurations

Object

Configuración empresarial de una instancia de Grafana

Nombre	Tipo	Description
marketplaceAutoRenew	MarketplaceAutoRenew	Configuración AutoRenew de la suscripción Enterprise
marketplacePlanId	string	Identificador de plan de la suscripción de Azure Marketplace para los complementos enterprise

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GrafanaConfigurations

Object

Configuraciones de servidor de una instancia de Grafana

Nombre	Tipo	Description
security	Security	Configuración de seguridad de Grafana
smtp	Smtp	Configuración del servidor de correo electrónico. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp
snapshots	Snapshots	Configuración de instantáneas de Grafana
users	Users	Configuración de usuarios de Grafana

GrafanaIntegrations

Object

GrafanaIntegrations es una experiencia de observabilidad agrupada (por ejemplo, origen de datos preconfigurado, paneles personalizados de Grafana, valores predeterminados de alerta) para escenarios comunes de supervisión.

Nombre	Tipo	Description
azureMonitorWorkspaceIntegrations	AzureMonitorWorkspaceIntegration[]	Integraciones para el área de trabajo de Azure Monitor.

GrafanaPlugin

Object

Complemento de Grafana

Nombre	Tipo	Description
pluginId	string	Identificador del complemento de Grafana

ManagedGrafana

Object

Tipo de recurso grafana.

Nombre	Tipo	Description
id	string	Id. de ARM del recurso de grafana
identity	ManagedServiceIdentity	Identidad administrada del recurso de grafana.
location	string	Ubicación geográfica donde reside el recurso de grafana
name	string	Nombre del recurso de grafana.
properties	ManagedGrafanaProperties	Propiedades específicas del recurso de grafana.
sku	ResourceSku	SKU del recurso grafana.
systemData	systemData	Metadatos del sistema relacionados con este recurso de grafana.
tags	object	Etiquetas para el recurso de grafana.
type	string	Tipo del recurso de grafana.

ManagedGrafanaProperties

Object

Propiedades específicas del recurso de grafana.

Nombre	Tipo	Valor predeterminado	Description
apiKey	ApiKey	Disabled	Configuración de la clave de API de la instancia de Grafana.
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope		Ámbito del cálculo hash de nombre determinista dns.
deterministicOutboundIP	DeterministicOutboundIP	Disabled	Si una instancia de Grafana usa direcciones IP de salida deterministas.
endpoint	string		Punto de conexión de la instancia de Grafana.
enterpriseConfigurations	EnterpriseConfigurations		Configuración empresarial de una instancia de Grafana
grafanaConfigurations	GrafanaConfigurations		Configuraciones de servidor de una instancia de Grafana
grafanaIntegrations	GrafanaIntegrations		GrafanaIntegrations es una experiencia de observabilidad agrupada (por ejemplo, origen de datos preconfigurado, paneles personalizados de Grafana, valores predeterminados de alerta) para escenarios comunes de supervisión.
grafanaMajorVersion	string		La versión principal del software de Grafana que se va a dirigir.
grafanaPlugins	<string, GrafanaPlugin>		Lista de complementos instalada de la instancia de Grafana. La clave es el identificador del complemento, el valor es la definición del complemento.
grafanaVersion	string		La versión de software de Grafana.
outboundIPs	string[]		Lista de direcciones IP de salida si está habilitado deterministaOutboundIP.
privateEndpointConnections	PrivateEndpointConnection[]		Conexiones de punto de conexión privado de la instancia de Grafana.
provisioningState	ProvisioningState		Estado de aprovisionamiento del recurso.
publicNetworkAccess	PublicNetworkAccess	Enabled	Indique el estado para habilitar o deshabilitar el tráfico a través de la interfaz pública.
zoneRedundancy	ZoneRedundancy	Disabled	Configuración de redundancia de zona de la instancia de Grafana.

ManagedServiceIdentity

Object

Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)

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.

ManagedServiceIdentityType

Enumeración

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

Valor	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MarketplaceAutoRenew

Enumeración

Configuración AutoRenew de la suscripción Enterprise

Valor	Description
Disabled
Enabled

PrivateEndpoint

Object

El recurso Punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador de ARM para punto de conexión privado

PrivateEndpointConnection

Object

El recurso Conexión de punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.groupIds	string[]	Identificadores del grupo de conexiones del punto de conexión privado.
properties.privateEndpoint	PrivateEndpoint	Recurso del punto de conexión privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento del recurso de conexión de punto de conexión privado.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeración

Estado de aprovisionamiento actual.

Valor	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeración

Estado de conexión del punto de conexión privado.

Valor	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

Nombre	Tipo	Description
actionsRequired	string	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description	string	Motivo de aprobación o rechazo de la conexión.
status	PrivateEndpointServiceConnectionStatus	Indica si el propietario del servicio ha aprobado o rechazado o eliminado la conexión.

ProvisioningState

Enumeración

Valor	Description
Accepted
Canceled
Creating
Deleted
Deleting
Failed
NotSpecified
Succeeded
Updating

PublicNetworkAccess

Enumeración

Indique el estado para habilitar o deshabilitar el tráfico a través de la interfaz pública.

Valor	Description
Disabled
Enabled

ResourceSku

Object

Nombre	Tipo	Description
name	string

Security

Object

Configuración de seguridad de Grafana

Nombre	Tipo	Description
csrfAlwaysCheck	boolean	Establézcalo en true para ejecutar la comprobación CSRF incluso si la cookie de inicio de sesión no está en una solicitud (el valor predeterminado es false).

Smtp

Object

Configuración del servidor de correo electrónico. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp

Nombre	Tipo	Valor predeterminado	Description
enabled	boolean	False	Habilite esta opción para permitir que Grafana envíe correo electrónico. El valor predeterminado es false
fromAddress	string		Dirección que se usa al enviar correos electrónicos https://pkg.go.dev/net/mail#Address
fromName	string		Nombre que se usará al enviar correos electrónicos. El valor predeterminado es "Notificación de Grafana administrada de Azure" https://pkg.go.dev/net/mail#Address
host	string		Nombre de host del servidor SMTP con puerto, por ejemplo, test.email.net:587
password	string		Contraseña de la autenticación SMTP. Si la contraseña contiene # o ;, tiene que encapsularla con comillas triples.
skipVerify	boolean		Compruebe SSL para el servidor SMTP. El valor predeterminado es false https://pkg.go.dev/crypto/tls#Config
startTLSPolicy	StartTLSPolicy		Valor StartTLSPolicy de la configuración SMTP https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy
user	string		Usuario de la autenticación SMTP

Snapshots

Object

Configuración de instantáneas de Grafana

Nombre	Tipo	Description
externalEnabled	boolean	Establézcalo en false para deshabilitar el punto de conexión de publicación de instantáneas externas

StartTLSPolicy

Enumeración

Valor StartTLSPolicy de la configuración SMTP https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy

Valor	Description
MandatoryStartTLS
NoStartTLS
OpportunisticStartTLS

systemData

Object

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

Object

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.

Users

Object

Configuración de usuarios de Grafana

Nombre	Tipo	Description
viewersCanEdit	boolean	Establézcalo en true para que los visores puedan acceder a los paneles de los paneles a los que tienen acceso y usar exploran y realizan modificaciones temporales en los paneles a los que tienen acceso. No pueden guardar sus cambios.

ZoneRedundancy

Enumeración

Valor	Description
Disabled
Enabled

Compartir a través de

Grafana - Get

Parámetros de identificador URI

Respuestas

Ejemplos

Grafana_Get

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ApiKey

AutoGeneratedDomainNameLabelScope

AzureMonitorWorkspaceIntegration

createdByType

DeterministicOutboundIP

EnterpriseConfigurations

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GrafanaConfigurations

GrafanaIntegrations

GrafanaPlugin

ManagedGrafana

ManagedGrafanaProperties

ManagedServiceIdentity

ManagedServiceIdentityType

MarketplaceAutoRenew

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ProvisioningState

PublicNetworkAccess

ResourceSku

Security

Smtp

Snapshots

StartTLSPolicy

systemData

UserAssignedIdentity

Users

ZoneRedundancy