Web Services - List

リファレンス

Service:: ML Studio (classic)

API Version:: 2016-05-01-preview

指定したサブスクリプション内の Web サービスを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices?api-version=2016-05-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices?$skiptoken={$skiptoken}&api-version=2016-05-01-preview

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Azure サブスクリプション ID。
api-version	query	True	string	使用する Microsoft.MachineLearning リソースプロバイダー API のバージョン。
$skiptoken	query		string	改ページの継続トークン。

応答

名前	型	説明
200 OK	PaginatedWebServicesList	正常終了しました。応答には、Web サービスオブジェクトのページ分割された配列と、次の結果セット (存在する場合) への URI が含まれます。応答コンテンツの領域を節約するために、Web サービスオブジェクトがまばらに設定されていることに注意してください。完全な Web サービスオブジェクトを取得するには、Web サービスで GET 操作を呼び出します。 Media Types: "application/json", "text/json"

名前

型

説明

200 OK

PaginatedWebServicesList

正常終了しました。応答には、Web サービスオブジェクトのページ分割された配列と、次の結果セット (存在する場合) への URI が含まれます。応答コンテンツの領域を節約するために、Web サービスオブジェクトがまばらに設定されていることに注意してください。完全な Web サービスオブジェクトを取得するには、Web サービスで GET 操作を呼び出します。

Media Types: "application/json", "text/json"

定義

名前	説明
AssetItem	Web サービスに関連付けられている資産に関する情報。
AssetLocation	Web サービス資産のアクセス場所について説明します。
AssetType	資産の種類。
ColumnFormat	データ型の追加の形式情報。
ColumnSpecification	Web サービスの入力または出力を表すデータテーブル内の列の Swagger 2.0 スキーマ。 Swagger の仕様に関するページを参照してください。 http://swagger.io/specification/
ColumnType	列のデータ型です。
CommitmentPlan	Web サービスに関連付けられている機械学習コミットメントプランに関する情報。
DiagnosticsConfiguration	Azure ML Web サービスの診断設定。
DiagnosticsLevel	診断出力の詳細度を指定します。有効な値は次のとおりです。なし - トレースを無効にします。Error - エラー (stderr) トレースのみを収集します。All - すべてのトレース (stdout と stderr) を収集します。
ExampleRequest	サービスの入力のサンプル入力データ。
GraphEdge	Web サービスのグラフ内のエッジを定義します。
GraphNode	Web サービスグラフ内のノードを指定します。ノードには入力ノード、出力ノード、またはアセットノードのいずれかを指定できるため、対応する id プロパティの 1 つだけが特定の時点で設定されます。
GraphPackage	機械学習ソリューションを構成するモジュールのグラフを定義します。
GraphParameter	グラフのグローバルパラメーターを定義します。
GraphParameterLink	グラフ内のノードへのグラフグローバルパラメーターの関連付けリンク。
InputPort	資産入力ポート
InputPortType	ポートデータ型。
MachineLearningWorkspace	Web サービスのソースである実験を含む機械学習ワークスペースに関する情報。
ModeValueInfo	入れ子になったパラメーター定義。
ModuleAssetParameter	モジュール資産のパラメーター定義。
OutputPort	資産出力ポート
OutputPortType	ポートデータ型。
PaginatedWebServicesList	Web サービスのページ分割された一覧。
ParameterType	Graph パラメーターの型。
ProvisioningState	読み取り専用: Web サービスのプロビジョニング状態。有効な値は、Unknown、Provisioning、Succeeded、Failed です。
RealtimeConfiguration	Azure ML Web サービスエンドポイントで使用できる構成オプションを保持します。
ServiceInputOutputSpecification	サービスの入力または出力を記述する swagger 2.0 スキーマ。 Swagger の仕様を参照してください。 http://swagger.io/specification/
StorageAccount	ストレージアカウントのアクセス情報。
TableSpecification	1 つのサービス入力または出力を記述する swagger 2.0 スキーマ。 Swagger の仕様に関するページを参照してください。 http://swagger.io/specification/
WebService	Azure ML Web サービスリソースのインスタンス。
WebServiceKeys	Web サービス呼び出しのアクセスキー。
WebServicePropertiesForGraph	Graph ベースの Web サービスに固有のプロパティ。

AssetItem

Web サービスに関連付けられている資産に関する情報。

名前	型	説明
id	string	資産の ID。
inputPorts	<string, InputPort>	資産の入力ポートに関する情報。
locationInfo	AssetLocation	資産のアクセス情報。
metadata	object	アセットがカスタムモジュールの場合、これはモジュールのメタデータを保持します。
name	string	資産のフレンドリ名。
outputPorts	<string, OutputPort>	資産の出力ポートに関する情報。
parameters	ModuleAssetParameter[]	アセットがカスタムモジュールの場合、これはモジュールのパラメーターを保持します。
type	AssetType	資産の種類。

AssetLocation

Web サービス資産のアクセス場所について説明します。

名前	型	説明
credentials	string	資産のアクセス資格情報 (該当する場合) (ストレージアカウントで指定された資産接続文字列 + BLOB URI)
uri	string	資産にアクセスできる URI (システム資産または https://xyz ユーザー資産の aml://abc など)

AssetType

資産の種類。

名前	型	説明
Module	string
Resource	string

ColumnFormat

データ型の追加の形式情報。

名前	型	説明
Byte	string
Char	string
Complex128	string
Complex64	string
Date-time	string
Date-timeOffset	string
Double	string
Duration	string
Float	string
Int16	string
Int32	string
Int64	string
Int8	string
Uint16	string
Uint32	string
Uint64	string
Uint8	string

ColumnSpecification

Web サービスの入力または出力を表すデータテーブル内の列の Swagger 2.0 スキーマ。 Swagger の仕様に関するページを参照してください。 http://swagger.io/specification/

名前	型	説明
enum	object[]	データ型がカテゴリの場合、受け入れられるカテゴリの一覧が提供されます。
format	ColumnFormat	データ型の追加の形式情報。
type	ColumnType	列のデータ型です。
x-ms-isnullable	boolean	型が null 値をサポートしているかどうかを示すフラグ。
x-ms-isordered	boolean	カテゴリ列の場合、カテゴリが順序付きセットとして扱われるかどうかを示すフラグ。

ColumnType

列のデータ型です。

名前	型	説明
Boolean	string
Integer	string
Number	string
String	string

CommitmentPlan

Web サービスに関連付けられている機械学習コミットメントプランに関する情報。

名前	型	説明
id	string	Web サービスに関連付けられているコミットメントプランの Azure Resource Manager ID を指定します。

DiagnosticsConfiguration

Azure ML Web サービスの診断設定。

名前	型	説明
expiry	string	ログ記録が停止する日時を指定します。 null の場合、診断コレクションは時間制限されません。
level	DiagnosticsLevel	診断出力の詳細度を指定します。有効な値は次のとおりです。なし - トレースを無効にします。Error - エラー (stderr) トレースのみを収集します。All - すべてのトレース (stdout と stderr) を収集します。

DiagnosticsLevel

診断出力の詳細度を指定します。有効な値は次のとおりです。なし - トレースを無効にします。Error - エラー (stderr) トレースのみを収集します。All - すべてのトレース (stdout と stderr) を収集します。

名前	型	説明
All	string
Error	string
None	string

ExampleRequest

サービスの入力のサンプル入力データ。

名前	型	説明
globalParameters	object	Web サービスのグローバルパラメーターのサンプル入力データ
inputs	object	サンプル入力値マトリックスマップへの入力名として指定された Web サービスの入力のサンプル入力データ。

GraphEdge

Web サービスのグラフ内のエッジを定義します。

名前	型	説明
sourceNodeId	string	ソースグラフノードの識別子。
sourcePortId	string	エッジが接続するソースノードのポートの識別子。
targetNodeId	string	変換先グラフノードの識別子。
targetPortId	string	エッジが接続する宛先ノードのポートの識別子。

GraphNode

Web サービスグラフ内のノードを指定します。ノードには入力ノード、出力ノード、またはアセットノードのいずれかを指定できるため、対応する id プロパティの 1 つだけが特定の時点で設定されます。

名前	型	説明
assetId	string	このノードによって表される資産の ID。
inputId	string	このノードによって表される入力要素の ID。
outputId	string	このノードによって表される出力要素の ID。
parameters	object	該当する場合は、ノードのパラメーター。グローバルグラフパラメーターは、実行時に設定された値を使用して、これらにマップされます。

GraphPackage

機械学習ソリューションを構成するモジュールのグラフを定義します。

名前	型	説明
edges	GraphEdge[]	グラフを構成するエッジの一覧。
graphParameters	<string, GraphParameter>	GraphParameter マップへのグローバルパラメーター名として指定された、グラフのグローバルパラメーターのコレクション。ここでの各パラメーターには、WebServiceProperties レベルで宣言されたグローバルパラメーター値マップと 1 対 1 の一致があります。
nodes	<string, GraphNode>	GraphNode マップへの nodeId として提供される、グラフを構成するノードのセット

GraphParameter

グラフのグローバルパラメーターを定義します。

名前	型	説明
description	string	このグラフパラメーターの説明。
links	GraphParameterLink[]	このパラメーターの関連付けは、グラフ内のノードにリンクします。
type	ParameterType	Graph パラメーターの型。

GraphParameterLink

グラフ内のノードへのグラフグローバルパラメーターの関連付けリンク。

名前	型	説明
nodeId	string	グラフノードの識別子
parameterKey	string	グローバルパラメーターがマップされるノードパラメーターの識別子。

InputPort

資産入力ポート

名前	型	既定値	説明
type	InputPortType	Dataset	ポートデータ型。

InputPortType

ポートデータ型。

名前	型	説明
Dataset	string

MachineLearningWorkspace

Web サービスのソースである実験を含む機械学習ワークスペースに関する情報。

名前	型	説明
id	string	Web サービスに関連付けられている機械学習ワークスペースのワークスペース ID を指定します

ModeValueInfo

入れ子になったパラメーター定義。

名前	型	説明
interfaceString	string	入れ子になったパラメーターのインターフェイス文字列名。
parameters	ModuleAssetParameter[]	パラメーターの定義。

ModuleAssetParameter

モジュール資産のパラメーター定義。

名前	型	説明
modeValuesInfo	<string, ModeValueInfo>	これが複雑なモジュールパラメーターである場合の、入れ子になったインターフェイスパラメーターの定義。
name	string	パラメーター名です。
parameterType	string	パラメーターの型。

OutputPort

資産出力ポート

名前	型	既定値	説明
type	OutputPortType	Dataset	ポートデータ型。

OutputPortType

ポートデータ型。

名前	型	説明
Dataset	string

PaginatedWebServicesList

Web サービスのページ分割された一覧。

名前	型	説明
nextLink	string	一覧にある結果の次のページへの継続リンク (絶対 URI)
value	WebService[]	Web サービスオブジェクトの配列。

ParameterType

Graph パラメーターの型。

名前	型	説明
Boolean	string
ColumnPicker	string
Credential	string
DataGatewayName	string
Double	string
Enumerated	string
Float	string
Int	string
Mode	string
ParameterRange	string
Script	string
String	string

ProvisioningState

読み取り専用: Web サービスのプロビジョニング状態。有効な値は、Unknown、Provisioning、Succeeded、Failed です。

名前	型	説明
Failed	string
Provisioning	string
Succeeded	string
Unknown	string

RealtimeConfiguration

Azure ML Web サービスエンドポイントで使用できる構成オプションを保持します。

名前	型	説明
maxConcurrentCalls	integer	Web サービスに対して実行できる最大同時呼び出しを指定します。最小値: 4、最大値: 200。

ServiceInputOutputSpecification

サービスの入力または出力を記述する swagger 2.0 スキーマ。 Swagger の仕様を参照してください。 http://swagger.io/specification/

名前	型	既定値	説明
description	string		Swagger スキーマの説明。
properties	<string, TableSpecification>		Web サービスの入力または出力ごとに列スキーマを含むコレクションを指定します。詳細については、Swagger の仕様に関するページを参照してください。
title	string		Swagger スキーマのタイトル。
type	string	object	swagger で説明されているエンティティの型。常に 'object'。

StorageAccount

ストレージアカウントのアクセス情報。

名前	型	説明
key	string	ストレージアカウントへのアクセスに使用するキーを指定します。
name	string	ストレージアカウントの名前を指定します。

TableSpecification

1 つのサービス入力または出力を記述する swagger 2.0 スキーマ。 Swagger の仕様に関するページを参照してください。 http://swagger.io/specification/

名前	型	既定値	説明
description	string		Swagger スキーマの説明。
format	string		'type' が 'object' でない場合の形式
properties	<string, ColumnSpecification>		データテーブル内の列のセット。
title	string		Swagger スキーマのタイトル。
type	string	object	swagger で説明されているエンティティの型。

WebService

Azure ML Web サービスリソースのインスタンス。

名前	型	説明
id	string	リソース ID を指定します。
location	string	リソースの場所を指定します。
name	string	リソースの名前を指定します。
properties	WebServiceProperties: WebServicePropertiesForGraph	Web サービスを記述するプロパティペイロードを格納します。
tags	object	キーと値のペアとして定義されたリソースタグが含まれています。
type	string	リソースの種類を指定します。

WebServiceKeys

Web サービス呼び出しのアクセスキー。

名前	型	説明
primary	string	プライマリアクセスキー。
secondary	string	セカンダリアクセスキー。

WebServicePropertiesForGraph

Graph ベースの Web サービスに固有のプロパティ。

名前	型	説明
assets	<string, AssetItem>	Web サービス資産を記述するユーザー定義プロパティが含まれます。プロパティは、キーと値のペアとして表されます。
commitmentPlan	CommitmentPlan	この Web サービスに関連付けられているコミットメントプランが含まれています。作成時に設定します。一度設定すると、この値は変更できません。注: コミットメント計画は、GET 操作の呼び出しから返されません。
createdOn	string	読み取り専用: Web サービスが作成された日時。
description	string	Web サービスの説明。
diagnostics	DiagnosticsConfiguration	Web サービスの診断トレースコレクションを制御する設定。
exampleRequest	ExampleRequest	1 つ以上のサービスの入力のサンプル入力データを定義します。
exposeSampleData	boolean	true に設定すると、サンプルデータが Web サービスの swagger 定義に含まれます。既定値は、true です。
input	ServiceInputOutputSpecification	1 つ以上の Web サービスの入力を記述する Swagger 2.0 スキーマが含まれています。詳細については、Swagger の仕様に関するページを参照してください。
keys	WebServiceKeys	Web サービスプロビジョニングキーが含まれています。プロビジョニングキーを指定しない場合、Azure Machine Learning システムによって自動的に生成されます。注: キーは GET 操作の呼び出しから返されません。
machineLearningWorkspace	MachineLearningWorkspace	Web サービスのソースである実験を含む Machine Learning ワークスペースを指定します。
modifiedOn	string	読み取り専用: Web サービスが最後に変更された日時。
output	ServiceInputOutputSpecification	1 つ以上の Web サービスの出力を記述する Swagger 2.0 スキーマが含まれます。詳細については、Swagger の仕様に関するページを参照してください。
package	GraphPackage	この Web サービスを構成するグラフパッケージの定義。
packageType	string: Graph	パッケージの種類を指定します。有効な値は、Graph (Machine Learning Studio を介して発行された Web サービスを指定します) とコード (Python などのコードを使用して発行された Web サービスを指定します) です。注: 現時点では、コードはサポートされていません。
parameters	object	Web サービスに対して定義されたグローバルパラメーター値のセット。既定値マップへのグローバルパラメーター名として指定されます。既定値が指定されていない場合、パラメーターは必須と見なされます。
provisioningState	ProvisioningState	読み取り専用: Web サービスのプロビジョニング状態。有効な値は、Unknown、Provisioning、Succeeded、Failed です。
readOnly	boolean	true に設定すると、Web サービスが読み取り専用であり、更新または修正プログラムの適用がなくなり、削除のみ可能であることを示します。既定値は false です。注: true に設定すると、その値を変更することはできません。
realtimeConfiguration	RealtimeConfiguration	Web サービスエンドポイントの構成設定が含まれます。
storageAccount	StorageAccount	Azure Machine Learning が Web サービスに関する情報を格納するために使用するストレージアカウントを指定します。 GET 操作の呼び出しから返されるのは、ストレージアカウントの名前のみです。ストレージアカウント情報を更新する場合は、必要なすべての資産が新しいストレージアカウントで使用可能であるか、Web サービスの呼び出しが失敗することを確認する必要があります。
swaggerLocation	string	読み取り専用: この Web サービスに関連付けられている swagger 仕様の URI が含まれます。
title	string	Web サービスのタイトル。

Web Services - List

URI パラメーター

応答

定義

AssetItem

AssetLocation

AssetType

ColumnFormat

ColumnSpecification

ColumnType

CommitmentPlan

DiagnosticsConfiguration

DiagnosticsLevel

ExampleRequest

GraphEdge

GraphNode

GraphPackage

GraphParameter

GraphParameterLink

InputPort

InputPortType

MachineLearningWorkspace

ModeValueInfo

ModuleAssetParameter

OutputPort

OutputPortType

PaginatedWebServicesList

ParameterType

ProvisioningState

RealtimeConfiguration

ServiceInputOutputSpecification

StorageAccount

TableSpecification

WebService

WebServiceKeys

WebServicePropertiesForGraph

その他のリソース