Azure Data Factory または Synapse Analytics を使用して ServiceNow からデータをコピーする
適用対象: Azure Data Factory Azure Synapse Analytics
ヒント
企業向けのオールインワン分析ソリューション、Microsoft Fabric の Data Factory をお試しください。 Microsoft Fabric は、データ移動からデータ サイエンス、リアルタイム分析、ビジネス インテリジェンス、レポートまで、あらゆるものをカバーしています。 無料で新たに試用を開始する方法については、こちらをご覧ください。
この記事では、Azure Data Factory および Synapse Analytics パイプラインでコピー アクティビティを使用して、ServiceNow からデータをコピーする方法について説明します。 この記事は、コピー アクティビティの概要を示しているコピー アクティビティの概要に関する記事に基づいています。
重要
新しい ServiceNow コネクタでは、ネイティブ ServiceNow のサポートが強化されています。 ソリューションでレガシ ServiceNow コネクタを使用している場合は、2024 年 10 月 31 日までに ServiceNow コネクタをアップグレードしてください。 レガシ バージョンと最新バージョンの違いの詳細については、このセクションを参照してください。
サポートされる機能
この ServiceNow コネクタは、次の機能でサポートされます。
サポートされる機能 | IR |
---|---|
Copy アクティビティ (ソース/-) | ① ② |
Lookup アクティビティ | ① ② |
① Azure 統合ランタイム ② セルフホステッド統合ランタイム
ソースおよびシンクとしてサポートされているデータ ストアの一覧については、「サポートされているデータ ストア」の表を参照してください。
このサービスでは、接続を可能にする組み込みのドライバーが提供されます。 そのため、このコネクタを使用するドライバーを手動でインストールする必要はありません。
ServiceNow に表示される値ではなく、実際の値を使用してください。
前提条件
このコネクタを使うには、ServiceNow の sys_db_object と sys_dictionary テーブルへの少なくとも読み取りアクセス権を持つロールが必要です。
作業の開始
パイプラインでコピー アクティビティを実行するには、次のいずれかのツールまたは SDK を使用します。
UI を使用して ServiceNow のリンク サービスを作成する
次の手順を使用して、Azure portal UI で ServiceNow のリンク サービスを作成します。
Azure Data Factory または Synapse ワークスペースの [管理] タブに移動し、[リンクされたサービス] を選択して、[新規] をクリックします。
ServiceNow を検索し、ServiceNow コネクタを選択します。
サービスの詳細を構成し、接続をテストして、新しいリンク サービスを作成します。
コネクタの構成の詳細
次のセクションでは、ServiceNow コネクタに固有の Data Factory エンティティの定義に使用されるプロパティについて詳しく説明します。
リンクされたサービスのプロパティ
ServiceNow のリンクされたサービスでは、次のプロパティがサポートされます。
プロパティ | 内容 | 必須 |
---|---|---|
type | type プロパティは ServiceNowV2 に設定する必要があります | はい |
endpoint | ServiceNow サーバーのエンドポイント (http://<instance>.service-now.com )。 |
はい |
authenticationType | 使用する認証の種類。 使用できる値は、以下のとおりです。Basic、OAuth2 |
はい |
username | Basic および OAuth2 認証で ServiceNow サーバーへの接続に使用されるユーザー名。 | はい |
password | Basic および OAuth2 認証のユーザー名に対応するパスワード。 このフィールドを SecureString とマークして安全に保存するか、Azure Key Vault に保存されているシークレットを参照します。 | はい |
clientId | OAuth2 認証のクライアント ID。 | はい (OAuth 認証の場合) |
clientSecret | OAuth2 認証のクライアント シークレット。 このフィールドを SecureString とマークして安全に保存するか、Azure Key Vault に保存されているシークレットを参照します。 | はい (OAuth 認証の場合) |
grantType | クライアント アプリがトークンへのアクセスに使用する OAuth2.0 フローの種類を指定します。 既定値は password です。 | はい (OAuth 認証の場合) |
例:
{
"name": "ServiceNowLinkedService",
"properties": {
"type": "ServiceNowV2",
"typeProperties": {
"endpoint" : "http://<instance>.service-now.com",
"authenticationType" : "Basic",
"username" : "<username>",
"password": {
"type": "SecureString",
"value": "<password>"
}
}
}
}
データセットのプロパティ
データセットを定義するために使用できるセクションとプロパティの完全な一覧については、データセットに関する記事をご覧ください。 このセクションでは、ServiceNow データセットでサポートされるプロパティの一覧を示します。
ServiceNow からデータをコピーするには、データセットの type プロパティを ServiceNowV2Object に設定します。 次のプロパティがサポートされています。
プロパティ | 内容 | 必須 |
---|---|---|
type | データセットの type プロパティは、ServiceNowV2Object に設定する必要があります | はい |
tableName | テーブルの名前。 | はい |
例
{
"name": "ServiceNowDataset",
"properties": {
"type": "ServiceNowV2Object",
"typeProperties": {
"tableName": "<table name>"
},
"schema": [],
"linkedServiceName": {
"referenceName": "<ServiceNow linked service name>",
"type": "LinkedServiceReference"
}
}
}
コピー アクティビティのプロパティ
アクティビティの定義に利用できるセクションとプロパティの完全な一覧については、パイプラインに関する記事を参照してください。 このセクションでは、ServiceNow ソース でサポートされるプロパティの一覧を示します。
ソースとしての ServiceNow
ServiceNow からデータをコピーするには、コピー アクティビティのソースの種類を ServiceNowV2Source に設定します。 コピー アクティビティの source セクションでは、次のプロパティがサポートされます。
プロパティ | 内容 | 必須 |
---|---|---|
type | Copy アクティビティ ソースの type プロパティは ServiceNowV2Source に設定する必要があります | はい |
式 (expression) | 式を使用してデータを読み取ります。 クエリ ビルダーで式を構成できます。 これは、ServiceNow の条件ビルダーと同じ使い方です。 使用方法については、こちらの記事をご覧ください。 | いいえ |
expression の "下" |
||
type | 式の型。 値には、定数 (既定値)、単項、バイナリ、フィールドを指定できます。 | いいえ |
値 | 定数の値です。 | 式の型が定数またはフィールドの場合は、はい |
演算子 | 演算子の値。 演算子の詳細については、この記事の文字列を含む選択フィールドで使用可能な演算子セクションをご覧ください。 | 式の型が単項またはバイナリの場合は、はい |
オペランド | 演算子が適用される式の一覧。 | 式の型が単項またはバイナリの場合は、はい |
例:
"activities": [
{
"name": "CopyFromServiceNow",
"type": "Copy",
"inputs": [
{
"referenceName": "<ServiceNow input dataset name>",
"type": "DatasetReference"
}
],
"outputs": [
{
"referenceName": "<output dataset name>",
"type": "DatasetReference"
}
],
"typeProperties": {
"source": {
"type": "ServiceNowV2Source",
"expression": {
"type": "Nary",
"operators": [
"<"
],
"operands": [
{
"type": "Field",
"value": "u_founded"
},
{
"type": "Constant",
"value": "2000"
}
]
}
},
"sink": {
"type": "<sink type>"
}
}
}
]
Lookup アクティビティのプロパティ
プロパティの詳細については、Lookup アクティビティに関するページを参照してください。
ServiceNow コネクタをアップグレードする
ServiceNow コネクタをアップグレードする際に役立つ手順を次に示します。
- 「リンクされたサービスのプロパティ」を参照して、新しいリンクされたサービスを作成します。
- ソース内のクエリは、ServiceNow の条件ビルダーと同じ使用法のクエリ ビルダーにアップグレードされます。 ServiceNow をソースとして参照する設定方法について説明します。
ServiceNow と ServiceNow (レガシ) の違い
ServiceNow コネクタは新しい機能を提供し、ServiceNow (レガシ) コネクタのほとんどの機能と互換性があります。 次の表は、ServiceNow と ServiceNow (レガシ) の機能の違いを示しています。
ServiceNow | ServiceNow (レガシ) |
---|---|
リンクされたサービスでは useEncryptedEndpoints、useHostVerification、usePeerVerification をサポートしません。 | リンクされたサービスでは、useEncryptedEndpoints、useHostVerification、usePeerVerification をサポートします。 |
ソースでクエリ ビルダーをサポートします。 | ソースでクエリ ビルダーをサポートしません。 |
SQL ベースのクエリをサポートしません。 | SQL ベースのクエリをサポートします。 |
クエリ ビルダーで、sortBy クエリをサポートしません。 | クエリで sortBy クエリをサポートします。 |
データセット内のスキーマを表示できます。 | データセット内のスキーマは表示できません。 |
関連するコンテンツ
Copy アクティビティでソースおよびシンクとしてサポートされるデータ ストアの一覧については、サポートされるデータ ストアに関するセクションを参照してください。