.NET 用 Azure Purview 管理クライアント ライブラリ - バージョン 1.0.0-beta.1

Azure Purview 管理には、Purview アカウントと Purview MetdataPolicy マネージド クラウド サービスが含まれています。

このライブラリを使用するには、 サービスのドキュメント と プロトコル クライアント ドキュメント に大きく依存してください

ソースコード | パッケージ (NuGet) | 製品ドキュメント

作業の開始

パッケージをインストールする

NuGet を使用して .NET 用 Azure Purview 管理クライアント ライブラリをインストールします。

dotnet add package Azure.Analysis.Purview.Administration

前提条件

• このパッケージを使用するには、 Azure サブスクリプション と Purview リソース が必要です。

クライアントを認証する

Azure Active Directory の使用

このドキュメントでは、 DefaultAzureCredential を使用して Azure Active Directory 経由で認証する方法について説明します。 ただし、 Azure.Identity によって提供される資格情報はすべて受け入れられます。 その他の資格情報の詳細については、 Azure.Identity のドキュメントを参照してください。

資格情報を選択して構成したら、 または PurviewMetadataRolesClientのインスタンスをPurviewAccountClientPurviewMetadataPolicyClient作成できます。

var credential = new DefaultAzureCredential();
var accountClient = new PurviewAccountClient(new Url("https://<my-account-name>.purview.azure.com"), credential);
var policyClient = new PurviewMetadataPolicyClient(new Url("https://<my-account-name>.purview.azure.com"), "myCollection", credential);
var roleClient = new PurviewMetadataRolesClient(new Url("https://<my-account-name>.purview.azure.com"), credential);

主要な概念

プロトコル メソッド

Purview Account SDK for .NET によって公開される操作は 、プロトコル メソッドを 使用して、基になる REST 操作を公開します。 プロトコルメソッドを使用する SDK クライアントの使用方法の詳細については、 こちらのドキュメントを参照してください。

スレッド セーフ

すべてのクライアント インスタンス メソッドがスレッド セーフであり、相互に独立していることを保証します (ガイドライン)。 これにより、クライアント インスタンスの再利用に関する推奨事項は、スレッド間でも常に安全になります。

その他の概念

クライアント オプション | 応答 | へのアクセス実行時間の長い操作 | エラーの | 処理診断 | あざける | クライアントの有効期間

例

次のセクションでは、クライアントを初期化して認証し、カタログ内のすべての型定義を取得する方法を示します。

すべてのアカウントの種類の定義を取得する

var credential = new DefaultAzureCredential();
var client = new PurviewAccountClient(new Uri("https://<my-account-name>.purview.azure.com"), credential);

var Response response = await client.GetAccountPropertiesAsync();
var responseDocument = JsonDocument.Parse(response.Content);
Console.WriteLine(responseDocument.RootElement.GetProperty("name"));

すべてのロールを一覧表示する

var credential = new DefaultAzureCredential();
var client = new PurviewMetadataRolesClient(new Uri("https://<my-account-name>.purview.azure.com"), credential);

AsyncPageable<BinaryData> fetchResponse = client.GetMetadataRolesAsync(new());
await foreach (BinaryData item in fetchResponse)
{
    JsonElement fetchBodyJson = JsonDocument.Parse(item).RootElement;
    Console.WriteLine(fetchBodyJson.GetProperty("id"));
}

トラブルシューティング

コンソール ログの設定

ログを表示する最も簡単な方法は、コンソール ログを有効にすることです。 コンソールにメッセージを出力する Azure SDK ログ リスナーを作成するには、AzureEventSourceListener.CreateConsoleLogger メソッドを使用します。

// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();

その他のログメカニズムの詳細については、 こちらを参照してください。

次のステップ

このクライアント 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 宛てに質問またはコメントをお送りください。