Azure Active Directory への接続を追加

Azure Active Directory への接続を追加するには：

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

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Azure Active Directory への認証

Azure AD

Azure AD は、Microsoft のマルチテナント、クラウドベースのディレクトリおよびID 管理サービスです。これはユーザーベースの認証で、AuthScheme をAzureAD に設定する必要があります。

Web アプリケーションを介したAzure AD への認証には、 常にカスタムOAuth アプリケーションの作成が必要です。

カスタムOAuthアプリケーションの作成の詳細については、Azure AD アプリケーションの作成 を参照してください。

Azure サービスプリンシパル

Azure サービスプリンシパルは、ロールに基づいたアプリケーションベースの認証です。これは、認証がユーザーごとではなく、アプリケーションごとに行われることを意味します。 アプリケーションで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで、割り当てられたロールに基づいて実行されます。 リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

Azure サービスプリンシパル認証の設定方法については、サービスプリンシパルによるAzure AD アプリの作成 を参照してください。

Managed Service Identity (MSI)

Azure VM 上でAzure Active Directory を実行しており、マネージドID（MSI）認証情報を自動的に取得して接続したい場合は、AuthScheme を AzureMSI に設定します。

User-Managed Identities

マネージドID のトークンを取得するには、OAuthClientId プロパティを使用してマネージドID のclient_id を指定します。

VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。

このセクションでは、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 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

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

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

CData Sync App はAzure Active Directory をテーブル、ビュー、ストアドプロシージャを備えた使いやすいSQL データベースとしてモデル化します。これらのオブジェクトへのライブ接続により、Azure Active Directory アカウントへのあらゆる変更はSync App に即座に反映されます。

テーブル

Tables セクションには標準SQL テーブルの詳細が、Views セクションには読み取り専用SQL テーブルの一覧が記載されています。これらには、Azure Active Directory アカウントでのアクセスを想定したサンプルが含まれています。

一般的なテーブルには以下のものが含まれます。

テーブル	説明
Users	Lists all Azure AD users, including their profile and directory information, within the authenticated permissions.
Groups	Lists all Azure AD groups, including Office 365 and security groups, accessible to the authenticated user.
Applications	Contains details of all registered applications within the organization for the authenticated user, including app-specific configurations.
Devices	Lists all devices registered within the organization that the authenticated user has access to, including device details.
DirectoryRoles	Contains a list of directory roles, detailing roles assigned to users and groups within the organization.
DirectoryRoleMembers	Identifies the members assigned to specific directory roles within the Azure AD environment.
GroupMembers	Provides a detailed view of group memberships, listing all members of each group within the organization.
SignIns	Tracks and lists all user sign-in activities for audit and monitoring purposes.
DirectoryAudits	Tracks and lists all directory audit events accessible to the authenticated user for compliance and monitoring.
Organization	Contains metadata and details about the organization accessible to the authenticated user.
RoleAssignments	Displays all role assignments configured within the Azure AD environment.
RoleDefinitions	Provides definitions for roles available in Azure AD, detailing their permissions and scope.
DeviceRegisteredOwners	Maps device objects to their registered owners for tracking and management purposes.
DeviceRegisteredUsers	Associates device objects with their registered users, facilitating detailed user-device relationship analysis.
AdministrativeUnits	Displays a comprehensive list of administrative units accessible to the authenticated user, enabling management of organizational structure.
AdministrativeUnitMembers	Lists all members of administrative units available to the authenticated user, providing details on their membership relationships.
Domains	Displays all domains registered and verified within the organization, along with their configurations.
PhoneAuthenticationMethods	Lists phone-based authentication methods configured for users within the organization.
UserManagers	Maps users to their assigned managers within the organization for reporting and hierarchy management.
SubscribedSKUs	Lists service subscriptions (SKUs) the organization is subscribed to, including details of usage and availability.

ストアドプロシージャ

Stored Procedures は、SQLクエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、OAuth アクセストークンの取得や更新、グループの管理などのより高度なタスクも実行します。

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

Azure Active Directory Connector for CData Sync Tables

Name	Description
Applications	Contains details of all registered applications within the organization for the authenticated user, including app-specific configurations.
Devices	Lists all devices registered within the organization that the authenticated user has access to, including device details.
Domains	Displays all domains registered and verified within the organization, along with their configurations.
Groups	Lists all Azure AD groups, including Office 365 and security groups, accessible to the authenticated user.
Users	Lists all Azure AD users, including their profile and directory information, within the authenticated permissions.

Contains details of all registered applications within the organization for the authenticated user, including app-specific configurations.

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%'

Insert

Specify a displayName in order to create a new Application, the displayName should be the name of the new Application:

INSERT INTO Applications (displayName) VALUES ('TestApp')

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'

Delete

To delete an Application record, you need to specify the Id in WHERE clause.

DELETE FROM Applications WHERE Id = '480a2785-1c18-49ac-9a80-9dfc1b40e1f2'

Columns

Name	Type	ReadOnly	Description
id [KEY]	String	False	The unique identifier of the application, used as the primary key.
addIns	String	False	A list of add-ins associated with the application, detailing additional functionalities.
api_acceptMappedClaims	Bool	False	Indicates whether the application accepts mapped claims in tokens.
api_knownClientApplications	String	False	A list of known client applications that this API trusts.
api_oauth2PermissionScopes	String	False	The OAuth2 permission scopes defined for the API of the application.
api_preAuthorizedApplications	String	False	Applications pre-authorized to call this application's API.
api_requestedAccessTokenVersion	Int	False	The version of access tokens requested by the application API.
appId	String	False	The globally unique application ID assigned to the application.
applicationTemplateId	String	False	The ID of the application template used during creation.
appRoles	String	False	Roles defined for the application that can be assigned to users or groups.
authenticationBehaviors_removeUnverifiedEmailClaim	Bool	False	Specifies if unverified email claims should be removed during authentication.
authenticationBehaviors_requireClientServicePrincipal	Bool	False	Indicates if a client service principal is required for authentication.
certification_certificationDetailsUrl	String	False	The URL providing details about the application's certification.
certification_certificationExpirationDateTime	Datetime	False	The date and time when the application's certification expires.
certification_isCertifiedByMicrosoft	Bool	False	Specifies if the application is certified by Microsoft.
certification_isPublisherAttested	Bool	False	Indicates if the application's publisher attested to its certification.
certification_lastCertificationDateTime	Datetime	False	The date and time of the application's last certification.
createdDateTime	Datetime	False	The date and time the application was created.
defaultRedirectUri	String	False	The default redirect URI used in the application's authentication flows.
description	String	False	A brief description of the application's purpose or functionality.
disabledByMicrosoftStatus	String	False	Indicates if the application is disabled by Microsoft and the reason for it.
displayName	String	False	The friendly name of the application, displayed in portals.
groupMembershipClaims	String	False	The claims related to group memberships that the application can receive.
identifierUris	String	False	The URIs that identify the application within its tenant.
info_logoUrl	String	False	The URL of the application's logo image.
info_marketingUrl	String	False	The URL of the application's marketing or promotional page.
info_privacyStatementUrl	String	False	The URL of the application's privacy policy.
info_supportUrl	String	False	The URL for the application's support page.
info_termsOfServiceUrl	String	False	The URL of the application's terms of service.
isDeviceOnlyAuthSupported	Bool	False	Indicates if the application supports authentication for devices only.
isFallbackPublicClient	Bool	False	Specifies if the application can fallback to public client behavior.
keyCredentials	String	False	The list of key credentials associated with the application for authentication.
logo	String	False	The binary data of the application's logo.
notes	String	False	Additional notes or metadata about the application.
oauth2RequirePostResponse	Bool	False	Indicates if the application requires a POST response for OAuth2 authorization.
optionalClaims_accessToken	String	False	Optional claims included in the application's access tokens.
optionalClaims_idToken	String	False	Optional claims included in the application's ID tokens.
optionalClaims_saml2Token	String	False	Optional claims included in the application's security assertion markup language 2.0 (SAML2) tokens.
parentalControlSettings_countriesBlockedForMinors	String	False	Countries where the application is blocked for minors, based on parental control settings.
parentalControlSettings_legalAgeGroupRule	String	False	Rules for age group restrictions applied to the application.
passwordCredentials	String	False	The list of password credentials associated with the application.
publicClient_redirectUris	String	False	Redirect URIs defined for public client flows of the application.
publisherDomain	String	False	The verified domain of the application publisher.
requiredResourceAccess	String	False	Resources and permissions the application requires for operation.
samlMetadataUrl	String	False	The metadata URL for security assertion markup language (SAML) integration with the application.
serviceManagementReference	String	False	A reference for managing the application's service configuration.
servicePrincipalLockConfiguration_isEnabled	Bool	False	Indicates if the service principal lock configuration is enabled.
servicePrincipalLockConfiguration_allProperties	Bool	False	Specifies if all properties of the service principal are locked.
servicePrincipalLockConfiguration_credentialsWithUsageVerify	Bool	False	Locks credentials used for verifying tokens in the application.
servicePrincipalLockConfiguration_credentialsWithUsageSign	Bool	False	Locks credentials used for signing tokens in the application.
servicePrincipalLockConfiguration_tokenEncryptionKeyId	Bool	False	Locks the token encryption key ID for the application.
signInAudience	String	False	Defines the audience that can sign in to the application.
spa_redirectUris	String	False	Redirect URIs defined for single-page applications.
tags	String	False	Custom tags associated with the application for organization.
tokenEncryptionKeyId	String	False	The ID of the token encryption key used by the application.
verifiedPublisher_addedDateTime	Datetime	False	The date and time when the publisher was verified.
verifiedPublisher_displayName	String	False	The display name of the verified publisher.
verifiedPublisher_verifiedPublisherId	String	False	The ID of the verified publisher of the application.
web_homePageUrl	String	False	The URL of the application's web homepage.
web_implicitGrantSettings_enableAccessTokenIssuance	Bool	False	Specifies if implicit grant access tokens are enabled for web applications.
web_implicitGrantSettings_enableIdTokenIssuance	Bool	False	Specifies if implicit grant ID tokens are enabled for web applications.
web_logoutUrl	String	False	The URL for logout redirection in the application.
web_redirectUris	String	False	Redirect URIs defined for web applications.

Lists all devices registered within the organization that the authenticated user has access to, including device details.

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%'

Insert

Specify deviceId, accountEnabled, displayName, operatingSystem, operatingSystemVersion, and alternativeSecurityIds values in order to create a new Device:

INSERT INTO Devices (deviceId, accountEnabled, displayName, operatingSystem, operatingSystemVersion, alternativeSecurityIds) VALUES ('4c299165-6e8f-4b45-a5ba-c5d250a707ff', false, 'JustinBTest', 'Windows', '15.1', '[{"type":2,"key":"101010101011"}]')

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'

Columns

Name	Type	ReadOnly	Description
id [KEY]	String	False	The unique identifier assigned to the device within Azure Active Directory.
deletedDateTime	Datetime	False	The date and time when the device was deleted, useful for tracking device lifecycle.
accountEnabled	Bool	False	Indicates whether the device's account is active and can be used for authentication.
alternativeSecurityIds	String	False	Alternate security identifiers associated with the device, used for authentication and management.
approximateLastSignInDateTime	Datetime	False	The estimated date and time of the device's most recent sign-in, useful for activity monitoring.
complianceExpirationDateTime	Datetime	False	The date and time when the device's compliance status is set to expire.
deviceCategory	String	False	The category assigned to the device, which can help with organization and policy application.
deviceId	String	False	The unique identifier for the device, often used for internal tracking and management.
deviceMetadata	String	False	Metadata associated with the device, containing additional contextual information.
deviceOwnership	String	False	Specifies whether the device is corporate-owned or personally owned, useful for applying policies.
deviceVersion	Int	False	The version number of the device, often used for managing updates and compatibility.
displayName	String	False	The user-friendly name assigned to the device for easier identification.
enrollmentProfileName	String	False	The name of the enrollment profile used to onboard the device into management.
isCompliant	Bool	False	Indicates whether the device meets the organization's compliance requirements.
isManaged	Bool	False	Indicates whether the device is being managed by the organization's IT policies.
isManagementRestricted	Bool	False	Specifies if the device has restrictions preventing certain management actions.
mdmAppId	String	False	The unique identifier of the Mobile Device Management (MDM) application associated with the device.
onPremisesLastSyncDateTime	Datetime	False	The last date and time when the device was synced with on-premises systems.
onPremisesSecurityIdentifier	String	False	The security identifier (SID) assigned to the device in on-premises systems.
onPremisesSyncEnabled	Bool	False	Indicates whether the device is enabled for synchronization with on-premises systems.
operatingSystem	String	False	The name of the operating system running on the device.
operatingSystemVersion	String	False	The version of the operating system running on the device.
physicalIds	String	False	A list of physical identifiers for the device, often used for inventory tracking.
profileType	String	False	The type of profile assigned to the device, determining its role and policies.
registrationDateTime	Datetime	False	The date and time when the device was registered in Azure Active Directory.
systemLabels	String	False	Labels assigned to the device, often used for grouping and applying policies.
trustType	String	False	The type of trust relationship established between the device and Azure Active Directory.

Displays all domains registered and verified within the organization, along with their configurations.

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 Domains (Id) 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 unique identifier of the domain, used to reference it in the directory.
authenticationType	String	False	Specifies whether the type of authentication supported by the domain, such as 'Managed' or 'Federated'.
availabilityStatus	String	False	Indicates whether the domain is available and properly configured within Azure Active Directory.
isAdminManaged	Bool	False	Indicates whether the domain is managed and controlled by an administrator.
isDefault	Bool	False	Specifies whether the domain is set as the default domain for the directory.
isInitial	Bool	False	Shows whether the domain was the initial domain created for the directory.
isRoot	Bool	False	Denotes whether the domain is a root domain within the directory hierarchy.
isVerified	Bool	False	Indicates whether the domain has been verified with Azure Active Directory.
passwordNotificationWindowInDays	Int	False	The number of days before password expiration when a notification is sent to users.
passwordValidityPeriodInDays	Int	False	The duration, in days, for which passwords associated with the domain remain valid.
state_lastActionDateTime	Datetime	False	The timestamp of the last action performed on the domain's state.
state_operation	String	False	Describes the most recent operation performed on the domain's state, such as 'Verify' or 'Update'.
state_status	String	False	The current status of the domain's state operation, such as 'InProgress', 'Completed', or 'Failed'.
supportedServices	String	False	A list of services supported by the domain, such as Exchange or SharePoint.

Lists all Azure AD groups, including Office 365 and security groups, accessible to the authenticated user.

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 Azure AD アプリケーションの作成 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 unique identifier for the group within Azure Active Directory.
deletedDateTime	Datetime	False	The date and time when the group was deleted, if applicable.
allowExternalSenders	Bool	False	Indicates whether the group allows emails from external senders.
assignedLabels	String	False	A collection of labels assigned to the group, often used for categorization or compliance.
assignedLicenses	String	False	A list of licenses that have been assigned to the group for service access.
autoSubscribeNewMembers	Bool	False	Indicates whether new members are automatically subscribed to group notifications.
classification	String	False	The classification assigned to the group, typically used for compliance or organizational purposes.
createdDateTime	Datetime	False	The date and time when the group was created in Azure Active Directory.
description	String	False	A brief description or summary of the group, providing context about its purpose or function.
displayName	String	False	The user-friendly name of the group, as shown in the Azure portal and directory.
expirationDateTime	Datetime	False	The date and time when the group is scheduled to expire, if applicable.
groupTypes	String	False	A list of group types, such as 'Unified' or 'Security', that define the group's functionality.
hasMembersWithLicenseErrors	Bool	False	Indicates if any group members have errors related to license assignments.
hideFromAddressLists	Bool	False	Specifies whether the group is hidden from address lists in the directory.
hideFromOutlookClients	Bool	False	Specifies whether the group is hidden from visibility in Outlook clients.
isArchived	Bool	False	Indicates if the group has been archived, meaning it is no longer active but retained for records.
isAssignableToRole	Bool	False	Indicates if the group can be assigned to Azure roles or permissions.
isManagementRestricted	Bool	False	Indicates whether management operations on the group are restricted.
isSubscribedByMail	Bool	False	Indicates if members of the group are subscribed to email notifications.
licenseProcessingState	String	False	The current processing state of the group's licenses, such as 'Enabled' or 'Disabled'.
mail	String	False	The primary email address associated with the group.
mailEnabled	Bool	False	Indicates if the group is configured to send and receive emails.
mailNickname	String	False	The alias for the group's email address, used as a shorthand identifier.
membershipRule	String	False	The rule that defines the criteria for group membership, typically for dynamic groups.
membershipRuleProcessingState	String	False	The current state of processing the membership rule, such as 'NotStarted' or 'Running'.
onPremisesDomainName	String	False	The domain name associated with the group for on-premises synchronization.
onPremisesLastSyncDateTime	Datetime	False	The date and time when the group was last synced with on-premises Active Directory.
onPremisesProvisioningErrors	String	False	Details about any provisioning errors encountered during on-premises synchronization.
onPremisesSamAccountName	String	False	The Security Account Manager (SAM) account name associated with the group for on-premises Active Directory.
onPremisesSecurityIdentifier	String	False	The security identifier (SID) of the group for on-premises synchronization.
onPremisesSyncEnabled	Bool	False	Indicates if the group is configured for synchronization with on-premises Active Directory.
preferredDataLocation	String	False	The preferred geographic location for the group's data, such as 'US' or 'Europe'.
preferredLanguage	String	False	The default language for the group, used for communications and notifications.
proxyAddresses	String	False	A collection of proxy addresses assigned to the group, used for email routing.
renewedDateTime	Datetime	False	The most recent date and time when the group was renewed, if applicable.
securityEnabled	Bool	False	Indicates if the group is a security-enabled group, allowing it to be used for access control.
securityIdentifier	String	False	The security identifier (SID) of the group in Azure Active Directory.
serviceProvisioningErrors	String	False	Details about any errors encountered during service provisioning for the group.
theme	String	False	The theme associated with the group, often used for branding or categorization.
unseenCount	Int	False	The number of items, such as notifications or messages, that remain unseen by the group.
visibility	String	False	The visibility level of the group, such as 'Public', 'Private', or 'HiddenMembership'.

Lists all Azure AD users, including their profile and directory information, 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'

Note: when querying the Users table with an asterik (*), only the default columns will be returned. (i.e. businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, userPrincipalName)

To get the data for extra columns in the Users table, you must provide them in the query. For example:

SELECT id, department, officeLocation, state, displayName, mail FROM Users

Insert

The following are required to create a new organizational User:

INSERT INTO Users (AccountEnabled, DisplayName, MailNickname, UserPrincipalName, PasswordProfile_ForceChangePasswordNextSignIn, PasswordProfile_Password) VALUES (false, 'John Smith', 'JohnS', '[email protected]', true, '123password')

Update

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

UPDATE Users SET JobTitle = 'New Job Title' WHERE Id = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'

Delete

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

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

GetDeleted

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

GETDELETED FROM Users

Columns

Name	Type	ReadOnly	Description
Manager_Id	String	False	The unique identifier assigned to the manager of the user.
Manager_DisplayName	String	False	The display name of the user's manager, typically used for display purposes.
id [KEY]	String	False	The unique identifier of the user within the directory.
deletedDateTime	Datetime	False	The timestamp indicating when the user was deleted from the directory.
accountEnabled	Bool	False	A flag indicating whether the user's account is currently active.
assignedLicenses	String	False	A list of licenses assigned to the user, detailing their access to specific services.
businessPhones	String	False	The business phone numbers associated with the user.
city	String	False	The city specified in the user's profile.
companyName	String	False	The name of the company associated with the user.
country	String	False	The country or region where the user resides.
createdDateTime	Datetime	False	The date and time when the user account was created.
department	String	False	The department in which the user works.
displayName	String	False	The user's full name, commonly displayed in user interfaces.
employeeHireDate	Datetime	False	The date the user was hired by the organization.
employeeId	String	False	The unique employee ID assigned to the user by the organization.
employeeOrgData_costCenter	String	False	The cost center associated with the user's organizational data.
employeeOrgData_division	String	False	The division of the organization to which the user belongs.
employeeType	String	False	The employment type of the user, such as 'Full-Time' or 'Contractor'.
givenName	String	False	The user's first name or given name.
identities	String	False	A list of identity providers and identifiers associated with the user.
imAddresses	String	False	The instant messaging addresses associated with the user.
isManagementRestricted	Bool	False	Indicates whether the user has restrictions due to management policies.
isResourceAccount	Bool	False	Specifies if the user account is designated as a resource account.
jobTitle	String	False	The user's job title within the organization.
lastPasswordChangeDateTime	Datetime	False	The timestamp of the user's last password change.
mail	String	False	The primary email address of the user.
mailNickname	String	False	The mail alias or nickname for the user.
mobilePhone	String	False	The user's mobile phone number.
officeLocation	String	False	The location of the user's office, typically a building or room number.
onPremisesDistinguishedName	String	False	The distinguished name of the user in the on-premises directory.
onPremisesDomainName	String	False	The domain name associated with the user in the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute1	String	False	Custom extension attribute 1 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute10	String	False	Custom extension attribute 10 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute11	String	False	Custom extension attribute 11 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute12	String	False	Custom extension attribute 12 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute13	String	False	Custom extension attribute 13 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute14	String	False	Custom extension attribute 14 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute15	String	False	Custom extension attribute 15 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute2	String	False	Custom extension attribute 2 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute3	String	False	Custom extension attribute 3 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute4	String	False	Custom extension attribute 4 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute5	String	False	Custom extension attribute 5 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute6	String	False	Custom extension attribute 6 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute7	String	False	Custom extension attribute 7 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute8	String	False	Custom extension attribute 8 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute9	String	False	Custom extension attribute 9 defined in the on-premises directory for the user.
onPremisesImmutableId	String	False	The immutable identifier assigned to the user in the on-premises directory.
onPremisesLastSyncDateTime	Datetime	False	The timestamp of the user's last synchronization with the on-premises directory.
onPremisesProvisioningErrors	String	False	Details of provisioning errors encountered during synchronization.
onPremisesSamAccountName	String	False	The Security Account Manager (SAM) account name of the user in the on-premises directory.
onPremisesSecurityIdentifier	String	False	The unique security identifier (SID) of the user in the on-premises directory.
onPremisesSyncEnabled	Bool	False	A flag indicating whether synchronization with the on-premises directory is enabled.
onPremisesUserPrincipalName	String	False	The User Principal Name (UPN) of the user in the on-premises directory.
otherMails	String	False	Additional email addresses associated with the user.
passwordProfile_forceChangePasswordNextSignIn	Bool	False	Indicates whether the user is required to change their password at the next sign-in.
passwordProfile_forceChangePasswordNextSignInWithMfa	Bool	False	Indicates if the user must change their password and complete MFA at the next sign-in.
passwordProfile_password	String	False	The password profile configured for the user account.
postalCode	String	False	The postal code of the user's address.
preferredLanguage	String	False	The language preference specified by the user.
serviceProvisioningErrors	String	False	Details of errors encountered during service provisioning.
state	String	False	The state or province of the user's address.
streetAddress	String	False	The street address of the user.
surname	String	False	The last name or surname of the user.
userPrincipalName	String	False	The unique UPN of the user within the directory, often used for authentication.
userType	String	False	The type of user, such as 'Member' or 'Guest'.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Azure Active Directory Connector for CData Sync Views

Name	Description
AdministrativeUnitMembers	Lists all members of administrative units available to the authenticated user, providing details on their membership relationships.
AdministrativeUnits	Displays a comprehensive list of administrative units accessible to the authenticated user, enabling management of organizational structure.
Contacts	Provides access to the organizational contact list, including external and internal contact details.
Contracts	Presents all active contracts for the authenticated user, detailing subscription and agreement terms.
DeviceLocalCredentials	Offers information on local administrator account credentials for specific device objects.
DeviceRegisteredOwners	Maps device objects to their registered owners for tracking and management purposes.
DeviceRegisteredUsers	Associates device objects with their registered users, facilitating detailed user-device relationship analysis.
DirectoryAudits	Tracks and lists all directory audit events accessible to the authenticated user for compliance and monitoring.
DirectoryRoleMembers	Identifies the members assigned to specific directory roles within the Azure AD environment.
DirectoryRoles	Contains a list of directory roles, detailing roles assigned to users and groups within the organization.
DirectoryRoleTemplates	Offers a template view of all directory roles available for use within Azure AD.
GroupApplicationRoleAssignments	Tracks application role assignments assigned to specific groups for managing permissions.
GroupMembers	Provides a detailed view of group memberships, listing all members of each group within the organization.
Organization	Contains metadata and details about the organization accessible to the authenticated user.
PhoneAuthenticationMethods	Lists phone-based authentication methods configured for users within the organization.
ProfileCardProperties	Retrieves custom properties displayed on user profile cards within the organization.
RoleAssignments	Displays all role assignments configured within the Azure AD environment.
RoleDefinitions	Provides definitions for roles available in Azure AD, detailing their permissions and scope.
SignIns	Tracks and lists all user sign-in activities for audit and monitoring purposes.
SubscribedSKUs	Lists service subscriptions (SKUs) the organization is subscribed to, including details of usage and availability.
UserApplicationRoleAssignments	Tracks application role assignments assigned to specific users for managing access and permissions.
UserManagers	Maps users to their assigned managers within the organization for reporting and hierarchy management.
UserMemberships	Provides details of group and directory role memberships for specific users within the organization.

Lists all members of administrative units available to the authenticated user, providing details on their membership relationships.

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 unique identifier of the administrative unit, representing an Azure Active Directory organizational unit.
MemberId [KEY]	String	The unique identifier of the user or group that is a member of the specified administrative unit.

Displays a comprehensive list of administrative units accessible to the authenticated user, enabling management of organizational structure.

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	A unique identifier for the administrative unit, used to differentiate it from other units within the directory.
deletedDateTime	Datetime	The timestamp indicating when the administrative unit was deleted. It is null if the unit has not been deleted.
description	String	A brief text providing details about the purpose or characteristics of the administrative unit.
displayName	String	The user-friendly name of the administrative unit, intended for easy identification.
isMemberManagementRestricted	Bool	Specifies whether member management within this administrative unit is restricted to specific roles or users.
visibility	String	Defines the visibility level of the administrative unit, such as whether it is publicly discoverable or restricted to internal use.

Provides access to the organizational contact list, including external and internal contact details.

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 unique identifier for the organizational contact, used for tracking and referencing.
deletedDateTime	Datetime	The timestamp indicating when the contact was deleted, if applicable.
addresses	String	A list of physical or postal addresses associated with the organizational contact.
companyName	String	The name of the company that the organizational contact is associated with.
department	String	The department within the company where the organizational contact works.
displayName	String	The full display name of the organizational contact, typically used in directories.
givenName	String	The first name or given name of the organizational contact.
jobTitle	String	The professional title or role of the organizational contact within the organization.
mail	String	The primary email address of the organizational contact.
mailNickname	String	An alias or nickname used for the contact's email.
onPremisesLastSyncDateTime	Datetime	The last recorded timestamp when the contact was synchronized with on-premises systems.
onPremisesProvisioningErrors	String	Details of any errors encountered during the provisioning of the contact on-premises.
onPremisesSyncEnabled	Bool	Indicates whether the contact is enabled for synchronization with on-premises systems.
phones	String	A list of phone numbers associated with the organizational contact.
proxyAddresses	String	Secondary email addresses or aliases associated with the organizational contact.
surname	String	The last name or family name of the organizational contact.

Presents all active contracts for the authenticated user, detailing subscription and agreement terms.

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 unique identifier for the contract, used to distinguish it from other records.
deletedDateTime	Datetime	The date and time when the contract was marked as deleted, indicating it is no longer active.
contractType	String	Specifies the type or category of the contract, such as subscription or licensing agreement.
customerId	String	The unique identifier of the customer associated with the contract.
defaultDomainName	String	The default domain name linked to the contract, typically used for customer authentication or services.
displayName	String	The user-friendly name or title assigned to the contract for easy identification.

Offers information on local administrator account credentials for specific device objects.

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 DeviceLocalCredentials WHERE Id = '2183313c-ac52-4772-8482-7b2eb2a5d7c9_LBZWQ_311068785'
SELECT * FROM DeviceLocalCredentials WHERE Id IN ('2183313c-ac52-4772-8482-7b2eb2a5d7c9_LBZWQ_311068785')
SELECT * FROM DeviceLocalCredentials WHERE DeviceName LIKE '%Desktop%'

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the device's local credentials, used for secure identification.
credentials	String	Encrypted or hashed representation of the device's local credentials used for authentication or access.
deviceName	String	The name assigned to the device, often used for identification or management purposes.
lastBackupDateTime	Datetime	The timestamp indicating when the device's credentials were last successfully backed up.
refreshDateTime	Datetime	The timestamp indicating the next scheduled refresh or expiration of the device's credentials.

Maps device objects to their registered owners for tracking and management purposes.

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 unique identifier for the device, used to reference the specific registered device in Azure Active Directory.
OwnerId [KEY]	String	The unique identifier for the user who owns the device, linking the device to its respective owner in Azure Active Directory.

Associates device objects with their registered users, facilitating detailed user-device relationship analysis.

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 unique identifier assigned to each device registered in Azure Active Directory, used to track and manage devices.
UserId [KEY]	String	The unique identifier of the user associated with the registered device, enabling user-to-device relationship tracking.

Tracks and lists all directory audit events accessible to the authenticated user for compliance and monitoring.

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 unique identifier for the DirectoryAudit entry, used to distinguish each audit record.
activityDateTime	Datetime	The date and time when the activity occurred, recorded in UTC.
activityDisplayName	String	The name of the activity or operation that was logged in the DirectoryAudit.
additionalDetails	String	Additional information or metadata about the activity, providing context or supplementary data.
category	String	The category of the activity, indicating the type of event (for example, user management, application management).
correlationId	String	The unique identifier for correlating this activity with related events across services.
initiatedBy_app_appid	String	The unique identifier of the application that initiated the activity, if applicable.
initiatedBy_app_displayName	String	The display name of the application that initiated the activity, providing a user-friendly identifier.
initiatedBy_app_servicePrincipalId	String	The service principal ID of the application that initiated the activity, used for authentication and authorization.
initiatedBy_app_servicePrincipalName	String	The service principal name of the application that initiated the activity, giving additional context about the app.
loggedByService	String	The name of the Azure service that logged this DirectoryAudit entry.
operationType	String	The type of operation performed (for example, CREATE, UPDATE, DELETE), providing high-level information about the activity.
result	String	The outcome of the activity, such as success or failure.
resultReason	String	The reason for the activity's result, offering details about any errors or issues encountered.
targetResources	String	Details about the resources targeted by this activity, including resource type and identifier.

Identifies the members assigned to specific directory roles within the Azure AD environment.

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 unique identifier for the directory role to which the user belongs. This value is used to associate a role with its members.
UserId [KEY]	String	The unique identifier for the user who is a member of the specified directory role. This value links the user to the role they belong to.

Contains a list of directory roles, detailing roles assigned to users and groups within 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 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 unique identifier for the directory role, used to differentiate it from other roles.
deletedDateTime	Datetime	The timestamp indicating when the directory role was deleted, or null if it has not been deleted.
description	String	A detailed explanation of the directory role's purpose and functionality.
displayName	String	The human-readable name of the directory role, typically used in user interfaces.
roleTemplateId	String	The unique identifier for the template that defines the permissions and structure of this directory role.

Offers a template view of all directory roles available for use within 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 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 unique identifier for the directory role template, typically used as the primary key.
deletedDateTime	Datetime	The timestamp indicating when the directory role template was deleted, useful for auditing and recovery.
description	String	A detailed explanation or notes about the purpose and scope of the directory role template.
displayName	String	The human-readable name of the directory role template, used for display in user interfaces.

Tracks application role assignments assigned to specific groups for managing permissions.

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 unique identifier for the group associated with the application role assignment.
id [KEY]	String	The unique identifier for the application role assignment.
appRoleId	String	The unique identifier of the specific application role being assigned to the group.
createdDateTime	Datetime	The date and time when the application role assignment was created.
principalDisplayName	String	The display name of the principal (for example, user, group, or service principal) involved in the role assignment.
principalId	String	The unique identifier of the principal (for example, user, group, or service principal) associated with the role assignment.
principalType	String	The type of the principal (for example, user, group, or service principal) involved in the role assignment.
resourceDisplayName	String	The display name of the resource (for example, application or service) associated with the role assignment.
resourceId	String	The unique identifier of the resource (for example, application or service) to which the role assignment applies.

Provides a detailed view of group memberships, listing all members of each group within the organization.

Table Specific Information

Select

Query the GroupMembers table by retrieving everything from Azure AD or by specifying the 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 unique identifier of the group, representing a specific collection of users or entities in Azure Active Directory.
MemberId [KEY]	String	The unique identifier of a user or entity that belongs to the specified group in Azure Active Directory.

Contains metadata and details about the organization accessible to the authenticated user.

Table Specific Information

Select

SELECT * FROM Organization

Update

To update an Organization record you need to specify the Id in WHERE clause.

Update Organization set marketingNotificationEmails = '[email protected]' where Id = 'bf6e4267-a9fb-419b-ae7b-7586fab0ff66'

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the organization.
deletedDateTime	Datetime	The timestamp when the organization was marked as deleted, useful for auditing purposes.
assignedPlans	String	A list of plans assigned to the organization, detailing available services or subscriptions.
businessPhones	String	Contact phone numbers associated with the organization for business purposes.
city	String	The city where the organization's primary office is located.
country	String	The country where the organization is registered or primarily operates.
countryLetterCode	String	The ISO 3166-1 alpha-2 country code representing the organization's country.
createdDateTime	Datetime	The timestamp when the organization was first created in the system.
defaultUsageLocation	String	Default location code indicating where the organization primarily consumes services.
displayName	String	The human-readable name of the organization, often used for display purposes.
marketingNotificationEmails	String	Email addresses for receiving marketing-related communications from the system.
mobileDeviceManagementAuthority	String	Specifies the authority responsible for managing the organization's mobile devices, such as Intune.
onPremisesLastPasswordSyncDateTime	Datetime	The timestamp of the last successful password synchronization with on-premises systems.
onPremisesLastSyncDateTime	Datetime	The timestamp of the last directory synchronization with on-premises systems.
onPremisesSyncEnabled	Bool	Indicates whether synchronization with on-premises directories is enabled for the organization.
partnerTenantType	String	The type of tenant partnership, such as reseller or customer.
postalCode	String	The postal code of the organization's primary address.
preferredLanguage	String	The preferred language for communications and system interactions with the organization.
privacyProfile_contactEmail	String	The contact email address listed in the organization's privacy profile for data protection inquiries.
privacyProfile_statementUrl	String	The URL of the organization's privacy statement, outlining data protection policies.
provisionedPlans	String	A list of plans that have been provisioned for the organization, detailing available services.
securityComplianceNotificationMails	String	Email addresses for receiving security and compliance-related notifications.
securityComplianceNotificationPhones	String	Phone numbers for receiving security and compliance-related notifications.
state	String	The state or province where the organization's primary office is located.
street	String	The street address of the organization's primary office.
technicalNotificationMails	String	Email addresses for receiving technical alerts and system notifications.
tenantType	String	The type of tenant, such as educational or business.
verifiedDomains	String	A list of domains verified for use by the organization in the system.

Lists phone-based authentication methods configured for users within the organization.

Columns

Name	Type	Description
UserId [KEY]	String	The unique identifier for the user, representing their Azure Active Directory account.
id	String	The unique identifier for the phone authentication method associated with the user.
phoneNumber	String	The phone number registered for the user's authentication, formatted in international standard (E.164).
phoneType	String	The type of phone used for authentication, such as mobile, office, or home.
smsSignInState	String	Indicates the current state of Systems Management Server (SMS) sign-in for the user, such as enabled, disabled, or pending.

Retrieves custom properties displayed on user profile cards within the organization.

Table Specific Information

Select

SELECT * FROM ProfileCardProperties

Columns

Name	Type	Description
directoryPropertyName	String	Specifies the name of the directory property used in the Profile Card for identifying user attributes or details.
annotations	String	Provides additional metadata or notes about the directory property within the Profile Card for enhanced configurability.

Displays all role assignments configured within the Azure AD environment.

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 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 unique identifier for the role assignment, used to distinguish it within the system.
condition	String	Specifies the condition under which the role assignment is applicable, often used for conditional access scenarios.
roleDefinitionId	String	The unique identifier of the role definition linked to this assignment, defining the permissions granted.
principalId	String	The unique identifier of the principal (user, group, or service principal) assigned this role.
directoryScopeId	String	The unique identifier for the directory scope in which this role assignment is effective, such as a specific Azure AD object or resource.
appScopeId	String	The unique identifier for the application scope of the role assignment, typically used for application-specific roles.

Provides definitions for roles available in Azure AD, detailing their permissions and scope.

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 unique identifier for the role definition within Azure Active Directory.
allowedPrincipalTypes	String	Specifies the types of principals (for example, users, groups, applications) that can be assigned to this role.
description	String	A detailed explanation of the role definition's purpose and functionality.
displayName	String	The user-friendly name of the role definition, typically used for display in the Azure portal.
isBuiltIn	Bool	Indicates whether this role definition is prebuilt and provided by Azure (true) or custom-created (false).
isEnabled	Bool	Specifies if the role definition is currently active and available for assignments.
isPrivileged	Bool	Highlights whether this role definition includes privileged or high-impact permissions.
resourceScopes	String	Defines the set of resources or scopes (for example, subscriptions, resource groups) where the role applies.
rolePermissions	String	Lists the permissions and actions that this role grants within the defined resource scopes.
templateId	String	The unique identifier used for associating the role definition with a predefined template in Azure.
version	String	The version of the role definition, useful for tracking updates or changes.

Tracks and lists all user sign-in activities for audit and monitoring purposes.

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	Unique identifier for the sign-in entry.
appDisplayName	String	The display name of the application involved in the sign-in event.
appId	String	The unique identifier (client ID) of the application involved in the sign-in event.
appliedConditionalAccessPolicies	String	List of conditional access policies applied during the sign-in event.
clientAppUsed	String	The type of client application (for example, browser, mobile app) used during the sign-in event.
conditionalAccessStatus	String	The status of the conditional access policy evaluation during the sign-in event (for example, success, failure).
correlationId	String	The unique identifier to correlate this sign-in event with related events for troubleshooting.
createdDateTime	Datetime	The date and time when the sign-in event occurred.
deviceDetail_browser	String	The browser used on the device during the sign-in event.
deviceDetail_deviceId	String	The unique identifier of the device used during the sign-in event.
deviceDetail_displayName	String	The display name of the device used during the sign-in event.
deviceDetail_isCompliant	Bool	Indicates whether the device used during the sign-in event complies with organizational policies.
deviceDetail_isManaged	Bool	Indicates whether the device used during the sign-in event is managed by the organization.
deviceDetail_operatingSystem	String	The operating system of the device used during the sign-in event.
deviceDetail_trustType	String	The trust type of the device (for example, Azure AD joined, hybrid Azure AD joined).
ipAddress	String	The IP address of the client device used during the sign-in event.
isInteractive	Bool	Indicates whether the sign-in was initiated interactively by the user.
signInLocation_city	String	The city where the sign-in event originated.
signInLocation_countryOrRegion	String	The country or region where the sign-in event originated.
signInLocation_state	String	The state or province where the sign-in event originated.
resourceDisplayName	String	The display name of the resource accessed during the sign-in event.
resourceId	String	The unique identifier of the resource accessed during the sign-in event.
riskDetail	String	Details about the risk assessment associated with the sign-in event.
riskEventTypes	String	The types of risk events detected during the sign-in event.
riskEventTypes_v2	String	A more detailed list of risk events detected during the sign-in event, using an updated schema.
riskLevelAggregated	String	The aggregated risk level for the sign-in event (for example, low, medium, high).
riskLevelDuringSignIn	String	The assessed risk level during the sign-in event (for example, low, medium, high).
riskState	String	The current state of the detected risk (for example, confirmed, dismissed).
signInStatus_additionalDetails	String	Additional details about the sign-in status, if available.
signInStatus_errorCode	Int	The error code returned for a failed sign-in attempt, if applicable.
signInStatus_failureReason	String	A descriptive reason for the failure of the sign-in event, if applicable.
userDisplayName	String	The display name of the user who performed the sign-in.
userId	String	The unique identifier of the user who performed the sign-in.
userPrincipalName	String	The user principal name (UPN) of the user who performed the sign-in, typically in email format.

Lists service subscriptions (SKUs) the organization is subscribed to, including details of usage and availability.

Table Specific Information

Select

SELECT * FROM SubscribedSKUs

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the subscribed SKU.
accountId	String	The unique identifier for the account associated with the subscribed SKU.
accountName	String	The name of the account associated with the subscribed SKU.
appliesTo	String	Specifies the target audience or entity the subscribed SKU applies to.
capabilityStatus	String	The current status of the capabilities enabled by the subscribed SKU (for example, active, disabled).
consumedUnits	Int	The number of units from the subscription that have been consumed.
prepaidUnits_enabled	Int	The number of prepaid units currently enabled and available for use.
prepaidUnits_lockedOut	Int	The number of prepaid units that are locked out and cannot be used.
prepaidUnits_suspended	Int	The number of prepaid units that are suspended and temporarily unavailable.
prepaidUnits_warning	Int	The number of prepaid units with warning status, potentially indicating issues.
servicePlans	String	The service plans included in the subscribed SKU, listed as a string.
skuId	String	The unique identifier for the Stock Keeping Unit (SKU).
skuPartNumber	String	The part number associated with the SKU, often used for tracking and purchasing.
subscriptionIds	String	A list of subscription IDs tied to the subscribed SKU.

Tracks application role assignments assigned to specific users for managing access and permissions.

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 unique identifier for the user assigned to the application role.
id [KEY]	String	The unique identifier for this specific application role assignment.
appRoleId	String	The unique identifier of the application role associated with the assignment.
createdDateTime	Datetime	The date and time when this application role assignment was created, in ISO 8601 format.
principalDisplayName	String	The display name of the principal (for example, user, group, or service principal) assigned the application role.
principalId	String	The unique identifier of the principal (for example, user, group, or service principal) associated with this role assignment.
principalType	String	The type of principal (for example, user, group, or service principal) associated with the role assignment.
resourceDisplayName	String	The display name of the target resource (for example, application or service) for the role assignment.
resourceId	String	The unique identifier of the target resource (for example, application or service) associated with the role assignment.

Maps users to their assigned managers within the organization for reporting and hierarchy management.

Table Specific Information

Select

Get the manager of users 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 UserManagers WHERE UserId = 'ffacf701-6caf-4228-9e3b-7e57c14122ee'

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

Columns

Name	Type	Description
UserId [KEY]	String	The unique identifier for the user associated with the manager.
ManagerId [KEY]	String	The unique identifier for the manager overseeing the user.
displayName	String	The full display name of the manager, typically used for identification in user interfaces.
jobTitle	String	The professional job title of the manager, indicating their role or position within the organization.
mail	String	The primary email address of the manager, used for communication purposes.
userPrincipalName	String	The principal username of the manager, typically formatted as an email address and used for sign-in.

Provides details of group and directory role memberships for specific users within the organization.

Table Specific Information

Select

Get the memberships of users 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 UserMemberships WHERE UserId = 'ffacf701-6caf-4228-9e3b-7e57c14122ee'

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

Columns

Name	Type	Description
UserId [KEY]	String	The unique identifier for the user associated with this membership.
MembershipId [KEY]	String	The unique identifier for the membership entry.
classification	String	The classification label used to organize or categorize the membership.
createdDateTime	Datetime	The timestamp indicating when the membership was created.
creationOptions	String	Options or parameters specified during the creation of the membership.
deletedDateTime	Datetime	The timestamp indicating when the membership was deleted, if applicable.
description	String	A descriptive label or summary for the membership entry.
displayName	String	The human-readable name of the membership used for display purposes.
expirationDateTime	Datetime	The timestamp when the membership is set to expire, if applicable.
groupTypes	String	The types of groups the membership belongs to, such as 'Unified' or 'Dynamic'.
isAssignableToRole	Bool	Indicates whether this membership can be assigned to a role.
mail	String	The email address associated with the membership, if applicable.
mailEnabled	Bool	Indicates whether the membership has an active email mailbox.
mailNickname	String	The email alias or nickname associated with the membership.
membershipRule	String	The rules governing dynamic membership conditions for this group.
membershipRuleProcessingState	String	The current state of processing for the dynamic membership rules.
onPremisesDomainName	String	The domain name for the membership, synced from on-premises directories.
onPremisesLastSyncDateTime	Datetime	The timestamp of the last synchronization with the on-premises directory.
onPremisesNetBiosName	String	The NetBIOS name for the membership from the on-premises directory.
onPremisesProvisioningErrors	String	Details of any provisioning errors encountered during an on-premises synchronization.
onPremisesSamAccountName	String	The Security Account Manager (SAM) account name for the membership.
onPremisesSecurityIdentifier	String	The unique security identifier (SID) for the membership from the on-premises directory.
onPremisesSyncEnabled	Bool	Indicates whether synchronization with the on-premises directory is enabled.
preferredDataLocation	String	The preferred geographic location for storing the membership's data.
preferredLanguage	String	The preferred language setting for the membership.
proxyAddresses	String	A list of proxy addresses associated with the membership.
renewedDateTime	Datetime	The timestamp of the most recent renewal of the membership.
resourceBehaviorOptions	String	Behavioral options or settings applied to resources linked to the membership.
resourceProvisioningOptions	String	Provisioning options for resources tied to the membership.
securityEnabled	Bool	Indicates whether the membership has security features enabled.
securityIdentifier	String	The unique security identifier (SID) for the membership.
serviceProvisioningErrors	String	Details of any errors during service provisioning for the membership.
theme	String	The visual theme or branding applied to the membership.
uniqueName	String	A system-generated unique name for the membership.
visibility	String	The visibility setting of the membership, such as 'Public' or 'Private'.

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	データにアクセスするために使用されるAzure Active Directory テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）
AzureEnvironment	接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

OAuth

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthGrantType	選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

JWT OAuth

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

SSL

---

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

Firewall

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
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	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

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

---

プロパティ	説明
AuthScheme	Azure Active Directory に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。

Azure Active Directory に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。

解説

• AzureAD：Azure Active Directory（ユーザーベース）のOAuth 認証を実行します。
• AzureMSI：Azure VM で実行している際に、Azure AD マネージドサービスID の資格情報を自動的に取得します。
• AzureServicePrincipal：クライアントシークレットを使用してAzure サービスプリンシパル（ロールベース、アプリケーションベース）として認証します。
• AzureServicePrincipalCert：証明書を使用してAzure サービスプリンシパル（ロールベース、アプリケーションベース）として認証します。

Azure AD で認証するためのカスタムアプリケーションの作成方法については、Azure AD アプリケーションの作成 を参照してください。

Azure AD サービスプリンシパルで認証するためのカスタムアプリケーションの作成方法については、サービスプリンシパルによるAzure AD アプリの作成 を参照してください。

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

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるAzure Active Directory テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）
AzureEnvironment	接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

データにアクセスするために使用されるAzure Active Directory テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）

解説

テナントは、主にドメイン（例えば、microsoft.com）に関連付けられた、組織のデジタル表現です。 テナントは、Tenant ID（ディレクトリID とも呼ばれる）によって管理されます。これは、Azure リソースへのアクセスや管理権限をユーザーに割り当てる際に指定します。

Azure ポータルでディレクトリID を見つけるには、Azure Active Directory -> プロパティに移動します。

AuthScheme = AzureServicePrincipal またはAzureServicePrincipalCert のいずれかである場合、またはAzureTenant = AzureAD であり、ユーザーが複数のテナントに属している場合は、AzureTenant を指定する必要があります。

接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

解説

Azure アカウントがGlobal ネットワークとは異なるネットワーク（China、USGOVT、USGOVTDOD など）の一部である場合は、必要です。

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

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthGrantType	選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

解説

ほとんどの場合、デフォルトのグラント種別は変更すべきではありません。 最も一般的なOAuth グラント種別とそれぞれのメリット・デメリットについては、https://oauth.net/2/grant-types/ を参照してください。

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

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

JWT 証明書のストア。

解説

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

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

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

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

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

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

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

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

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 形式の証明書を含む文字列の名前です。
BCFKSFILE	この証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOB	この証明書ストアは、Bouncy Castle キーストアを含む文字列（Base-64エンコード）です。

OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

解説

このプロパティは、証明書ストアを開くために必要なパスワードを指定します。ただし、ストアの種類がパスワードを必要とする場合に限ります。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

解説

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

• サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
• 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
• 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例：CN=www.server.com, OU=test, C=US, [email protected]。一般的なフィールドには以下のものが含まれます。

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

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例："O=ACME, Inc."。

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

---

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

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 プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がAzure Active Directory への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がAzure Active Directory への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がAzure Active Directory にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

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

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

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

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

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

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

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

• BASIC：Sync App はHTTP BASIC 認証を行います。
• DIGEST：Sync App はHTTP DIGEST 認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

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

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

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

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

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

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

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

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

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

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

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

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

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

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。

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

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

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

プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

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

---

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

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

統合およびフォーマット

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

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

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

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビュー を参照してください。