biblioteca cliente de artefactos de Azure Synapse Analytics para .NET: versión 1.0.0-preview.18

Artículo
07/31/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.

La biblioteca cliente de desarrollo de Azure Synapse Analytics permite administrar artefactos mediante programación, ofrecer métodos para crear, actualizar, enumerar y eliminar canalizaciones, conjuntos de datos, flujos de datos, cuadernos, definiciones de trabajos de Spark, scripts SQL, servicios vinculados y desencadenadores.

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 completo de Microsoft Azure se puede descargar desde la página de 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 desarrollo de Azure Synapse Analytics para .NET con NuGet:

dotnet add package Azure.Analytics.Synapse.Artifacts --prerelease

Prerrequisitos

Suscripción de Azure: Para usar los servicios de Azure, incluido 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 parte del servicio Azure Synapse Analytics, deberá crear una instancia de la clase de cliente correspondiente:

Necesita un punto de conexión de á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, identificador 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:

dotnet add package Azure.Identity

Ejemplos

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

Creación de un cuaderno

CreateOrUpdateNotebook crea un cuaderno.

NotebookCreateOrUpdateNotebookOperation operation = await client.StartCreateOrUpdateNotebookAsync(notebookName, notebookResource);
await operation.WaitForCompletionAsync();
Console.WriteLine("The notebook is created");

Recuperación de un cuaderno

GetNoteBook recupera un cuaderno.

NotebookResource retrievedNotebook = client.GetNotebook(notebookName);

Enumerar cuadernos

GetNotebooksByWorkspace enumera los cuadernos del área de trabajo de Synapse.

Pageable<NotebookResource> notebooks = client.GetNotebooksByWorkspace();
foreach (NotebookResource notebook in notebooks)
{
    Console.WriteLine(notebook.Name);
}

Eliminación de un cuaderno

DeleteNotebook elimina un cuaderno.

NotebookDeleteNotebookOperation deleteNotebookOperation = client.StartDeleteNotebook(notebookName);
await deleteNotebookOperation.WaitForCompletionResponseAsync();

Para compilar

Para obtener información sobre cómo compilar la biblioteca cliente de Azure Synapse, consulte Creación del 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 del Microsoft Azure SDK para .NET.

Conceptos clave

NotebookControlClient

Con un cliente de cuaderno, puede crear, actualizar, enumerar y eliminar canalizaciones, conjuntos de datos, flujos de datos, cuadernos, definiciones de trabajos de Spark, scripts SQL, servicios vinculados y desencadenadores.

Seguridad para subprocesos

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

Conceptos adicionales

Solución de problemas

Abra el problema en github.

Pasos siguientes

El siguiente paso es agregar más ejemplos

Contribuciones

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.

Compartir a través de