接続の確立

Sync App アプリケーションの接続ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Azure Data Catalog への接続を作成します。Azure Data Catalog アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからAzure Data Catalog コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

Azure Data Catalog への接続

以下をオプションで設定して、Azure Data Catalog から返された異なるカタログデータを読み出すことができます。

CatalogName：Azure Data Catalog に紐づいているカタログ名に設定。空のままにすると、デフォルトのカタログが使用されます。
カタログ名を取得するには、［Azure Portal ホームページ］>［データカタログ］>［カタログ名］に移動します。

Azure Data Catalog への認証

Azure AD

Azure AD は、OAuth を使用して認証する接続タイプです。OAuth では認証するユーザーにインターネットブラウザでAzure Data Catalog との通信を要求します。下記で説明するとおり、Sync App はさまざまな方法でこれをサポートします。 AuthScheme をAzureAD に設定します。すべてのAzure AD フローは、すでに設定済みであることを前提として書かれています。

デスクトップアプリケーション

CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、カスタムOAuth アプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、カスタムAzureAD アプリの作成を参照してください。

認証に関する2つの方法の違いは、カスタムOAuth アプリケーションを使用する場合に、2つの接続プロパティを追加で設定する必要があることだけです。

次の接続プロパティを設定して、接続してください。

OAuthClientId：（カスタムアプリケーションのみ）アプリケーション設定のクライアントId に設定。
OAuthClientSecret：（カスタムアプリケーションのみ）アプリケーション設定のクライアントシークレットに設定。
CallbackURL：アプリケーション設定のリダイレクトURL に設定。

接続すると、Sync App はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

Web アプリケーション

Web アプリケーション経由で接続する場合は、 Azure Data Catalog にカスタムOAuth アプリを登録する必要があります。カスタムAzureAD アプリの作成を参照してください。それからSync App を使用してOAuth トークンの値を取得および管理します。 OAuth アクセストークンの取得

認証タイプに応じて以下のいずれかの接続プロパティグループを設定して、OAuthAccessToken を取得します。

クライアントシークレットを使用した認証
- OAuthClientId：アプリ設定のクライアントId に設定。
- OAuthClientSecret：アプリ設定のクライアントシークレットに設定。
証明書を使用した認証
- OAuthClientId：アプリ設定のクライアントId に設定。
- OAuthJWTCert：JWT 証明書ストアを設定。
- OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL インプットをアプリケーション設定で指定したリダイレクトURI に設定します。必要に応じて、Permissions パラメータを設定してカスタム権限をリクエストします。

ストアドプロシージャがOAuth エンドポイントのURL を返します。
URL を開き、ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"code" パラメータに設定します。必要に応じて、Permissions パラメータを設定してカスタム権限をリクエストします。

OAuthAccessToken 接続プロパティをストアドプロシージャで返されたアクセストークンに設定し、データに接続します。ExpiresIn 秒後に、アクセストークンの期限が切れたときは、GetOAuthAccessToken を呼び出し、新しいアクセストークンを取得します。

管理者の同意

管理者の同意とは、Azure Active Directory テナントの管理者が、管理者の同意を必要とするアプリケーションに権限を付与することを指します。 CData Sync App 内の埋め込みアプリには、管理者の同意を必要とするアクセス許可はありません。したがって、この情報はカスタムアプリケーションにのみ適用されます。

管理者の同意の付与

Azure ポータルで新しいAzureAD アプリを作成する場合には、アプリに必要なアクセス許可を指定する必要があります。一部のアクセス許可には、「管理者の同意が必要」と記載されている場合があります。例えば、すべてのグループのアクセス許可には管理者の同意が必要です。アプリに管理者の同意が必要な場合、いくつかの方法があります。

管理者の同意を付与する最も簡単な方法は、管理者がportal.azure.com にログインして、［アプリの登録］で作成したアプリに移動するだけです。API のアクセス許可で、 同意の付与をクリックして、アプリが作成されたテナントでアクセス権限を持つようにします。

組織に複数のテナントがある場合、または組織外の他のテナントにアプリのアクセス許可を与える必要がある場合、GetAdminConsentURL ストアドプロシージャを使用してAdmin Authorization URL を生成します。GetOAuthAuthorizationURL とは異なり、このエンドポイントから返される重要な情報はありません。OAuth アプリケーションが正常に認可されると、アクセス権限が付与されたことを示すBoolean 値が返されます。

管理者がOAuth アプリケーションを承認後、認証を続行できます。

クライアントクレデンシャル

クライアント資格情報は、直接ユーザー認証が行われないOAuth のフローを指します。代わりに、資格情報はアプリ自体のためだけに作成されます。アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。そのため、認証フローが標準とは少し違ったものになります。

クライアントOAuth フロー

クライアントOAuth フローに関連するすべての権限には、管理者の同意が必要です。これは、CData Sync App が埋め込まれたアプリをクライアントOAuth フローでは使用できないことを意味します。クライアント資格情報を使用するには、独自のOAuth アプリの作成が必要になります。詳しくは、カスタムAzureAD アプリの作成を参照してください。

portal.azure.com の［アプリの登録］で［API のアクセス許可］に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には、委任されたアクセス許可とアプリケーションの許可の2つの異なるアクセス許可セットがあります。クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。インテグレーションに必要なアクセス許可を選択します。

認証タイプに応じていずれかの接続プロパティグループを設定すると、接続できるようになります。

クライアントシークレットを使用した認証
- InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
- AzureTenant：接続するテナントに設定。
- OAuthGrantType：CLIENT に設定。
- OAuthClientId：アプリ設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
証明書を使用した認証
- InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
- AzureTenant：接続するテナントに設定。
- OAuthGrantType：CLIENT に設定。
- OAuthClientId：アプリ設定のクライアントId に設定。
- OAuthJWTCert：JWT 証明書ストアを設定。
- OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。

Azure サービスプリンシパル

Azure サービスプリンシパルは、OAuth を経由する接続タイプです。AuthScheme をAzureServicePrincipal に設定します。 Azure サービスプリンシパルとしての認証は、OAuth クライアントクレデンシャルフローを介して処理され、直接のユーザー認証は行われません。代わりに、クレデンシャルはアプリ自体のためだけに作成されます。アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

Note： ロールを割り当てる前に、カスタムアプリケーションを作成する必要があります。詳しくは、カスタムAzureAD アプリの作成を参照してください。

Azure サービスプリンシパルを使用して認証する場合、Azure AD テナントにアプリケーションを登録する必要があります。以下の手順に従って、ロールベースのアクセス制御で使用できる新しいサービスプリンシパルを作成します。

アプリケーションへのロールの割り当て

サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。

検索バーでサブスクリプションサービスを検索・選択して、［サブスクリプション］ページを開きます。
アプリケーションを割り当てる特定のサブスクリプションを選択します。
［アクセス制御 (IAM)］を開き、［追加］->［ロール割り当ての追加］を選択して［ロール割り当ての追加］ページを開きます。
作成したAzure AD アプリに割り当てるロールとして、［所有者］を選択します。

認証の完了

設定されたアプリ認証（クライアントシークレットまたは証明書）に応じて、以下のいずれかの接続プロパティグループを設定すると、接続できるようになります。

両メソッド共通

クライアントシークレットか証明書認証を選択する前に、まず以下の手順に従って設定を行います。その後、該当するセクションの設定に進んでください。

AuthScheme：アプリ設定のAzureServicePrincipal に設定。
InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使えば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
AzureTenant：接続するテナントに設定。
OAuthClientId：アプリ設定のクライアントId に設定。

クライアントシークレットを使用した認証

続いて、以下を設定します。

OAuthClientId：アプリ設定のクライアントId に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。

証明書を使用した認証

続いて、以下を設定します。

OAuthJWTCert：JWT 証明書ストアを設定。
OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

MSI

Azure VM 上でAzure Data Catalog を実行している場合は、Managed Service Identity（MSI）の資格情報を利用して接続が可能です。

AuthScheme：AzureMSI に設定。

MSI 資格情報が認証用に自動的に取得されます。

高度な機能

このセクションでは、Azure Data Catalog Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Azure Data Catalog にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングでは、次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、より洗練されたロギングをサポートする多数の機能があります。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Azure Data Catalog API へのSQL の実行について詳しく説明します。

主要機能

Sync App はカスタムデータソース、データ資産、およびデータ資産注釈などのAzure Data Catalog エンティティをリレーショナルビューとしてモデル化し、SQL を記述してAzure Data Catalog データをクエリできるようにします。
これらのオブジェクトへのライブ接続により、Sync App を使用するとAzure Data Catalog アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビューでは、利用可能なビューを説明します。ビューは、カスタムデータソース、データ資産、データ資産注釈などを静的にモデル化するように定義されています。

ビュー

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Azure Data Catalog Connector for CData Sync ビュー


Name	Description
ColumnDataProfiles	Get list of column data profiles.
CustomDataSourceProperties	Get Identity properties of Custom Data Sources.
CustomDataSources	Retrieves list of custom data sources, which are registered with the catalog.
Databases	Get list of databases.
Descriptions	Get list of descriptions of databases, tables, and objects.
Experts	Get list of experts of databases, tables, and objects.
Objects	Get list datasource properties.
TableColumns	Get details of table schema.
TableDataProfiles	Get list of table data profiles.
Tables	Get list of tables in the data asset.
Tags	Get list of tags of databases, tables, and objects.

ColumnDataProfiles

Get list of column data profiles.

Table Specific Information

Select

The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ItemId is required in order to query ColumnDataProfiles.

ItemId supports the '=' operator.

For example:

    SELECT * FROM ColumnDataProfiles WHERE ItemId = '8a2b7305-b474-45d6-9fba-562454045070'

Columns


Name	Type	Description
ItemId [KEY]	String	Item Id of a view or table.
ColumnName	String	The name of the column.
Type	String	The type of the column.
Min	String	The minimum value in the data set.
Max	String	The maximum value in the data set.
Avg	Decimal	The average value in the data set.
Stdev	Double	The standard deviation for the data set.
NullCount	Integer	The count of null values in the data set.
DistinctCount	Integer	The count of distinct values in the data set.

CustomDataSourceProperties

Get Identity properties of Custom Data Sources.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the Sync App.

Columns


Name	Type	Description
Namespace	String	Qualified name of the custom data source protocol.
Name	String	Name of the custom data source property.
Type	String	Data type of the custom data source property.

CustomDataSources

Retrieves list of custom data sources, which are registered with the catalog.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the Sync App.

Columns


Name	Type	Description
Id	String	Id of a custom data source.
Name	String	Name of a custom data source.
Namespace	String	Qualified name of the custom data source protocol.
Timestamp	Datetime	It contains the date and time at which an event occurred.
IdentitySets	String	Property of identity sets.

Databases

Get list of databases.

Table Specific Information

Select

The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

Name supports the '=, !=, <>, CONTAINS' operators.
Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
LastRegisteredTime supports the '=, CONTAINS' operators.
ObjectType supports the '=' operator.
SourceType supports the '=' operator.
FriendlyName supports the '=, CONTAINS' operators.
Experts supports the '=, CONTAINS' operators.
Description supports the '=, CONTAINS' operators.
Tags supports the '=, !=, <>, CONTAINS' operators.
HasTags supports the '=' operator.
HasPreviews supports the '=' operator.
HasDocumentation supports the '=' operator.
HasTableDataProfiles supports the '=' operator.
HasColumnsDataProfiles supports the '=' operator.
HasDescription supports the '=' operator.
View supports the '=' operator.
Facets supports the '=' operator.

For example:

    SELECT * FROM Databases WHERE HasDocumentation=false AND HasDescription = false AND HasTags = true;

    SELECT * FROM Databases WHERE Timestamp > '2019-09-19T04:39:54.0083651Z'

    SELECT * FROM Databases WHERE Tags = 'sales' OR Name = 'FactProductInventory'

Columns


Name	Type	Description
Id	String	Id of a database.
Type	String	Type of database.
EffectiveRights	String	Rights a particular annotation has.
Roles	String	Roles of a database.
RoleMembers	String	Members whom roles was assigned.
Timestamp	Datetime	Created time of database.
Name	String	Name of a property.
ObjectType	String	Type of object. Eg. table, etc.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
DslAddressDatabase	String	DSL address of a database.
DslAuthentication	String	Type of authentication used.
DslProtocol	String	Describes a protocol used to communicate with the data source.
FromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
LastRegisteredByObjectId	String	Object Id of a last registered user.
LastRegisteredByUpn	String	Upn of last registered user.
AccessInstructionsId	String	Id of an access instructions.
AccessInstructionsType	String	Type of an access instructions.
AccessInstructionsEffectiveRights	String	Effective rights of a particular access instructions.
AccessInstructionsMimeType	String	Mime type of access instructions.
AccessInstructionsContent	String	Content of an access instructions.
AccessInstructionsFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
AccessInstructionsRoles	String	Roles of Database.
AccessInstructionsRoleMembers	String	Members whom roles was assigned.
AccessInstructionsTimestamp	Datetime	Created time of access instructions.
DocumentationType	String	Type of documentation.
DocumentationId	String	Id of a documentation.
DocumentationEffectiveRights	String	Rights a particular documentation has.
DocumentationMimeType	String	Mime type a documentation.
DocumentationContent	String	Content of a documentation.
DocumentationFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
DocumentationRoles	String	Roles of a documentation.
DocumentationRoleMembers	String	Members whom roles was assigned.
DocumentationTimestamp	Datetime	Created time of other:mirror=
FriendlyName	String	Name of a friendly name.
FriendlyNameId	String	Id of a friendly name.
FriendlyNameType	String	Type of friendly name.
FriendlyNameEffectiveRights	String	Rights a particular friendly name has.
FriendlyNameFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
FriendlyNameRoles	String	Roles of friendly name.
FriendlyNameRoleMembers	String	Members whom roles was assigned.
FriendlyNameTimestamp	Datetime	Created time of friendly name.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Description of databases.
Tags	String	Tags available in databases.
Facets	String	A comma separated field names to facet the results on.
View	String	Name of the view the client wants to see.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain a preview.
HasDocumentation	Boolean	Check items that contain documentation.
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
LastRegisteredTime	Date	Date and time when the metadata was registered.

Descriptions

Get list of descriptions of databases, tables, and objects.

Table Specific Information

Select

The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

Name supports the '=, !=, <>, CONTAINS' operators.
Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
LastRegisteredTime supports the '=, CONTAINS' operators.
ObjectType supports the '=' operator.
SourceType supports the '=' operator.
FriendlyName supports the '=, CONTAINS' operators.
Experts supports the '=, CONTAINS' operators.
Description supports the '=, CONTAINS' operators.
Tags supports the '=, !=, <>, CONTAINS' operators.
HasTags supports the '=' operator.
HasPreviews supports the '=' operator.
HasDocumentation supports the '=' operator.
HasTableDataProfiles supports the '=' operator.
HasColumnsDataProfiles supports the '=' operator.
HasDescription supports the '=' operator.
View supports the '=' operator.
Facets supports the '=' operator.

For example:

    SELECT * FROM Descriptions WHERE CONTAINS(Description,'sakila') AND ObjectType = table;

    SELECT * FROM Descriptions WHERE CONTAINS(Name,'customer') AND HasTags = true;

Columns


Name	Type	Description
Id	String	Id of a description.
Type	String	Type of description.
EffectiveRights	String	Rights a particular annotation has.
PropertyDescription	String	Content in description.
PropertyFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
PropertyKey	String	Key of a description.
Roles	String	Roles of a description.
RoleMembers	String	Members whom roles was assigned.
Timestamp	Datetime	Created time of description.
Name	String	Name of a table, database, object.
ObjectType	String	Type of object. Eg. table, etc.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
FriendlyName	String	Check items where the search term appears in the data source friendly name.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Content of a description.
Tags	String	Tags available in descriptions.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain preview
HasDocumentation	Boolean	Check items that contain documentation.
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.
View	String	Name of the view the client wants to see.
Facets	String	A comma separated field names to facet the results on.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
LastRegisteredTime	Date	Date and time when the metadata was registered.

Experts

Get list of experts of databases, tables, and objects.

Table Specific Information

Select

The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

Name supports the '=, !=, <>, CONTAINS' operators.
Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
LastRegisteredTime supports the '=, CONTAINS' operators.
ObjectType supports the '=' operator.
SourceType supports the '=' operator.
FriendlyName supports the '=, CONTAINS' operators.
Experts supports the '=, CONTAINS' operators.
Description supports the '=, CONTAINS' operators.
Tags supports the '=, !=, <>, CONTAINS' operators.
HasTags supports the '=' operator.
HasPreviews supports the '=' operator.
HasDocumentation supports the '=' operator.
HasTableDataProfiles supports the '=' operator.
HasColumnsDataProfiles supports the '=' operator.
HasDescription supports the '=' operator.
View supports the '=' operator.
Facets supports the '=' operator.

For example:

    SELECT * FROM Experts WHERE ObjectType = 'table' AND CONTAINS(Experts,'support')

    SELECT * FROM Experts WHERE Tags = 'orders' OR Name = 'orders' AND ObjectType = 'table';

Columns


Name	Type	Description
Id	String	Id of an expert.
Type	String	Type of expert.
EffectiveRights	String	Rights a particular annotation has.
FromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
Key	String	Key of an expert.
ExpertObjectId	String	Object Id of an expert.
ExpertUPN	String	User Principal Name of an expert.
Roles	String	Roles of an expert.
RoleMembers	String	Members whom roles was assigned.
Timestamp	Datetime	Created time of experts.
Name	String	Name of a table, database, object.
ObjectType	String	Type of object. Eg. table, etc.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
FriendlyName	String	Check items where the search term appears in the data source friendly name.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Description of an expert.
Tags	String	Tags available for experts.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain a preview.
HasDocumentation	Boolean	Check items that contain documentation.
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.
View	String	Name of the view the client wants to see.
Facets	String	A comma separated field names to facet the results on.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
LastRegisteredTime	Date	Date and time when the metadata was registered.

Objects

Get list datasource properties.

Table Specific Information

Select

The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

Name supports the '=, !=, <>, CONTAINS' operators.
Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
LastRegisteredTime supports the '=, CONTAINS' operators.
ObjectType supports the '=' operator.
SourceType supports the '=' operator.
FriendlyName supports the '=, CONTAINS' operators.
Experts supports the '=, CONTAINS' operators.
Description supports the '=, CONTAINS' operators.
Tags supports the '=, !=, <>, CONTAINS' operators.
HasTags supports the '=' operator.
HasPreviews supports the '=' operator.
HasDocumentation supports the '=' operator.
HasTableDataProfiles supports the '=' operator.
HasColumnsDataProfiles supports the '=' operator.
HasDescription supports the '=' operator.
View supports the '=' operator.
Facets supports the '=' operator.

For example:

    SELECT * FROM Objects WHERE Tags <> 'sales';

    SELECT * FROM Objects WHERE Name = 'sales' AND HasTags = true;

    SELECT * FROM Objects WHERE CONTAINS(Tags,'sales') AND CONTAINS(Tags,'customer');

Columns


Name	Type	Description
Id	String	Id of an Object.
Type	String	Type of an Object.
EffectiveRights	String	Rights a particular annotation has.
Name	String	Name of an Object.
ObjectType	String	Type of object. Eg. table, etc.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
DslAuthentication	String	Type of authentication used.
DslProtocol	String	Describes a protocol used to communicate with the data source.
FromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
LastRegisteredByObjectId	String	Object Id of a user.
LastRegisteredByUpn	String	User Principal Name of a user.
Roles	String	Roles of Database.
RoleMembers	String	Members whom roles was assigned.
Timestamp	Datetime	Created time of an Object.
AccessInstructionsId	String	Id of access instructions.
AccessInstructionsType	String	Type of access instructions.
AccessInstructionsEffectiveRights	String	Rights a particular annotation has.
AccessInstructionsMimeType	String	Mime type of a documentation.
AccessInstructionsContent	String	Content of a documentation.
AccessInstructionsFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
AccessInstructionsRoles	String	Roles of an object.
AccessInstructionsRoleMembers	String	Members whom roles was assigned.
AccessInstructionsTimestamp	Datetime	Created time of an object.
FriendlyName	String	Check items where the search term appears in the data source friendly name.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Description of objects.
Tags	String	Tags available for objects.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain a preview.
HasDocumentation	Boolean	Check items that contain documentation.
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.
View	String	Name of the view the client wants to see.
Facets	String	A comma separated field names to facet the results on.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
LastRegisteredTime	String	Date and time when the metadata was registered.

TableColumns

Get details of table schema.

Table Specific Information

Select

The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

ItemId supports the '=' operator.

For example:

    SELECT * FROM TableColumns WHERE ItemId = '8a2b7305-b474-45d6-9fba-57e954565070'

Columns


Name	Type	Description
Database	String	Name of the database.
TableName	String	Name of the table.
ColumnName	String	Name of the column or attribute.
Type	String	Data type of the column or attribute. The Allowable types depend on data sourceType of the asset.
MaxLength	Integer	The maximum length allowed for the column or attribute. Derived from data source.
Precision	Integer	The precision for the column or attribute. Derived from data source.
IsNullable	Boolean	Whether the column is allowed to have a null value or not. Derived from data source.
Expression	String	If the value is a calculated column, this field contains the expression that expresses the value. Derived from data source.
ItemId	String	Item Id of a view or table.

TableDataProfiles

Get list of table data profiles.

Table Specific Information

Select

The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

Name supports the '=, !=, <>, CONTAINS' operators.
Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
LastRegisteredTime supports the '=, CONTAINS' operators.
ObjectType supports the '=' operator.
SourceType supports the '=' operator.
FriendlyName supports the '=, CONTAINS' operators.
Experts supports the '=, CONTAINS' operators.
Description supports the '=, CONTAINS' operators.
Tags supports the '=, !=, <>, CONTAINS' operators.
HasTags supports the '=' operator.
HasPreviews supports the '=' operator.
HasDocumentation supports the '=' operator.
HasTableDataProfiles supports the '=' operator.
HasColumnsDataProfiles supports the '=' operator.
HasDescription supports the '=' operator.
View supports the '=' operator.
Facets supports the '=' operator.

For example:

    SELECT * FROM TableDataProfiles WHERE NOT Tags = 'FactProductInventory'

    SELECT * FROM TableDataProfiles WHERE Timestamp > '2019-09-20T04:39:54.0083651Z';

Columns


Name	Type	Description
Id	String	Id of a table data profile.
Type	String	Type of table data profile.
EffectiveRights	String	Rights a particular table data profile has.
Tag	String	Name of the tag.
FromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
Key	String	Key of a table data profiles.
Roles	String	Roles of table data profiles.
RoleMembers	String	Members whom roles was assigned.
Timestamp	Datetime	Created time of table data profiles.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
FriendlyName	String	Check items where the search term appears in the data source friendly name.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Description of table data profiles.
Tags	String	Tags available in table data profiles.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain preview
HasDocumentation	Boolean	Check items that contain documentation
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.
View	String	Name of the view the client wants to see.
Facets	String	A comma separated field names to facet the results on.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
LastRegisteredTime	Date	Date and time when the metadata was registered

Tables

Get list of tables in the data asset.

Table Specific Information

Select

The Sync App will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

Name supports the '=, !=, <>, CONTAINS' operators.
Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
LastRegisteredTime supports the '=, CONTAINS' operators.
ObjectType supports the '=' operator.
SourceType supports the '=' operator.
FriendlyName supports the '=, CONTAINS' operators.
Experts supports the '=, CONTAINS' operators.
Description supports the '=, CONTAINS' operators.
Tags supports the '=, !=, <>, CONTAINS' operators.
HasTags supports the '=' operator.
HasPreviews supports the '=' operator.
HasDocumentation supports the '=' operator.
HasTableDataProfiles supports the '=' operator.
HasColumnsDataProfiles supports the '=' operator.
HasDescription supports the '=' operator.
View supports the '=' operator.
Facets supports the '=' operator.

For example:

    SELECT * FROM Tables WHERE Tags = 'sales' OR Name = 'FactProductInventory';

    SELECT * FROM Tables WHERE Tags != 'FactProductInventory' AND NOT Tags = 'sales';

    SELECT * FROM Tables WHERE NOT Tags = 'FactProductInventory';

Columns


Name	Type	Description
Id	String	Id of a table.
Type	String	Type of table.
EffectiveRights	String	Rights a particular annotation has.
Roles	String	Roles of a table.
RoleMembers	String	Members to whom the role was assigned.
Timestamp	Datetime	Created time of table.
ItemId	String	Item Id of the table or view.
Name	String	Name of a table.
ContainerId	String	Id of a container.
ObjectType	String	Type of object. Eg. table, etc.
SourceType	String	Source type. Eg. Jdbc, Odbc, etc.
DslAddressDatabase	String	Name of the database.
DslAddressObject	String	Object of a table.
DslAddressOptionsDriver	String	Name of the driver.
DslAddressOptionsPort	String	Port number.
DslAddressOptionsServer	String	IP address of the server.
DslAuthentication	String	Type of authentication used.
DslProtocol	String	Describes a protocol used to communicate with the data source.
FromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
LastRegisteredByFirstName	String	First name of the registered user.
LastRegisteredByLastName	String	Last name of the registered user.
LastRegisteredByObjectId	String	Object Id of a user.
LastRegisteredByUpn	String	User Principal Name of a user.
AccessInstructionsId	String	Id of access instructions.
AccessInstructionsType	String	Type of access instructions.
AccessInstructionsEffectiveRights	String	Rights a particular annotation has.
AccessInstructionsMimeType	String	Mime type of access instructions.
AccessInstructionsContent	String	Content described in access instructions.
AccessInstructionsFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
AccessInstructionsRoles	String	Roles of table.
AccessInstructionsRoleMembers	String	Members to whom the role was assigned.
AccessInstructionsTimestamp	Datetime	Created time of table.
SchemaId	String	Id of a schema.
SchemaType	String	Type of schema.
SchemaEffectiveRights	String	Rights a particular annotation has.
SchemaFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
SchemaRoles	String	Roles of an schema for table.
SchemaRoleMembers	String	Members whom roles was assigned.
SchemaTimestamp	Datetime	Created time of an schema for table.
DocumentationId	String	Id of a documentation.
DocumentationType	String	Type of documentation.
DocumentationEffectiveRights	String	Rights a particular documentation has.
DocumentationMimeType	String	Mime type of a documentation.
DocumentationContent	String	Content of a documentation.
DocumentationFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
DocumentationRoles	String	Roles of an documentation for table.
DocumentationRoleMembers	String	Members whom roles was assigned.
DocumentationTimestamp	Datetime	Created time of an documentation for table.
FriendlyName	String	Name of a friendly name.
FriendlyNameId	String	Id of a friendly name.
FriendlyNameType	String	Type of friendly name.
FriendlyNameEffectiveRights	String	Rights a particular annotation has.
FriendlyNameFromSourceSystem	Boolean	Indicates whether data of an item is derived from a source system or authored by a user.
FriendlyNameRoles	String	Roles of an friendly name for table.
FriendlyNameRoleMembers	String	Members whom roles was assigned.
FriendlyNameTimestamp	Datetime	Created time of an friendly name for table.
Experts	String	Check items where the data source expert matches the search term.
Description	String	Description of table.
Tags	String	Tags available in tables.
HasTags	Boolean	Check items that have a tag.
HasPreviews	Boolean	Check items that contain preview.
HasDocumentation	Boolean	Check items that contain documentation.
HasTableDataProfiles	Boolean	Check items that have a table profile.
HasColumnsDataProfiles	Boolean	Check items that have a columns data profile.
HasDescription	Boolean	Check items that have a description.
View	String	Name of the view the client wants to see.
Facets	String	A comma separated field names to facet the results on.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
LastRegisteredTime	Date	Date and time when the metadata was registered.

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

プロパティ	説明
AuthScheme	Azure Data Catalog に接続する際に使用する認証の種類。
CatalogName	The name of the catalog to connect to.

Azure Authentication

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment	接続を確立するときに使用するAzure 環境。

OAuth

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

JWT OAuth

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Azure Data Catalog から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
AuthScheme	Azure Data Catalog に接続する際に使用する認証の種類。
CatalogName	The name of the catalog to connect to.

AuthScheme

Azure Data Catalog に接続する際に使用する認証の種類。

解説

AzureAD:Azure Active Directory OAuth 認証を実行する場合に設定。
AzureMSI：Azure VM で実行しているときにマネージドサービスID のクレデンシャルを自動的に取得する場合に設定。
AzureServicePrincipal：Set this to authenticate as an Azure Service Principal.

CatalogName

The name of the catalog to connect to.

解説

If left blank, the default catalog will be used. To obtain a given CatalogName, navigate to the Azure Portal home page -> Data Catalog -> Catalog Name.

Azure Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment	接続を確立するときに使用するAzure 環境。

AzureTenant

データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

解説

データにアクセスするために使用されるMicrosoft Online テナント。例えば、contoso.onmicrosoft.com です。あるいは、テナントId を指定します。この値は［Azure ポータル］->［Azure Active Directory］->［プロパティ］のディレクトリId です。

通常、Tenant を指定する必要はありません。OAuthGrantType をCODE（デフォルト）に設定している場合は、Microsoft が自動的に決定します。ただし、ユーザーがマルチテナントに所属している場合は失敗する可能性があります。例えば、ドメインA の管理者がドメインB のユーザーをゲストユーザーとして招待した場合。ユーザーは両方のテナントに属していることになります。 Tenant を指定するのはグッドプラクティスですが、一般的には指定しなくてもうまく動作するはずです。

OAuthGrantType をCLIENT に設定する場合は、AzureTenant が必須です。クライアント資格情報を使用する場合、ユーザーコンテキストはありません。資格情報は、アプリ自体のコンテキストから取得されます。Microsoft ではTenant を指定せずにクライアント資格情報を取得することを許容していますが、使用する特定のテナントを選択する可能性ははるかに低くなっています。このため、接続するドメインに適用される資格情報を確実に取得するために、すべてのクライアント資格情報接続に対してAzureTenant を明示的に指定する必要があります。

AzureEnvironment

接続を確立するときに使用するAzure 環境。

解説

ほとんどの場合、環境をグローバルに設定したままにしておくとうまく機能します。ただし、 Azure アカウントが別の環境に追加されている場合は、AzureEnvironment を使用してどの環境かを指定できます。利用可能な値はGLOBAL、CHINA、USGOVT、USGOVTDOD です。

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

OAuthClientId

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuthClientSecret

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

JWT OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

OAuthJWTCert

JWT 証明書のストア。

解説

クライアント証明書のための証明書ストア名。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。詳しくは、OAuthJWTCertSubject フィールドを参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。


MY	個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA	証明機関の証明書。
ROOT	ルート証明書。
SPC	ソフトウェア発行元証明書。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

OAuthJWTCertType

JWT 証明書を格納するキーストアの種類。

解説

このプロパティには次の値の一つを設定できます。


USER	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note：この種類はJava では利用できません。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note：この種類はJava では利用できません。
PFXFILE	この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。
PFXBLOB	この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILE	この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。 Note：この種類はJava のみで利用できます。
JKSBLOB	この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note：この種類はJava のみで利用できます。
PEMKEY_FILE	この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOB	この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILE	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOB	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILE	この証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOB	この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILE	この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILE	この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。
XMLFILE	この証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOB	この証明書ストアは、XML 形式の証明書を含む文字列の名前です。

OAuthJWTCertPassword

OAuth JWT 証明書のパスワード。

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

OAuthJWTCertSubject

OAuth JWT 証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。


フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	Eメールアドレス

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

OAuthJWTIssuer

Java Web Token の発行者。

解説

Java Web Token の発行者。通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。

OAuthJWTSubject

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSLServerCert

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。


タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はAzure Data Catalog への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

BASIC： Sync App はHTTP BASIC 認証を行います。
DIGEST： Sync App はHTTP DIGEST 認証を行います。
NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。


AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

LogModules

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログページを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\AzureDataCatalog Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、パフォーマンスが向上します。

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Azure Data Catalog から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

MaxRows

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Pagesize

Azure Data Catalog から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、Azure Data Catalog から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

各ルートエレメントはビューの名前を定義します。
各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Tables WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"