CData Sync App は、Microsoft Teams データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Microsoft Teams コネクタはCData Sync アプリケーションから使用可能で、Microsoft Teams からデータを取得して、サポートされている任意の同期先に移動できます。
Microsoft Graph API v1.0 経由でMicrosoft Teams データに連携します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
CData は、認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、認証用のカスタムアプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、カスタムOAuth アプリケーションの作成 を参照してください。
認証に関して、CData が提供する(埋め込み)アプリケーションを使用する場合と独自のカスタムアプリケーションを作成する場合の唯一の違いは、カスタムOAuth アプリケーションを使用する場合に、高度な設定タブで2つの接続プロパティを追加で設定する必要があることだけです。
接続の前に、カスタムAzure AD アプリケーションの場合のみ以下の変数を設定します。
Microsoft Teams への接続 をクリックして、デフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。
ドライバーは、以下のようにOAuth プロセスを完了します。
Azure サービスプリンシパルは、ロールに基づいたアプリケーションベースの認証です。これは、認証がユーザーごとではなく、アプリケーションごとに行われることを意味します。 アプリケーションで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで、割り当てられたロールに基づいて実行されます。 リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。
Azure サービスプリンシパル認証の設定方法については、カスタムOAuth アプリケーションの作成 を参照してください。
Azure VM 上でMicrosoft Teams を実行しており、MSI を利用して接続したい場合は、AuthScheme をAzureMSI に設定します。
VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。
このセクションでは、Microsoft Teams Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Microsoft Teams にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Sync App は、Microsoft Teams オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。 Microsoft Teams オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。 次のセクションでは、利用可能なAPI オブジェクトを示し、Microsoft Teams API へのSQL の実行について詳しく説明します。
ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。
Sync App はMicrosoft Teams のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
Apps | Apps table for MSTeams data provider. |
Channels | Channels table for MSTeams data provider. |
GroupMembers | GroupMembers table for MSTeams data provider. |
GroupOwners | GroupOwners table for MSTeams data provider. |
Groups | Groups table for MSTeams data provider. |
OpenShifts | Shifts table for MSTeams data provider. |
Schedules | Schedules table for MSTeams data provider. |
SchedulingGroups | SchedulingGroups table for MSTeams data provider. |
Shifts | Shifts table for MSTeams data provider. |
Teams | Teams table for MSTeams data provider. |
TeamsInstalledApps | TeamsInstalledApps table for MSTeams data provider. |
TeamTabs | TeamTabs table for MSTeams data provider. |
TimeOffReasons | TimesOffReasons table for MSTeams data provider. |
TimesOff | TimesOff table for MSTeams data provider. |
Apps table for MSTeams data provider.
この操作は、Microsoft Teams ストアと組織のアプリカタログ(テナントアプリカタログ)のアプリを両方含みます。組織のアプリカタログのみからアプリを取得する場合は、distributionMethod にOrganization を指定してください。 Sync App はMicrosoft Teams API を使って、次のカラムと演算子で作成したWHERE 句の条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Apps WHERE DisplayName = 'MailChimp' SELECT * FROM Apps WHERE DisplayName IN ('OneNote', 'Teams') SELECT * FROM Apps WHERE Id LIKE '%-3b58-%' SELECT * FROM Apps WHERE externalId IN (123, 156)
アプリは自身の組織のアプリカタログ(テナントアプリカタログ)からのみ削除できます。アプリレコードを削除するには、WHERE 句にId を指定する必要があります。
DELETE FROM Apps WHERE Id = 'ffdb7239-3b58-46ba-b108-7f90a6d8799b'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The catalog app's generated app ID. |
displayName | String | False |
The name of the catalog app provided by the app developer. |
distributionMethod | String | False |
The method of distribution for the app. |
externalId | String | False |
The ID of the catalog provided by the app developer in the Microsoft Teams zip app package. |
Channels table for MSTeams data provider.
すべてのチーム内のすべてのチャネルを取得するかTeamId を指定することで、Channels テーブルをクエリします。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。
その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Channels WHERE TeamId IN ('da838338-4e77-4c05-82a6-79d9f0274511', 'da838338-4e77-4c05-82a6-79d9f0274555') SELECT * FROM Channels WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND Id = '19:[email protected]' SELECT * FROM Channels WHERE description != 'desc' SELECT * FROM Channels WHERE webUrl LIKE '%teams.microsoft.com/l/channel/%'
最低でもTeamId およびDisplayName は、チームに新しいチャネルを追加するために必須です。他のフィールドもすべて指定できます。
INSERT INTO Channels (displayName, description, TeamId) VALUES ('a new channel', 'top tasks channel', 'da838338-4e77-4c05-82a6-79d9f0274511')
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The channel's unique identifier. |
TeamId | String | False |
The Team Id. |
CreatedDateTime | Datetime | False |
Timestamp at which the channel was created. |
Description | String | False |
Optional textual description for the channel. |
DisplayName | String | False |
Channel name as it will appear to the user in Microsoft Teams. |
String | False |
The email address for sending messages to the channel. Read-only. | |
IsFavoriteByDefault | Bool | False |
Indicates whether the channel should automatically be marked 'favorite' for all members of the team. Can only be set programmatically with Create team. Default: false. |
MembershipType | String | False |
The type of the channel. Can be set during creation and cannot be changed. Default: standard. |
WebUrl | String | False |
A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. |
FilesFolder_id | String | True |
The FilesFolder Id. |
GroupMembers table for MSTeams data provider.
チームからすべてを取得するか、GroupId を'=' とIN 演算子で指定することでGroupMembers テーブルをクエリします。デフォルトでは、自身がメンバーであるグループのメンバーのみ返されます。組織の全グループのメンバーを取得するには、IncludeAllGroups プロパティをtrue に設定してください。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
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'
GroupId およびMemberId フィールドは新しいメンバーをグループに挿入する際には必須です。MemberId はユーザーのId に対応し、Users テーブルをクエリすることでメンバーとして追加したいユーザーのId を取得できます。
INSERT INTO GroupMembers (GroupId, MemberId) VALUES ('acabe397-8370-4c31-aeb7-2d7ae6b8cda1', 'ad9de185-a7af-4ae5-946e-17fc1bf596f0')
GroupId およびMemberId を指定することでグループメンバーを削除できます。
DELETE FROM GroupMembers WHERE GroupId = 'e557c6d9-3d9a-4658-b51a-4f242c2f8ec8' AND MemberId = 'ba074a2a-69be-45d2-8519-2cc5688bca1e'
Name | Type | ReadOnly | Description |
GroupId [KEY] | String | False |
The Id of the Group. |
MemberId [KEY] | String | False |
The User Id of the member listed. |
GroupOwners table for MSTeams data provider.
チームからすべてを取得するか、GroupId を'=' とIN 演算子で指定することでGroupOwners テーブルをクエリします。デフォルトでは、自身がメンバーであるグループの所有者のみ返されます。組織の全グループの所有者を取得するには、IncludeAllGroups プロパティをtrue に設定してください。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM GroupOwners WHERE GroupId IN ('4729c5e5-f923-4435-8a41-44423d42ea79', 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1') SELECT * FROM GroupOwners WHERE GroupId = '4729c5e5-f923-4435-8a41-44423d42ea79'
ユーザーをグループの所有者に追加できます。所有者とは、グループオブジェクトを変更できる管理者ではないユーザーのことです。GroupId およびOwnerId フィールドは、新しいメンバーをグループに挿入するために必須です。OwnerId はユーザーのId に対応し、Users テーブルをクエリすることで所有者として追加したいユーザーのId を取得できます。
INSERT INTO GroupOwners (GroupId, OwnerId) VALUES ('acabe397-8370-4c31-aeb7-2d7ae6b8cda1', 'ad9de185-a7af-4ae5-946e-17fc1bf596f0')
GroupId およびOwnerId を指定することでグループメンバーを削除できます。
DELETE FROM GroupOwners WHERE GroupId = 'e557c6d9-3d9a-4658-b51a-4f242c2f8ec8' AND OwnerId = 'ba074a2a-69be-45d2-8519-2cc5688bca1e'
Name | Type | ReadOnly | Description |
GroupId [KEY] | String | False |
The Id of the Group. |
OwnerId [KEY] | String | False |
The User Id of the owner listed. |
Groups table for MSTeams data provider.
デフォルトでは、自身がメンバーであるグループのみ返されます。組織の全グループを取得するには、IncludeAllGroups プロパティをtrue に設定してください。Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Groups WHERE Id = 'aee54826-eedb-4145-8e6b-4ec1ac4d82c6'
最低でもDisplayName、MailEnabled、MailNickname、SecurityEnabled が新しいグループを挿入するには必須です。他のフィールドもすべて指定できます。
INSERT INTO Groups (DisplayName, Description, MailEnabled, MailNickname, SecurityEnabled) VALUES ('Test Group', 'Group created from Api', false, 'test123', true)
グループのレコードを更新するには、WHERE 句にId を指定してください。
UPDATE Groups SET Description = 'updated description from api' WHERE Id = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'
グループのレコードを削除するには、WHERE 句にId を指定してください。
DELETE FROM Groups WHERE Id = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier for the group. |
DeletedDateTime | Datetime | False |
Timestamp of when the group was deleted. |
AllowExternalSenders | Bool | False |
Indicates if people external to the organization can send messages to the group. Default value is false. |
AssignedLabels | String | False |
The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. |
AssignedLicenses | String | False |
The licenses that are assigned to the group. |
AutoSubscribeNewMembers | Bool | False |
Indicates if new members added to the group will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group. Default value is false. |
Classification | String | False |
Describes a classification for the group (such as low, medium or high business impact). |
CreatedDateTime | Datetime | False |
Timestamp of when the group was created. |
Description | String | False |
An optional description for the group. |
DisplayName | String | False |
The display name for the group. |
ExpirationDateTime | Datetime | False |
Timestamp of when the group is set to expire. |
GroupTypes | String | False |
Specifies the group type and its membership. |
HasMembersWithLicenseErrors | Bool | False |
Indicates whether there are members in this group that have license errors from its group-based license assignment. |
HideFromAddressLists | Bool | False |
true if the group is not displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups; false otherwise. Default value is false. |
HideFromOutlookClients | Bool | False |
true if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web, false otherwise. Default value is false. |
IsArchived | Bool | False |
Indicated whether the Group is Archived. |
IsSubscribedByMail | Bool | False |
Indicates whether the signed-in user is subscribed to receive email conversations. |
LicenseProcessingState_state | String | False |
Indicates status of the group license assignment to all members of the group. |
String | False |
The SMTP address for the group | |
MailEnabled | Bool | False |
Specifies whether the group is mail-enabled. |
MailNickname | String | False |
The mail alias for the group, unique in the organization. |
MembershipRule | String | False |
The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). |
MembershipRuleProcessingState | String | False |
Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. |
OnPremisesDomainName | String | False |
Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. |
OnPremisesLastSyncDateTime | Datetime | False |
Indicates the last time at which the group was synced with the on-premises directory. |
OnPremisesNetBiosName | String | False |
Contains the on-premises netBios name synchronized from the on-premises directory. |
OnPremisesProvisioningErrors | String | False |
Errors when using Microsoft synchronization product during provisioning. |
OnPremisesSamAccountName | String | False |
Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. |
OnPremisesSecurityIdentifier | String | False |
Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. |
OnPremisesSyncEnabled | Bool | False |
true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). |
PreferredDataLocation | String | False |
The preferred data location for the group. |
PreferredLanguage | String | False |
The preferred language for a Microsoft 365 group. |
ProxyAddresses | String | False |
Email addresses for the group that direct to the same group mailbox. |
RenewedDateTime | Datetime | False |
Timestamp of when the group was last renewed. |
SecurityEnabled | Bool | False |
Specifies whether the group is a security group. |
SecurityIdentifier | String | False |
Security identifier of the group, used in Windows scenarios. |
Theme | String | False |
Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. |
UnseenCount | Int | False |
Count of conversations that have received new posts since the signed-in user last visited the group. |
Visibility | String | False |
Specifies the group join policy and group content visibility for groups. |
Calendar_id | String | True |
The Calendar Id. |
CreatedOnBehalfOf_id | String | True |
The CreatedOnBehalfOf Id. |
Drive_id | String | True |
The Drive Id. |
Onenote_id | String | True |
The Onenote Id. |
Photo_id | String | True |
The Photo Id. |
Planner_id | String | True |
The Planner Id. |
Team_id | String | True |
The Team Id. |
Members | String | False |
The Members Id. |
Owners | String | False |
The Owners Id. |
UserId | String | False |
The User Id. |
Shifts table for MSTeams data provider.
チームからすべてを取得するか、GroupId を'=' とIN 演算子で指定することでOpenShifts テーブルをクエリします。デフォルトでは、自身がメンバーであるグループのチームの空のシフトのみ返されます。組織の全グループのチームの空のシフトアイテムを取得するには、IncludeAllGroups プロパティをtrue に設定してください。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM OpenShifts WHERE TeamId IN ('da838338-4e77-4c05-82a6-79d9f0274511', 'da834568-4df7-4c05-82a6-79d9f0274515') SELECT * FROM OpenShifts WHERE Id = 'OPNSHFT_2d49e6dd-d965-4ea2-a399-37f2a082852c' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'
チームスケジュールに空のシフトを挿入するにはTeamId と、startDateTime およびendDateTime を含むDraftOpenShift またはSharedOpenShift の情報の、どちらか1つを含む必要があります。
INSERT INTO OpenShifts (TeamId, draftopenshift_openslotcount, draftopenshift_startDateTime, draftopenshift_endDateTime) VALUES ('da838338-4e77-4c05-82a6-79d9f0274511', 4, '2020-09-16T10:00:00.000Z', '2020-09-16T18:00:00.000Z')
空のシフトを更新するには、WHERE 句にレコードId とTeamId が必要です。TeamId、Id、CreatedDateTime 以外のすべてのフィールドを更新できます。
UPDATE OpenShifts SET draftOpenShift_theme = 'blue' WHERE Id = 'OPNSHFT_2d49e6dd-d965-4ea2-a399-37f2a082852c' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'
シフトレコードを削除するには、WHERE 句にId とTeamId が必要です。
DELETE FROM OpenShifts WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND Id = 'OPNSHFT_2d49e6dd-d965-4ea2-a399-37f2a082852c'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
ID for the scheduling group that the open shift belongs to. |
CreatedDateTime | Datetime | False |
Timestamp at which the openshift was created. |
LastModifiedBy_application_displayName | String | False |
The display name of the application that last modified. |
LastModifiedBy_application_id | String | False |
The id of the application that last modified. |
LastModifiedDateTime | Datetime | False |
The timestamp on which this openshift was last updated. |
DraftOpenShift_openSlotCount | Int | False |
OpenSlotCount of DraftOpenShift |
SchedulingGroupId | String | False |
The SchedulingGroupId. |
SharedOpenShift_openSlotCount | Int | False |
OpenSlotCount of SharedOpenShift |
TeamId | String | False |
The Team Id. |
DraftOpenShift_displayName | String | False |
The shift label of the shiftItem.. |
DraftOpenShift_notes | String | False |
The shift notes for the shiftItem.. |
DraftOpenShift_StartDateTime | Datetime | False |
StartDateTime of DraftOpenShift |
DraftOpenShift_EndDateTime | Datetime | False |
EndDateTime of DraftOpenShift |
SharedOpenShift_displayName | String | False |
The shift label of the shiftItem.. |
SharedOpenShift_notes | String | False |
The shift notes for the shiftItem.. |
SharedOpenShift_StartDateTime | Datetime | False |
StartDateTime of SharedOpenShift |
SharedOpenShift_EndDateTime | Datetime | False |
EndDateTime of SharedOpenShift |
Schedules table for MSTeams data provider.
チームからすべてを取得するか、TeamId を'=' とIN 演算子で指定することでSchedules テーブルをクエリします。デフォルトでは、自身がメンバーであるグループのチームのスケジュールアイテムのみ返されます。組織の全グループのチームからスケジュールを取得するには、IncludeAllGroups プロパティをtrue に設定してください。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Schedules WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'
スケジュールのレコードを更新するには、WHERE 句にId とTeamId が必要です。
UPDATE Schedules SET timeZone = 'Africa/Casablanca', enabled = true WHERE Id = '4729c5e5-f923-4435-8a41-44423d42ea79' AND TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
ID of the schedule. |
TeamId [KEY] | String | False |
The Team Id. |
Enabled | Bool | False |
Indicates whether the schedule is enabled for the team. |
OfferShiftRequestsEnabled | Bool | False |
Indicates whether offer shift requests are enabled for the schedule. |
OpenShiftsEnabled | Bool | False |
Indicates whether open shifts are enabled for the schedule. |
ProvisionStatus | String | False |
The status of the schedule provisioning. The possible values are notStarted, running, completed, failed. |
ProvisionStatusCode | String | False |
Additional information about why schedule provisioning failed. |
SwapShiftsRequestsEnabled | Bool | False |
Indicates whether swap shifts requests are enabled for the schedule. |
TimeClockEnabled | Bool | False |
Indicates whether time clock is enabled for the schedule. |
TimeOffRequestsEnabled | Bool | False |
Indicates whether time off requests are enabled for the schedule. |
TimeZone | String | False |
Indicates the time zone of the schedule team using tz database format. |
WorkforceIntegrationIds | String | False |
The WorkforceIntegration Ids. |
SchedulingGroups table for MSTeams data provider.
チームからすべてを取得するか、TeamId を'=' とIN 演算子で指定することでSchedulingGroups テーブルをクエリします。デフォルトでは、自身がメンバーであるグループのチームのスケジュールグループのみ返されます。組織の全グループのチームからスケジュールグループを取得するには、IncludeAllGroups プロパティをtrue に設定してください。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM SchedulingGroups WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND Id = 'TAG_357350ce-2fa2-498d-9967-494296509c32'
チームにスケジュールグループを挿入するには、TeamId と最低でもDisplayName、IsActive、iconType の内1つのフィールドを指定する必要があります。
INSERT INTO SchedulingGroups (TeamId, DisplayName, IsActive) VALUES ('da838338-4e77-4c05-82a6-79d9f0274511', 'Cashiers', 'true')
スケジュールグループを更新するには、WHERE 句にId とTeamId が必要です。DisplayName およびIsActive フィールドは更新できます。
UPDATE SchedulingGroups SET DisplayName = 'Supervisors' WHERE Id = 'TAG_357350ce-2fa2-498d-9967-494296509c32' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'
スケジュールグループを削除するには、WHERE 句にId とTeamId が必要です。
DELETE FROM SchedulingGroups WHERE TeamId = 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1' AND Id = 'TAG_101f11df-e7c0-49f2-8d5c-a9ad085c97aa'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
ID of the schedulingGroup. |
TeamId | String | False |
The Team Id. |
CreatedDateTime | Datetime | False |
The time stamp in which this schedulingGroup was first created. |
LastModifiedBy_application_displayName | String | False |
The display name of the application that last modified. |
LastModifiedBy_application_id | String | False |
The id of the application that last modified. |
LastModifiedDateTime | Datetime | False |
The time stamp in which this schedulingGroup was last updated. |
DisplayName | String | False |
The display name for the schedulingGroup. |
IsActive | Bool | False |
Indicates whether the schedulingGroup can be used when creating new entities or updating existing ones. |
UserIds | String | False |
The list of user IDs that are a member of the schedulingGroup. |
Shifts table for MSTeams data provider.
チームからすべてを取得するか、TeamId を'=' とIN 演算子で指定することでShifts テーブルをクエリします。デフォルトでは、自身がメンバーであるグループのチームのシフトのみ返されます。組織の全グループのチームのシフトアイテムを取得するには、IncludeAllGroups プロパティをtrue に設定してください。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Shifts WHERE TeamId IN ('da838338-4e77-4c05-82a6-79d9f0274511', 'da834568-4df7-4c05-82a6-79d9f0274515') SELECT * FROM Shifts WHERE Id = 'SHFT_aac21ce9-82b3-4ad1-a841-dadb570c8ebf' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'
チームスケジュールにシフトを挿入するには、TeamId とこの休暇が付与される人のUserId に加えて、休暇のstartDateTime およびendDateTime を含むDraftShift またはSharedShift の情報の、どちらか1つを含む必要があります。
INSERT INTO Shifts (TeamId, UserId, draftShift_startDateTime, draftShift_endDateTime) VALUES ('da838338-4e77-4c05-82a6-79d9f0274511', '0409f710-2aa9-4f05-8944-ef382160f1d1', '2019-07-17T07:00:00Z', '2019-07-17T15:00:00Z') INSERT INTO Shifts (TeamId, UserId, sharedShift_startDateTime, sharedShift_endDateTime) VALUES ('da838338-4e77-4c05-82a6-79d9f0274511', '0409f710-2aa9-4f05-8944-ef382160f1d1', '2019-07-17T07:00:00Z', '2019-07-17T15:00:00Z')
シフトのレコードを更新するには、WHERE 句にId とTeamId が必要です。TeamId、Id、CreatedDateTime 以外のすべてのフィールドを更新できます。
UPDATE Shifts SET draftShift_theme = 'blue', draftShift_displayname = 'somename' WHERE Id = 'SHFT_aac21ce9-82b3-4ad1-a841-dadb570c8ebf' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'
シフトのレコードを削除するには、WHERE 句にId とTeamId が必要です。
DELETE FROM Shifts WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND Id = 'SHFT_aac21ce9-82b3-4ad1-a841-dadb570c8ebf'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
ID of the shift. |
TeamId | String | False |
The Team Id. |
UserId | String | False |
ID of the user assigned to the shift. |
CreatedDateTime | Datetime | False |
The timestamp on which this shift was first created. |
LastModifiedBy_application_displayName | String | False |
The display name of the application that last modified. |
LastModifiedBy_application_id | String | False |
The id of the application that last modified. |
LastModifiedDateTime | Datetime | False |
The timestamp on which this shift was last updated. |
DraftShift_activities | String | False |
An incremental part of a shift which can cover details of when and where an employee is during their shift. For example, an assignment or a scheduled break or lunch. |
DraftShift_displayName | String | False |
The shift label of the shiftItem. |
DraftShift_notes | String | False |
The shift notes for the shiftItem. |
DraftShift_startDateTime | Datetime | False |
The start date and time for the Draftshift |
DraftShift_endDateTime | Datetime | False |
The end date and time for the Draftshift |
SchedulingGroupId | String | False |
ID of the scheduling group the shift is part of. |
SharedShift_activities | String | False |
An incremental part of a shift which can cover details of when and where an employee is during their shift. For example, an assignment or a scheduled break or lunch. |
SharedShift_displayName | String | False |
The shift label of the shiftItem. |
SharedShift_notes | String | False |
The shift notes for the shiftItem. |
SharedShift_startDateTime | Datetime | False |
The start date and time for the Sharedshift |
SharedShift_endDateTime | Datetime | False |
The end date and time for the Sharedshift |
Teams table for MSTeams data provider.
チームからすべてを取得するか、GroupId を'=' とIN 演算子で指定することでTeams テーブルをクエリします。デフォルトでは、自身がメンバーであるグループのチームのみ返されます。組織の全グループのチームを取得するには、IncludeAllGroups プロパティをtrue に設定してください。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Teams WHERE GroupId IN ('4729c5e5-f923-4435-8a41-44423d42ea79', 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1') SELECT * FROM Teams WHERE GroupId = '4729c5e5-f923-4435-8a41-44423d42ea79'
最低でもGroupId およびDisplayName は、グループに新しいチームを追加するために必須です。他のフィールドもすべて指定できます。
INSERT INTO Teams (DisplayName, GroupId, funSettings_allowGiphy) VALUES ('Cool team', 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1', false)
チームのレコードを更新するには、WHERE 句にId を指定してください。アーカイブされていないチームのみ更新できます。
UPDATE Teams SET DisplayName = 'My Team', funSettings_allowGiphy = false, funSettings_allowGiphy = true, funSettings_allowStickersAndMemes = true, funSettings_allowCustomMemes = false, guestSettings_allowCreateUpdateChannels = true, guestSettings_allowDeleteChannels = false, memberSettings_allowCreateUpdateChannels = false, memberSettings_allowDeleteChannels = true, Description = 'some desc' WHERE Id = '4729c5e5-f923-4435-8a41-44423d42ea79'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The Team Id. |
GroupId | String | False |
The Group Id. |
DisplayName | String | False |
The name of the team. |
Description | String | False |
An optional description for the team. |
Classification | String | False |
An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory. |
CreatedDateTime | Datetime | False |
Timestamp at which the team was created. |
FunSettings_allowCustomMemes | Bool | False |
If set to true, enables users to include custom memes. |
FunSettings_allowGiphy | Bool | False |
If set to true, enables Giphy use. |
FunSettings_allowStickersAndMemes | Bool | False |
If set to true, enables users to include stickers and memes. |
FunSettings_giphyContentRating | String | False |
Giphy content rating. Possible values are: moderate, strict. |
GuestSettings_allowCreateUpdateChannels | Bool | False |
If set to true, guests can add and update channels. |
GuestSettings_allowDeleteChannels | Bool | False |
If set to true, guests can delete channels. |
InternalId | String | False |
A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API. |
IsArchived | Bool | False |
Whether this team is in read-only mode. |
MemberSettings_allowAddRemoveApps | Bool | False |
If set to true, members can add and remove apps. |
MemberSettings_allowCreatePrivateChannels | Bool | False |
If set to true, members can add and update private channels. |
MemberSettings_allowCreateUpdateChannels | Bool | False |
If set to true, members can add and update any channels. |
MemberSettings_allowCreateUpdateRemoveConnectors | Bool | False |
If set to true, members can add, update, and remove connectors. |
MemberSettings_allowCreateUpdateRemoveTabs | Bool | False |
If set to true, members can add, update, and remove tabs. |
MemberSettings_allowDeleteChannels | Bool | False |
If set to true, members can delete channels. |
MessagingSettings_allowChannelMentions | Bool | False |
If set to true, @channel mentions are allowed. |
MessagingSettings_allowOwnerDeleteMessages | Bool | False |
If set to true, owners can delete any message. |
MessagingSettings_allowTeamMentions | Bool | False |
If set to true, @team mentions are allowed. |
MessagingSettings_allowUserDeleteMessages | Bool | False |
If set to true, users can delete their messages. |
MessagingSettings_allowUserEditMessages | Bool | False |
If set to true, users can edit their messages. |
Specialization | String | False |
Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case. |
Visibility | String | False |
The visibility of the group and team. Defaults to Public. |
WebUrl | String | False |
A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed. |
Group_id | String | True |
The Group Id. |
PrimaryChannel_id | String | True |
The PrimaryChannel Id. |
Schedule_id | String | True |
The Schedule Id. |
Template_id | String | True |
The Template Id. |
summary_guestsCount | Integer | True |
Count of guests in a team. |
summary_membersCount | Integer | True |
Count of members in a team. |
summary_ownersCount | Integer | True |
Count of owners in a team. |
TeamsInstalledApps table for MSTeams data provider.
Name | Type | ReadOnly | Description |
TeamId | String | False |
Id of Team. |
TeamsAppId | String | False |
Id of TeamsApp. |
TeamsAppDefinitionDescription | String | False |
Teams App Definition Description. |
TeamsAppDefinitionDisplayName | String | False |
Teams App Definition Display Name |
TeamsAppDefinitionLastModifiedDateTime | Datetime | False |
Teams App Definition Last Modified Date Time |
TeamsAppDefinitionPublishingState | String | False |
Teams App Definition Publishing State |
TeamsAppDefinitionShortDescription | String | False |
Teams App Definition Short Description |
TeamsAppDefinitionVersion | String | False |
Teams App Definition Version |
TeamTabs table for MSTeams data provider.
TeamsTabs テーブルをクエリするには、特定のチームに属する特定のチャネルのタブを取得するために、TeamId およびChannelId フィルタを指定する必要があります。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM TeamsTabs WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND ChannelId = '19:[email protected]' SELECT * FROM TeamsTabs WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5' AND ChannelId IN (SELECT Id FROM Channels WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5') AND Id LIKE '%-ade1-400a-a82b-e7a435199b7a' SELECT * FROM TeamsTabs WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5' AND ChannelId IN (SELECT Id FROM Channels WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5') AND configuration_entityId IS NOT NULL
最低でもTeamId、ChannelId、およびAppId は、チームに新しいタブを追加するために必須です。他のフィールドもすべて指定できます。
INSERT INTO TeamsTabs (TeamId, ChannelId, DisplayName, AppID) VALUES ('4729c5e5-f923-4435-8a41-44423d42ea79', '19:[email protected]', 'new tab for test', '0d820ecd-def2-4297-adad-78056cde7c78')
タブのレコードを更新するには、WHERE 句にId、ChannelId、TeamId を指定してください。
UPDATE TeamsTabs SET DisplayName = 'updatetabname' WHERE Id = 'c41cbfe0-7713-44d6-96dd-b692569f1766' AND ChannelId = '19:[email protected]' AND TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79'
タブのレコードを削除するには、WHERE 句にId、ChannelId、TeamId を指定してください。
DELETE FROM TeamsTabs WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND ChannelId = '19:[email protected]' AND Id = '16ba49df-d7e1-4dc7-b6c3-ea721d327d38'
Name | Type | ReadOnly | Description |
id [KEY] | String | False |
Identifier that uniquely identifies a specific instance of a channel tab. |
AppId | String | False |
The App Id. |
ChannelId | String | False |
The Channel Id. |
Configuration_contentUrl | String | False |
Url used for rendering tab contents in Teams. Required. |
Configuration_entityId | String | False |
Identifier for the entity hosted by the tab provider. |
Configuration_removeUrl | String | False |
Url called by Teams client when a Tab is removed using the Teams Client. |
Configuration_websiteUrl | String | False |
Url for showing tab contents outside of Teams. |
DisplayName | String | False |
Name of the tab. |
WebUrl | String | False |
Deep link URL of the tab instance. |
TeamsApp_id | String | True |
App definition identifier of the tab. |
TeamId | String | False |
The Team Id. |
TimesOffReasons table for MSTeams data provider.
チームからすべてを取得するか、TeamId を指定することでTimeOffReasons テーブルをクエリします。デフォルトでは、自身がメンバーであるグループのチームの休暇理由のみ返されます。組織の全グループのチームから休暇理由を取得するには、IncludeAllGroups プロパティをtrue に設定してください。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM TimeOffReasons WHERE TeamId IN ('da838338-4e77-4c05-82a6-79d9f0274511', 'da834568-4df7-4c05-82a6-79d9f0274515') SELECT * FROM TimeOffReasons WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND Id = 'SHFT_0aee55c3-2bac-4ede-9792-26838fc8bb01'
チームに休暇理由を挿入するには、TeamId と最低でもDisplayName、IsActive、iconType の内1つのフィールドを指定する必要があります。
INSERT INTO TimeOffReasons (TeamId, DisplayName, IsActive) VALUES ('acabe397-8370-4c31-aeb7-2d7ae6b8cda1', 'a new reason', 'true')
休暇理由のレコードを削除するには、WHERE 句にId とTeamId が必要です。
DELETE FROM TimeOffReasons WHERE Id = 'SHFT_dd50b99a-e2d8-44ad-a445-53ad58bfc37b' AND TeamId = 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
ID of the timeOffReason. |
TeamId | String | False |
The Team Id. |
CreatedDateTime | Datetime | False |
The time stamp on which this timeOffReason was first created. |
LastModifiedBy_application_displayName | String | False |
The display name of the application that last modified. |
LastModifiedBy_application_id | String | False |
The id of the application that last modified. |
LastModifiedDateTime | Datetime | False |
The time stamp on which this timeOffReason was last updated. |
DisplayName | String | False |
The name of the timeOffReason. Required. |
IconType | String | False |
Supported icon types: none; car; calendar; running; plane; firstAid; doctor; notWorking; clock; juryDuty; globe; cup; phone; weather; umbrella; piggyBank; dog; cake; trafficCone; pin; sunny. |
IsActive | Bool | False |
Indicates whether the timeOffReason can be used when creating new entities or updating existing ones. |
TimesOff table for MSTeams data provider.
チームからすべてを取得するか、TeamId を指定することでTimesOff テーブルをクエリします。デフォルトでは、自身がメンバーであるグループのチームの休暇のみ返されます。組織の全グループのチームから休暇を取得するには、IncludeAllGroups プロパティをtrue に設定してください。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM TimesOff WHERE TeamId IN ('da838338-4e77-4c05-82a6-79d9f0274511', 'da834568-4df7-4c05-82a6-79d9f0274515') SELECT * FROM TimesOff WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'
チームスケジュールに休暇を挿入するには、TeamId とこの休暇が付与される人のUserId に加えて、休暇のstartDateTime、endDateTime およびtimeOff_ReasonId を含むDraftTimeOff またはSharedTimeOff の情報の、どちらかを含む必要があります。
INSERT INTO TimesOff (TeamId, UserId, sharedTimeOff_startDateTime, sharedTimeOff_endDateTime, SharedTimeOff_TimeOffReasonId) VALUES ('da838338-4e77-4c05-82a6-79d9f0274511', '0409f710-2aa9-4f05-8944-ef382160f1d1', '2019-03-11T07:00:00Z', '2019-03-12T07:00:00Z', 'TOR_97de5f58-462b-4bde-8a95-038b4073bffb')
休暇のレコードを更新するには、WHERE 句にId とTeamId が必要です。TeamId、Id、CreatedDateTime 以外のすべてのフィールドを更新できます。
UPDATE Timesoff SET draftTimeOff_timeOffReasonId = 'TOR_97de5f58-462b-4bde-8a95-038b4073bffb' WHERE Id = 'SHFT_dd50b99a-e2d8-44ad-a445-53ad58bfc37b' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'
休暇のレコードを削除するには、WHERE 句にId とTeamId が必要です。
DELETE FROM TimesOff WHERE Id = 'SHFT_dd50b99a-e2d8-44ad-a445-53ad58bfc37b' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
ID of the timeOff. |
UserId | String | False |
ID of the user assigned to the timeOff. |
TeamId | String | False |
The Team Id. |
CreatedDateTime | Datetime | False |
The time stamp at which this timeOff was first created. |
LastModifiedBy_application_displayName | String | False |
The display name of the application that last modified. |
LastModifiedBy_application_id | String | False |
The id of the application that last modified. |
LastModifiedDateTime | Datetime | False |
The time stamp at which this timeOff was last updated. |
DraftTimeOff_timeOffReasonId | String | False |
DraftTimeOff's timeOffReasonId |
SharedTimeOff_timeOffReasonId | String | False |
SharedTimeOff's timeOffReasonId |
DraftTimeOff_StartDateTime | Datetime | False |
StartDateTime of DraftTimeOff |
DraftTimeOff_EndDateTime | Datetime | False |
EndDateTime of DraftTimeOff |
SharedTimeOff_StartDateTime | Datetime | False |
StartDateTime of DraftTimeOff |
SharedTimeOfft_EndDateTime | Datetime | False |
EndDateTime of DraftTimeOff |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
CallRecords | Details of calls on MS Teams. |
CallRecordSessions | Details of call sessions on MS Teams. |
CallRecordSessionSegments | Details of call session segments on MS Teams. |
ChannelMembers | Get members from channel. |
ChannelMessages | Get Channel messages and its replies. |
ChatMembers | Get members from chat. |
ChatMessages | Get Chat Messages. |
Chats | Get Chats. |
DirectRoutingCalls | Retrieves a list of direct routing calls |
PstnCalls | Retrieves a list of PSTN Calls |
TeamMembers | Get members from team. |
UserPresence | UserPresence table for MSTeams data provider. |
Users | Users table for MSTeams data provider. |
Details of calls on MS Teams.
CallRecord テーブルをクエリして、Teams のピアツーピアおよびグループ通話セッションセグメントの詳細を取得します。 CallRecordsId は、callRecord の取得の説明に従って取得してください。 カスタムアプリおよびクライアントクレデンシャルを使用する必要があります。カスタムOAuth アプリケーションの作成 を参照してください。
次にクエリの例を示します。
SELECT * FROM CallRecords WHERE CallRecordsId = 'b6ee7caa-f730-451f-b6bd-24592a3429a7'
Name | Type | Description |
Id [KEY] | String | Call record Id |
EndDateTime | Datetime | Time the call ended |
JoinWebUrl | String | URL used to join Meeting |
LastModifiedDateTime | Datetime | Last Modified date of this call record |
Modalities | String | Modalities which can be one or more of audio, video, videoBasedScreenSharing, data and screenSharing |
Organizer | String | Details of the organizer of the meeting |
Participants | String | Participants of the call. |
StartDateTime | Datetime | Start time of the meeting |
Type | String | Type of call peerToPeer or groupCall |
Version | Long | Version |
CallRecordsId | String | Call record Id. Mandatory internal column to be used in WHERE clause |
Details of call sessions on MS Teams.
CallRecordSessions テーブルをクエリして、Teams のピアツーピアおよびグループ通話セッションセグメントの情報を取得します。 CallRecordsId は、callRecord の取得の説明に従って取得してください。 カスタムアプリおよびクライアントクレデンシャルを使用する必要があります。カスタムOAuth アプリケーションの作成 を参照してください。
次にクエリの例を示します。
SELECT * FROM CallRecordSessions WHERE CallRecordsId = 'b6ee7caa-f730-451f-b6bd-24592a3429a7'
Name | Type | Description |
Id [KEY] | String | Call record Id |
Callee_UserAgent_ApplicationVersion | String | Callee UserAgent Application Version |
Callee_UserAgent_HeaderValue | String | Callee UserAgent Header Value |
Caller_UserAgent_ApplicationVersion | String | Caller UserAgent Application Version |
Caller_UserAgent_HeaderValue | String | Caller UserAgent Header Value |
EndDateTime | Datetime | Time the call ended |
FailureInfo_Reason | String | Failure Information Reason |
FailureInfo_Stage | String | Failure Information Stage |
Modalities | String | Modalities which can be one or more of audio, video, videoBasedScreenSharing, data and screenSharing |
StartDateTime | Datetime | Start time of the meeting |
CallRecordsId | String | Call record Id. Mandatory internal column to be used in WHERE clause |
Details of call session segments on MS Teams.
CallRecordSessionSegments テーブルをクエリして、Teams のピアツーピアおよびグループ通話セッションセグメントの詳細を取得します。 CallRecordsId は、callRecord の取得の説明に従って取得してください。 カスタムアプリおよびクライアントクレデンシャルを使用する必要があります。カスタムOAuth アプリケーションの作成 を参照してください。
次にクエリの例を示します。
SELECT * FROM CallRecordSessionSegments WHERE CallRecordsId = 'b6ee7caa-f730-451f-b6bd-24592a3429a7'
Name | Type | Description |
Id [KEY] | String | Call record Id |
Callee_UserAgent_ApplicationVersion | String | Callee UserAgent Application Version |
Callee_UserAgent_HeaderValue | String | Callee UserAgent Header Value |
Caller_UserAgent_ApplicationVersion | String | Caller UserAgent Application Version |
Caller_UserAgent_HeaderValue | String | Caller UserAgent Header Value |
EndDateTime | Datetime | Time the call ended |
FailureInfo_Reason | String | Failure Information Reason |
FailureInfo_Stage | String | Failure Information Stage |
Media | String | Call media details |
StartDateTime | Datetime | Start time of the meeting |
CallRecordsId | String | Call record Id. Mandatory internal column to be used in WHERE clause |
Get members from channel.
The Sync App uses the Microsoft Teams 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 ChannelMembers WHERE ChannelId = '19:[email protected]' AND TeamId = 'f7985bee-7fb4-404d-a954-5ba68ae7c8db' SELECT * FROM ChannelMembers WHERE ChannelId = '19:[email protected]' AND TeamId IN ('f7985bee-7fb4-404d-a954-5ba68ae7c8db', 'da838338-4e77-4c05-82a6-79d9f0274511')
Name | Type | Description |
Id [KEY] | String | Member Id. |
TeamId | String | Team Id. |
DisplayName | String | Display name. |
String | Email of member. | |
Roles | String | Role of member. |
TenantId | String | Tenant Id. |
UserId | String | User Id. |
StartDateTime | Datetime | History start date time. |
ChannelId | String | The Channel Id. |
Get Channel messages and its replies.
The Sync App uses the Microsoft Teams API to process WHERE clause conditions built with the columns and operator shown below. The rest of the filter is executed client-side within the Sync App.
Note: ChannelId and TeamId are required columns to get results from this view, and must both be specified in the WHERE clause. The data cannot be retrieved by the Sync App using ChannelId alone.
Example Queries
The Sync App executes this by fetching ChannelID and TeamId from Microsoft Teams API:
SELECT * FROM ChannelMessages
This query uses the TeamID from Microsoft Teams API to obtain the ChannelID:
SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79'
SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]'
SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]' AND Id='1688061957561'
To get all the replies in a message:
SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]' AND ReplyToId='1688061957561'
SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]' AND Id='1688061957562' AND ReplyToId='1688061957561'
Name | Type | Description |
Id [KEY] | String | The Channel Messsages Id. |
BodyContent | String | Content of the Body. |
BodyContentType | String | Type of BodyContent. |
ChannelId | String | The Channel Id. |
TeamId | String | The Team Id. |
Mentions | String | List of entities mentioned in the channel message. Supported entities are: user, bot, team, and channel. |
Reactions | String | Reactions for the channel messages (for example, Like). |
Attachments | String | References to attached objects like files, tabs, meetings etc. |
Importance | String | Importance of the messages. |
CreatedDateTime | Datetime | Timestamp of when the channel message was created. |
LastEditedDateTime | Datetime | The timestamp on which this message was last edited. |
LastModifiedDateTime | Datetime | The timestamp on which this message was last updated. |
DeletedDateTime | Datetime | Timestamp at which the channel messages was deleted, or null if not deleted. |
MessageType | String | Type of Channel message. |
ChatId | String | The Chat Id. |
Etag | String | Version number of the channel message. |
FromUserDisplayName | String | From User Display Name. |
FromUserId | String | From User Id. |
FromUserUserIdentityType | String | From User UserIdentityType. |
FromApplication | String | The From Application. |
FromDevice | String | The From Device. |
Locale | String | Locale of the channel message set by the client. Always set to en-us. |
PolicyViolation | String | Channel Message Policy Violation. |
ReplyToId | String | ID of the parent chat message or root chat message of the thread. |
Subject | String | The subject of the channel message, in plaintext. |
Summary | String | Summary text of the channel message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat. |
WebUrl | String | Link to the message in Microsoft Teams. |
EventDetail | String | The Event Message Detail. |
Get members from chat.
The Sync App use the Microsoft Teams API to process WHERE clause conditions built with the following column and operator:
The rest of the filter is executed client side within the Sync App.
The following is an example query:
SELECT * FROM ChatMembers WHERE UserId = 'e4ea490e-b30c-4b1e-92b0-337117920315' AND ChatId = '19:92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe_90a27c51-5c74-453b-944a-134ba86da790@unq.gbl.spaces' SELECT * FROM ChatMembers WHERE UserId = 'e4ea490e-b30c-4b1e-92b0-337117920315' AND ChatId IN ('19:92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe_90a27c51-5c74-453b-944a-134ba86da790@unq.gbl.spaces', '19:92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe_b62067c0-8314-42f8-9d02-d1c2051dfcdc@unq.gbl.spaces')
Name | Type | Description |
Id [KEY] | String | Member Id. |
ChatId | String | Chat Id. |
DisplayName | String | Display name. |
String | Email of member. | |
Roles | String | Role of member. |
TenantId | String | Tenant Id. |
UserId | String | User Id. |
StartDateTime | Datetime | History start date time. |
Get Chat Messages.
The Sync App uses the Microsoft Teams API to process WHERE clause conditions built with the following column and operator:
The rest of the filter is executed client side within the Sync App.
The following is an example query:
SELECT * FROM ChatMessages WHERE ChatId = '19:92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe_e4ea490e-b30c-4b1e-92b0-337117920315@unq.gbl.spaces'
Name | Type | Description |
Id [KEY] | String | The Chat Messages Id. |
ChatId | String | The Chat Id. |
BodyContent | String | Content of the Body. |
BodyContentType | String | Type of BodyContent. |
MessageType | String | Type of chat message. |
CreatedDateTime | Datetime | Timestamp of when the chat message was created. |
LastEditedDateTime | Datetime | The timestamp on which this message was last edited. |
LastModifiedDateTime | Datetime | The timestamp on which this message was last updated. |
DeletedDateTime | Datetime | Timestamp at which the chat message was deleted, or null if not deleted. |
Reactions | String | Reactions for the chat message (for example, Like). |
Mentions | String | List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel. |
Attachments | String | References to attached objects like files, tabs, meetings etc. |
Importance | String | Importance of the messages. |
FromUserDisplayName | String | From User Display Name. |
FromUserId | String | From User Id. |
FromUserIdentityType | String | From User UserIdentityType. |
ChannelIdentity | String | Identity of the Channel. |
Locale | String | Locale of the chat message set by the client. Always set to en-us. |
ReplyToId | String | ID of the parent chat message or root chat message of the thread. |
Subject | String | The subject of the chat message, in plaintext. |
Summary | String | Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat. |
PolicyViolation | String | Chat Message Policy Violation. |
Etag | String | Version number of the chat message. |
FromApplication | String | The From Application. |
FromDevice | String | The From Device. |
WebUrl | String | Link to the message in Microsoft Teams. |
EventDetail | String | The Event Message Detail. |
Get Chats.
The Sync App use the Microsoft Teams API to process WHERE clause conditions built with the following column and operator:
The rest of the filter is executed client side within the Sync App.
The following is an example query:
SELECT * FROM Chats WHERE Id = '19:32caef50-395c-425a-a994-e3fa4569b23b_92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe@unq.gbl.spaces'
Name | Type | Description |
Id [KEY] | String | The Chat Id. |
ChatType | String | The type of Chat. |
UserId | String | The User Id. |
CreatedDateTime | Datetime | Timestamp of when the message was created. |
LastUpdatedDateTime | Datetime | The timestamp on which this message was last updated. |
Topic | String | The Topic. |
Retrieves a list of direct routing calls
カスタムアプリおよびクライアントクレデンシャルを使用する必要があります。カスタムOAuth アプリケーションの作成 を参照してください。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
次にクエリの例を示します。
SELECT * FROM DirectRoutingCalls WHERE FromDate = '2021-01-01' SELECT * FROM DirectRoutingCalls WHERE FromDate = '2021-01-01' AND ToDate = '2021-02-09'
Note:FromDate とToDate は必須パラメータであり、指定されていない場合はデフォルトの日付を日付範囲90日で使用します。
Name | Type | Description |
Id | String | The Id of the Direct routing call |
CorrelationId | String | The Correlation ID |
UserId | String | The Id of the user |
UserPrincipalName | String | The principal name of the user |
UserDisplayName | String | The display name of the user |
StartDateTime | Edm.DateTimeOffset | The start date time of the call |
InviteDateTime | Edm.DateTimeOffset | The invite date time |
FailureDateTime | Edm.DateTimeOffset | The failure date time |
EndDateTime | Edm.DateTimeOffset | The end date time of the call |
Duration | Integer | The duration of the call |
CallType | String | The type of the call |
SuccessfulCall | String | The successful call |
CallerNumber | String | The caller number |
CalleeNumber | String | The callee number |
MediaPathLocation | String | The media path location |
SignalingLocation | String | The signaling location |
FinalSipCode | Integer | The final SIP Code |
CallEndSubReason | Integer | The sub reason of the call end |
FinalSipCodePhrase | String | The final SIP code phrase |
MediaBypassEnabled | Boolean | Whether Media Bypass is enabled or not |
FromDate | Edm.Date | The date from which calls to be fetched |
ToDate | Edm.Date | the date till when calls to be fetched |
Retrieves a list of PSTN Calls
カスタムアプリおよびクライアントクレデンシャルを使用する必要があります。カスタムOAuth アプリケーションの作成 を参照してください。 Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
次にクエリの例を示します。
SELECT * FROM PstnCalls WHERE FromDate = '2021-01-01' SELECT * FROM PstnCalls WHERE FromDate = '2021-01-01' AND ToDate = '2021-02-09'
Note:FromDate およびToDate は必須パラメータであり、指定されていない場合はデフォルトの日付を日付範囲90日で使用します。
Name | Type | Description |
Id | String | The Id of of the PSTN Call |
CallId | String | The Id of the Call |
UserId | String | The Id of the user |
UserPrincipalName | String | The principal name of the user |
UserDisplayName | String | The display name of the user |
StartDateTime | Edm.DateTimeOffset | The datetime of the call when it was started |
EndDateTime | Edm.DateTimeOffset | The datetime of the call when it was ended |
Duration | Integer | The call duration |
Charge | Edm.Double | The charge |
CallType | String | The type of the call |
Currency | String | Currency |
CallerNumber | String | The number of the caller |
CalleeNumber | String | The number of the callee |
UsageCountryCode | String | The usage country code |
TenantCountryCode | String | The tenant country code |
ConnectionCharge | Edm.Double | The connection charge |
DestinationName | String | The destination name |
ConferenceId | String | The Id of the conference |
LicenseCapability | String | The License Capability |
InventoryType | String | The type of the inventory |
FromDate | Edm.Date | The date from which calls to be fetched |
ToDate | Edm.Date | the date till when calls to be fetched |
Get members from team.
The Sync App will use the Microsoft Teams 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 query is processed server side:
SELECT * FROM TeamMembers WHERE TeamId = 'f7985bee-7fb4-404d-a954-5ba68ae7c8db' SELECT * FROM TeamMembers WHERE TeamId IN ('f7985bee-7fb4-404d-a954-5ba68ae7c8db', 'da838338-4e77-4c05-82a6-79d9f0274511')
Name | Type | Description |
Id [KEY] | String | Member Id. |
TeamId | String | Team Id. |
DisplayName | String | Display name. |
String | Email of member. | |
Roles | String | Role of member. |
TenantId | String | Tenant Id. |
UserId | String | User Id. |
StartDateTime | Datetime | History start date time. |
UserPresence table for MSTeams data provider.
The Sync App will use the Microsoft Teams API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Following is an example query:
SELECT * FROM UserPresence WHERE Id = '142478877' SELECT * FROM UserPresence WHERE Id IN ('0409f710-2aa9-4f05-8944-ef382160f1d1', '04a54c2f-2402-4cee-ac8e-9eee05d0dd30')
Name | Type | Description |
Id | String | Id of the users. |
Availability | String | Availbility of user |
Activity | String | Activity of user |
Users table for MSTeams data provider.
Users テーブルをクエリします。Sync App は Microsoft Teams API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Users WHERE Id = '08d30c14-2775-45c9-8809-3eca47340959'
Name | Type | Description |
Id [KEY] | String | The unique identifier for the user. |
DeletedDateTime | Datetime | The date and time when the user was deleted. |
AboutMe | String | A freeform text entry field for the user to describe themselves. |
AccountEnabled | Bool | true if the account is enabled; otherwise, false. |
AgeGroup | String | Sets the age group of the user. |
AssignedLicenses | String | The licenses that are assigned to the user. |
AssignedPlans | String | The plans that are assigned to the user. |
Birthday | Datetime | The birthday of the user. |
BusinessPhones | String | The telephone numbers for the user. |
City | String | The city in which the user is located. |
CompanyName | String | The company name which the user is associated. |
ConsentProvidedForMinor | String | Sets whether consent has been obtained for minors. |
Country | String | The country/region in which the user is located |
CreatedDateTime | Datetime | The date and time the user was created. |
CreationType | String | Indicates whether the user account was created as a regular school or work account (null), an external account (Invitation), a local account for an Azure Active Directory B2C tenant (LocalAccount) or self-service sign-up using email verification (EmailVerified). |
Department | String | The name for the department in which the user works. |
DeviceEnrollmentLimit | Int | The Device Enrollment Limit. |
DisplayName | String | The name displayed in the address book for the user. |
EmployeeHireDate | Datetime | The date and time when the user was hired or will start work in case of a future hire. |
EmployeeId | String | The employee identifier assigned to the user by the organization. |
EmployeeOrgData_costCenter | String | The cost center associated with the user. |
EmployeeOrgData_division | String | The name of the division in which the user works. |
EmployeeType | String | Captures enterprise worker type. |
ExternalUserState | String | For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. |
ExternalUserStateChangeDateTime | Datetime | Shows the timestamp for the latest change to the externalUserState property. |
FaxNumber | String | The fax number of the user. |
GivenName | String | The given name (first name) of the user. |
HireDate | Datetime | The hire date of the user. |
Identities | String | Represents the identities that can be used to sign in to this user account. |
ImAddresses | String | The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. |
Interests | String | A list for the user to describe their interests. |
IsResourceAccount | Bool | Do not use reserved for future use. |
JobTitle | String | The user's job title. |
LastPasswordChangeDateTime | Datetime | The time when this Azure AD user last changed their password. |
LegalAgeGroupClassification | String | Used by enterprise applications to determine the legal age group of the user. |
LicenseAssignmentStates | String | State of license assignments for this user. |
String | The SMTP address for the user. | |
MailboxSettings_archiveFolder | String | Folder ID of an archive folder for the user. |
MailboxSettings_automaticRepliesSetting_externalAudience | String | The set of audience external to the signed-in user's organization who will receive the ExternalReplyMessage, if Status is AlwaysEnabled or Scheduled. Possible values are: none, contactsOnly, all. |
MailboxSettings_automaticRepliesSetting_externalReplyMessage | String | The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled. |
MailboxSettings_automaticRepliesSetting_internalReplyMessage | String | The automatic reply to send to the audience internal to the signed-in user's organization, if Status is AlwaysEnabled or Scheduled. |
MailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime | String | The date and time that automatic replies are set to end, if Status is set to Scheduled. |
MailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone | String | The date and time that automatic replies are set to begin, if Status is set to Scheduled. |
MailboxSettings_automaticRepliesSetting_status | String | Configurations status for automatic replies. Possible values are: disabled, alwaysEnabled, scheduled. |
MailboxSettings_dateFormat | String | The date format for the user's mailbox. |
MailboxSettings_delegateMeetingMessageDeliveryOptions | String | If the user has a calendar delegate, this specifies whether the delegate, mailbox owner, or both receive meeting messages and meeting responses. |
MailboxSettings_language_displayName | String | The Language. |
MailboxSettings_language_locale | String | The locale information for the user, including the preferred language and country/region. |
MailboxSettings_timeFormat | String | The time format for the user's mailbox. |
MailboxSettings_timeZone | String | The default time zone for the user's mailbox. |
MailboxSettings_workingHours_daysOfWeek | String | The days of the week on which the user works. |
MailboxSettings_workingHours_endTime | Time | The time of the day that the user starts working. |
MailboxSettings_workingHours_startTime | Time | The time of the day that the user stops working. |
MailboxSettings_workingHours_timeZone_name | String | The time zone to which the working hours apply. |
MailNickname | String | The mail alias for the user. |
MobilePhone | String | The primary cellular telephone number for the user. |
MySite | String | The URL for the user's personal site. |
OfficeLocation | String | The office location in the user's place of business. |
OnPremisesDistinguishedName | String | Contains the on-premises Active Directory distinguished name or DN. |
OnPremisesDomainName | String | Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. |
OnPremisesExtensionAttributes_extensionAttribute1 | String | First customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute10 | String | Tenth customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute11 | String | Eleventh customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute12 | String | Twelfth customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute13 | String | Thirteenth customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute14 | String | Fourteenth customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute15 | String | Fifteenth customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute2 | String | Second customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute3 | String | Third customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute4 | String | Fourth customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute5 | String | Fifth customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute6 | String | Sixth customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute7 | String | Seventh customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute8 | String | Eighth customizable extension attribute. |
OnPremisesExtensionAttributes_extensionAttribute9 | String | Ninth customizable extension attribute. |
OnPremisesImmutableId | String | This property is used to associate an on-premises Active Directory user account to their Azure AD user object. |
OnPremisesLastSyncDateTime | Datetime | Indicates the last time at which the object was synced with the on-premises directory |
OnPremisesProvisioningErrors | String | Errors when using Microsoft synchronization product during provisioning. |
OnPremisesSamAccountName | String | Contains the on-premises sAMAccountName synchronized from the on-premises directory. |
OnPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. |
OnPremisesSyncEnabled | Bool | true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). |
OnPremisesUserPrincipalName | String | Contains the on-premises userPrincipalName synchronized from the on-premises directory. |
OtherMails | String | A list of additional email addresses for the user |
PasswordPolicies | String | Specifies password policies for the user. |
PasswordProfile_forceChangePasswordNextSignIn | Bool | If true, at next sign-in, the user must change their password. After a password change, this property will be automatically reset to *false. If not set, default is false. |
PasswordProfile_forceChangePasswordNextSignInWithMfa | Bool | If true, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. |
PasswordProfile_password | String | The password for the user. |
PastProjects | String | A list for the user to enumerate their past projects. |
PostalCode | String | The postal code for the user's postal address. |
PreferredLanguage | String | The preferred language for the user. |
PreferredName | String | The preferred name for the user. |
ProvisionedPlans | String | The plans that are provisioned for the user. |
ProxyAddresses | String | The Proxy Address. |
Responsibilities | String | A list for the user to enumerate their responsibilities. |
Schools | String | A list for the user to enumerate the schools they have attended. |
ShowInAddressList | Bool | true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false. |
SignInSessionsValidFromDateTime | Datetime | Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). |
Skills | String | A list for the user to enumerate their skills. |
State | String | The state or province in the user's address. |
StreetAddress | String | The street address of the user's place of business. |
Surname | String | The user's surname |
UsageLocation | String | A two letter country code |
UserPrincipalName | String | The user principal name (UPN) of the user. |
UserType | String | UserType |
Authentication_id | String | The Authentication Id |
Calendar_id | String | The Calendar Id |
Drive_id | String | The Drive Id |
InferenceClassification_id | String | The InferenceClassification Id |
Insights_id | String | The Insights Id |
Manager_id | String | The Manager Id |
Onenote_id | String | The Onenote Id |
Outlook_id | String | The Outlook Id |
Photo_id | String | The Photo Id |
Planner_id | String | The Planner Id |
Presence_id | String | The Presence Id |
Settings_id | String | The Settings Id |
Teamwork_id | String | The Teamwork Id |
Todo_id | String | The Todo Id |
プロパティ | 説明 |
AuthScheme | Microsoft Teams に接続する際に使用する認証の種類。 |
プロパティ | 説明 |
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 を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
IncludeAllGroups | A boolean indicating if you would like to list all the groups in your organizations or only groups the logged in user is member of. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | The maximum number of results to return per page from MSTeams. |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | Microsoft Teams に接続する際に使用する認証の種類。 |
Microsoft Teams に接続する際に使用する認証の種類。
このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。
プロパティ | 説明 |
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、USGOVT、USGOVTDOD です。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthGrantType | OAuth フローのグラント種別。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
OAuth フローのグラント種別。
次のオプションが利用可能です:CODE,CLIENT
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
JWT 証明書のストア。
クライアント証明書のための証明書ストア名。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
CA | 証明機関の証明書。 |
ROOT | ルート証明書。 |
SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。
JWT 証明書を格納するキーストアの種類。
このプロパティには次の値の一つを設定できます。
USER | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。 |
MACHINE | Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note:この種類はJava では利用できません。 |
PFXFILE | この証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。 |
PFXBLOB | この証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 |
JKSFILE | この証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。 Note:この種類はJava のみで利用できます。 |
JKSBLOB | この証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note:この種類はJava のみで利用できます。 |
PEMKEY_FILE | この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。 |
PEMKEY_BLOB | この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。 |
PUBLIC_KEY_FILE | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。 |
PUBLIC_KEY_BLOB | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。 |
SSHPUBLIC_KEY_FILE | この証明書ストアは、SSH 公開キーを含むファイルの名前です。 |
SSHPUBLIC_KEY_BLOB | この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。 |
P7BFILE | この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。 |
PPKFILE | この証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。 |
XMLFILE | この証明書ストアは、XML 形式の証明書を含むファイルの名前です。 |
XMLBLOB | この証明書ストアは、XML 形式の証明書を含む文字列の名前です。 |
OAuth JWT 証明書のパスワード。
証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。
OAuth JWT 証明書のサブジェクト。
証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。
完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。
それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。
"*" に設定すると、証明書ストアの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 を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はMicrosoft Teams への接続を開き、プロキシを経由して通信が行われます。 |
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 で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するには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 を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\MSTeams Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
Platform | %APPDATA% |
Windows | APPDATA 環境変数の値 |
Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、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` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
IncludeAllGroups | A boolean indicating if you would like to list all the groups in your organizations or only groups the logged in user is member of. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | The maximum number of results to return per page from MSTeams. |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
A boolean indicating if you would like to list all the groups in your organizations or only groups the logged in user is member of.
Setting this to true will list all the groups in your organization instead of only the groups the logged in user is member of.
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
The maximum number of results to return per page from MSTeams.
The Pagesize property affects the maximum number of results to return per page from MSTeams only for Users and Groups tables. If you must use client paging on your server and have a fast server, setting a higher Pagesize may be desireable. We recommend testing various sizes against a large resultset to determine what works best in your use case.
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Teams WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。