.NET 用 Azure Purview Workflow クライアント ライブラリ - バージョン 1.0.0-beta.1
ワークフローは自動化された反復可能なビジネス プロセスであり、ユーザーは Microsoft Purview 内に作成して、データ エンティティに対する CUD (作成、更新、削除) 操作を検証し、調整することができます。 これらのプロセスを有効にすると、組織は変更を追跡し、ポリシー準拠を強制し、データ ランドスケープ全体の品質の高いデータを確保できます。
Purview Workflow のクライアント ライブラリを使用して、次の作業を行います。
- ワークフローの管理
- ユーザー要求を送信し、ワークフローの実行を監視する
- ワークフロー タスクの表示と対応
ワークフローの使用方法の詳細については、サービスのドキュメントを参照してください
作業の開始
パッケージをインストールする
dotnet add package Azure.Analytics.Purview.Workflows --prerelease
前提条件
このパッケージを使用するには、 Azure サブスクリプション と Purview リソース が必要です。
クライアントを認証する
ワークフロー サービスは認証と識別に Azure Active Directory (AAD) ベアラー トークンを使用するため、ワークフローを使用する際に通知できるように、電子メール アドレスをトークンにエンコードする必要があります。 Azure ID ライブラリは UsernamePasswordCredential と共に使用することをお勧めします。 ワークフローで Azure Identity ライブラリを使用する前に、UsernamePasswordCredential に渡される clientId にアプリケーションを登録して使用する必要があります。
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);
例
次のセクションでは、次のような最も一般的なシナリオをカバーするいくつかのコード スニペットを示します。
ワークフローを作成する
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));
ユーザー要求を送信する
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));
ワークフロー タスクを承認する
// 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));
主要な概念
トラブルシューティング
次のステップ
このクライアント SDK はプロトコル メソッドを使用して操作を公開します。 プロトコル メソッドを使用する SDK クライアントの使用方法の詳細については、 ドキュメントを参照してください。
共同作成
このライブラリのビルド、テスト、および投稿の詳細については、 CONTRIBUTING.md を参照してください。
このプロジェクトでは、共同作成と提案を歓迎しています。 ほとんどの共同作成では、共同作成者使用許諾契約書 (CLA) にご同意いただき、ご自身の共同作成内容を使用する権利を Microsoft に供与する権利をお持ちであり、かつ実際に供与することを宣言していただく必要があります。 詳細については、「 cla.microsoft.com」を参照してください。
pull request を送信すると、CLA を提供して PR (ラベル、コメントなど) を適宜装飾する必要があるかどうかを CLA ボットが自動的に決定します。 ボットによって提供される手順にそのまま従ってください。 この操作は、Microsoft の CLA を使用するすべてのリポジトリについて、1 回だけ行う必要があります。
このプロジェクトでは、Microsoft オープン ソースの倫理規定を採用しています。 詳しくは、「Code of Conduct FAQ (倫理規定についてよくある質問)」を参照するか、opencode@microsoft.com 宛てに質問またはコメントをお送りください。