CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるAzure Active Directory へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してAzure Active Directory に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Azure Active Directory への接続を標準化し、構成することができます。
このページでは、CData Cloud でのAzure Active Directory への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのAzure Active Directory への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してAzure Active Directory からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Azure Active Directory に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
Azure サービスプリンシパルは、ロールに基づいたアプリケーションベースの認証です。これは、認証がユーザーごとではなく、アプリケーションごとに行われることを意味します。 アプリケーションで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで、割り当てられたロールに基づいて実行されます。 リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。
Azure サービスプリンシパル認証の設定方法については、カスタムOAuth アプリケーションの作成 を参照してください。
Azure VM 上でAzure Active Directory を実行しており、MSI を利用して接続したい場合は、AuthScheme をAzureMSI に設定します。
VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。
Azure サービスプリンシパルは、ロールに基づいたアプリケーションベースの認証です。これは、認証がユーザーごとではなく、アプリケーションごとに行われることを意味します。 アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。 リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。
Azure サービスプリンシパル認証を使用するには、以下を行います。
以下の手順に従います。
管理者の同意は、Azure Active Directory テナントの管理者が、管理者の同意を明示的に必要とするカスタムアプリケーションに権限を付与する場合に行います。
Azure ポータルで新しいAzure AD アプリケーションを作成する場合には、アプリケーションに必要なアクセス許可を指定する必要があります。一部のアクセス許可には、「管理者の同意が必要」と記載されている場合があります。 例えば、すべてのグループのアクセス許可には管理者の同意が必要です。アプリケーションが管理者の同意を必要とする場合、方法は2つあります。
管理者の同意を付与する最も簡単な方法は、管理者がportal.azure.com にログインして、アプリの登録で作成したアプリケーションに移動することです。API のアクセス許可で、 同意の付与をクリックします。これにより、アプリケーションが作成されたテナントにアクセス権限が付与されます。
組織に複数のテナントがある場合、または組織外の他のテナントにアプリのアクセス許可を与える必要がある場合、GetAdminConsentURL ストアドプロシージャを使用してAdmin Authorization URL を生成します。GetOAuthAuthorizationURL ストアドプロシージャとは異なり、このエンドポイントから返される重要な情報はありません。代わりに、OAuth アプリケーションが正常に認可されると、アクセス権限が付与されたことを示すBoolean 値が返されます。
管理者がOAuth アプリケーションを承認後、認証を続行できます。
クライアントOAuth フローに関連するすべてのアクセス許可には、管理者の同意が必要です。これは、CData Cloud が埋め込まれたアプリケーションをクライアントOAuth フローでは使用できないことを意味します。クライアント資格情報を使用するには、独自のOAuth アプリケーションの作成が必要になります。詳しくは、カスタムOAuth アプリケーションの作成 を参照してください。
portal.azure.com の[アプリの登録]で[API のアクセス許可]に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、[アプリケーションの許可]の下にあります。
インテグレーションに必要なアクセス許可を選択します。その後、次の接続プロパティを設定します。
クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、Azure Active Directory API へのSQL の実行について詳しく説明します。
Stored Procedures は、Azure Active Directory のファンクションライクなインターフェースです。これらを使用して、Azure Active Directory 内の情報を変更できます。
Cloud はAzure Active Directory のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
Applications | Retrieves all applications for the authenticated user. |
Devices | Retrieves all Devices for the authenticated user. |
Domains | Retrieves all Domains for the authenticated user. |
Groups | Retrieves all Azure Active Directory (Azure AD) groups, which can be Office 365 groups, or security groups. |
Users | Retrieves all Azure AD user accounts within the authenticated permissions. |
Retrieves all applications for the authenticated user.
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%'
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')
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'
To delete an Application record, you need to specify the Id in WHERE clause.
DELETE FROM Applications WHERE Id = '480a2785-1c18-49ac-9a80-9dfc1b40e1f2'
Name | Type | ReadOnly | Description |
id [KEY] | String | False |
The id of the application. |
addIns | String | False |
The addIns of the application. |
api_acceptMappedClaims | Bool | False |
The api_acceptMappedClaims of the application. |
api_knownClientApplications | String | False |
The api_knownClientApplications of the application. |
api_oauth2PermissionScopes | String | False |
The api_oauth2PermissionScopes of the application. |
api_preAuthorizedApplications | String | False |
The api_preAuthorizedApplications of the application. |
api_requestedAccessTokenVersion | Int | False |
The api_requestedAccessTokenVersion of the application. |
appId | String | False |
The appId of the application. |
applicationTemplateId | String | False |
The applicationTemplateId of the application. |
appRoles | String | False |
The appRoles of the application. |
authenticationBehaviors_removeUnverifiedEmailClaim | Bool | False |
The authenticationBehaviors_removeUnverifiedEmailClaim of the application. |
authenticationBehaviors_requireClientServicePrincipal | Bool | False |
The authenticationBehaviors_requireClientServicePrincipal of the application. |
certification_certificationDetailsUrl | String | False |
The certification_certificationDetailsUrl of the application. |
certification_certificationExpirationDateTime | Datetime | False |
The certification_certificationExpirationDateTime of the application. |
certification_isCertifiedByMicrosoft | Bool | False |
The certification_isCertifiedByMicrosoft of the application. |
certification_isPublisherAttested | Bool | False |
The certification_isPublisherAttested of the application. |
certification_lastCertificationDateTime | Datetime | False |
The certification_lastCertificationDateTime of the application. |
createdDateTime | Datetime | False |
The createdDateTime of the application. |
defaultRedirectUri | String | False |
The defaultRedirectUri of the application. |
description | String | False |
The description of the application. |
disabledByMicrosoftStatus | String | False |
The disabledByMicrosoftStatus of the application. |
displayName | String | False |
The displayName of the application. |
groupMembershipClaims | String | False |
The groupMembershipClaims of the application. |
identifierUris | String | False |
The identifierUris of the application. |
info_logoUrl | String | False |
The info_logoUrl of the application. |
info_marketingUrl | String | False |
The info_marketingUrl of the application. |
info_privacyStatementUrl | String | False |
The info_privacyStatementUrl of the application. |
info_supportUrl | String | False |
The info_supportUrl of the application. |
info_termsOfServiceUrl | String | False |
The info_termsOfServiceUrl of the application. |
isDeviceOnlyAuthSupported | Bool | False |
The isDeviceOnlyAuthSupported of the application. |
isFallbackPublicClient | Bool | False |
The isFallbackPublicClient of the application. |
keyCredentials | String | False |
The keyCredentials of the application. |
logo | String | False |
The logo of the application. |
notes | String | False |
The notes of the application. |
oauth2RequirePostResponse | Bool | False |
The oauth2RequirePostResponse of the application. |
optionalClaims_accessToken | String | False |
The optionalClaims_accessToken of the application. |
optionalClaims_idToken | String | False |
The optionalClaims_idToken of the application. |
optionalClaims_saml2Token | String | False |
The optionalClaims_saml2Token of the application. |
parentalControlSettings_countriesBlockedForMinors | String | False |
The parentalControlSettings_countriesBlockedForMinors of the application. |
parentalControlSettings_legalAgeGroupRule | String | False |
The parentalControlSettings_legalAgeGroupRule of the application. |
passwordCredentials | String | False |
The passwordCredentials of the application. |
publicClient_redirectUris | String | False |
The publicClient_redirectUris of the application. |
publisherDomain | String | False |
The publisherDomain of the application. |
requiredResourceAccess | String | False |
The requiredResourceAccess of the application. |
samlMetadataUrl | String | False |
The samlMetadataUrl of the application. |
serviceManagementReference | String | False |
The serviceManagementReference of the application. |
servicePrincipalLockConfiguration_isEnabled | Bool | False |
The servicePrincipalLockConfiguration_isEnabled of the application. |
servicePrincipalLockConfiguration_allProperties | Bool | False |
The servicePrincipalLockConfiguration_allProperties of the application. |
servicePrincipalLockConfiguration_credentialsWithUsageVerify | Bool | False |
The servicePrincipalLockConfiguration_credentialsWithUsageVerify of the application. |
servicePrincipalLockConfiguration_credentialsWithUsageSign | Bool | False |
The servicePrincipalLockConfiguration_credentialsWithUsageSign of the application. |
servicePrincipalLockConfiguration_tokenEncryptionKeyId | Bool | False |
The servicePrincipalLockConfiguration_tokenEncryptionKeyId of the application. |
signInAudience | String | False |
The signInAudience of the application. |
spa_redirectUris | String | False |
The spa_redirectUris of the application. |
tags | String | False |
The tags of the application. |
tokenEncryptionKeyId | String | False |
The tokenEncryptionKeyId of the application. |
verifiedPublisher_addedDateTime | Datetime | False |
The verifiedPublisher_addedDateTime of the application. |
verifiedPublisher_displayName | String | False |
The verifiedPublisher_displayName of the application. |
verifiedPublisher_verifiedPublisherId | String | False |
The verifiedPublisher_verifiedPublisherId of the application. |
web_homePageUrl | String | False |
The web_homePageUrl of the application. |
web_implicitGrantSettings_enableAccessTokenIssuance | Bool | False |
The web_implicitGrantSettings_enableAccessTokenIssuance of the application. |
web_implicitGrantSettings_enableIdTokenIssuance | Bool | False |
The web_implicitGrantSettings_enableIdTokenIssuance of the application. |
web_logoutUrl | String | False |
The web_logoutUrl of the application. |
web_redirectUris | String | False |
The web_redirectUris of the application. |
Retrieves all Devices for the authenticated user.
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%'
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"}]')
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'
To delete a Device record, you need to specify the Id in WHERE clause.
DELETE FROM Devices WHERE Id = '6c32edb5-7f28-41f8-9965-f3f9a1718fde'
Name | Type | ReadOnly | Description |
id [KEY] | String | False |
The Id of the device. |
deletedDateTime | Datetime | False |
The datetime when the device was deleted. |
accountEnabled | Bool | False |
Indicator if device is account enabled. |
alternativeSecurityIds | String | False |
The alternativeSecurityIds of the device. |
approximateLastSignInDateTime | Datetime | False |
The approximateLastSignInDateTime of the device. |
complianceExpirationDateTime | Datetime | False |
The complianceExpirationDateTime of the device. |
deviceCategory | String | False |
The deviceCategory of the device. |
deviceId | String | False |
The deviceId of the device. |
deviceMetadata | String | False |
The deviceMetadata of the device. |
deviceOwnership | String | False |
The deviceOwnership of the device. |
deviceVersion | Int | False |
The deviceVersion of the device. |
displayName | String | False |
The displayName of the device. |
enrollmentProfileName | String | False |
The enrollmentProfileName of the device. |
isCompliant | Bool | False |
Indicator if device is compliant. |
isManaged | Bool | False |
Indicator if device is managed. |
isManagementRestricted | Bool | False |
Indicator if device is management restricted. |
mdmAppId | String | False |
The mdmAppId of the device. |
onPremisesLastSyncDateTime | Datetime | False |
The onPremisesLastSyncDateTime of the device. |
onPremisesSecurityIdentifier | String | False |
The onPremisesSecurityIdentifier of the device. |
onPremisesSyncEnabled | Bool | False |
Indicator if device is on premises sync enabled. |
operatingSystem | String | False |
The operatingSystem of the device. |
operatingSystemVersion | String | False |
The operatingSystemVersion of the device. |
physicalIds | String | False |
The physicalIds of the device. |
profileType | String | False |
The profileType of the device. |
registrationDateTime | Datetime | False |
The registrationDateTime of the device. |
systemLabels | String | False |
The systemLabels of the device. |
trustType | String | False |
The trustType of the device. |
Retrieves all Domains for the authenticated user.
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%'
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')
To update a Domain record you need to specify the Id in WHERE clause.
UPDATE Domains SET passwordNotificationWindowInDays = 14 WHERE Id = 'cdata.com'
To delete a Domain record, you need to specify the Id in WHERE clause.
DELETE FROM Domains WHERE Id = 'cdata.com'
Name | Type | ReadOnly | Description |
id [KEY] | String | False |
The id of the domain. |
authenticationType | String | False |
The authenticationType of the domain. |
availabilityStatus | String | False |
The availabilityStatus of the domain. |
isAdminManaged | Bool | False |
Indicator if domain is admin managed. |
isDefault | Bool | False |
Indicator if domain is default. |
isInitial | Bool | False |
Indicator if domain is initial. |
isRoot | Bool | False |
Indicator if domain is root. |
isVerified | Bool | False |
Indicator if domain is verified. |
passwordNotificationWindowInDays | Int | False |
The passwordNotificationWindowInDays of the domain. |
passwordValidityPeriodInDays | Int | False |
The passwordValidityPeriodInDays of the domain. |
state_lastActionDateTime | Datetime | False |
The lastActionDateTime of the state. |
state_operation | String | False |
The operation of the state. |
state_status | String | False |
The status of the state. |
supportedServices | String | False |
The supported services of the domain. |
Retrieves all Azure Active Directory (Azure AD) groups, which can be Office 365 groups, or security groups.
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 カスタムOAuth アプリケーションの作成 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.
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'
The following are required to create a new Security Group:
INSERT INTO Groups (DisplayName, MailEnabled, MailNickname, SecurityEnabled) VALUES ('Test group', false, 'test', true)
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'
To delete a group record, you need to specify the Id in WHERE clause.
DELETE FROM Groups WHERE Id = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'
Retrieve recently deleted groups. Deleted groups remain available for up to 30 days.
GETDELETED FROM Groups
Name | Type | ReadOnly | Description |
id [KEY] | String | False |
The Id of the group. |
deletedDateTime | Datetime | False |
The datetime when the group was deleted. |
allowExternalSenders | Bool | False |
The indicator showing if external senders should be allowed or not. |
assignedLabels | String | False |
The assigned labels of the group. |
assignedLicenses | String | False |
The assigned licenses of the group. |
autoSubscribeNewMembers | Bool | False |
The indicator showing if new members should be autosubscribed. |
classification | String | False |
The classification of the group. |
createdDateTime | Datetime | False |
The created DateTime of the group. |
description | String | False |
The description of the group. |
displayName | String | False |
The display name of the group. |
expirationDateTime | Datetime | False |
The expiration datetime of the group. |
groupTypes | String | False |
The types of the group. |
hasMembersWithLicenseErrors | Bool | False |
Indicator if there are members with license error. |
hideFromAddressLists | Bool | False |
Whether or not to hide the group from address lists. |
hideFromOutlookClients | Bool | False |
Whether or not to hide the group from Outlook Clients. |
isArchived | Bool | False |
Indicator if group is archived. |
isAssignableToRole | Bool | False |
Indicator if group is assignable to role. |
isManagementRestricted | Bool | False |
Indicator if group is management restricted. |
isSubscribedByMail | Bool | False |
Indicator if group is subscribed by email. |
licenseProcessingState | String | False |
The license processing state of the group. |
String | False |
The mail of the group. | |
mailEnabled | Bool | False |
Indicator if mail is enabled in the group. |
mailNickname | String | False |
The mail nickname of the group. |
membershipRule | String | False |
The membership rule of the group. |
membershipRuleProcessingState | String | False |
The membership rule processing state of the group. |
onPremisesDomainName | String | False |
The Domain Name of the group. |
onPremisesLastSyncDateTime | Datetime | False |
The LastSync DateTime of the group. |
onPremisesProvisioningErrors | String | False |
The provisioning errors of the group. |
onPremisesSamAccountName | String | False |
The Sam Account Name of the group. |
onPremisesSecurityIdentifier | String | False |
The security identifier of the group. |
onPremisesSyncEnabled | Bool | False |
Indicator if sync is enabled in the group. |
preferredDataLocation | String | False |
The preferred data location of the group. |
preferredLanguage | String | False |
Preferred language in the group. |
proxyAddresses | String | False |
The proxy addresses of the group. |
renewedDateTime | Datetime | False |
The renewed DateTime of the group. |
securityEnabled | Bool | False |
Indicator if security is enabled in the group. |
securityIdentifier | String | False |
The security identifier of the group. |
serviceProvisioningErrors | String | False |
The service provisioning errors of the group. |
theme | String | False |
The theme of the group. |
unseenCount | Int | False |
The unseen count of the group. |
visibility | String | False |
The visibility of the group. |
Retrieves all Azure AD user accounts within the authenticated permissions.
Query the Users table. The Cloud 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 Cloud.
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
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')
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'
To delete a user record, you need to specify the Id in WHERE clause.
DELETE FROM Users WHERE Id = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'
Retrieve recently deleted users. Deleted users remain available for up to 30 days.
GETDELETED FROM Users
Name | Type | ReadOnly | Description |
id [KEY] | String | False |
The id of the user. |
deletedDateTime | Datetime | False |
The deletedDateTime of the user. |
accountEnabled | Bool | False |
Indicates if accountEnabled for the user. |
businessPhones | String | False |
The businessPhones of the user. |
city | String | False |
The city of the user. |
companyName | String | False |
The companyName of the user. |
country | String | False |
The country of the user. |
createdDateTime | Datetime | False |
The createdDateTime of the user. |
department | String | False |
The department of the user. |
displayName | String | False |
The displayName of the user. |
employeeHireDate | Datetime | False |
The employeeHireDate of the user. |
employeeId | String | False |
The employeeId of the user. |
employeeOrgData_costCenter | String | False |
The employeeOrgData_costCenter of the user. |
employeeOrgData_division | String | False |
The employeeOrgData_division of the user. |
employeeType | String | False |
The employeeType of the user. |
givenName | String | False |
The givenName of the user. |
identities | String | False |
The identities of the user. |
imAddresses | String | False |
The imAddresses of the user. |
isManagementRestricted | Bool | False |
Indicator if user is management restricted. |
isResourceAccount | Bool | False |
Indicates if it isResourceAccount of the user. |
jobTitle | String | False |
The jobTitle of the user. |
lastPasswordChangeDateTime | Datetime | False |
The lastPasswordChangeDateTime of the user. |
String | False |
The mail of the user. | |
mailNickname | String | False |
The mailNickname of the user. |
mobilePhone | String | False |
The mobilePhone of the user. |
officeLocation | String | False |
The officeLocation of the user. |
onPremisesDistinguishedName | String | False |
The onPremisesDistinguishedName of the user. |
onPremisesDomainName | String | False |
The onPremisesDomainName of the user. |
onPremisesExtensionAttributes_extensionAttribute1 | String | False |
The onPremisesExtensionAttributes_extensionAttribute1 of the user. |
onPremisesExtensionAttributes_extensionAttribute10 | String | False |
The onPremisesExtensionAttributes_extensionAttribute10 of the user. |
onPremisesExtensionAttributes_extensionAttribute11 | String | False |
The onPremisesExtensionAttributes_extensionAttribute11 of the user. |
onPremisesExtensionAttributes_extensionAttribute12 | String | False |
The onPremisesExtensionAttributes_extensionAttribute12 of the user. |
onPremisesExtensionAttributes_extensionAttribute13 | String | False |
The onPremisesExtensionAttributes_extensionAttribute13 of the user. |
onPremisesExtensionAttributes_extensionAttribute14 | String | False |
The onPremisesExtensionAttributes_extensionAttribute14 of the user. |
onPremisesExtensionAttributes_extensionAttribute15 | String | False |
The onPremisesExtensionAttributes_extensionAttribute15 of the user. |
onPremisesExtensionAttributes_extensionAttribute2 | String | False |
The onPremisesExtensionAttributes_extensionAttribute2 of the user. |
onPremisesExtensionAttributes_extensionAttribute3 | String | False |
The onPremisesExtensionAttributes_extensionAttribute3 of the user. |
onPremisesExtensionAttributes_extensionAttribute4 | String | False |
The onPremisesExtensionAttributes_extensionAttribute4 of the user. |
onPremisesExtensionAttributes_extensionAttribute5 | String | False |
The onPremisesExtensionAttributes_extensionAttribute5 of the user. |
onPremisesExtensionAttributes_extensionAttribute6 | String | False |
The onPremisesExtensionAttributes_extensionAttribute6 of the user. |
onPremisesExtensionAttributes_extensionAttribute7 | String | False |
The onPremisesExtensionAttributes_extensionAttribute7 of the user. |
onPremisesExtensionAttributes_extensionAttribute8 | String | False |
The onPremisesExtensionAttributes_extensionAttribute8 of the user. |
onPremisesExtensionAttributes_extensionAttribute9 | String | False |
The onPremisesExtensionAttributes_extensionAttribute9 of the user. |
onPremisesImmutableId | String | False |
The onPremisesImmutableId of the user. |
onPremisesLastSyncDateTime | Datetime | False |
The onPremisesLastSyncDateTime of the user. |
onPremisesProvisioningErrors | String | False |
The onPremisesProvisioningErrors of the user. |
onPremisesSamAccountName | String | False |
The onPremisesSamAccountName of the user. |
onPremisesSecurityIdentifier | String | False |
The onPremisesSecurityIdentifier of the user. |
onPremisesSyncEnabled | Bool | False |
Indicates onPremisesSyncEnabled for the user. |
onPremisesUserPrincipalName | String | False |
The onPremisesUserPrincipalName of the user. |
otherMails | String | False |
The otherMails of the user. |
passwordProfile_forceChangePasswordNextSignIn | Bool | False |
The passwordProfile_forceChangePasswordNextSignIn of the user. |
passwordProfile_forceChangePasswordNextSignInWithMfa | Bool | False |
The passwordProfile_forceChangePasswordNextSignInWithMfa of the user. |
passwordProfile_password | String | False |
The passwordProfile_password of the user. |
postalCode | String | False |
The postalCode of the user. |
preferredLanguage | String | False |
The preferredLanguage of the user. |
serviceProvisioningErrors | String | False |
The service provisioning errors of the user. |
state | String | False |
The state of the user. |
streetAddress | String | False |
The streetAddress of the user. |
surname | String | False |
The surname of the user. |
userPrincipalName | String | False |
The userPrincipalName of the user. |
userType | String | False |
The userType of the user. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
AdministrativeUnitMembers | Retrieves all AdministrativeUnitMembers for the authenticated user. |
AdministrativeUnits | Retrieves all AdministrativeUnits for the authenticated user. |
Contacts | Retrieves the Contacts for the organization. |
Contracts | Retrieves all contracts for the authenticated user. |
DeviceLocalCredentials | Retrieves the local administrator account credential of a device object. |
DeviceRegisteredOwners | DeviceRegisteredOwners table for Azure AD data provider. |
DeviceRegisteredUsers | DeviceRegisteredUsers table for Azure AD data provider. |
DirectoryAudits | Retrieves all directory audit items for the authenticated user. |
DirectoryRoleMembers | DirectoryRoleMembers table for Azure AD data provider. |
DirectoryRoles | Retrieves all DirectoryRoles for the authenticated user. |
DirectoryRoleTemplates | Retrieves all DirectoryRoleTemplates for the authenticated user. |
GroupApplicationRoleAssignments | GroupApplicationRoleAssignments table for Azure AD data provider. |
GroupMembers | GroupMembers table for Azure AD data providers. |
Organization | Retrieves the Organization for the authenticated user. |
RoleAssignments | Retrieves the Role Assignments for the Azure AD. |
RoleDefinitions | Retrieves the Role Definitions for the Azure AD. |
SignIns | Retrieves the user sign-ins for your tenant. |
UserApplicationRoleAssignments | UserApplicationRoleAssignments table for Azure AD data provider. |
UserManagers | UserManagers table for Azure AD data provider. |
Retrieves all AdministrativeUnitMembers for the authenticated user.
Get the members of administrative units in your Azure Active Directory. You can filter results by UnitId and MemberId.
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)
Name | Type | Description |
UnitId [KEY] | String | The id of the administrativeUnit. |
MemberId [KEY] | String | The User or Group Id of the user listed. |
Retrieves all AdministrativeUnits for the authenticated user.
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%'
Name | Type | Description |
id [KEY] | String | The id of the administrativeUnit. |
deletedDateTime | Datetime | The datetime when the administrativeUnit was deleted. |
description | String | The description of the administrativeUnit. |
displayName | String | The displayName of the administrativeUnit. |
isMemberManagementRestricted | Bool | Indicator if administrativeUnit is member management restricted. |
visibility | String | The visibility of the administrativeUnit. |
Retrieves the Contacts for the organization.
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%'
Name | Type | Description |
id [KEY] | String | The id of the organizationalContact. |
deletedDateTime | Datetime | The datetime when the contact was deleted. |
addresses | String | The addresses of the organizationalContact. |
companyName | String | The companyName of the organizationalContact. |
department | String | The department of the organizationalContact. |
displayName | String | The displayName of the organizationalContact. |
givenName | String | The givenName of the organizationalContact. |
jobTitle | String | The jobTitle of the organizationalContact. |
String | The mail of the organizationalContact. | |
mailNickname | String | The mailNickname of the organizationalContact. |
onPremisesLastSyncDateTime | Datetime | The onPremisesLastSyncDateTime of the organizationalContact. |
onPremisesProvisioningErrors | String | The provisioning errors of the organizationalContact. |
onPremisesSyncEnabled | Bool | Indicator if organizationalContact is onPremisesSyncEnabled. |
phones | String | The phones of the organizationalContact. |
proxyAddresses | String | The proxyAddresses of the organizationalContact. |
surname | String | The surname of the organizationalContact. |
Retrieves all contracts for the authenticated user.
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%'
Name | Type | Description |
id [KEY] | String | The id of the contract. |
deletedDateTime | Datetime | The datetime when the contract was deleted. |
contractType | String | The contractType of the contract. |
customerId | String | The customerId of the contract. |
defaultDomainName | String | The defaultDomainName of the contract. |
displayName | String | The displayName of the contract. |
Retrieves the local administrator account credential of a device object.
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%'
Name | Type | Description |
id [KEY] | String | The id of the deviceLocalCredential. |
credentials | String | The credentials of the deviceLocalCredential. |
deviceName | String | The deviceName of the deviceLocalCredential. |
lastBackupDateTime | Datetime | The lastBackupDateTime of the deviceLocalCredential. |
refreshDateTime | Datetime | The refreshDateTime of the deviceLocalCredential. |
DeviceRegisteredOwners table for Azure AD data provider.
Get the owners of registered Devices in your Azure Active Directory. You can filter results by DeviceId and OwnerId.
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)
Name | Type | Description |
DeviceId [KEY] | String | The Id of the Device. |
OwnerId [KEY] | String | The User Id of the owner listed. |
DeviceRegisteredUsers table for Azure AD data provider.
Get the users of registered Devices in your Azure Active Directory. You can filter results by DeviceId and UserId.
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)
Name | Type | Description |
DeviceId [KEY] | String | The Id of the Device. |
UserId [KEY] | String | The User Id of the user listed. |
Retrieves all directory audit items for the authenticated user.
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%'
Name | Type | Description |
id [KEY] | String | The id of the DirectoryAudit. |
activityDateTime | Datetime | The activityDateTime of the DirectoryAudit. |
activityDisplayName | String | The activityDisplayName of the DirectoryAudit. |
additionalDetails | String | The additionalDetails of the DirectoryAudit. |
category | String | The category of the DirectoryAudit. |
correlationId | String | The correlationId of the DirectoryAudit. |
initiatedBy_app_appid | String | The initiatedBy_app_appid of the DirectoryAudit. |
initiatedBy_app_displayName | String | The initiatedBy_app_displayName of the DirectoryAudit. |
initiatedBy_app_servicePrincipalId | String | The initiatedBy_app_servicePrincipalId of the DirectoryAudit. |
initiatedBy_app_servicePrincipalName | String | The initiatedBy_app_servicePrincipalName of the DirectoryAudit. |
loggedByService | String | The loggedByService of the DirectoryAudit. |
operationType | String | The operationType of the DirectoryAudit. |
result | String | The result of the DirectoryAudit. |
resultReason | String | The resultReason of the DirectoryAudit. |
targetResources | String | The targetResources of the DirectoryAudit. |
DirectoryRoleMembers table for Azure AD data provider.
Get the members of Directory Roles in your Azure Active Directory. You can filter results by RoleId and UserId.
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)
Name | Type | Description |
RoleId [KEY] | String | The id of the directoryRole. |
UserId [KEY] | String | The User Id of the user listed. |
Retrieves all DirectoryRoles for the authenticated user.
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%'
Name | Type | Description |
id [KEY] | String | The id of the directoryRole. |
deletedDateTime | Datetime | The datetime when the directoryRole was deleted. |
description | String | The description of the directoryRole. |
displayName | String | The displayName of the directoryRole. |
roleTemplateId | String | The roleTemplateId of the directoryRole. |
Retrieves all DirectoryRoleTemplates for the authenticated user.
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%'
Name | Type | Description |
id [KEY] | String | The id of the directoryRoleTemplate. |
deletedDateTime | Datetime | The datetime when the directoryRoleTemplate was deleted. |
description | String | The description of the directoryRoleTemplate. |
displayName | String | The displayName of the directoryRoleTemplate. |
GroupApplicationRoleAssignments table for Azure AD data provider.
Get the group application roles assignments in your Azure Active Directory. You can filter results by GroupId.
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)
Name | Type | Description |
GroupId [KEY] | String | The GroupId of the ApplicationRoleAssignment. |
id [KEY] | String | The id of the ApplicationRoleAssignment. |
appRoleId | String | The appRoleId of the ApplicationRoleAssignment. |
createdDateTime | Datetime | The createdDateTime of the ApplicationRoleAssignment. |
principalDisplayName | String | The principalDisplayName of the ApplicationRoleAssignment. |
principalId | String | The principalId of the ApplicationRoleAssignment. |
principalType | String | The principalType of the ApplicationRoleAssignment. |
resourceDisplayName | String | The resourceDisplayName of the ApplicationRoleAssignment. |
resourceId | String | The resourceId of the ApplicationRoleAssignment. |
GroupMembers table for Azure AD data providers.
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.
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'
Name | Type | Description |
GroupId [KEY] | String | The Id of the Group. |
MemberId [KEY] | String | The User Id of the member listed. |
Retrieves the Organization for the authenticated user.
SELECT * FROM Organization
Name | Type | Description |
id [KEY] | String | The id of the organization. |
deletedDateTime | Datetime | The datetime when the organization was deleted. |
assignedPlans | String | The assignedPlans of the organization. |
businessPhones | String | The businessPhones of the organization. |
city | String | The city of the organization. |
country | String | The country of the organization. |
countryLetterCode | String | The countryLetterCode of the organization. |
createdDateTime | Datetime | The createdDateTime of the organization. |
defaultUsageLocation | String | The defaultUsageLocation of the organization. |
displayName | String | The displayName of the organization. |
marketingNotificationEmails | String | The marketingNotificationEmails of the organization. |
mobileDeviceManagementAuthority | String | The mobileDeviceManagementAuthority of the organization. |
onPremisesLastPasswordSyncDateTime | Datetime | The onPremisesLastPasswordSyncDateTime of the organization. |
onPremisesLastSyncDateTime | Datetime | The onPremisesLastSyncDateTime of the organization. |
onPremisesSyncEnabled | Bool | Indicator if organization is onPremisesSyncEnabled. |
partnerTenantType | String | The partnerTenantType of the organization. |
postalCode | String | The postalCode of the organization. |
preferredLanguage | String | The preferredLanguage of the organization. |
privacyProfile_contactEmail | String | The contactEmail of the privacyProfile. |
privacyProfile_statementUrl | String | The statementUrl of the privacyProfile. |
provisionedPlans | String | The provisionedPlans of the organization. |
securityComplianceNotificationMails | String | The securityComplianceNotificationMails of the organization. |
securityComplianceNotificationPhones | String | The securityComplianceNotificationPhones of the organization. |
state | String | The state of the organization. |
street | String | The street of the organization. |
technicalNotificationMails | String | The technicalNotificationMails of the organization. |
tenantType | String | The tenantType of the organization. |
verifiedDomains | String | The verifiedDomains of the organization. |
Retrieves the Role Assignments for the Azure AD.
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'
Name | Type | Description |
id [KEY] | String | The id of the roleAssignment. |
condition | String | The condition of the roleAssignment. |
roleDefinitionId | String | The roleDefinitionId of the roleAssignment. |
principalId | String | The principalId of the roleAssignment. |
directoryScopeId | String | The directoryScopeId of the roleAssignment. |
appScopeId | String | The appScopeId of the roleAssignment. |
Retrieves the Role Definitions for the Azure AD.
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%'
Name | Type | Description |
id [KEY] | String | The id of the roleDefinition. |
allowedPrincipalTypes | String | The allowedPrincipalTypes of the roleDefinition. |
description | String | The description of the roleDefinition. |
displayName | String | The displayName of the roleDefinition. |
isBuiltIn | Bool | Indicator if roleDefinition is Builtin. |
isEnabled | Bool | Indicator if roleDefinition is Enabled. |
isPrivileged | Bool | Indicator if roleDefinition is Privileged. |
resourceScopes | String | The resourceScopes of the roleDefinition. |
rolePermissions | String | The rolePermissions of the roleDefinition. |
templateId | String | The templateId of the roleDefinition. |
version | String | The version of the roleDefinition. |
Retrieves the user sign-ins for your tenant.
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%'
Name | Type | Description |
id [KEY] | String | The id of the SignIns. |
appDisplayName | String | The appDisplayName of the SignIns. |
appId | String | The appId of the SignIns. |
appliedConditionalAccessPolicies | String | The appliedConditionalAccessPolicies of the SignIns. |
clientAppUsed | String | The clientAppUsed of the SignIns. |
conditionalAccessStatus | String | The conditionalAccessStatus of the SignIns. |
correlationId | String | The correlationId of the SignIns. |
createdDateTime | Datetime | The createdDateTime of the SignIns. |
deviceDetail_browser | String | The deviceDetail_browser of the SignIns. |
deviceDetail_deviceId | String | The deviceDetail_deviceId of the SignIns. |
deviceDetail_displayName | String | The deviceDetail_displayName of the SignIns. |
deviceDetail_isCompliant | Bool | The deviceDetail_isCompliant of the SignIns. |
deviceDetail_isManaged | Bool | The deviceDetail_isManaged of the SignIns. |
deviceDetail_operatingSystem | String | The deviceDetail_operatingSystem of the SignIns. |
deviceDetail_trustType | String | The deviceDetail_trustType of the SignIns. |
ipAddress | String | The ipAddress of the SignIns. |
isInteractive | Bool | The isInteractive of the SignIns. |
signInLocation_city | String | The signInLocation_city of the SignIns. |
signInLocation_countryOrRegion | String | The signInLocation_countryOrRegion of the SignIns. |
signInLocation_state | String | The signInLocation_state of the SignIns. |
resourceDisplayName | String | The resourceDisplayName of the SignIns. |
resourceId | String | The resourceId of the SignIns. |
riskDetail | String | The riskDetail of the SignIns. |
riskEventTypes | String | The riskEventTypes of the DirectoryAudit. |
riskEventTypes_v2 | String | The riskEventTypes_v2 of the DirectoryAudit. |
riskLevelAggregated | String | The riskLevelAggregated of the SignIns. |
riskLevelDuringSignIn | String | The riskLevelDuringSignIn of the SignIns. |
riskState | String | The riskState of the SignIns. |
signInStatus_additionalDetails | String | The signInStatus_additionalDetails of the SignIns. |
signInStatus_errorCode | Int | The signInStatus_errorCode of the application. |
signInStatus_failureReason | String | The signInStatus_failureReason of the SignIns. |
userDisplayName | String | The userDisplayName of the SignIns. |
userId | String | The userId of the SignIns. |
userPrincipalName | String | The userPrincipalName of the SignIns. |
UserApplicationRoleAssignments table for Azure AD data provider.
Get the user application roles assignments in your Azure Active Directory. You can filter results by UserId.
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)
Name | Type | Description |
UserId [KEY] | String | The UserId of the ApplicationRoleAssignment. |
id [KEY] | String | The id of the ApplicationRoleAssignment. |
appRoleId | String | The appRoleId of the ApplicationRoleAssignment. |
createdDateTime | Datetime | The createdDateTime of the ApplicationRoleAssignment. |
principalDisplayName | String | The principalDisplayName of the ApplicationRoleAssignment. |
principalId | String | The principalId of the ApplicationRoleAssignment. |
principalType | String | The principalType of the ApplicationRoleAssignment. |
resourceDisplayName | String | The resourceDisplayName of the ApplicationRoleAssignment. |
resourceId | String | The resourceId of the ApplicationRoleAssignment. |
UserManagers table for Azure AD data provider.
Get the manager of users in your Azure Active Directory. You can filter results by UserId.
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)
Name | Type | Description |
UserId [KEY] | String | The UserId of the manager. |
id [KEY] | String | The id of the manager. |
displayName | String | The displayName of the manager. |
jobTitle | String | The jobTitle of the manager. |
String | The mail of the manager. | |
userPrincipalName | String | The userPrincipalName of the manager. |
ストアドプロシージャはファンクションライクなインターフェースで、Azure Active Directory の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにAzure Active Directory から関連するレスポンスデータを返します。
Name | Description |
ActivateDirectoryRole | Activates a directory role. |
AddGroupApplicationRoleAssignment | Add group to an Application Role Assignment. |
AddGroupMember | Adds a member to a group. |
AddMember | Add member to a directory role. |
AddUserApplicationRoleAssignment | Add user to an Application Role Assignment. |
CheckMemberObjectsForUser | Check for membership in groups, administrative units, or directory roles for a user. |
FetchAdditionalUserFields | Fetch all T1, T2, and T3 fields for a specified user. |
GetAdminConsentURL | Gets the admin consent URL that an admin of a given domain must open separately to grant access to your application. Only needed when using custom OAuth credentials. |
PromoteDomain | Promotes a domain. |
RemoveGroupApplicationRoleAssignment | Removes a group from an Application Role Assignment. |
RemoveGroupMember | Remove a member from a Group. |
RemoveMember | Removes a member from a directory role. |
RemoveUserApplicationRoleAssignment | Remove a user from an Application Role Assignment. |
VerifyDomain | Verifies a domain. |
Activates a directory role.
Name | Type | Description |
RoleTemplateId | String | The Id of the directoryRoleTemplate that the role is based on. |
Name | Type | Description |
Id | String | Id of the directory role activated. |
RoleTemplateId | String | RoleTemplateId of the directory role activated. |
DisplayName | String | DisplayName of the directory role activated. |
Description | String | Description of the directory role activated. |
Add group to an Application Role Assignment.
Name | Type | Description |
ResourceId | String | The unique identifier of the resource. |
AppRoleId | String | The unique identifier of the app role. |
GroupId | String | The unique identifier of the group. |
Name | Type | Description |
Success | String | Whether the operation was successful. |
Adds a member to a group.
Name | Type | Description |
GroupId | String | The unique identifier of the group. |
MemberId | String | The unique identifier of the member. |
Name | Type | Description |
Success | String | Whether the operation was successful. |
Add member to a directory role.
Name | Type | Description |
RoleId | String | The unique identifier of the directory role. |
RoleTemplateId | String | The unique identifier of the directory role template. |
UserId | String | The unique identifier of the user. |
Name | Type | Description |
Success | String | Whether the operation was successful. |
Add user to an Application Role Assignment.
Name | Type | Description |
ResourceId | String | The unique identifier of the resource. |
AppRoleId | String | The unique identifier of the app role. |
UserId | String | The unique identifier of the user. |
Name | Type | Description |
Success | String | Whether the operation was successful. |
Check for membership in groups, administrative units, or directory roles for a user.
Name | Type | Description |
UserId | String | The unique identifier of the user. |
Ids | String | A collection of comma-seperated unique identifiers of the groups, administrative units, or directory roles in which to check membership. |
Name | Type | Description |
Success | String | Whether the operation was successful. |
Value | String | The value of the response. |
Fetch all T1, T2, and T3 fields for a specified user.
Name | Type | Description |
UserId | String | The unique identifier of the user. |
Name | Type | Description |
* | String | Results of the query. |
Gets the admin consent URL that an admin of a given domain must open separately to grant access to your application. Only needed when using custom OAuth credentials.
Name | Type | Description |
CallbackUrl | String | The URL the user will be redirected to after authorizing your application. This value must match the Reply URL in the Azure AD app settings. |
State | String | The same value for state that you sent when you requested the authorization code. |
Scope | String | A space-separated list of scopes to request from the Admin.
The default value is https://graph.microsoft.com/group.readwrite.all https://graph.microsoft.com/user.read.all https://graph.microsoft.com/user.read https://graph.microsoft.com/directory.readwrite.all https://graph.microsoft.com/RoleManagement.ReadWrite.Directory https://graph.microsoft.com/directory.accessasuser.all https://graph.microsoft.com/domain.readwrite.all https://graph.microsoft.com/device.read.all https://graph.microsoft.com/RoleManagement.Read.Directory https://graph.microsoft.com/organization.Read.all https://graph.microsoft.com/Application.ReadWrite.all https://graph.microsoft.com/groupmember.readwrite.all https://graph.microsoft.com/AuditLog.Read.All https://graph.microsoft.com/DeviceLocalCredential.Read.All. |
Name | Type | Description |
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Promotes a domain.
Name | Type | Description |
Id | String | The Id of the domain to be promoted. |
Name | Type | Description |
Success | String | Whether the operation was successful. |
Removes a group from an Application Role Assignment.
Name | Type | Description |
AppRoleAssignmentId | String | The unique identifier of the app role assignment. |
GroupId | String | The unique identifier of the group. |
Name | Type | Description |
Success | String | Whether the operation was successful. |
Remove a member from a Group.
Name | Type | Description |
MemberId | String | The unique identifier of the member. |
GroupId | String | The unique identifier of the group. |
Name | Type | Description |
Success | String | Whether the operation was successful. |
Removes a member from a directory role.
Name | Type | Description |
RoleId | String | The unique identifier of the directory role. |
RoleTemplateId | String | The unique identifier of the directory role template. |
UserId | String | The unique identifier of the user. |
Name | Type | Description |
Success | String | Whether the operation was successful. |
Remove a user from an Application Role Assignment.
Name | Type | Description |
AppRoleAssignmentId | String | The unique identifier of the app role assignment. |
UserId | String | The unique identifier of the user. |
Name | Type | Description |
Success | String | Whether the operation was successful. |
Verifies a domain.
Name | Type | Description |
Id | String | The Id of the domain to be verified. |
Name | Type | Description |
Success | String | Whether the operation was successful. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Azure Active Directory のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | データベース名。 |
SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベース。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | テーブル名またはビュー名。 |
TableType | String | テーブルの種類(テーブルまたはビュー)。 |
Description | String | テーブルまたはビューの説明。 |
IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、DirectoryRoles テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='DirectoryRoles'
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | カラムを含むテーブルまたはビューの名前。 |
ColumnName | String | カラム名。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | カラムのストレージサイズ。 |
DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
IsNullable | Boolean | カラムがNull を含められるかどうか。 |
Description | String | カラムの簡単な説明。 |
Ordinal | Int32 | カラムのシーケンスナンバー。 |
IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
IsHidden | Boolean | カラムが非表示かどうか。 |
IsArray | Boolean | カラムが配列かどうか。 |
IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベース。 |
SchemaName | String | ストアドプロシージャを含むスキーマ。 |
ProcedureName | String | ストアドプロシージャの名前。 |
Description | String | ストアドプロシージャの説明。 |
ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、AddMember ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='AddMember' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
ColumnName | String | ストアドプロシージャパラメータの名前。 |
Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | 数値データの小数点以下の桁数。 |
IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
IsArray | Boolean | パラメータが配列かどうか。 |
Description | String | パラメータの説明。 |
Ordinal | Int32 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、DirectoryRoles テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='DirectoryRoles'
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
名前 | タイプ | 説明 |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前。 |
KeySeq | String | 主キーのシーケンス番号。 |
KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | インデックスを含むデータベースの名前。 |
SchemaName | String | インデックスを含むスキーマの名前。 |
TableName | String | インデックスを含むテーブルの名前。 |
IndexName | String | インデックス名。 |
ColumnName | String | インデックスに関連付けられたカラムの名前。 |
IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
このテーブルをクエリする際は、config 接続文字列を使用する必要があります。
jdbc:cdata:azuread:config:
この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | 接続プロパティ名。 |
ShortDescription | String | 簡単な説明。 |
Type | String | 接続プロパティのデータ型。 |
Default | String | 明示的に設定されていない場合のデフォルト値。 |
Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
Required | Boolean | プロパティが接続に必要かどうか。 |
Category | String | 接続プロパティのカテゴリ。 |
IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
Ordinal | Int32 | パラメータのインデックス。 |
CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
名前 | 説明 | 有効な値 |
AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | サポートされている文字列関数。 | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | サポートされている数値関数。 | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | サポートされている日付および時刻関数。 | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | レプリケーション中にスキップされたテーブルを示します。 | |
REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
DIALECT | 使用するSQL ダイアレクトを示します。 | |
KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | 使用したいcacheOptions を指定する文字列値。 | |
ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
Name | Type | Description |
NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | データ変更処理から返された、データベース生成Id。 |
Batch | String | バッチの識別子。1 は単一処理。 |
Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
The Cloud 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 |
プロパティ | 説明 |
AuthScheme | Azure Active Directory に接続する際に使用する認証の種類。 |
プロパティ | 説明 |
AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
AzureEnvironment | 接続を確立するときに使用するAzure 環境。 |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthGrantType | OAuth フローのグラント種別。 |
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | Azure Active Directory に接続する際に使用する認証の種類。 |
Azure Active Directory に接続する際に使用する認証の種類。
string
"AzureAD"
このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。
プロパティ | 説明 |
AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
AzureEnvironment | 接続を確立するときに使用するAzure 環境。 |
データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
string
""
データにアクセスするために使用されるMicrosoft Online テナント。例えば、contoso.onmicrosoft.com です。あるいは、 テナントId を指定します。この値は[Azure ポータル]->[Azure Active Directory]->[プロパティ]のディレクトリId です。
通常、Tenant を指定する必要はありません。OAuthGrantType をCODE(デフォルト)に設定している場合は、Microsoft が自動的に決定します。 ただし、ユーザーがマルチテナントに所属している場合は失敗する可能性があります。 例えば、ドメインA の管理者がドメインB のユーザーをゲストユーザーとして招待した場合。ユーザーは両方のテナントに属していることになります。 Tenant を指定するのはグッドプラクティスですが、一般的には指定しなくてもうまく動作するはずです。
OAuthGrantType をCLIENT に設定する場合は、AzureTenant が必須です。クライアント資格情報を使用する場合、ユーザーコンテキストはありません。 資格情報は、アプリ自体のコンテキストから取得されます。Microsoft ではTenant を指定せずにクライアント資格情報を取得することを許容していますが、使用する特定のテナントを選択する可能性ははるかに低くなっています。 このため、接続するドメインに適用される資格情報を確実に取得するために、すべてのクライアント資格情報接続に対してAzureTenant を明示的に指定する必要があります。
接続を確立するときに使用するAzure 環境。
string
"GLOBAL"
ほとんどの場合、環境をグローバルに設定したままにしておくとうまく機能します。ただし、 Azure アカウントが別の環境に追加されている場合は、AzureEnvironment を使用してどの環境かを 指定できます。利用可能な値はGLOBAL、CHINA、USGOVT、USGOVTDOD です。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthGrantType | OAuth フローのグラント種別。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
OAuth フローのグラント種別。
string
"CODE"
次のオプションが利用可能です:CODE,CLIENT
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
JWT 証明書のストア。
string
""
クライアント証明書のための証明書ストア名。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
CA | 証明機関の証明書。 |
ROOT | ルート証明書。 |
SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。
JWT 証明書を格納するキーストアの種類。
string
"PEMKEY_BLOB"
このプロパティには次の値の一つを設定できます。
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 形式の証明書を含む文字列の名前です。 |
OAuth JWT 証明書のパスワード。
string
""
証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。
OAuth JWT 証明書のサブジェクト。
string
"*"
証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。
完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。
それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。
"*" に設定すると、証明書ストアの1番目の証明書が選択されます。
証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。
フィールド | 説明 |
CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
O | 法人名 |
OU | 法人の部署名 |
L | 法人の住所(市町村名) |
S | 法人の住所(都道府県) |
C | 国名 |
E | Eメールアドレス |
フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
string
""
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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。