Bibliothèque cliente de workflow Azure Purview pour .NET - version 1.0.0-beta.1

Article
04/18/2023

Les workflows sont des processus d’entreprise automatisés et reproductibles que les utilisateurs peuvent créer dans Microsoft Purview pour valider et orchestrer des opérations CUD (création, mise à jour, suppression) sur leurs entités de données. L’activation de ces processus permet aux organisations de suivre les modifications, d’appliquer la conformité à la stratégie et de garantir des données de qualité dans leur paysage de données.

Utilisez la bibliothèque cliente pour le flux de travail Purview pour :

Gérer les flux de travail
Envoyer des demandes utilisateur et surveiller les exécutions de flux de travail
Afficher et répondre aux tâches de flux de travail

Pour plus d’informations sur l’utilisation du flux de travail, reportez-vous à la documentation du service

Prise en main

Installer le package

dotnet add package Azure.Analytics.Purview.Workflows --prerelease

Prérequis

Vous devez disposer d’un abonnement Azure et d’une ressource Purview pour utiliser ce package.

Authentifier le client

Étant donné que le service de flux de travail utilise un jeton du porteur Azure Active Directory (AAD) pour l’authentification et l’identification, une adresse e-mail doit être encodée dans le jeton pour permettre la notification lors de l’utilisation du flux de travail. Il est recommandé d’utiliser la bibliothèque d’identités Azure avec usernamePasswordCredential. Avant d’utiliser la bibliothèque d’identités Azure avec workflow, une application doit être inscrite et utilisée pour le clientId passé à UsernamePasswordCredential.

Uri endpoint = new Uri(Environment.GetEnvironmentVariable("WORKFLOW_ENDPOINT"));
string clientId = Environment.GetEnvironmentVariable("ClientId");
string tenantId = Environment.GetEnvironmentVariable("TenantId");
string username = Environment.GetEnvironmentVariable("Username");
string password = Environment.GetEnvironmentVariable("Password");

TokenCredential usernamePasswordCredential = new UsernamePasswordCredential(clientId,tenantId, username,password, null);
var client = new PurviewWorkflowServiceClient(endpoint, usernamePasswordCredential);

Exemples

La section suivante fournit plusieurs extraits de code couvrant certains des scénarios les plus courants, notamment :

Bibliothèque de client de flux de travail Azure Purview pour .NET

Créer un workflow

Guid workflowId = Guid.NewGuid();

string workflow = "{\"name\":\"Create glossary term workflow\",\"description\":\"\",\"triggers\":[{\"type\":\"when_term_creation_is_requested\",\"underGlossaryHierarchy\":\"/glossaries/20031e20-b4df-4a66-a61d-1b0716f3fa48\"}],\"isEnabled\":true,\"actionDag\":{\"actions\":{\"Startandwaitforanapproval\":{\"type\":\"Approval\",\"inputs\":{\"parameters\":{\"approvalType\":\"PendingOnAll\",\"title\":\"ApprovalRequestforCreateGlossaryTerm\",\"assignedTo\":[\"eece94d9-0619-4669-bb8a-d6ecec5220bc\"]}},\"runAfter\":{}},\"Condition\":{\"type\":\"If\",\"expression\":{\"and\":[{\"equals\":[\"@outputs('Startandwaitforanapproval')['body/outcome']\",\"Approved\"]}]},\"actions\":{\"Createglossaryterm\":{\"type\":\"CreateTerm\",\"runAfter\":{}},\"Sendemailnotification\":{\"type\":\"EmailNotification\",\"inputs\":{\"parameters\":{\"emailSubject\":\"GlossaryTermCreate-APPROVED\",\"emailMessage\":\"YourrequestforGlossaryTerm@{triggerBody()['request']['term']['name']}isapproved.\",\"emailRecipients\":[\"@{triggerBody()['request']['requestor']}\"]}},\"runAfter\":{\"Createglossaryterm\":[\"Succeeded\"]}}},\"else\":{\"actions\":{\"Sendrejectemailnotification\":{\"type\":\"EmailNotification\",\"inputs\":{\"parameters\":{\"emailSubject\":\"GlossaryTermCreate-REJECTED\",\"emailMessage\":\"YourrequestforGlossaryTerm@{triggerBody()['request']['term']['name']}isrejected.\",\"emailRecipients\":[\"@{triggerBody()['request']['requestor']}\"]}},\"runAfter\":{}}}},\"runAfter\":{\"Startandwaitforanapproval\":[\"Succeeded\"]}}}}}";

Response createResult = await client.CreateOrReplaceWorkflowAsync(workflowId, RequestContent.Create(workflow));

Envoyer des demandes utilisateur

string request = "{\"operations\":[{\"type\":\"CreateTerm\",\"payload\":{\"glossaryTerm\":{\"name\":\"term\",\"anchor\":{\"glossaryGuid\":\"20031e20-b4df-4a66-a61d-1b0716f3fa48\"},\"status\":\"Approved\",\"nickName\":\"term\"}}}],\"comment\":\"Thanks!\"}";

Response submitResult = await client.SubmitUserRequestsAsync(RequestContent.Create(request));

Approuver la tâche de flux de travail

// This taskId represents an existing workflow task. The id can be obtained by calling GetWorkflowTasksAsync API.
Guid taskId = new Guid("b129fe16-72d3-4994-9135-b997b9be46e0");

string request = "{\"comment\":\"Thanks!\"}";

Response approveResult = await client.ApproveApprovalTaskAsync(taskId, RequestContent.Create(request));

Concepts clés

Dépannage

Étapes suivantes

Ce Kit de développement logiciel (SDK) client expose les opérations à l’aide de méthodes de protocole. Vous pouvez en savoir plus sur l’utilisation des clients sdk qui utilisent des méthodes de protocole dans notre documentation.

Contribution

Consultez la CONTRIBUTING.md pour plus d’informations sur la création, le test et la contribution à cette bibliothèque.

Ce projet accepte les contributions et les suggestions. La plupart des contributions vous demandent d’accepter un contrat de licence de contribution (CLA) déclarant que vous avez le droit de nous accorder, et que vous nous accordez réellement, les droits d’utilisation de votre contribution. Pour plus d’informations, visitez cla.microsoft.com.

Quand vous envoyez une demande de tirage (pull request), un bot CLA détermine automatiquement si vous devez fournir un contrat CLA et agrémenter la demande de tirage de façon appropriée (par exemple, avec une étiquette ou un commentaire). Suivez simplement les instructions fournies par le bot. Vous ne devez effectuer cette opération qu’une seule fois sur tous les dépôts utilisant notre contrat CLA.

Ce projet a adopté le Code de conduite Open Source de Microsoft. Pour plus d’informations, consultez les Questions fréquentes (FAQ) sur le code de conduite ou envoyez vos questions ou vos commentaires à opencode@microsoft.com.

Partager via