biblioteca cliente de supervisión de Azure Synapse Analytics para .NET: versión 1.0.0-beta.3

Artículo
04/21/2023

Este directorio contiene el subconjunto código abierto del SDK de .NET. Para obtener documentación del SDK completo de Azure, consulte el Centro para desarrolladores de Microsoft Azure .NET.

Azure Synapse Analytics proporciona una experiencia de supervisión enriquecida dentro de Azure Portal que expone la información relacionada con la carga de trabajo del almacenamiento de datos. La biblioteca cliente de supervisión de Azure Synapse Analytics permite supervisar los recursos mediante programación.

Azure Synapse es un servicio de análisis ilimitado que reúne el almacenamiento de datos empresariales y el análisis de macrodatos. Le ofrece la libertad de consultar los datos como prefiera, ya sea a petición sin servidor o con recursos aprovisionados, a escala. Azure Synapse reúne estos dos mundos con una experiencia unificada para ingerir, preparar, administrar y servir datos para las necesidades inmediatas de inteligencia empresarial y aprendizaje automático.

Introducción

El SDK de Microsoft Azure completo se puede descargar desde la página descargas de Microsoft Azure y se incluye con compatibilidad para compilar paquetes de implementación, integrar con herramientas, herramientas de línea de comandos enriquecidas, etc.

Para obtener la mejor experiencia de desarrollo, los desarrolladores deben usar los paquetes NuGet oficiales de Microsoft para bibliotecas. Los paquetes NuGet se actualizan periódicamente con nuevas funcionalidades y revisiones.

Instalar el paquete

Instale la biblioteca cliente de supervisión de Azure Synapse Analytics para .NET con NuGet:

dotnet add package Azure.Analytics.Synapse.Monitoring --version 1.0.0-preview.1

Requisitos previos

Suscripción de Azure: Para usar los servicios de Azure, incluida Azure Synapse, necesitará una suscripción. Si no tiene una cuenta de Azure existente, puede registrarse para obtener una evaluación gratuita o usar las ventajas de la suscripción de Visual Studio al crear una cuenta.
Un área de trabajo de Azure Synapse existente. Si necesita crear un área de trabajo de Azure Synapse, puede usar Azure Portal o la CLI de Azure.

Si usa la CLI de Azure, el comando tiene el siguiente aspecto:

az synapse workspace create \
    --name <your-workspace-name> \
    --resource-group <your-resource-group-name> \
    --storage-account <your-storage-account-name> \
    --file-system <your-storage-file-system-name> \
    --sql-admin-login-user <your-sql-admin-user-name> \
    --sql-admin-login-password <your-sql-admin-user-password> \
    --location <your-workspace-location>

Autenticar el cliente

Para interactuar con el servicio Azure Synapse Analytics, deberá crear una instancia de la clase MonitoringClient. Necesita un punto de conexión del área de trabajo, que puede ver como "Punto de conexión de desarrollo" en el portal y credenciales de secreto de cliente (id. de cliente, secreto de cliente, id. de inquilino) para crear instancias de un objeto de cliente.

La autenticación de credenciales de secreto de cliente se usa en esta sección de introducción, pero puede encontrar más formas de autenticarse con la identidad de Azure. Para usar el proveedor DefaultAzureCredential que se muestra a continuación u otros proveedores de credenciales proporcionados con el SDK de Azure, debe instalar el paquete Azure.Identity:

Install-Package Azure.Identity

Conceptos clave

MonitoringClient

Con un MonitoringClient puede obtener una lista de aplicaciones spark o consulta de OD/DW de SQL para el área de trabajo.

Seguridad para subprocesos

Garantizamos que todos los métodos de instancia de cliente sean seguros para subprocesos e independientes entre sí (guía). Esto garantiza que la recomendación de reutilizar instancias de cliente siempre es segura, incluso entre subprocesos.

Conceptos adicionales

Ejemplos

El paquete Azure.Analytics.Synapse.Monitoring admite API sincrónicas y asincrónicas. En la sección siguiente se tratan algunas de las tareas relacionadas con la supervisión de Azure Synapse Analytics más comunes:

Ejemplos de supervisión

Obtención de una lista de aplicaciones spark
Obtención de una consulta SQL

Obtención de una lista de aplicaciones spark

GetSparkJobList obtiene una lista de aplicaciones spark para el área de trabajo.

SparkJobListViewResponse sparkJobList = client.GetSparkJobList();
foreach (var sparkJob in sparkJobList.SparkJobs)
{
    if (sparkJob.State == "Running")
    {
        Console.WriteLine ($"{sparkJob.Name} has been running for {sparkJob.RunningDuration}");
    }
    else
    {
        Console.WriteLine ($"{sparkJob.Name} has been in {sparkJob.State} for {sparkJob.QueuedDuration}");
    }
}

Obtención de la consulta de SQl

GetSqlJobQueryString obtiene la consulta de OD/DW de SQL.

SqlQueryStringDataModel sqlQuery = client.GetSqlJobQueryString();

Para compilar

Para obtener información sobre cómo compilar la biblioteca cliente de Azure Synapse, consulte Creación de la Microsoft Azure SDK para .NET

Versiones de .NET Framework de destino

Para obtener información sobre las plataformas de destino de la biblioteca cliente de Azure Synapse, consulte las plataformas de destino de la Microsoft Azure SDK para .NET.

Solución de problemas

Abra el problema en github.

Pasos siguientes

El siguiente paso es agregar más ejemplos

Contribuir

Este proyecto ha adoptado el Código de conducta de Microsoft Open Source. Para más información, consulte las preguntas más frecuentes del código de conducta o póngase en contacto con opencode@microsoft.com si tiene cualquier otra pregunta o comentario.