サービス定義のアップロード (サーバーツール)

サマリー

Web レイヤー、ロケーター、Web ツール、サービス、またはナレッジグラフを、ArcGIS Online、ArcGIS Enterprise、または ArcGIS Server にアップロードして共有します。

使用法

このツールは、入力のサービス定義に基づいて Web レイヤー、ロケーター、Web ツール、サービス、またはナレッジグラフをアップロードして共有します。
このツールでは、サービス定義のドラフトファイル (.sddraft) はアップロードおよび共有されません。サービス定義のドラフトがある場合は、サービスのステージングツールを使用して、ステージングされたサービス定義に変換できます。
Web ツールは ArcGIS Enterprise にのみ共有可能です。ジオプロセシングサービスは ArcGIS Server にのみ公開可能です。
ロケーター ArcGIS Enterprise にのみ共有可能です。ジオコードサービスは ArcGIS Server にのみ公開可能です。
ナレッジグラフは ArcGIS Enterprise 12.0 以降にのみ共有可能です。
次のものを対応する ArcGIS Enterprise バージョンに共有するときのみ、アイテム ID を指定できます:
- Web feature layer that copies all data—ArcGIS Enterprise 10.8.1 以降
- Web tile layer—ArcGIS Enterprise 10.8.1 以降
- Map image layer—ArcGIS Enterprise 11.2 以降
- Web feature layer that references registered data—ArcGIS Enterprise 11.2 以降
- OGC feature layer—ArcGIS Enterprise 11.2 以降
- WMS service layer—ArcGIS Enterprise 11.2 以降
- WFS service layer—ArcGIS Enterprise 11.2 以降
- Knowledge graphs—ArcGIS Enterprise 12.0 以降

ラベル	説明	データタイプ
サービス定義	Web レイヤー、ロケーター、Web ツール、サービス、またはナレッジグラフを共有するために必要なすべての情報が含まれているサービス定義ファイル (`.sd`)。	File
サーバー	サーバーの種類。サポートされているサーバータイプとしては、次のものがあります。 My Hosted Services—ホストされた Web レイヤーを ArcGIS Online または ArcGIS Enterprise で共有するときに使用します。サーバーコネクションの [マイホストサービス] を入力します。各単語の 1 文字目を大文字にし、単語と単語の間にスペースを入れます。 HOSTING_SERVER—ホストされた Web レイヤーを ArcGIS Online または ArcGIS Enterprise で共有するときに使用します。 URL to the ArcGIS Enterprise portal federated server—ArcGIS Enterprise のポータルフェデレーテッドサーバーに Web ツールやマップイメージレイヤーを共有するときに使用します。 ArcGIS Server connection—マップまたはジオプロセシングサービスを ArcGIS Server で共有するときに使用します。プロジェクトウィンドウのサーバーノードの下に一覧表示されている ArcGIS Server コネクションを使用するか、サーバーコネクションファイルが保存されているフォルダーを参照できます。 URL to ArcGIS Server—マップまたはジオプロセシングサービスを ArcGIS Server で共有するときに使用します。 ArcGIS Server への公開者コネクションが ArcGIS Pro プロジェクトに追加されており、そのプロジェクトをスクリプトで開いているか、ArcGIS Pro でツールを実行している場合は、ArcGIS Server の URL を指定できます。 KNOWLEDGE_SERVER—ナレッジグラフを ArcGIS Enterprise 12.0 以降に共有するときに使用します。	ServerConnection
サービス名 (オプション)	サービス定義で指定されている現在のサービス名を無効にするサービス名。	String
クラスター (オプション)	サービスが割り当てられている現在のクラスターを無効にするクラスター名。指定したサーバー上のクラスターから選択する必要があります。レガシー: クラスターは ArcGIS Enterprise 10.5.1 で廃止されました。このパラメーターは、複数のクラスターをサポートしないサーバーでは無視されます。	String
フォルダータイプ (オプション)	フォルダーのソースを決定するために使用するフォルダータイプを指定します。デフォルトは、サービス定義にあるフォルダーです。指定したオンラインサーバーに存在しているフォルダーのリストを取得することもできます。また、Web レイヤー、サービス、またはナレッジグラフを共有するときに、新しいフォルダーを作成するように指定することもできます。新規—新しいフォルダーが作成されます。既存—サーバー上の既存のフォルダーが使用されます。サービス定義から—サービス定義のフォルダーが使用されます。これがデフォルトです。	String
フォルダー (オプション)	Web レイヤー、サービス、またはナレッジグラフの場合に使用するフォルダー。フォルダーを指定しない場合、サービス定義に指定されているフォルダーが使用されます。フォルダータイプに新規を指定した場合は、このパラメーターを使用してフォルダー名を指定します。フォルダータイプに既存を指定した場合は、サーバー上の既存のフォルダーを選択できます。	String
サービスを直ちに開始 (オプション)	共有後にサービスを開始するかどうかを指定します。オン—共有後にサービスが開始されます。これがデフォルトです。オフ—共有後にサービスが開始されません。	Boolean
プロパティを共有しているサービス定義を上書き (オプション)	サービス定義で設定されている共有プロパティを無視するかどうかを指定します。これらのプロパティは、Web レイヤー、Web ツール、またはナレッジグラフを ArcGIS Online または ArcGIS Enterprise で共有するかどうかと、共有の方法を定義します。共有プロパティを上書きする場合は、ArcGIS Online または ArcGIS Enterprise にサインインする必要があります。このパラメーターは、ArcGIS Server で共有するときには使用されません。オン—サービス定義で設定されている共有プロパティを無視します。オフ—サービス定義で設定されている共有プロパティを無視せず、使用します。これがデフォルトです。	Boolean
ArcGIS Online での共有 (オプション)	Web レイヤー、Web ツール、またはナレッジグラフを共有するかどうかを指定します。すべての共有 Web レイヤー、Web ツール、またはナレッジグラフは、マイコンテンツから利用可能です。組織内の特定のグループのみと共有したい場合でも、Web レイヤー、Web ツール、またはナレッジグラフはマイコンテンツからも共有されます。共有プロパティを上書きする場合は、ポータルにサインインしている必要があります。このパラメーターは、ArcGIS Server で共有するときには使用されません。オン—コンテンツは ArcGIS Online または ArcGIS Enterprise で共有されます。 Web レイヤー、Web ツール、またはナレッジグラフがマイコンテンツに一覧表示されます。オフ—コンテンツは ArcGIS Online または ArcGIS Enterprise で共有されません。他の ArcGIS Online または ArcGIS Enterprise ユーザーおよびクライアントは、Web 上でコンテンツにアクセスできません。これがデフォルトです。	Boolean
すべての人と共有 (パブリック) (オプション)	一般ユーザーが Web レイヤーまたは Web ツールを利用できるようにするかどうかを指定します。共有プロパティを上書きする場合は、ArcGIS Online または ArcGIS Enterprise にサインインする必要があります。このパラメーターは、ArcGIS Server で共有するときには使用されません。このパラメーターは、ナレッジグラフの共有時には使用できません。オン—コンテンツは一般ユーザーがアクセスできます。オフ—コンテンツは一般ユーザーがアクセスできません。これがデフォルトです。	Boolean
組織と共有 (オプション)	Web レイヤー、Web ツール、またはナレッジグラフを組織と共有するかどうかを指定します。共有プロパティを上書きする場合は、ArcGIS Online または ArcGIS Enterprise にサインインする必要があります。このパラメーターは、ArcGIS Server で共有するときには使用されません。オン—コンテンツは組織と共有されます。オフ—コンテンツは組織と共有されません。これがデフォルトです。	Boolean
グループと共有 (オプション)	Web レイヤー、Web ツール、またはナレッジグラフを組織内の指定したグループと共有するかどうかを指定します。 Checked—コンテンツは指定されたグループと共有されます。 Unchecked—コンテンツは指定されたグループと共有されません。共有プロパティを上書きする場合は、ArcGIS Online または ArcGIS Enterprise にサインインする必要があります。このパラメーターは、ArcGIS Server で共有するときには使用されません。	String
出力アイテム ID (オプション)	入力サービス定義でステージングされる出力 Web レイヤーまたはナレッジグラフのアイテム ID を指定します。各アイテムについてアイテム ID を指定できます。この ID は利用可能で、a から f までの英字と 0 から 9 までの数字による、32 桁の英数字の値であることが必要です。 ID が指定されていなければ、アイテム ID が自動的に作成されます。次のものにアイテム ID を指定できます。 Web フィーチャレイヤー— ArcGIS Enterprise 10.8.1 以降 Web タイルレイヤー— ArcGIS Enterprise 10.8.1 以降マップイメージレイヤー— ArcGIS Enterprise 11.2 以降 OGC フィーチャレイヤー— ArcGIS Enterprise 11.2 以降 WMS— ArcGIS Enterprise 11.2 以降 WFS— ArcGIS Enterprise 11.2 以降ナレッジグラフ— ArcGIS Enterprise 12.0 以降既存のサービスを上書きするようにサービス定義が設定されているか、ArcGIS Server への ArcGIS Server コネクションまたは URL が指定されている場合、このパラメーターは使用できません。値テーブル列: Item Type—The item type. Item ID—The item IDs of the output web layers staged in the input service definition.	Value Table

派生した出力

ラベル	説明	データタイプ
SOAP サービス URL	サーバーに公開するサービスの SOAP URL。	String
REST サービス URL	サーバーに公開するサービスの REST URL。	String
ホストマップサービスアイテム ID	ポータルで共有するマップイメージレイヤーのアイテム ID。	String
ホストフィーチャサービスアイテム ID	ポータルで共有するホストフィーチャサービスレイヤーのアイテム ID。	String
キャッシュサービス	キャッシュが有効になったイメージサービスまたはマップサービス。	Image Service; Map Server
フィーチャサービス URL	ポータルで共有するホストフィーチャレイヤーの REST URL。	String
マップサービス URL	ポータルで共有するマップイメージレイヤーの REST URL。	String
レイヤー ID	Layer1\|ID1;Layer2\|ID2; などの形式による、公開されたレイヤーとそれぞれに対応する ID。	String
サービス URL	Table1\|ID1;Table2\|ID2; などの形式による、公開されたスタンドアロンテーブルとそれぞれに対応する ID。	String
ホストベクタータイルサービスアイテム ID	ベクタータイルサービスのアイテム ID。	String
ベクタータイルサービスの URL	ベクタータイルサービスの REST URL。	String
Item ID	ポータルに共有される Web アイテムのアイテム ID。アイテム ID には、次のいずれかの文字列が含まれます: `web_feature_layer_id` `web_tile_layer_id` `map_image_layer_id` `ogc_feature_layer_id` `wms_id` `wfs_id` `knowledge_graph_id`	Value Table

arcpy.server.UploadServiceDefinition(in_sd_file, in_server, {in_service_name}, {in_cluster}, {in_folder_type}, {in_folder}, {in_startupType}, {in_override}, {in_my_contents}, {in_public}, {in_organization}, {in_groups}, {in_item_id})

名前	説明	データタイプ
in_sd_file	Web レイヤー、ロケーター、Web ツール、サービス、またはナレッジグラフを共有するために必要なすべての情報が含まれているサービス定義ファイル (`.sd`)。	File
in_server	サーバーの種類。サポートされているサーバータイプとしては、次のものがあります。 My Hosted Services—ホストされた Web レイヤーを ArcGIS Online または ArcGIS Enterprise で共有するときに使用します。サーバーコネクションの [マイホストサービス] を入力します。各単語の 1 文字目を大文字にし、単語と単語の間にスペースを入れます。 HOSTING_SERVER—ホストされた Web レイヤーを ArcGIS Online または ArcGIS Enterprise で共有するときに使用します。 URL to the ArcGIS Enterprise portal federated server—ArcGIS Enterprise のポータルフェデレーテッドサーバーに Web ツールやマップイメージレイヤーを共有するときに使用します。 ArcGIS Server connection—マップまたはジオプロセシングサービスを ArcGIS Server で共有するときに使用します。プロジェクトウィンドウのサーバーノードの下に一覧表示されている ArcGIS Server コネクションを使用するか、サーバーコネクションファイルが保存されているフォルダーを参照できます。 URL to ArcGIS Server—マップまたはジオプロセシングサービスを ArcGIS Server で共有するときに使用します。 ArcGIS Server への公開者コネクションが ArcGIS Pro プロジェクトに追加されており、そのプロジェクトをスクリプトで開いているか、ArcGIS Pro でツールを実行している場合は、ArcGIS Server の URL を指定できます。 KNOWLEDGE_SERVER—ナレッジグラフを ArcGIS Enterprise 12.0 以降に共有するときに使用します。	ServerConnection
in_service_name (オプション)	サービス定義で指定されている現在のサービス名を無効にするサービス名。	String
in_cluster (オプション)	サービスが割り当てられている現在のクラスターを無効にするクラスター名。指定したサーバー上のクラスターから選択する必要があります。レガシー: クラスターは ArcGIS Enterprise 10.5.1 で廃止されました。このパラメーターは、複数のクラスターをサポートしないサーバーでは無視されます。	String
in_folder_type (オプション)	フォルダーのソースを決定するために使用するフォルダータイプを指定します。デフォルトは、サービス定義にあるフォルダーです。指定したオンラインサーバーに存在しているフォルダーのリストを取得することもできます。また、Web レイヤー、サービス、またはナレッジグラフを共有するときに、新しいフォルダーを作成するように指定することもできます。 `NEW`—新しいフォルダーが作成されます。 `EXISTING`—サーバー上の既存のフォルダーが使用されます。 `FROM_SERVICE_DEFINITION`—サービス定義のフォルダーが使用されます。これがデフォルトです。	String
in_folder (オプション)	Web レイヤー、サービス、またはナレッジグラフの場合に使用するフォルダー。フォルダーを指定しない場合、サービス定義に指定されているフォルダーが使用されます。 `in_folder_type` に `NEW` を指定した場合は、このパラメーターを使用してフォルダー名を指定します。 `in_folder_type` に `EXISTING` を指定した場合は、サーバー上の既存のフォルダーを選択できます。	String
in_startupType (オプション)	共有後にサービスを開始するかどうかを指定します。 `STARTED`—共有後にサービスが開始されます。これがデフォルトです。 `STOPPED`—共有後にサービスが開始されません。	Boolean
in_override (オプション)	サービス定義で設定されている共有プロパティを無視するかどうかを指定します。これらのプロパティは、Web レイヤー、Web ツール、またはナレッジグラフを ArcGIS Online または ArcGIS Enterprise で共有するかどうかと、共有の方法を定義します。共有プロパティを上書きする場合は、ArcGIS Online または ArcGIS Enterprise にサインインする必要があります。このパラメーターは、ArcGIS Server で共有するときには使用されません。 `OVERRIDE_DEFINITION`—サービス定義で設定されている共有プロパティを無視します。 `USE_DEFINITION`—サービス定義で設定されている共有プロパティを無視せず、使用します。これがデフォルトです。	Boolean
in_my_contents (オプション)	Web レイヤー、Web ツール、またはナレッジグラフを共有するかどうかを指定します。すべての共有 Web レイヤー、Web ツール、またはナレッジグラフは、マイコンテンツから利用可能です。組織内の特定のグループのみと共有したい場合でも、Web レイヤー、Web ツール、またはナレッジグラフはマイコンテンツからも共有されます。共有プロパティを上書きする場合は、ポータルにサインインしている必要があります。このパラメーターは、ArcGIS Server で共有するときには使用されません。 `SHARE_ONLINE`—コンテンツは ArcGIS Online または ArcGIS Enterprise で共有されます。 Web レイヤー、Web ツール、またはナレッジグラフがマイコンテンツに一覧表示されます。 `NO_SHARE_ONLINE`—コンテンツは ArcGIS Online または ArcGIS Enterprise で共有されません。他の ArcGIS Online または ArcGIS Enterprise ユーザーおよびクライアントは、Web 上でコンテンツにアクセスできません。これがデフォルトです。	Boolean
in_public (オプション)	一般ユーザーが Web レイヤーまたは Web ツールを利用できるようにするかどうかを指定します。共有プロパティを上書きする場合は、ArcGIS Online または ArcGIS Enterprise にサインインする必要があります。このパラメーターは、ArcGIS Server で共有するときには使用されません。このパラメーターは、ナレッジグラフの共有時には使用できません。 `PUBLIC`—コンテンツは一般ユーザーがアクセスできます。 `PRIVATE`—コンテンツは一般ユーザーがアクセスできません。これがデフォルトです。	Boolean
in_organization (オプション)	Web レイヤー、Web ツール、またはナレッジグラフを組織と共有するかどうかを指定します。共有プロパティを上書きする場合は、ArcGIS Online または ArcGIS Enterprise にサインインする必要があります。このパラメーターは、ArcGIS Server で共有するときには使用されません。 `SHARE_ORGANIZATION`—コンテンツは組織と共有されます。 `NO_SHARE_ORGANIZATION`—コンテンツは組織と共有されません。これがデフォルトです。	Boolean
in_groups [in_groups,...] (オプション)	Web レイヤー、Web ツール、またはナレッジグラフを共有するグループ名のリスト。共有プロパティを上書きする場合は、ArcGIS Online または ArcGIS Enterprise にサインインする必要があります。このパラメーターは、ArcGIS Server で共有するときには使用されません。	String
in_item_id [in_item_id,...] (オプション)	入力サービス定義でステージングされる出力 Web レイヤーまたはナレッジグラフのアイテム ID を指定します。各アイテムについてアイテム ID を指定できます。この ID は利用可能で、a から f までの英字と 0 から 9 までの数字による、32 桁の英数字の値であることが必要です。 ID が指定されていなければ、アイテム ID が自動的に作成されます。次のものにアイテム ID を指定できます。 `web_feature_layer_id`—ArcGIS Enterprise 10.8.1 以降 `web_tile_layer_id`—ArcGIS Enterprise 10.8.1 以降 `map_image_layer_id`—ArcGIS Enterprise 11.2 以降 `ogc_feature_layer_id`—ArcGIS Enterprise 11.2 以降 `wms_id`—ArcGIS Enterprise 11.2 以降 `wfs_id`—ArcGIS Enterprise 11.2 以降 `knowledge_graph_id`—ArcGIS Enterprise 12.0 以降既存のサービスを上書きするようにサービス定義が設定されているか、ArcGIS Server への ArcGIS Server コネクションまたは URL が指定されている場合、このパラメーターは使用できません。値テーブル列: `Item Type`—The item type. `Item ID`—The item IDs of the output web layers staged in the input service definition.	Value Table

派生した出力

名前	説明	データタイプ
out_soap_svc_url	サーバーに公開するサービスの SOAP URL。	String
out_rest_svc_url	サーバーに公開するサービスの REST URL。	String
out_mapServiceItemID	ポータルで共有するマップイメージレイヤーのアイテム ID。	String
out_featServiceItemID	ポータルで共有するホストフィーチャサービスレイヤーのアイテム ID。	String
out_cached_service	キャッシュが有効になったイメージサービスまたはマップサービス。	Image Service; Map Server
out_featureServiceURL	ポータルで共有するホストフィーチャレイヤーの REST URL。	String
out_mapServiceURL	ポータルで共有するマップイメージレイヤーの REST URL。	String
out_LayerIDMap	Layer1\|ID1;Layer2\|ID2; などの形式による、公開されたレイヤーとそれぞれに対応する ID。	String
out_standaloneTableIDMap	Table1\|ID1;Table2\|ID2; などの形式による、公開されたスタンドアロンテーブルとそれぞれに対応する ID。	String
out_vectorTileServiceID	ベクタータイルサービスのアイテム ID。	String
out_vectorTileServiceURL	ベクタータイルサービスの REST URL。	String
out_item_id	ポータルに共有される Web アイテムのアイテム ID。アイテム ID には、次のいずれかの文字列が含まれます: `web_feature_layer_id` `web_tile_layer_id` `map_image_layer_id` `ogc_feature_layer_id` `wms_id` `wfs_id` `knowledge_graph_id`	Value Table

コードのサンプル

UploadServiceDefinition の例 1 (スタンドアロンスクリプト)

次のスクリプトは、マップのレイヤー一覧を Web タイルレイヤーとして ArcGIS Enterprise または ArcGIS Online に公開します。ポータル情報は、SignInToPortal 関数から取得されます。

import arcpy
import os

# Sign in to portal
arcpy.SignInToPortal("https://www.arcgis.com", "MyUserName", "MyPassword")

# Set output file names
outdir = r"C:\Project\Output"
service = "TileSharingDraftExample"
sddraft_filename = service + ".sddraft"
sddraft_output_filename = os.path.join(outdir, sddraft_filename)

# Reference map to publish
aprx = arcpy.mp.ArcGISProject(r"C:\Project\World.aprx")
m = aprx.listMaps("World")[0]
lyrs = []
lyrs.append(m.listLayers('Cities')[0])
lyrs.append(m.listLayers('Counties')[0])

# Create TileSharingDraft and set service properties
sharing_draft = m.getWebLayerSharingDraft("HOSTING_SERVER", "TILE", service, lyrs)
sharing_draft.summary = "My Summary"
sharing_draft.tags = "My Tags"
sharing_draft.description = "My Description"
sharing_draft.credits = "My Credits"
sharing_draft.useLimitations = "My Use Limitations"

# Create Service Definition Draft file
sharing_draft.exportToSDDraft(sddraft_output_filename)

# Stage Service
sd_filename = service + ".sd"
sd_output_filename = os.path.join(outdir, sd_filename)
arcpy.server.StageService(sddraft_output_filename, sd_output_filename)

# Share to portal
print("Start Uploading")
result = arcpy.server.UploadServiceDefinition(sd_output_filename, "My Hosted Services")

value_table_op = arcpy.ValueTable(2)
value_table_op.loadFromString(result[11])
for i in range(0, value_table_op.rowCount):
   print(value_table_op.getRow(i))

print("Finish Publishing")

UploadServiceDefinition の例 2 (スタンドアロンスクリプト)

次のスクリプトでは、既存のサービス定義をアップロードし、オプションパラメーターを使用してサービスのプロパティを変更します。

import arcpy

# Set local variables
inSdFile = r"C:\Project\MapServiceDraftExample.sd"
inServer = r"C:\Project\gisserver.ags.esri.com.ags"
inServiceName = "newServiceName"
inFolderType = "NEW"
inFolder = "newFolder"
inStartup = "STOPPED"

# Run UploadServiceDefinition
arcpy.server.UploadServiceDefinition(inSdFile, inServer, inServiceName,
                                     in_folder_type=inFolderType, in_folder=inFolder,
                                     in_startupType=inStartup)

UploadServiceDefinition の例 3 (スタンドアロンスクリプト)

次のスクリプトでは、既存のサービス定義を ArcGIS Online または ArcGIS Enterprise にアップロードし、オプションパラメーターを使用してサービスのプロパティを変更します。 in_item_id パラメーターはオプションで、ArcGIS Enterprise と共有するときに Web レイヤーのアイテム ID を指定するため使用されます。

import arcpy

# Sign in to portal
arcpy.SignInToPortal("https://organization.example.com/webadaptorname",
                     "MyUserName", "MyPassword")

# Set local variables
inSdFile = r"C:\Project\MapImageLayer_WFS_WMSExample.sd"
inServer = "https://gisserver.example.com/webadaptor"
inServiceName = "newServiceName"
inFolderType = "EXISTING"
inFolder = "existingFolder"
inOverride = "OVERRIDE_DEFINITION"
inMyContents = "SHARE_ONLINE"
inPublic = "PRIVATE"
inOrganization = "NO_SHARE_ORGANIZATION"
inGroups = ["My Group", "MyGroup 2"]

# Replace "itemid1" and "itemid2" with desired item IDs
item_id = "wfs_id itemid1; wms_id itemid2"

# Run UploadServiceDefinition
arcpy.server.UploadServiceDefinition(inSdFile, inServer, inServiceName,
                                     in_folder_type=inFolderType,
                                     in_folder=inFolder,
                                     in_override=inOverride,
                                     in_my_contents=inMyContents,
                                     in_public=inPublic,
                                     in_organization=inOrganization,
                                     in_groups=inGroups,
                                     in_item_id=item_id)

環境

このツールは、ジオプロセシング環境を一切使用しません。

ライセンス情報

Basic: はい
Standard: はい
Advanced: はい

サービス定義のアップロード (サーバー ツール)

サマリー

使用法

パラメーター

レガシー:

派生した出力

環境

ライセンス情報

関連トピック

サービス定義のアップロード (サーバーツール)