Web Services - Patch

サービス:

ML Studio (classic)

API バージョン:

2016-05-01-preview

既存の Web サービス リソースを変更します。 PATCH API 呼び出しは非同期操作です。 正常に完了したかどうかを確認するには、Get 操作を実行する必要があります。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	Web サービスが配置されているリソース グループの名前。
subscriptionId	path	True	string	Azure サブスクリプション ID。
webServiceName	path	True	string	Web サービスの名前。
api-version	query	True	string	使用する Microsoft.MachineLearning リソース プロバイダー API のバージョン。

要求本文

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

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

応答

名前	型	説明
200 OK	WebService	成功。 応答ペイロードは、GET 操作によって返される応答ペイロードと同じです。 応答には、プロビジョニング状態と Azure-AsyncOperation ヘッダーが含まれます。 操作の進行状況を取得するには、ヘッダー フィールドの URL に対して GET 操作 Azure-AsyncOperation 呼び出します。 非同期操作の詳細については、「https://msdn.microsoft.com/en-us/library/mt742920.aspx」を参照してください。 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	診断出力の詳細度を指定します。 有効な値: なし - トレースを無効にします。エラー - エラー (stderr) トレースのみを収集します。All - すべてのトレース (stdout と stderr) を収集します。
ExampleRequest	サービスの入力のサンプル入力データ。
GraphEdge	Web サービスのグラフ内のエッジを定義します。
GraphNode	Web サービス グラフ内のノードを指定します。 ノードは入力ノード、出力ノード、または資産ノードのいずれかであるため、対応する ID プロパティの 1 つだけが特定の時点で設定されます。
GraphPackage	機械学習ソリューションを構成するモジュールのグラフを定義します。
GraphParameter	グラフ内のグローバル パラメーターを定義します。
GraphParameterLink	グラフ内のノードへのグラフ グローバル パラメーターの関連付けリンク。
InputPort	資産入力ポート
InputPortType	ポート データ型。
MachineLearningWorkspace	Web サービスのソースである実験を含む機械学習ワークスペースに関する情報。
ModeValueInfo	入れ子になったパラメーター定義。
ModuleAssetParameter	モジュール資産のパラメーター定義。
OutputPort	資産出力ポート
OutputPortType	ポート データ型。
ParameterType	グラフ パラメーターの型。
ProvisioningState	読み取り専用: Web サービスのプロビジョニング状態。 有効な値は、[不明]、[プロビジョニング]、[成功]、[失敗] です。
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

Object

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

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

AssetLocation

Object

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

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

AssetType

列挙

資産の種類。

値	説明
Module
Resource

ColumnFormat

列挙

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

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

ColumnSpecification

Object

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
Integer
Number
String

CommitmentPlan

Object

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

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

DiagnosticsConfiguration

Object

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

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

DiagnosticsLevel

列挙

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

値	説明
All
Error
None

ExampleRequest

Object

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

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

GraphEdge

Object

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

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

GraphNode

Object

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

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

GraphPackage

Object

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

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

GraphParameter

Object

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

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

GraphParameterLink

Object

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

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

InputPort

Object

資産入力ポート

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

InputPortType

列挙

ポート データ型。

値	説明
Dataset

MachineLearningWorkspace

Object

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

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

ModeValueInfo

Object

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

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

ModuleAssetParameter

Object

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

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

OutputPort

Object

資産出力ポート

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

OutputPortType

列挙

ポート データ型。

値	説明
Dataset

ParameterType

列挙

グラフ パラメーターの型。

値	説明
Boolean
ColumnPicker
Credential
DataGatewayName
Double
Enumerated
Float
Int
Mode
ParameterRange
Script
String

ProvisioningState

列挙

読み取り専用: Web サービスのプロビジョニング状態。 有効な値は、[不明]、[プロビジョニング]、[成功]、[失敗] です。

値	説明
Failed
Provisioning
Succeeded
Unknown

RealtimeConfiguration

Object

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

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

ServiceInputOutputSpecification

Object

サービスの入力または出力を記述する 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

Object

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

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

TableSpecification

Object

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

Object

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

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

WebServiceKeys

Object

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

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

WebServicePropertiesForGraph

Object

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

名前	型	説明
assets	<string,  AssetItem>	Web サービス資産を記述するユーザー定義のプロパティが含まれています。 プロパティは、キーと値のペアとして表されます。
commitmentPlan	CommitmentPlan	この Web サービスに関連付けられているコミットメント プランが含まれています。 作成時に設定します。 一度設定すると、この値を変更することはできません。 注: コミットメント計画は、GET 操作の呼び出しから返されません。
createdOn	string (date-time)	読み取り専用: 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 (date-time)	読み取り専用: 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 サービスのプロビジョニング状態。 有効な値は、[不明]、[プロビジョニング]、[成功]、[失敗] です。
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 サービスのタイトル。