Web Services - Get

服務:

ML Studio (classic)

API 版本:

2016-05-01-preview

取得訂用帳戶、資源群組和名稱所指定的 Web 服務定義。 請注意，此呼叫不會傳回記憶體認證和 Web 服務密鑰。 若要取得 Web 服務存取金鑰，請呼叫清單金鑰。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	Web 服務所在的資源群組名稱。
subscriptionId	path	True	string	Azure 訂用帳戶標識碼。
webServiceName	path	True	string	Web 服務的名稱。
api-version	query	True	string	要使用的 Microsoft.MachineLearning 資源提供者 API 版本。

回應

名稱	類型	Description
200 OK	WebService	成功。 回應包含布建狀態和 Azure-AsyncOperation 標頭。 若要取得作業的進度，請在 [Azure-AsyncOperation 標頭] 字段中的 URL 上呼叫 GET 作業。 如需異步作的詳細資訊，請參閱 https://msdn.microsoft.com/en-us/library/mt742920.aspx。 Media Types: "application/json", "text/json"

定義

名稱	Description
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 服務圖形中的節點。 節點可以是輸入、輸出或資產節點，因此在任何指定時間只填入其中一個對應的標識碼屬性。
GraphPackage	定義組成機器學習解決方案的模組圖形。
GraphParameter	在圖形中定義全局參數。
GraphParameterLink	圖形全域參數與圖形中節點的關聯連結。
InputPort	資產輸入埠
InputPortType	埠數據類型。
MachineLearningWorkspace	包含 Web 服務來源實驗之機器學習工作區的相關信息。
ModeValueInfo	巢狀參數定義。
ModuleAssetParameter	模組資產的參數定義。
OutputPort	資產輸出埠
OutputPortType	埠數據類型。
ParameterType	Graph 參數的類型。
ProvisioningState	只讀：Web 服務的布建狀態。 有效值為 Unknown、Provisioning、Succeeded 和 Failed。
RealtimeConfiguration	保留 Azure ML Web 服務端點的可用組態選項。
ServiceInputOutputSpecification	描述服務輸入或輸出的 Swagger 2.0 架構。 請參閱 Swagger 規格：http://swagger.io/specification/
StorageAccount	存取記憶體帳戶的資訊。
TableSpecification	描述單一服務輸入或輸出的 Swagger 2.0 架構。 請參閱 Swagger 規格：http://swagger.io/specification/
WebService	Azure ML Web 服務資源的實例。
WebServiceKeys	Web 服務呼叫的存取金鑰。
WebServicePropertiesForGraph	圖形型 Web 服務特有的屬性。

AssetItem

Object

與 Web 服務相關聯的資產相關信息。

名稱	類型	Description
id	string	資產的標識碼。
inputPorts	<string,  InputPort>	資產輸入埠的相關信息。
locationInfo	AssetLocation	存取資產的資訊。
metadata	object	如果資產是自定義模組，這會保存模組的元數據。
name	string	資產的易記名稱。
outputPorts	<string,  OutputPort>	資產輸出埠的相關信息。
parameters	ModuleAssetParameter[]	如果資產是自定義模組，這會保存模組的參數。
type	AssetType	資產的類型。

AssetLocation

Object

描述 Web 服務資產的存取位置。

名稱	類型	Description
credentials	string	如果適用，請存取資產的認證（例如記憶體帳戶連接字串 + Blob URI 所指定的資產）
uri	string (url)	可從存取資產的 URI（例如系統資產的 aml://abc，或用戶資產 https://xyz

AssetType

列舉型別

資產的類型。

值	Description
Module
Resource

ColumnFormat

列舉型別

數據類型的其他格式資訊。

值	Description
Byte
Char
Complex64
Complex128
Date-time
Date-timeOffset
Double
Duration
Float
Int8
Int16
Int32
Int64
Uint8
Uint16
Uint32
Uint64

ColumnSpecification

Object

代表 Web 服務輸入或輸出之數據表內數據行的 Swagger 2.0 架構。 請參閱 Swagger 規格：http://swagger.io/specification/

名稱	類型	Description
enum	object[]	如果數據類型是類別目錄，這會提供已接受的類別清單。
format	ColumnFormat	數據類型的其他格式資訊。
type	ColumnType	數據行的數據類型。
x-ms-isnullable	boolean	指出型別是否支援 Null 值的旗標。
x-ms-isordered	boolean	指出類別是否被視為已排序集合的旗標，如果這是類別數據行。

ColumnType

列舉型別

數據行的數據類型。

值	Description
Boolean
Integer
Number
String

CommitmentPlan

Object

與 Web 服務相關聯的機器學習承諾方案相關信息。

名稱	類型	Description
id	string	指定與 Web 服務相關聯的承諾用量方案的 Azure Resource Manager 識別符。

DiagnosticsConfiguration

Object

Azure ML Web 服務的診斷設定。

名稱	類型	Description
expiry	string (date-time)	指定記錄停止的日期和時間。 如果為 null，診斷收集不會有時間限制。
level	DiagnosticsLevel	指定診斷輸出的詳細資訊。 有效值為：無 - 停用追蹤;錯誤 - 只收集錯誤 （stderr） 追蹤;All - 收集所有追蹤（stdout 和 stderr）。

DiagnosticsLevel

列舉型別

指定診斷輸出的詳細資訊。 有效值為：無 - 停用追蹤;錯誤 - 只收集錯誤 （stderr） 追蹤;All - 收集所有追蹤（stdout 和 stderr）。

值	Description
None
Error
All

ExampleRequest

Object

服務的輸入數據範例。

名稱	類型	Description
globalParameters	object	Web 服務全域參數的範例輸入數據
inputs	object	以輸入名稱的形式提供給 Web 服務的輸入資料範例輸入數據，以取樣輸入值矩陣對應。

GraphEdge

Object

定義 Web 服務圖形內的邊緣。

名稱	類型	Description
sourceNodeId	string	來源圖形節點的標識碼。
sourcePortId	string	邊緣所連線來源節點埠的標識碼。
targetNodeId	string	目的地圖形節點的標識碼。
targetPortId	string	邊緣所連線目的地節點埠的標識碼。

GraphNode

Object

指定 Web 服務圖形中的節點。 節點可以是輸入、輸出或資產節點，因此在任何指定時間只填入其中一個對應的標識碼屬性。

名稱	類型	Description
assetId	string	這個節點所代表資產的標識碼。
inputId	string	這個節點所表示之輸入專案的標識碼。
outputId	string	這個節點所表示之輸出項目的標識碼。
parameters	object	如果適用，則為節點的參數。 全域圖形參數會對應至這些參數，並在運行時間設定值。

GraphPackage

Object

定義組成機器學習解決方案的模組圖形。

名稱	類型	Description
edges	GraphEdge[]	組成圖形的邊緣清單。
graphParameters	<string,  GraphParameter>	圖形的全局參數集合，指定為 GraphParameter 地圖的全局參數名稱。 這裡的每個參數都有 1：1 比對，與 WebServiceProperties 層級宣告的全域參數值對應。
nodes	<string,  GraphNode>	組成圖形的節點集，提供做為 GraphNode 地圖的 nodeId

GraphParameter

Object

在圖形中定義全局參數。

名稱	類型	Description
description	string	這個圖表參數的描述。
links	GraphParameterLink[]	此參數與圖形中節點的關聯連結。
type	ParameterType	Graph 參數的類型。

GraphParameterLink

Object

圖形全域參數與圖形中節點的關聯連結。

名稱	類型	Description
nodeId	string	圖形節點的標識碼
parameterKey	string	全域參數所對應的節點參數標識碼。

InputPort

Object

資產輸入埠

名稱	類型	預設值	Description
type	InputPortType	Dataset	埠數據類型。

InputPortType

列舉型別

埠數據類型。

值	Description
Dataset

MachineLearningWorkspace

Object

包含 Web 服務來源實驗之機器學習工作區的相關信息。

名稱	類型	Description
id	string	指定與 Web 服務相關聯的機器學習工作區工作區標識碼

ModeValueInfo

Object

巢狀參數定義。

名稱	類型	Description
interfaceString	string	巢狀參數的介面字串名稱。
parameters	ModuleAssetParameter[]	參數的定義。

ModuleAssetParameter

Object

模組資產的參數定義。

名稱	類型	Description
modeValuesInfo	<string,  ModeValueInfo>	如果這是複雜的模塊參數，則為巢狀介面參數的定義。
name	string	參數名稱。
parameterType	string	參數類型。

OutputPort

Object

資產輸出埠

名稱	類型	預設值	Description
type	OutputPortType	Dataset	埠數據類型。

OutputPortType

列舉型別

埠數據類型。

值	Description
Dataset

ParameterType

列舉型別

Graph 參數的類型。

值	Description
String
Int
Float
Enumerated
Script
Mode
Credential
Boolean
Double
ColumnPicker
ParameterRange
DataGatewayName

ProvisioningState

列舉型別

只讀：Web 服務的布建狀態。 有效值為 Unknown、Provisioning、Succeeded 和 Failed。

值	Description
Unknown
Provisioning
Succeeded
Failed

RealtimeConfiguration

Object

保留 Azure ML Web 服務端點的可用組態選項。

名稱	類型	Description
maxConcurrentCalls	integer minimum: 4 maximum: 200	指定可對 Web 服務進行的最大並行呼叫。 最小值：4，最大值：200。

ServiceInputOutputSpecification

Object

描述服務輸入或輸出的 Swagger 2.0 架構。 請參閱 Swagger 規格：http://swagger.io/specification/

名稱	類型	預設值	Description
description	string		Swagger 架構的描述。
properties	<string,  TableSpecification>		指定集合，其中包含 Web 服務每個輸入或輸出的數據行架構。 如需詳細資訊，請參閱 Swagger 規格。
title	string		Swagger 架構的標題。
type	string	object	swagger 中所述之實體的類型。 一律為 『object』。

StorageAccount

Object

存取記憶體帳戶的資訊。

名稱	類型	Description
key	string	指定用來存取記憶體帳戶的金鑰。
name	string	指定記憶體帳戶的名稱。

TableSpecification

Object

描述單一服務輸入或輸出的 Swagger 2.0 架構。 請參閱 Swagger 規格：http://swagger.io/specification/

名稱	類型	預設值	Description
description	string		Swagger 架構描述。
format	string		格式，如果 'type' 不是 'object'
properties	<string,  ColumnSpecification>		數據表內的數據行集。
title	string		Swagger 架構標題。
type	string	object	swagger 中所述之實體的類型。

WebService

Object

Azure ML Web 服務資源的實例。

名稱	類型	Description
id	string	指定資源識別碼。
location	string	指定資源的位置。
name	string	指定資源的名稱。
properties	WebServiceProperties: WebServicePropertiesForGraph	包含描述 Web 服務的屬性承載。
tags	object	包含定義為索引鍵/值組的資源標記。
type	string	指定資源的類型。

WebServiceKeys

Object

Web 服務呼叫的存取金鑰。

名稱	類型	Description
primary	string	主要存取金鑰。
secondary	string	次要存取金鑰。

WebServicePropertiesForGraph

Object

圖形型 Web 服務特有的屬性。

名稱	類型	Description
assets	<string,  AssetItem>	包含描述 Web 服務資產的使用者定義屬性。 屬性會以索引鍵/值組表示。
commitmentPlan	CommitmentPlan	包含與此 Web 服務相關聯的承諾方案。 在建立時設定。 設定之後，就無法變更此值。 注意：承諾用量計劃不會從對 GET 作業的呼叫傳回。
createdOn	string (date-time)	唯讀：建立 Web 服務的日期和時間。
description	string	Web 服務的描述。
diagnostics	DiagnosticsConfiguration	控制 Web 服務的診斷追蹤集合的設定。
exampleRequest	ExampleRequest	定義一或多個服務輸入的範例輸入數據。
exposeSampleData	boolean	當設定為 true 時，範例數據會包含在 Web 服務的 Swagger 定義中。 預設值為 True。
input	ServiceInputOutputSpecification	包含 Swagger 2.0 架構，描述一或多個 Web 服務的輸入。 如需詳細資訊，請參閱 Swagger 規格。
keys	WebServiceKeys	包含 Web 服務佈建金鑰。 如果您未指定佈建密鑰，Azure Machine Learning 系統就會為您產生它們。 注意：金鑰不會從呼叫 GET 作業傳回。
machineLearningWorkspace	MachineLearningWorkspace	指定 Machine Learning 工作區，其中包含 Web 服務的來源實驗。
modifiedOn	string (date-time)	唯讀：上次修改 Web 服務的日期和時間。
output	ServiceInputOutputSpecification	包含 Swagger 2.0 架構，描述一或多個 Web 服務的輸出。 如需詳細資訊，請參閱 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 服務的標題。