CData Sync App は、Microsoft Planner データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Microsoft Planner コネクタはCData Sync アプリケーションから使用可能で、Microsoft Planner からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Microsoft Planner への接続を作成します。Microsoft Planner アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからMicrosoft Planner コネクタをダウンロードおよびインストールします。
必須プロパティは[設定]タブにリストされています。[Advanced]タブには、通常は必要ない接続プロパティが表示されます。
Azure AD は、OAuth を経由する接続タイプです。AuthScheme をAzureAD に設定し、認証方法についてはOAuth 認証の使用 を参照してください。
Azure サービスプリンシパルは、OAuth を経由する接続タイプです。AuthScheme をAzureServicePrincipal に設定し、認証方法についてはAzure サービスプリンシパル認証の使用 を参照してください。
Azure VM 上でMicrosoft Planner を実行している場合は、Managed Service Identity(MSI)の資格情報を利用して接続が可能です。
MSI 資格情報が認証用に自動的に取得されます。
このセクションでは、Microsoft Planner Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 These views are useful when you cannot directly control queries being issued to the drivers.カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合して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 の操作を実行できます。
Sync App は、Microsoft Planner にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをインメモリで処理します。このセクションでは、API の制限および要件についても説明します。
Sync App がクライアントサイドのインメモリ処理でAPI 制限を回避する方法の詳細については、SupportEnhancedSQL を参照してください。
Sync App はMicrosoft Planner のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、Microsoft Planner テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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. |
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 |
The Users resource provides methods that allow you to manage users for the account.
The Sync App 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 Sync App.
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 |
Property | Description |
AuthScheme | Microsoft Planner に接続する際に使用する認証の種類。 |
Property | Description |
AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
AzureEnvironment | 接続を確立するときに使用するAzure 環境。 |
Property | Description |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthGrantType | The grant type for the OAuth flow. |
Property | Description |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
Property | Description |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
Property | Description |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
Property | Description |
LogModules | ログファイルに含めるコアモジュール。 |
Property | Description |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
Property | Description |
Scope | Specify this property to turn on / off the admin consent scopes. |
IncludeLabels | Determines if labels of the task will be shown. |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
SupportEnhancedSQL | このプロパティは、API から直接サポートされる範囲を超えるSQL 機能の拡張は、インメモリによるクライアントサイド処理を有効にすることで可能になります。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
AuthScheme | Microsoft Planner に接続する際に使用する認証の種類。 |
Microsoft Planner に接続する際に使用する認証の種類。
This section provides a complete list of the Azure Authentication properties you can configure in the connection string for this provider.
Property | Description |
AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
AzureEnvironment | 接続を確立するときに使用するAzure 環境。 |
データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
データにアクセスするために使用されるMicrosoft Online テナント。例えば、contoso.onmicrosoft.com です。あるいは、 テナントId を指定します。この値は[Azure ポータル]->[Azure Active Directory]->[プロパティ]のディレクトリId です。
通常、Tenant を指定する必要はありません。OAuthGrantType をCODE(デフォルト)に設定している場合は、Microsoft が自動的に決定します。 ただし、ユーザーがマルチテナントに所属している場合は失敗する可能性があります。 例えば、ドメインA の管理者がドメインB のユーザーをゲストユーザーとして招待した場合。ユーザーは両方のテナントに属していることになります。 Tenant を指定するのはグッドプラクティスですが、一般的には指定しなくてもうまく動作するはずです。
OAuthGrantType をCLIENT に設定する場合は、AzureTenant が必須です。クライアント資格情報を使用する場合、ユーザーコンテキストはありません。 資格情報は、アプリ自体のコンテキストから取得されます。Microsoft ではTenant を指定せずにクライアント資格情報を取得することを許容していますが、使用する特定のテナントを選択する可能性ははるかに低くなっています。 このため、接続するドメインに適用される資格情報を確実に取得するために、すべてのクライアント資格情報接続に対してAzureTenant を明示的に指定する必要があります。
接続を確立するときに使用するAzure 環境。
ほとんどの場合、環境をグローバルに設定したままにしておくとうまく機能します。ただし、 Azure アカウントが別の環境に追加されている場合は、AzureEnvironment を使用してどの環境かを 指定できます。利用可能な値はGLOBAL、CHINA、GERMANY、USGOVT、およびUSGOVTDOD です。
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
Property | Description |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthGrantType | The grant type for the OAuth flow. |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
The grant type for the OAuth flow.
The grant type for the OAuth flow. The following options are available: CODE, PASSWORD;
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
Property | Description |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はMicrosoft Planner への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
Property | Description |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
LogModules | ログファイルに含めるコアモジュール。 |
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\MicrosoftPlanner Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
Scope | Specify this property to turn on / off the admin consent scopes. |
IncludeLabels | Determines if labels of the task will be shown. |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
SupportEnhancedSQL | このプロパティは、API から直接サポートされる範囲を超えるSQL 機能の拡張は、インメモリによるクライアントサイド処理を有効にすることで可能になります。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
Specify this property to turn on / off the admin consent scopes.
初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。
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.
Determines if labels of the task will be shown.
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
このプロパティは、API から直接サポートされる範囲を超えるSQL 機能の拡張は、インメモリによるクライアントサイド処理を有効にすることで可能になります。
SupportEnhancedSQL がtrue に設定されている場合、Sync App はMicrosoft Planner にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをインメモリで処理します。この方法で、Sync App はサポートされていない宣言、JOIN、および集計を実行することができます。
SupportEnhancedSQL がfalse に設定されている場合、Sync App はSQL 実行をMicrosoft Planner API でサポートされている範囲に制限します。
Sync App は、どの句がデータソースでサポートされているかを決定し、クエリを充足する最小セットの行を取得するためにソースにクエリを送信します。そして、残りの行をローカルでフィルタリングします。フィルタリング処理がストリームされている場合、Sync App は大きなデータセットに対しても効率よいフィルタリングが可能です。
Sync App は、インメモリでのJOIN でさまざまな技術を使用します。Sync App は、メモリ使用量と同じテーブルを複数回読む要求をトレードオフします。
Sync App は、インメモリで集計を処理するために必要なすべての行を取得します。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。