CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるMicrosoft Planner へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してMicrosoft Planner に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Microsoft Planner への接続を標準化し、構成することができます。
このページでは、CData Cloud でのMicrosoft Planner への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのMicrosoft Planner への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してMicrosoft Planner からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Microsoft Planner に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
Azure サービスプリンシパルとしての認証は、OAuth クライアントクレデンシャルフローを介して処理されます。直接のユーザー認証は行われません。代わりに、クレデンシャルはアプリケーション自体のためだけに作成されます。アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。
AzureAD アプリとAzure サービスプリンシパルの作成
Azure サービスプリンシパルを使用して認証する場合、Azure AD テナントにAzure AD アプリケーションを作成して登録する必要があります。詳しくは、カスタムOAuth アプリケーションの作成 を参照してください。
portal.azure.com の[アプリの登録]で[API のアクセス許可]に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、[アプリケーションの許可]の下にあります。
アプリケーションへのロールの割り当て
サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。
クライアントシークレット
次の接続プロパティを設定します。
証明書
次の接続プロパティを設定します。
これで接続する準備が整いました。クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。
Azure VM 上でMicrosoft Planner を実行しており、MSI を利用して接続したい場合は、AuthScheme をAzureMSI に設定します。
VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、Microsoft Planner API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なテーブルを説明します。テーブルはTasks、Plans、Buckets などをモデル化するために動的に定義されます。
ビュー では、利用可能なビューを説明します。ビューは、Groups およびUsers をモデル化するために動的に定義されます。ビューは変更できませんが、テーブルへのクエリを補足するために使用できます。
ストアドプロシージャ は、Microsoft Planner のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、タスクボード形式の更新やoauth クレデンシャルの取得など、Microsoft Planner の操作を実行できます。
Cloud はMicrosoft Planner のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
Buckets | The Buckets resource provides methods that allow you to manage buckets for the account. |
PlanDetails | The PlanDetails resource provides methods that allow you to manage plan details for the account. |
Plans | The Plans resource provides methods that allow you to manage plans for the account. |
TaskDetails | The TaskDetails resource provides methods that allow you to manage task details for the account. |
Tasks | The Tasks resource provides methods that allow you to manage tasks for the account. |
The Buckets resource provides methods that allow you to manage buckets for the account.
The Cloud will use the Microsoft Planner 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 queries are processed server side:
SELECT * FROM Buckets WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC' SELECT * FROM Buckets WHERE BucketId = 'qIguxctMLEGHYhmgSVGSNGUAAZOZ'
Required fields for an insert are: name and planId.
Optional: orderHint.
INSERT INTO Buckets (Name, PlanId) VALUES ('Advertising', 'xqQg5FS2LkCp935s-FIFm2QAFkHM') INSERT INTO Buckets (Name, PlanId, orderHint) VALUES ('Advertising', 'xqQg5FS2LkCp935s-FIFm2QAFkHM', ' !')
Microsoft Planner allows updates for the name and orderHint columns.
UPDATE Buckets SET Name = 'To do', orderHint = ' !' WHERE BucketId = 'rWpNKGmHukm84GaiDF_ZL2UAOlMj'
Buckets can be deleted by providing BucketId.
DELETE FROM Buckets WHERE BucketId = 'yHiJQjZK0kGVt4flhItk0mUANJwN'
Name | Type | ReadOnly | Description |
name | String | False | |
orderHint | String | False | |
planId | String | False | |
Linkedtasks | String | False | |
BucketId [KEY] | String | False | |
Etag | String | False |
The PlanDetails resource provides methods that allow you to manage plan details for the account.
The Cloud will use the Microsoft Planner 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 queries are processed server side:
SELECT * FROM PlanDetails WHERE planId = 'nETc1IDpYkmb1E17w8TxGmUAGFWC'
INSERT is not supported for this table.
Microsoft Planner allows updates for the title, bucketId, percentComplete, assigneePriority, conversationThreadId, orderHint, dueDateTime and startDateTime columns.
UPDATE PlanDetails SET categoryDescriptions_category1 = 'Cat#1', categoryDescriptions_category2 = 'Cat#2', categoryDescriptions_category3 = 'Cat#3', categoryDescriptions_category4 = 'Cat#4', categoryDescriptions_category5 = 'Cat#5', categoryDescriptions_category6 = 'Cat#6' WHERE PlanId = 'nETc1IDpYkmb1E17w8TxGmUAGFWC'
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
categoryDescriptions_category1 | String | False | |
categoryDescriptions_category2 | String | False | |
categoryDescriptions_category3 | String | False | |
categoryDescriptions_category4 | String | False | |
categoryDescriptions_category5 | String | False | |
categoryDescriptions_category6 | String | False | |
PlanId [KEY] | String | False |
The Plans resource provides methods that allow you to manage plans for the account.
The Cloud will use the Microsoft Planner 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.
If Scope = NoAdminConsent, List the data related to the groups that the user is a member of.
If Scope = AdminConsent, List all the data related to groups.
For example, the following query is processed server side:
SELECT * FROM Plans WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC'
Required fields for an insert are: title and owner.
INSERT INTO Plans (title, owner) VALUES ('Plan#5', 'acc24236-0d62-4d30-9a7f-98cfbcd3a6e7')
Microsoft Planner allows updates for the title and owner columns.
UPDATE Plans SET title = 'Plan#1' WHERE PlanId = 'nETc1IDpYkmb1E17c4TxGmUAGFWC'
Name | Type | ReadOnly | Description |
createdBy_application_displayName | String | False | |
createdBy_application_id | String | False | |
createdDateTime | Datetime | False | |
owner | String | False | |
title | String | False | |
Linkedbuckets | String | False | |
Linkeddetails | String | False | |
Linkedtasks | String | False | |
GroupId | String | False | |
PlanId [KEY] | String | False | |
Etag | String | False |
The TaskDetails resource provides methods that allow you to manage task details for the account.
The Cloud will use the Microsoft Planner 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 queries are processed server side:
SELECT * FROM TaskDetails WHERE TaskId = '7POTl5DUfkOsgzptPrzdzGUAHy1z'
INSERT is not supported for this table.
Microsoft Planner allows updates for the title, bucketId, percentComplete, assigneePriority, conversationThreadId, orderHint, dueDateTime and startDateTime columns.
UPDATE TaskDetails SET Description = 'Task description', previewType = 'reference' WHERE TaskId = '7POTl5DUfkOsgzptPrzdzGUAHy1z'
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
isChecked | Bool | False | |
title | String | False | |
orderHint | String | False | |
checklist_lastModifiedBy_application_displayName | String | False | |
checklist_lastModifiedBy_application_id | String | False | |
lastModifiedDateTime | Datetime | False | |
description | String | False | |
previewType | String | False | |
TaskId [KEY] | String | False | |
CheckListId | String | False |
The Tasks resource provides methods that allow you to manage tasks for the account.
The Cloud will use the Microsoft Planner 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 queries are processed server side:
SELECT * FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK' SELECT * FROM Tasks WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC' SELECT * FROM Tasks WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe' SELECT * FROM Tasks WHERE BucketId = 'qIguxctMLEGHYhmgSVGSNGUAAZOZ'
Required fields for an insert are: title and planId.
Optional: bucketId.
INSERT INTO Tasks (title, planId) VALUES ('test44', 'nETc1IDpYkmb1E17w8TxGmUAGFWC') INSERT INTO Tasks (title, planId, bucketId) VALUES ('test44', 'nETc1IDpYkmb1E17w8TxGmUAGFWC', 'ZfzKVriNQ0yzR4IqJp-8FWUADq0Y')
Microsoft Planner allows updates for the title, bucketId, percentComplete, assigneePriority, conversationThreadId, orderHint, dueDateTime and startDateTime columns.
UPDATE Tasks SET assigneePriority = '8377555 94446!', bucketId = 'rWpNKGmHukm84GaiDF_ZL2UAOlMj', conversationThreadId = 'AAQkADlmMzE1ZGIzLWY3OTctNDcyMy1iYmNlLWNlZmNlZTc5', dueDateTime = '2019-09-30T14:49:23', orderHint = '343d 454fd!', startDateTime = '2019-07-31T14:49:23.269', title = 'updatedTask', percentComplete = '35' WHERE TaskId = '7POTl5DUfkOsgzptPrzdzGUAHy1z'
Tasks can be deleted by providing TaskId.
DELETE FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'
Name | Type | ReadOnly | Description |
activeChecklistItemCount | Int | False | |
assigneePriority | String | False | |
bucketId | String | False | |
checklistItemCount | Int | False | |
completedBy_application_displayName | String | False | |
completedBy_application_id | String | False | |
completedDateTime | Datetime | False | |
conversationThreadId | String | False | |
createdBy_application_displayName | String | False | |
createdBy_application_id | String | False | |
createdDateTime | Datetime | False | |
dueDateTime | Datetime | False | |
hasDescription | Bool | False | |
orderHint | String | False | |
percentComplete | Int | False | |
planId | String | False | |
previewType | String | False | |
referenceCount | Int | False | |
startDateTime | Datetime | False | |
title | String | False | |
LinkedassignedToTaskBoardFormat | String | False | |
LinkedbucketTaskBoardFormat | String | False | |
Linkeddetails | String | False | |
LinkedprogressTaskBoardFormat | String | False | |
TaskId [KEY] | String | False | |
UserId | String | False | |
Etag | String | False |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Groups | The Groups resource provides methods that allow you to manage groups for the account. |
TaskAssignments | The Tasks resource provides methods that allow you to manage tasks for the account. |
TaskComments | Retrieves comments of a task. |
Users | The Users resource provides methods that allow you to manage users for the account. |
The Groups resource provides methods that allow you to manage groups for the account.
The Cloud will use the Microsoft Planner 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.
If Scope = NoAdminConsent, List the data related to the groups that the user is a member of.
If Scope = AdminConsent, List all the data related to groups.
For example, the following queries are processed server side:
SELECT * FROM Groups WHERE Id = 'nETc1IDpYkmb1E17w8TxGmUAGFWC'
Name | Type | Description |
id [KEY] | String | |
Etag | String | |
deletedDateTime | Datetime | |
allowExternalSenders | Bool | |
assignedLicenses | String | |
autoSubscribeNewMembers | Bool | |
classification | String | |
createdDateTime | Datetime | |
description | String | |
displayName | String | |
groupTypes | String | |
hasMembersWithLicenseErrors | Bool | |
isArchived | Bool | |
isSubscribedByMail | Bool | |
licenseProcessingState_state | String | |
String | ||
mailEnabled | Bool | |
mailNickname | String | |
onPremisesLastSyncDateTime | Datetime | |
onPremisesProvisioningErrors | String | |
onPremisesSecurityIdentifier | String | |
onPremisesSyncEnabled | Bool | |
preferredDataLocation | String | |
proxyAddresses | String | |
renewedDateTime | Datetime | |
securityEnabled | Bool | |
unseenCount | Int | |
visibility | String |
The Tasks resource provides methods that allow you to manage tasks for the account.
The Cloud uses the Microsoft Planner 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.
If Scope = NoAdminConsent, List the data related to the groups that the user is a member of.
If Scope = AdminConsent, List all the data related to groups.
For example, the following queries are processed server side:
SELECT * FROM TaskAssignments WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK' SELECT * FROM TaskAssignments WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC' SELECT * FROM TaskAssignments WHERE PlanId IN ('nETc1IDpYk3r3e317w8TxGmUAGFWC', 'v8iK3uCb30C5I_ocMGu3SGUAHQLI', 't2eNwoPxpEqhZs38GwT1HWUADwjN') SELECT * FROM TaskAssignments WHERE BucketId = 'qIguxctMLEGHYhmgSVGSNGUAAZOZ'
Name | Type | Description |
PlanId [KEY] | String | |
BucketId | String | |
TaskId [KEY] | String | |
AssignedToUser | String | |
AssignedByUserId | String | |
AssignedByUserName | String | |
AssignedDateTime | Datetime | |
OrderHint | String |
Retrieves comments of a task.
The Cloud uses the Microsoft Planner 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.
If Scope = NoAdminConsent, List the data related to the groups that the user is a member of.
If Scope = AdminConsent, List all the data related to groups.
For example, the following queries are processed server side:
SELECT * FROM TaskComments SELECT * FROM TaskComments WHERE GroupId = '73094928-3786-4246-a0d1-90c' SELECT * FROM TaskComments WHERE ConversationThreadId = 'AAQkADBlMTk2ZmZjLTJlZmYtNGQ0Zi05ZmViLTQwNzM0MWM0NWU5ZAMkABAAWZ7-9ddvEUa7ZFI' SELECT * FROM TaskComments WHERE ConversationThreadId = 'AAQkADBlMTk2ZmZjLTJlZmYtNGQ0Zi05ZmViLTQwNzM0MWM0NWU5ZAMkABAAWZ7-9ddvEUa7ZFI' and GroupId = '73094928-3786-4246-a0d1-90c'
Name | Type | Description |
body_content | String | The contents of the post. |
body_contentType | String | The content type of the post. |
conversationId [KEY] | String | Unique ID of the conversation. |
conversationThreadId | String | Unique ID of the conversation thread. |
from_emailAddress_address | String | Indicates the email address, who posted the message on behalf of another user. |
from_emailAddress_name | String | Indicates the name, who posted the message on behalf of another user. |
hasAttachments | Bool | Indicates whether the post has at least one attachment. |
newParticipants | String | Conversation participants that were added to the thread as part of this post. |
receivedDateTime | Datetime | Specifies when the post was received. |
sender_emailAddress_address | String | Contains the email address of the sender. |
sender_emailAddress_name | String | Contains the name of the sender. |
inReplyTo_id | String | Reply to post id. |
GroupId | String | Group Id. |
The Users resource provides methods that allow you to manage users for the account.
The Cloud will use the Microsoft Planner 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 queries are processed server side:
SELECT * FROM Users WHERE Id = '9523f1-aa0-4fe17-a9w7b-6860618adf'
Name | Type | Description |
aboutMe | String | |
accountEnabled | Bool | |
ageGroup | String | |
assignedLicenses | String | |
assignedPlans | String | |
birthday | Datetime | |
businessPhones | String | |
city | String | |
companyName | String | |
consentProvidedForMinor | String | |
country | String | |
department | String | |
deviceEnrollmentLimit | Int | |
displayName | String | |
employeeId | String | |
faxNumber | String | |
givenName | String | |
hireDate | Datetime | |
imAddresses | String | |
interests | String | |
isResourceAccount | Bool | |
jobTitle | String | |
legalAgeGroupClassification | String | |
licenseAssignmentStates | String | |
String | ||
mailboxSettings_automaticRepliesSetting_status | String | |
mailboxSettings_automaticRepliesSetting_externalAudience | String | |
mailboxSettings_automaticRepliesSetting_scheduledStartDateTime_dateTime | String | |
mailboxSettings_automaticRepliesSetting_scheduledStartDateTime_timeZone | String | |
mailboxSettings_automaticRepliesSetting_internalReplyMessage | String | |
mailboxSettings_automaticRepliesSetting_externalReplyMessage | String | |
mailboxSettings_archiveFolder | String | |
mailboxSettings_timeZone | String | |
mailboxSettings_language_locale | String | |
mailboxSettings_language_displayName | String | |
mailboxSettings_workingHours_daysOfWeek | String | |
mailboxSettings_workingHours_startTime | Time | |
mailboxSettings_workingHours_endTime | Time | |
mailboxSettings_workingHours_timeZone_name | String | |
mailNickname | String | |
mobilePhone | String | |
mySite | String | |
officeLocation | String | |
onPremisesDistinguishedName | String | |
onPremisesDomainName | String | |
onPremisesExtensionAttributes_extensionAttribute1 | String | |
onPremisesExtensionAttributes_extensionAttribute2 | String | |
onPremisesExtensionAttributes_extensionAttribute3 | String | |
onPremisesExtensionAttributes_extensionAttribute4 | String | |
onPremisesExtensionAttributes_extensionAttribute5 | String | |
onPremisesExtensionAttributes_extensionAttribute6 | String | |
onPremisesExtensionAttributes_extensionAttribute7 | String | |
onPremisesExtensionAttributes_extensionAttribute8 | String | |
onPremisesExtensionAttributes_extensionAttribute9 | String | |
onPremisesExtensionAttributes_extensionAttribute10 | String | |
onPremisesExtensionAttributes_extensionAttribute11 | String | |
onPremisesExtensionAttributes_extensionAttribute12 | String | |
onPremisesExtensionAttributes_extensionAttribute13 | String | |
onPremisesExtensionAttributes_extensionAttribute14 | String | |
onPremisesExtensionAttributes_extensionAttribute15 | String | |
onPremisesImmutableId | String | |
onPremisesLastSyncDateTime | Datetime | |
onPremisesProvisioningErrors | String | |
onPremisesSamAccountName | String | |
onPremisesSecurityIdentifier | String | |
onPremisesSyncEnabled | Bool | |
onPremisesUserPrincipalName | String | |
otherMails | String | |
passwordPolicies | String | |
passwordProfile_password | String | |
passwordProfile_forceChangePasswordNextSignIn | Bool | |
passwordProfile_forceChangePasswordNextSignInWithMfa | Bool | |
pastProjects | String | |
postalCode | String | |
preferredLanguage | String | |
preferredName | String | |
provisionedPlans | String | |
proxyAddresses | String | |
responsibilities | String | |
schools | String | |
showInAddressList | Bool | |
signInSessionsValidFromDateTime | Datetime | |
skills | String | |
state | String | |
streetAddress | String | |
surname | String | |
usageLocation | String | |
userPrincipalName | String | |
userType | String | |
Id [KEY] | String |
ストアドプロシージャはファンクションライクなインターフェースで、Microsoft Planner の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMicrosoft Planner から関連するレスポンスデータを返します。
Name | Description |
GetAdminConsentURL | Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials. |
UpdateAssignedToTaskBoardTaskFormat | This stored procedure is used to render a task correctly in the AssignedTo view of the Task Board (a view organized by users to whom tasks are assigned to). |
UpdateBucketTaskBoardFormat | This stored procedure is used to render a task correctly in the Buckets view of the Task Board (a view organized by tasks within the buckets they are assigned to). |
UpdateProgressTaskBoardFormat | This stored procedure is used to render a task correctly in the Progress view of the Task Board (a view organized by the state of the PercentComplete field on the task object, with columns for Not Started, In Progress and Complete). |
Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.
Name | Type | Required | Description |
CallbackUrl | String | False | 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 | False | The same value for state that you sent when you requested the authorization code. |
Scope | String | False | A space-separated list of permissions to request from the Admin. The default value is 'offline_access https://graph.microsoft.com/Group.Read.All https://graph.microsoft.com/User.ReadBasic.All https://graph.microsoft.com/User.Read.All' |
Name | Type | Description |
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
This stored procedure is used to render a task correctly in the AssignedTo view of the Task Board (a view organized by users to whom tasks are assigned to).
Name | Type | Required | Description |
TaskId | String | True | The task Id. |
UserId | String | True | Id of user assigned. |
OrderHint | String | True | Order hint. |
This stored procedure is used to render a task correctly in the Buckets view of the Task Board (a view organized by tasks within the buckets they are assigned to).
Name | Type | Required | Description |
TaskId | String | True | The task Id. |
OrderHint | String | True | Order hint. |
This stored procedure is used to render a task correctly in the Progress view of the Task Board (a view organized by the state of the PercentComplete field on the task object, with columns for Not Started, In Progress and Complete).
Name | Type | Required | Description |
TaskId | String | True | The task Id. |
OrderHint | String | True | Order hint. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Microsoft Planner のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
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 | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Tasks テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Tasks'
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 などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、UpdateAssignedToTaskBoardFormat ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='UpdateAssignedToTaskBoardFormat' 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 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Tasks テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Tasks'
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:microsoftplanner: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、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
プロパティ | 説明 |
AuthScheme | Microsoft Planner に接続する際に使用する認証の種類。 |
プロパティ | 説明 |
AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
AzureEnvironment | 接続を確立するときに使用するAzure 環境。 |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthGrantType | The grant type for the OAuth flow. |
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
Scope | Specify this property to turn on / off the admin consent scopes. |
IncludeLabels | Determines if labels of the task will be shown. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | Microsoft Planner に接続する際に使用する認証の種類。 |
Microsoft Planner に接続する際に使用する認証の種類。
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 | The grant type for the OAuth flow. |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
The grant type for the OAuth flow.
string
"CODE"
The grant type for the OAuth flow. The following options are available: CODE, PASSWORD;
このセクションでは、本プロバイダーの接続文字列で設定可能な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, E=support@cdata.com"。共通のフィールドとその説明は以下のとおりです。
フィールド | 説明 |
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 プロパティの全リストを提供します。
プロパティ | 説明 |
Scope | Specify this property to turn on / off the admin consent scopes. |
IncludeLabels | Determines if labels of the task will be shown. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
Specify this property to turn on / off the admin consent scopes.
string
"NoAdminConsent"
初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。
Set this property to AdminConsent to enable admin consent scopes in the driver or set to NoAdminConsent to use default scopes which does not require admin consent.
Determines if labels of the task will be shown.
bool
false
Determines if labels of the task will be shown.
クエリで集計または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 は例外をスローします。