接続の確立

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

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

Azure Active Directory への認証

Azure AD

Azure AD は、OAuth を使用して認証する接続タイプです。OAuth では認証するユーザーにインターネットブラウザでAzure Active Directory との通信を要求します。下記で説明するとおり、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 Active Directory にカスタム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 Active Directory を実行している場合は、Managed Service Identity（MSI）の資格情報を利用して接続が可能です。

AuthScheme：AzureMSI に設定。

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

高度な機能

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

Sync App は、Azure Active Directory にできるだけ多くの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 Active Directory API へのSQL の実行について詳しく説明します。

主要機能

Sync App はデバイス登録所有者やロールの割り当てなどのAzure Active Directory エンティティをリレーショナルビューとしてモデル化し、またグループをリレーショナルテーブルとしてモデル化して、SQL を記述してAzure Active Directory データをクエリできるようにします。
ストアドプロシージャを使用すると、アクセストークンの取得やOAuth 2.0でのリフレッシュの維持など、Azure Active Directory の操作を実行できます。
これらのオブジェクトへのライブ接続により、Sync App を使用するとAzure Active Directory アカウントへのあらゆる変更が即座に反映されます。

ビュー

Views は、AdministrativeUnitMembers、AdministrativeUnits、およびContacts などのエンティティを静的にモデル化するように定義されています。

ストアドプロシージャ

Stored Procedures は、Azure Active Directory のファンクションライクなインターフェースです。これらを使用して、Azure Active Directory 内の情報を変更できます。

Tables

Sync App はAzure Active Directory のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。

一般的には、Azure Active Directory テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。

Azure Active Directory Connector for CData Sync Tables


Name	Description
Applications	Retrieves all applications for the authenticated user.
Devices	Retrieves all Devices for the authenticated user.
Domains	Retrieves all Domains for the authenticated user.
Groups	Retrieves all Azure Active Directory (Azure AD) groups, which can be Office 365 groups, or security groups.
Users	Retrieves all Azure AD user accounts within the authenticated permissions.

Applications

Retrieves all applications for the authenticated user.

Table Specific Information

Select

You can query Applications by specifying an Id or selecting all:

SELECT * FROM Applications WHERE Id = '037c5534-1059-4c71-9f1c-a9b887e34b03'

Select a certain column from the entity and filter by that column:

SELECT Id FROM Applications WHERE Id LIKE '%037c5534-1059-4c71-9f1c-a9b887e34b03%'

Update

To update a Applications record you need to specify the Id in WHERE clause.

UPDATE Applications SET displayName = 'Test' WHERE Id = '037c5534-1059-4c71-9f1c-a9b887e34b03'

Columns


Name	Type	ReadOnly	Description
id [KEY]	String	False	The id of the application.
addIns	String	False	The addIns of the application.
api_acceptMappedClaims	Bool	False	The api_acceptMappedClaims of the application.
api_knownClientApplications	String	False	The api_knownClientApplications of the application.
api_oauth2PermissionScopes	String	False	The api_oauth2PermissionScopes of the application.
api_preAuthorizedApplications	String	False	The api_preAuthorizedApplications of the application.
api_requestedAccessTokenVersion	Int	False	The api_requestedAccessTokenVersion of the application.
appId	String	False	The appId of the application.
applicationTemplateId	String	False	The applicationTemplateId of the application.
appRoles	String	False	The appRoles of the application.
certification_certificationDetailsUrl	String	False	The certification_certificationDetailsUrl of the application.
certification_certificationExpirationDateTime	Datetime	False	The certification_certificationExpirationDateTime of the application.
certification_isCertifiedByMicrosoft	Bool	False	The certification_isCertifiedByMicrosoft of the application.
certification_isPublisherAttested	Bool	False	The certification_isPublisherAttested of the application.
certification_lastCertificationDateTime	Datetime	False	The certification_lastCertificationDateTime of the application.
createdDateTime	Datetime	False	The createdDateTime of the application.
defaultRedirectUri	String	False	The defaultRedirectUri of the application.
description	String	False	The description of the application.
disabledByMicrosoftStatus	String	False	The disabledByMicrosoftStatus of the application.
displayName	String	False	The displayName of the application.
groupMembershipClaims	String	False	The groupMembershipClaims of the application.
identifierUris	String	False	The identifierUris of the application.
info_logoUrl	String	False	The info_logoUrl of the application.
info_marketingUrl	String	False	The info_marketingUrl of the application.
info_privacyStatementUrl	String	False	The info_privacyStatementUrl of the application.
info_supportUrl	String	False	The info_supportUrl of the application.
info_termsOfServiceUrl	String	False	The info_termsOfServiceUrl of the application.
isDeviceOnlyAuthSupported	Bool	False	The isDeviceOnlyAuthSupported of the application.
isFallbackPublicClient	Bool	False	The isFallbackPublicClient of the application.
keyCredentials	String	False	The keyCredentials of the application.
logo	String	False	The logo of the application.
notes	String	False	The notes of the application.
oauth2RequirePostResponse	Bool	False	The oauth2RequirePostResponse of the application.
optionalClaims_accessToken	String	False	The optionalClaims_accessToken of the application.
optionalClaims_idToken	String	False	The optionalClaims_idToken of the application.
optionalClaims_saml2Token	String	False	The optionalClaims_saml2Token of the application.
parentalControlSettings_countriesBlockedForMinors	String	False	The parentalControlSettings_countriesBlockedForMinors of the application.
parentalControlSettings_legalAgeGroupRule	String	False	The parentalControlSettings_legalAgeGroupRule of the application.
passwordCredentials	String	False	The passwordCredentials of the application.
publicClient_redirectUris	String	False	The publicClient_redirectUris of the application.
publisherDomain	String	False	The publisherDomain of the application.
requiredResourceAccess	String	False	The requiredResourceAccess of the application.
samlMetadataUrl	String	False	The samlMetadataUrl of the application.
serviceManagementReference	String	False	The serviceManagementReference of the application.
signInAudience	String	False	The signInAudience of the application.
spa_redirectUris	String	False	The spa_redirectUris of the application.
tags	String	False	The tags of the application.
tokenEncryptionKeyId	String	False	The tokenEncryptionKeyId of the application.
verifiedPublisher_addedDateTime	Datetime	False	The verifiedPublisher_addedDateTime of the application.
verifiedPublisher_displayName	String	False	The verifiedPublisher_displayName of the application.
verifiedPublisher_verifiedPublisherId	String	False	The verifiedPublisher_verifiedPublisherId of the application.
web_homePageUrl	String	False	The web_homePageUrl of the application.
web_implicitGrantSettings_enableAccessTokenIssuance	Bool	False	The web_implicitGrantSettings_enableAccessTokenIssuance of the application.
web_implicitGrantSettings_enableIdTokenIssuance	Bool	False	The web_implicitGrantSettings_enableIdTokenIssuance of the application.
web_logoutUrl	String	False	The web_logoutUrl of the application.
web_redirectUris	String	False	The web_redirectUris of the application.

Devices

Retrieves all Devices for the authenticated user.

Table Specific Information

Select

You can query Devices by specifying an Id or selecting all:

SELECT * FROM Devices WHERE Id = '2b9c0347-9640-4ba4-bd2d-50965fb026e7'

Select a certain column from the entity and filter by that column:

SELECT * FROM Devices WHERE DisplayName LIKE '%Desk%'

Update

To update a Device record you need to specify the Id in WHERE clause.

UPDATE Devices SET OperatingSystemVersion = 10.0.13439.0 WHERE Id = '6c32edb5-7f28-41f8-9965-f3f9a1718fde'

Delete

To delete a Device record, you need to specify the Id in WHERE clause.

DELETE FROM Devices WHERE Id = '6c32edb5-7f28-41f8-9965-f3f9a1718fde'

GetDeleted

Retrieve recently deleted devices. Deleted devices remain available for up to 30 days.

GETDELETED FROM Devices

Columns


Name	Type	ReadOnly	Description
id [KEY]	String	False	The Id of the device.
deletedDateTime	Datetime	False	The datetime when the device was deleted.
accountEnabled	Bool	False	Indicator if device is account enabled.
alternativeSecurityIds	String	False	The alternativeSecurityIds of the device.
approximateLastSignInDateTime	Datetime	False	The approximateLastSignInDateTime of the device.
complianceExpirationDateTime	Datetime	False	The complianceExpirationDateTime of the device.
deviceId	String	False	The deviceId of the device.
deviceMetadata	String	False	The deviceMetadata of the device.
deviceVersion	Int	False	The deviceVersion of the device.
displayName	String	False	The displayName of the device.
isCompliant	Bool	False	Indicator if device is compliant.
isManaged	Bool	False	Indicator if device is managed.
mdmAppId	String	False	The mdmAppId of the device.
onPremisesLastSyncDateTime	Datetime	False	The onPremisesLastSyncDateTime of the device.
onPremisesSyncEnabled	Bool	False	Indicator if device is on premises sync enabled.
operatingSystem	String	False	The operatingSystem of the device.
operatingSystemVersion	String	False	The operatingSystemVersion of the device.
physicalIds	String	False	The physicalIds of the device.
profileType	String	False	The profileType of the device.
systemLabels	String	False	The systemLabels of the device.
trustType	String	False	The trustType of the device.

Domains

Retrieves all Domains for the authenticated user.

Table Specific Information

Select

You can query Domains by specifying an Id or selecting all:

SELECT * FROM Domains WHERE Id = 'rssbus.cn'

Select a certain column from the entity and filter by that column:

SELECT Id FROM Domains WHERE Id LIKE '%rssbus%'

Insert

Specify an Id in order to create a new Domain, the Id should be the name of the new Domain:

INSERT INTO Calendars (Name) VALUES ('cdata.com')

Update

To update a Domain record you need to specify the Id in WHERE clause.

UPDATE Domains SET passwordNotificationWindowInDays = 14 WHERE Id = 'cdata.com'

Delete

To delete a Domain record, you need to specify the Id in WHERE clause.

DELETE FROM Domains WHERE Id = 'cdata.com'

Columns


Name	Type	ReadOnly	Description
id [KEY]	String	False	The id of the domain.
authenticationType	String	False	The authenticationType of the domain.
availabilityStatus	String	False	The availabilityStatus of the domain.
isAdminManaged	Bool	False	Indicator if domain is admin managed.
isDefault	Bool	False	Indicator if domain is default.
isInitial	Bool	False	Indicator if domain is initial.
isRoot	Bool	False	Indicator if domain is root.
isVerified	Bool	False	Indicator if domain is verified.
passwordNotificationWindowInDays	Int	False	The passwordNotificationWindowInDays of the domain.
passwordValidityPeriodInDays	Int	False	The passwordValidityPeriodInDays of the domain.
state_lastActionDateTime	Datetime	False	The lastActionDateTime of the state.
state_operation	String	False	The operation of the state.
state_status	String	False	The status of the state.
supportedServices	String	False	The supported services of the domain.

Groups

Retrieves all Azure Active Directory (Azure AD) groups, which can be Office 365 groups, or security groups.

Table Specific Information

Groups require Administrator permissions. To work with them, you must create your own custom OAuth App and set the appropriate OAuthClientId and OAuthClientSecret. In this app, you must configure it to request the Group.Read.All and the Group.ReadWrite.All permissions. This can be done at https://apps.dev.microsoft.com, or in the App Registrations panel at http://portal.azure.com. See カスタムAzureAD アプリの作成 for more details on creating a custom app.

To authorize Groups permissions, an administrator must grant the Groups permissions for your organization at large. This can be done via the administrator authorization endpoint. Simply have the administrator grant permissions. Then run the OAuth authorization as normal afterwards.

Note that if your organization has multiple tenants, you may replace the /common/ in the url with the tenant Id to indicate which tenant to grant permissions for.

Select

Retrieve all groups, specify a GroupId (Id), or simply filter by a certain column:

SELECT * FROM Groups WHERE Id = '029b15a8-dfd1-460e-83b6-262a75328c13'
SELECT Id, Description, DisplayName FROM Groups WHERE Name = 'test'

Insert

The following are required to create a new Security Group:

INSERT INTO Groups (DisplayName, MailEnabled, MailNickname, SecurityEnabled) VALUES ('Test group', false, 'test', true)

Update

To update a group record you need to specify the Id in WHERE clause.

UPDATE Groups SET Description='updated description from api' WHERE Id = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'

Delete

To delete a group record, you need to specify the Id in WHERE clause.

DELETE FROM Groups WHERE Id = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'

GetDeleted

Retrieve recently deleted groups. Deleted groups remain available for up to 30 days.

GETDELETED FROM Groups

Columns


Name	Type	ReadOnly	Description
id [KEY]	String	False	The Id of the group.
deletedDateTime	Datetime	False	The datetime when the group was deleted.
allowExternalSenders	Bool	False	The indicator showing if external senders should be allowed or not.
assignedLabels	String	False	The assigned labels of the group.
assignedLicenses	String	False	The assigned licenses of the group.
autoSubscribeNewMembers	Bool	False	The indicator showing if new members should be autosubscribed.
classification	String	False	The classification of the group.
createdDateTime	Datetime	False	The created DateTime of the group.
description	String	False	The description of the group.
displayName	String	False	The display name of the group.
expirationDateTime	Datetime	False	The expiration datetime of the group.
groupTypes	String	False	The types of the group.
hasMembersWithLicenseErrors	Bool	False	Indicator if there are members with license error.
hideFromAddressLists	Bool	False	Whether or not to hide the group from address lists.
hideFromOutlookClients	Bool	False	Whether or not to hide the group from Outlook Clients.
isArchived	Bool	False	Indicator if group is archived.
isAssignableToRole	Bool	False	Indicator if group is assignable to role.
isSubscribedByMail	Bool	False	Indicator if group is subscribed by email.
licenseProcessingState	String	False	The license processing state of the group.
mail	String	False	The mail of the group.
mailEnabled	Bool	False	Indicator if mail is enabled in the group.
mailNickname	String	False	The mail nickname of the group.
membershipRule	String	False	The membership rule of the group.
membershipRuleProcessingState	String	False	The membership rule processing state of the group.
onPremisesDomainName	String	False	The Domain Name of the group.
onPremisesLastSyncDateTime	Datetime	False	The LastSync DateTime of the group.
onPremisesProvisioningErrors	String	False	The provisioning errors of the group.
onPremisesSamAccountName	String	False	The Sam Account Name of the group.
onPremisesSecurityIdentifier	String	False	The security identifier of the group.
onPremisesSyncEnabled	Bool	False	Indicator if sync is enabled in the group.
preferredDataLocation	String	False	The preferred data location of the group.
preferredLanguage	String	False	Preferred language in the group.
proxyAddresses	String	False	The proxy addresses of the group.
renewedDateTime	Datetime	False	The renewed DateTime of the group.
securityEnabled	Bool	False	Indicator if security is enabled in the group.
securityIdentifier	String	False	The security identifier of the group.
theme	String	False	The theme of the group.
unseenCount	Int	False	The unseen count of the group.
visibility	String	False	The visibility of the group.

Users

Retrieves all Azure AD user accounts within the authenticated permissions.

Table Specific Information

Select

Query the Users table. The Sync App will use the Azure Active Directory API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

Id supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM Users WHERE Id = '08d30c14-2775-45c9-8809-3eca47340959'

GetDeleted

Retrieve recently deleted users. Deleted users remain available for up to 30 days.

GETDELETED FROM Users

Columns


Name	Type	ReadOnly	Description
id [KEY]	String	False	The id of the user.
deletedDateTime	Datetime	False	The deletedDateTime of the user.
aboutMe	String	False	The aboutMe of the user.
accountEnabled	Bool	False	Indicates if accountEnabled for the user.
ageGroup	String	False	The ageGroup of the user.
assignedLicenses	String	False	The assignedLicenses of the user.
assignedPlans	String	False	The assignedPlans of the user.
birthday	Datetime	False	The birthday of the user.
businessPhones	String	False	The businessPhones of the user.
city	String	False	The city of the user.
companyName	String	False	The companyName of the user.
consentProvidedForMinor	String	False	The consentProvidedForMinor of the user.
country	String	False	The country of the user.
createdDateTime	Datetime	False	The createdDateTime of the user.
creationType	String	False	The creationType of the user.
department	String	False	The department of the user.
deviceEnrollmentLimit	Int	False	The deviceEnrollmentLimit of the user.
displayName	String	False	The displayName of the user.
employeeHireDate	Datetime	False	The employeeHireDate of the user.
employeeId	String	False	The employeeId of the user.
employeeOrgData_costCenter	String	False	The employeeOrgData_costCenter of the user.
employeeOrgData_division	String	False	The employeeOrgData_division of the user.
employeeType	String	False	The employeeType of the user.
externalUserState	String	False	The externalUserState of the user.
externalUserStateChangeDateTime	Datetime	False	The externalUserStateChangeDateTime of the user.
faxNumber	String	False	The faxNumber of the user.
givenName	String	False	The givenName of the user.
hireDate	Datetime	False	The hireDate of the user.
identities	String	False	The identities of the user.
imAddresses	String	False	The imAddresses of the user.
interests	String	False	The interests of the user.
isResourceAccount	Bool	False	Indicates if it isResourceAccount of the user.
jobTitle	String	False	The jobTitle of the user.
lastPasswordChangeDateTime	Datetime	False	The lastPasswordChangeDateTime of the user.
legalAgeGroupClassification	String	False	The legalAgeGroupClassification of the user.
licenseAssignmentStates	String	False	The licenseAssignmentStates of the user.
mail	String	False	The mail of the user.
mailboxSettings_archiveFolder	String	False	The mailboxSettings_archiveFolder of the user.
mailboxSettings_automaticRepliesSetting_externalAudience	String	False	The mailboxSettings_automaticRepliesSetting_externalAudience of the user.
mailboxSettings_automaticRepliesSetting_externalReplyMessage	String	False	The mailboxSettings_automaticRepliesSetting_externalReplyMessage of the user.
mailboxSettings_automaticRepliesSetting_internalReplyMessage	String	False	The mailboxSettings_automaticRepliesSetting_internalReplyMessage of the user.
mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime	Datetime	False	The mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime of the user.
mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone	String	False	The mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone of the user.
mailboxSettings_automaticRepliesSetting_status	String	False	The mailboxSettings_automaticRepliesSetting_status of the user.
mailboxSettings_dateFormat	String	False	The mailboxSettings_dateFormat of the user.
mailboxSettings_delegateMeetingMessageDeliveryOptions	String	False	The mailboxSettings_delegateMeetingMessageDeliveryOptions of the user.
mailboxSettings_language_displayName	String	False	The mailboxSettings_language_displayName of the user.
mailboxSettings_language_locale	String	False	The mailboxSettings_language_locale of the user.
mailboxSettings_timeFormat	String	False	The mailboxSettings_timeFormat of the user.
mailboxSettings_timeZone	String	False	The mailboxSettings_timeZone of the user.
mailboxSettings_userPurpose	String	False	The mailboxSettings_userPurpose of the user.
mailboxSettings_workingHours_daysOfWeek	String	False	The mailboxSettings_workingHours_daysOfWeek of the user.
mailboxSettings_workingHours_endTime	Time	False	The mailboxSettings_workingHours_endTime of the user.
mailboxSettings_workingHours_startTime	Time	False	The mailboxSettings_workingHours_startTime of the user.
mailboxSettings_workingHours_timeZone_name	String	False	The mailboxSettings_workingHours_timeZone_name of the user.
mailNickname	String	False	The mailNickname of the user.
mobilePhone	String	False	The mobilePhone of the user.
mySite	String	False	The mySite of the user.
officeLocation	String	False	The officeLocation of the user.
onPremisesDistinguishedName	String	False	The onPremisesDistinguishedName of the user.
onPremisesDomainName	String	False	The onPremisesDomainName of the user.
onPremisesExtensionAttributes_extensionAttribute1	String	False	The onPremisesExtensionAttributes_extensionAttribute1 of the user.
onPremisesExtensionAttributes_extensionAttribute10	String	False	The onPremisesExtensionAttributes_extensionAttribute10 of the user.
onPremisesExtensionAttributes_extensionAttribute11	String	False	The onPremisesExtensionAttributes_extensionAttribute11 of the user.
onPremisesExtensionAttributes_extensionAttribute12	String	False	The onPremisesExtensionAttributes_extensionAttribute12 of the user.
onPremisesExtensionAttributes_extensionAttribute13	String	False	The onPremisesExtensionAttributes_extensionAttribute13 of the user.
onPremisesExtensionAttributes_extensionAttribute14	String	False	The onPremisesExtensionAttributes_extensionAttribute14 of the user.
onPremisesExtensionAttributes_extensionAttribute15	String	False	The onPremisesExtensionAttributes_extensionAttribute15 of the user.
onPremisesExtensionAttributes_extensionAttribute2	String	False	The onPremisesExtensionAttributes_extensionAttribute2 of the user.
onPremisesExtensionAttributes_extensionAttribute3	String	False	The onPremisesExtensionAttributes_extensionAttribute3 of the user.
onPremisesExtensionAttributes_extensionAttribute4	String	False	The onPremisesExtensionAttributes_extensionAttribute4 of the user.
onPremisesExtensionAttributes_extensionAttribute5	String	False	The onPremisesExtensionAttributes_extensionAttribute5 of the user.
onPremisesExtensionAttributes_extensionAttribute6	String	False	The onPremisesExtensionAttributes_extensionAttribute6 of the user.
onPremisesExtensionAttributes_extensionAttribute7	String	False	The onPremisesExtensionAttributes_extensionAttribute7 of the user.
onPremisesExtensionAttributes_extensionAttribute8	String	False	The onPremisesExtensionAttributes_extensionAttribute8 of the user.
onPremisesExtensionAttributes_extensionAttribute9	String	False	The onPremisesExtensionAttributes_extensionAttribute9 of the user.
onPremisesImmutableId	String	False	The onPremisesImmutableId of the user.
onPremisesLastSyncDateTime	Datetime	False	The onPremisesLastSyncDateTime of the user.
onPremisesProvisioningErrors	String	False	The onPremisesProvisioningErrors of the user.
onPremisesSamAccountName	String	False	The onPremisesSamAccountName of the user.
onPremisesSecurityIdentifier	String	False	The onPremisesSecurityIdentifier of the user.
onPremisesSyncEnabled	Bool	False	Indicates onPremisesSyncEnabled for the user.
onPremisesUserPrincipalName	String	False	The onPremisesUserPrincipalName of the user.
otherMails	String	False	The otherMails of the user.
passwordPolicies	String	False	The passwordPolicies of the user.
passwordProfile_forceChangePasswordNextSignIn	Bool	False	Indicate passwordProfile_forceChangePasswordNextSignIn for the user.
passwordProfile_forceChangePasswordNextSignInWithMfa	Bool	False	Indicate passwordProfile_forceChangePasswordNextSignInWithMfa for the user.
passwordProfile_password	String	False	The passwordProfile_password of the user.
pastProjects	String	False	The pastProjects of the user.
postalCode	String	False	The postalCode of the user.
preferredLanguage	String	False	The preferredLanguage of the user.
preferredName	String	False	The preferredName of the user.
provisionedPlans	String	False	The provisionedPlans of the user.
proxyAddresses	String	False	The proxyAddresses of the user.
responsibilities	String	False	The responsibilities of the user.
schools	String	False	The schools of the user.
showInAddressList	Bool	False	Indicate showInAddressList of the user.
signInSessionsValidFromDateTime	Datetime	False	The signInSessionsValidFromDateTime of the user.
skills	String	False	The skills of the user.
state	String	False	The state of the user.
streetAddress	String	False	The streetAddress of the user.
surname	String	False	The surname of the user.
usageLocation	String	False	The usageLocation of the user.
userPrincipalName	String	False	The userPrincipalName of the user.
userType	String	False	The userType of the user.

Views

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

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

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

Azure Active Directory Connector for CData Sync Views


Name	Description
AdministrativeUnitMembers	Retrieves all AdministrativeUnitMembers for the authenticated user.
AdministrativeUnits	Retrieves all AdministrativeUnits for the authenticated user.
Contacts	Retrieves the Contacts for the organization.
Contracts	Retrieves all contracts for the authenticated user.
DeviceRegisteredOwners	DeviceRegisteredOwners table for Azure AD data provider.
DeviceRegisteredUsers	DeviceRegisteredUsers table for Azure AD data provider.
DirectoryAudits	Retrieves all directory audit items for the authenticated user.
DirectoryRoleMembers	DirectoryRoleMembers table for Azure AD data provider.
DirectoryRoles	Retrieves all DirectoryRoles for the authenticated user.
DirectoryRoleTemplates	Retrieves all DirectoryRoleTemplates for the authenticated user.
GroupApplicationRoleAssignments	GroupApplicationRoleAssignments table for Azure AD data provider.
GroupMembers	GroupMembers table for Azure AD data provider.
Organization	Retrieves the Organization for the authenticated user.
RoleAssignments	Retrieves the Role Assignments for the Azure AD.
RoleDefinitions	Retrieves the Role Definitions for the Azure AD.
SignIns	Retrieves the user sign-ins for your tenant.
UserApplicationRoleAssignments	UserApplicationRoleAssignments table for Azure AD data provider.

AdministrativeUnitMembers

Retrieves all AdministrativeUnitMembers for the authenticated user.

Table Specific Information

Select

Get the members of administrative units in your Azure Active Directory. You can filter results by UnitId and MemberId.

UnitId supports the '=' and IN operators.
MemberId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM AdministrativeUnitMembers WHERE UnitId = '1721e354-9b76-49d5-bdf1-bb30a936c3ab'

SELECT * FROM AdministrativeUnitMembers WHERE MemberId IN (SELECT Id FROM Users)

Columns


Name	Type	Description
UnitId [KEY]	String	The id of the administrativeUnit.
MemberId [KEY]	String	The User or Group Id of the user listed.

AdministrativeUnits

Retrieves all AdministrativeUnits for the authenticated user.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM AdministrativeUnits WHERE Id = '1721e354-9b76-49d5-bdf1-bb30a936c3ab'
SELECT * FROM AdministrativeUnits WHERE Id IN ('1721e354-9b76-49d5-bdf1-bb30a936c3ab')
SELECT * FROM AdministrativeUnits WHERE DisplayName LIKE '%Test%'

Columns


Name	Type	Description
id [KEY]	String	The id of the administrativeUnit.
deletedDateTime	Datetime	The datetime when the administrativeUnit was deleted.
description	String	The description of the administrativeUnit.
displayName	String	The displayName of the administrativeUnit.
visibility	String	The visibility of the administrativeUnit.

Contacts

Retrieves the Contacts for the organization.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM Contacts WHERE Id = '8b0a526e-178d-4494-a276-8819b74d7933'
SELECT * FROM Contacts WHERE Id IN ('8b0a526e-178d-4494-a276-8819b74d7933', 'a8f14261-fb3b-42f7-a27a-d29877b5010b')
SELECT * FROM Contacts WHERE DisplayName LIKE '%Test%'

Columns


Name	Type	Description
id [KEY]	String	The id of the organizationalContact.
deletedDateTime	Datetime	The datetime when the contact was deleted.
addresses	String	The addresses of the organizationalContact.
companyName	String	The companyName of the organizationalContact.
department	String	The department of the organizationalContact.
displayName	String	The displayName of the organizationalContact.
givenName	String	The givenName of the organizationalContact.
jobTitle	String	The jobTitle of the organizationalContact.
mail	String	The mail of the organizationalContact.
mailNickname	String	The mailNickname of the organizationalContact.
onPremisesLastSyncDateTime	Datetime	The onPremisesLastSyncDateTime of the organizationalContact.
onPremisesProvisioningErrors	String	The provisioning errors of the organizationalContact.
onPremisesSyncEnabled	Bool	Indicator if organizationalContact is onPremisesSyncEnabled.
phones	String	The phones of the organizationalContact.
proxyAddresses	String	The proxyAddresses of the organizationalContact.
surname	String	The surname of the organizationalContact.

Contracts

Retrieves all contracts for the authenticated user.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM Contracts WHERE Id = '8b0a526e-178d-4494-a276-8819b74d7933'
SELECT * FROM Contracts WHERE Id IN ('8b0a526e-178d-4494-a276-8819b74d7933')
SELECT * FROM Contracts WHERE DisplayName LIKE '%Test%'

Columns


Name	Type	Description
id [KEY]	String	The id of the contract.
deletedDateTime	Datetime	The datetime when the contract was deleted.
contractType	String	The contractType of the contract.
customerId	String	The customerId of the contract.
defaultDomainName	String	The defaultDomainName of the contract.
displayName	String	The displayName of the contract.

DeviceRegisteredOwners

DeviceRegisteredOwners table for Azure AD data provider.

Table Specific Information

Select

Get the owners of registered Devices in your Azure Active Directory. You can filter results by DeviceId and OwnerId.

DeviceId supports the '=' and IN operators.
OwnerId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM DeviceRegisteredOwners WHERE DeviceId = '2b9c0347-9640-4ba4-bd2d-50965fb026e7'

SELECT * FROM DeviceRegisteredOwners WHERE OwnerId IN (SELECT Id FROM Groups)

Columns


Name	Type	Description
DeviceId [KEY]	String	The Id of the Device.
OwnerId [KEY]	String	The User Id of the owner listed.

DeviceRegisteredUsers

DeviceRegisteredUsers table for Azure AD data provider.

Table Specific Information

Select

Get the users of registered Devices in your Azure Active Directory. You can filter results by DeviceId and UserId.

DeviceId supports the '=' and IN operators.
UserId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM DeviceRegisteredUsers WHERE DeviceId = '2b9c0347-9640-4ba4-bd2d-50965fb026e7'

SELECT * FROM DeviceRegisteredUsers WHERE UsersId IN (SELECT Id FROM Users)

Columns


Name	Type	Description
DeviceId [KEY]	String	The Id of the Device.
UserId [KEY]	String	The User Id of the user listed.

DirectoryAudits

Retrieves all directory audit items for the authenticated user.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM DirectoryAudits WHERE Id = 'Directory_2183313c-ac52-4772-8482-7b2eb2a5d7c9_LBZWQ_311068785'
SELECT * FROM DirectoryAudits WHERE Id IN ('Directory_2183313c-ac52-4772-8482-7b2eb2a5d7c9_LBZWQ_311068785')
SELECT * FROM DirectoryAudits WHERE ActivityDisplayName LIKE '%Update%'

Columns


Name	Type	Description
id [KEY]	String	The id of the DirectoryAudit.
activityDateTime	Datetime	The activityDateTime of the DirectoryAudit.
activityDisplayName	String	The activityDisplayName of the DirectoryAudit.
additionalDetails	String	The additionalDetails of the DirectoryAudit.
category	String	The category of the DirectoryAudit.
correlationId	String	The correlationId of the DirectoryAudit.
initiatedBy_app_appid	String	The initiatedBy_app_appid of the DirectoryAudit.
initiatedBy_app_displayName	String	The initiatedBy_app_displayName of the DirectoryAudit.
initiatedBy_app_servicePrincipalId	String	The initiatedBy_app_servicePrincipalId of the DirectoryAudit.
initiatedBy_app_servicePrincipalName	String	The initiatedBy_app_servicePrincipalName of the DirectoryAudit.
loggedByService	String	The loggedByService of the DirectoryAudit.
operationType	String	The operationType of the DirectoryAudit.
result	String	The result of the DirectoryAudit.
resultReason	String	The resultReason of the DirectoryAudit.
targetResources	String	The targetResources of the DirectoryAudit.

DirectoryRoleMembers

DirectoryRoleMembers table for Azure AD data provider.

Table Specific Information

Select

Get the members of Directory Roles in your Azure Active Directory. You can filter results by RoleId and UserId.

RoleId supports the '=' and IN operators.
UserId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM DirectoryRoleMembers WHERE RoleId = '25502c98-94df-43fa-baf7-4a105e200030'

SELECT * FROM DirectoryRoleMembers WHERE UserId IN (SELECT Id FROM Users)

Columns


Name	Type	Description
RoleId [KEY]	String	The id of the directoryRole.
UserId [KEY]	String	The User Id of the user listed.

DirectoryRoles

Retrieves all DirectoryRoles for the authenticated user.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM DirectoryRoles WHERE Id = '0f1032b0-ec73-4f72-836e-3b4411ea70c6'
SELECT * FROM DirectoryRoles WHERE RoleTemplateId = '4d6ac14f-3453-41d0-bef9-a3e0c569773a'
SELECT * FROM DirectoryRoles WHERE Id IN ('0f1032b0-ec73-4f72-836e-3b4411ea70c6', '081c8ba7-15a3-4c39-9972-053427b3c857')
SELECT * FROM DirectoryRoles WHERE DisplayName LIKE '%Admin%'

Columns


Name	Type	Description
id [KEY]	String	The id of the directoryRole.
deletedDateTime	Datetime	The datetime when the directoryRole was deleted.
description	String	The description of the directoryRole.
displayName	String	The displayName of the directoryRole.
roleTemplateId	String	The roleTemplateId of the directoryRole.

DirectoryRoleTemplates

Retrieves all DirectoryRoleTemplates for the authenticated user.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM DirectoryRoleTemplates WHERE Id = '62e90394-69f5-4237-9190-012177145e10'
SELECT * FROM DirectoryRoleTemplates WHERE Id IN ('62e90394-69f5-4237-9190-012177145e10', '2af84b1e-32c8-42b7-82bc-daa82404023b')
SELECT * FROM DirectoryRoleTemplates WHERE DisplayName LIKE '%Admin%'

Columns


Name	Type	Description
id [KEY]	String	The id of the directoryRoleTemplate.
deletedDateTime	Datetime	The datetime when the directoryRoleTemplate was deleted.
description	String	The description of the directoryRoleTemplate.
displayName	String	The displayName of the directoryRoleTemplate.

GroupApplicationRoleAssignments

GroupApplicationRoleAssignments table for Azure AD data provider.

Table Specific Information

Select

Get the group application roles assignments in your Azure Active Directory. You can filter results by GroupId.

UserId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM GroupApplicationRoleAssignments WHERE GroupId = 'ffacf701-6caf-4228-9e3b-7e57c14122ee'

SELECT * FROM GroupApplicationRoleAssignments WHERE GroupId IN (SELECT Id FROM Groups)

Columns


Name	Type	Description
GroupId [KEY]	String	The GroupId of the ApplicationRoleAssignment.
id [KEY]	String	The id of the ApplicationRoleAssignment.
appRoleId	String	The appRoleId of the ApplicationRoleAssignment.
createdDateTime	Datetime	The createdDateTime of the ApplicationRoleAssignment.
principalDisplayName	String	The principalDisplayName of the ApplicationRoleAssignment.
principalId	String	The principalId of the ApplicationRoleAssignment.
principalType	String	The principalType of the ApplicationRoleAssignment.
resourceDisplayName	String	The resourceDisplayName of the ApplicationRoleAssignment.
resourceId	String	The resourceId of the ApplicationRoleAssignment.

GroupMembers

GroupMembers table for Azure AD data provider.

Table Specific Information

Select

Query the GroupMembers table by retrieving everything from Azure AD or by specifying GroupId with = and IN operators. You can filter results by GroupId and MemberId.

GroupId supports the '=' and IN operators.
MemberId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM GroupMembers WHERE GroupId IN ('4729c5e5-f923-4435-8a41-44423d42ea79', 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1')

SELECT * FROM GroupMembers WHERE GroupId = '4729c5e5-f923-4435-8a41-44423d42ea79'

Columns


Name	Type	Description
GroupId [KEY]	String	The Id of the Group.
MemberId [KEY]	String	The User Id of the member listed.

Organization

Retrieves the Organization for the authenticated user.

Table Specific Information

Select

SELECT * FROM Organization

Columns


Name	Type	Description
id [KEY]	String	The id of the organization.
deletedDateTime	Datetime	The datetime when the organization was deleted.
assignedPlans	String	The assignedPlans of the organization.
businessPhones	String	The businessPhones of the organization.
city	String	The city of the organization.
country	String	The country of the organization.
countryLetterCode	String	The countryLetterCode of the organization.
createdDateTime	Datetime	The createdDateTime of the organization.
displayName	String	The displayName of the organization.
marketingNotificationEmails	String	The marketingNotificationEmails of the organization.
mobileDeviceManagementAuthority	String	The mobileDeviceManagementAuthority of the organization.
onPremisesLastSyncDateTime	Datetime	The onPremisesLastSyncDateTime of the organization.
onPremisesSyncEnabled	Bool	Indicator if organization is onPremisesSyncEnabled.
postalCode	String	The postalCode of the organization.
preferredLanguage	String	The preferredLanguage of the organization.
privacyProfile_contactEmail	String	The contactEmail of the privacyProfile.
privacyProfile_statementUrl	String	The statementUrl of the privacyProfile.
provisionedPlans	String	The provisionedPlans of the organization.
securityComplianceNotificationMails	String	The securityComplianceNotificationMails of the organization.
securityComplianceNotificationPhones	String	The securityComplianceNotificationPhones of the organization.
state	String	The state of the organization.
street	String	The street of the organization.
technicalNotificationMails	String	The technicalNotificationMails of the organization.
tenantType	String	The tenantType of the organization.
verifiedDomains	String	The verifiedDomains of the organization.

RoleAssignments

Retrieves the Role Assignments for the Azure AD.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM RoleAssignments
SELECT * FROM RoleAssignments WHERE Id = '4yeYchSc90m7G5YI8Va7uM8rSNTfthJJt-QfAs-zqcI-1'
SELECT * FROM RoleAssignments WHERE RoleDefinitionId = '62e90394-69f5-4237-9190-012177145e10'
SELECT * FROM RoleAssignments WHERE PrincipalId = 'e5d250bd-92b4-44b2-b002-bc559f6d79e5'

Columns


Name	Type	Description
id [KEY]	String	The id of the roleAssignment.
condition	String	The condition of the roleAssignment.
roleDefinitionId	String	The roleDefinitionId of the roleAssignment.
principalId	String	The principalId of the roleAssignment.
directoryScopeId	String	The directoryScopeId of the roleAssignment.
appScopeId	String	The appScopeId of the roleAssignment.

RoleDefinitions

Retrieves the Role Definitions for the Azure AD.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM RoleDefinitions WHERE Id = '62e90394-69f5-4237-9190-012177145e10'
SELECT * FROM RoleDefinitions WHERE Id IN ('62e90394-69f5-4237-9190-012177145e10', 'fe930be7-5e62-47db-91af-98c3a49a38b1')
SELECT * FROM RoleDefinitions WHERE DisplayName LIKE '%Admin%'

Columns


Name	Type	Description
id [KEY]	String	The id of the roleDefinition.
description	String	The description of the roleDefinition.
displayName	String	The displayName of the roleDefinition.
isBuiltIn	Bool	Indicator if roleDefinition is Builtin.
isEnabled	Bool	Indicator if roleDefinition is Enabled.
resourceScopes	String	The resourceScopes of the roleDefinition.
rolePermissions	String	The rolePermissions of the roleDefinition.
templateId	String	The templateId of the roleDefinition.
version	String	The version of the roleDefinition.

SignIns

Retrieves the user sign-ins for your tenant.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM SignIns WHERE Id = '8b0a526e-178d-4494-a276-8819b74d7933'
SELECT * FROM SignIns WHERE Id IN ('8b0a526e-178d-4494-a276-8819b74d7933', 'a8f14261-fb3b-42f7-a27a-d29877b5010b')
SELECT * FROM SignIns WHERE ResourceDisplayName LIKE '%Test%'

Columns


Name	Type	Description
id [KEY]	String	The id of the SignIns.
appDisplayName	String	The appDisplayName of the SignIns.
appId	String	The appId of the SignIns.
appliedConditionalAccessPolicies	String	The appliedConditionalAccessPolicies of the SignIns.
clientAppUsed	String	The clientAppUsed of the SignIns.
conditionalAccessStatus	String	The conditionalAccessStatus of the SignIns.
correlationId	String	The correlationId of the SignIns.
createdDateTime	Datetime	The createdDateTime of the SignIns.
deviceDetail_browser	String	The deviceDetail_browser of the SignIns.
deviceDetail_deviceId	String	The deviceDetail_deviceId of the SignIns.
deviceDetail_displayName	String	The deviceDetail_displayName of the SignIns.
deviceDetail_isCompliant	Bool	The deviceDetail_isCompliant of the SignIns.
deviceDetail_isManaged	Bool	The deviceDetail_isManaged of the SignIns.
deviceDetail_operatingSystem	String	The deviceDetail_operatingSystem of the SignIns.
deviceDetail_trustType	String	The deviceDetail_trustType of the SignIns.
ipAddress	String	The ipAddress of the SignIns.
isInteractive	Bool	The isInteractive of the SignIns.
signInLocation_city	String	The signInLocation_city of the SignIns.
signInLocation_countryOrRegion	String	The signInLocation_countryOrRegion of the SignIns.
signInLocation_state	String	The signInLocation_state of the SignIns.
resourceDisplayName	String	The resourceDisplayName of the SignIns.
resourceId	String	The resourceId of the SignIns.
riskDetail	String	The riskDetail of the SignIns.
riskEventTypes	String	The riskEventTypes of the DirectoryAudit.
riskEventTypes_v2	String	The riskEventTypes_v2 of the DirectoryAudit.
riskLevelAggregated	String	The riskLevelAggregated of the SignIns.
riskLevelDuringSignIn	String	The riskLevelDuringSignIn of the SignIns.
riskState	String	The riskState of the SignIns.
signInStatus_additionalDetails	String	The signInStatus_additionalDetails of the SignIns.
signInStatus_errorCode	Int	The signInStatus_errorCode of the application.
signInStatus_failureReason	String	The signInStatus_failureReason of the SignIns.
userDisplayName	String	The userDisplayName of the SignIns.
userId	String	The userId of the SignIns.
userPrincipalName	String	The userPrincipalName of the SignIns.

UserApplicationRoleAssignments

UserApplicationRoleAssignments table for Azure AD data provider.

Table Specific Information

Select

Get the user application roles assignments in your Azure Active Directory. You can filter results by UserId.

UserId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM UserApplicationRoleAssignments WHERE UserId = 'ffacf701-6caf-4228-9e3b-7e57c14122ee'

SELECT * FROM UserApplicationRoleAssignments WHERE UserId IN (SELECT Id FROM Users)

Columns


Name	Type	Description
UserId [KEY]	String	The UserId of the ApplicationRoleAssignment.
id [KEY]	String	The id of the ApplicationRoleAssignment.
appRoleId	String	The appRoleId of the ApplicationRoleAssignment.
createdDateTime	Datetime	The createdDateTime of the ApplicationRoleAssignment.
principalDisplayName	String	The principalDisplayName of the ApplicationRoleAssignment.
principalId	String	The principalId of the ApplicationRoleAssignment.
principalType	String	The principalType of the ApplicationRoleAssignment.
resourceDisplayName	String	The resourceDisplayName of the ApplicationRoleAssignment.
resourceId	String	The resourceId of the ApplicationRoleAssignment.

データ型マッピング

Data Type Mappings

The Sync App maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.


Azure Active Directory (OData V4)	CData Schema
Edm.Binary	binary
Edm.Boolean	bool
Edm.Date	datetime
Edm.DateTimeOffset	datetime
Edm.Decimal	decimal
Edm.Double	double
Edm.Guid	guid
Edm.Int32	int
Edm.String	string
Edm.TimeOfDay	time

接続文字列オプション

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

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

Authentication

プロパティ	説明
AuthScheme	Azure Active Directory に接続する際に使用する認証の種類。

Azure Authentication

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

OAuth

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuthGrantType	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	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

Authentication

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

プロパティ	説明
AuthScheme	Azure Active Directory に接続する際に使用する認証の種類。

AuthScheme

Azure Active Directory に接続する際に使用する認証の種類。

解説

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

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 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuthGrantType	OAuth フローのグラント種別。

OAuthClientId

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

解説

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

OAuthClientSecret

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

解説

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

OAuthGrantType

OAuth フローのグラント種別。

解説

次のオプションが利用可能です：CODE,CLIENT

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 Active Directory への接続を開き、プロキシを経由して通信が行われます。
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\\AzureActiveDirectory 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	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

MaxRows

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

解説

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

Other

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

解説

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

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

統合およびフォーマット


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

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 DirectoryRoles WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

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

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