Web Services - Get

Služba:

ML Studio (classic)

Verze rozhraní API:

2016-05-01-preview

Získá definici webové služby určenou předplatným, skupinou prostředků a názvem. Všimněte si, že toto volání nevrací přihlašovací údaje úložiště a klíče webové služby. Pokud chcete získat přístupové klíče webové služby, zavolejte klíče seznamu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků, ve které se webová služba nachází.
subscriptionId	path	True	string	ID předplatného Azure.
webServiceName	path	True	string	Název webové služby.
api-version	query	True	string	Verze rozhraní API poskytovatele prostředků Microsoft.MachineLearning, která se má použít.

Odpovědi

Name	Typ	Description
200 OK	WebService	Úspěch. Odpověď zahrnuje stav zřizování a hlavičku Azure-AsyncOperation. Pokud chcete získat průběh operace, zavolejte operaci GET na adrese URL v poli záhlaví Azure-AsyncOperation. Další informace O asynchronních operacích naleznete v tématu https://msdn.microsoft.com/en-us/library/mt742920.aspx. Media Types: "application/json", "text/json"

Definice

Name	Description
AssetItem	Informace o prostředku přidruženém k webové službě
AssetLocation	Popisuje umístění přístupu pro prostředek webové služby.
AssetType	Typ aktiva.
ColumnFormat	Další informace o formátu datového typu
ColumnSpecification	Schéma Swaggeru 2.0 pro sloupec v tabulce dat představující vstup nebo výstup webové služby Viz specifikace Swaggeru: http://swagger.io/specification/
ColumnType	Datový typ sloupce
CommitmentPlan	Informace o plánu závazku strojového učení přidruženého k webové službě
DiagnosticsConfiguration	Nastavení diagnostiky pro webovou službu Azure ML
DiagnosticsLevel	Určuje úroveň podrobností výstupu diagnostiky. Platné hodnoty jsou: Žádné – zakáže trasování; Chyba – shromažďuje pouze trasování chyb (stderr); Vše – shromažďuje všechny trasování (stdout a stderr).
ExampleRequest	Ukázková vstupní data pro vstupy služby
GraphEdge	Definuje okraj v grafu webové služby.
GraphNode	Určuje uzel v grafu webové služby. Uzel může být vstupní, výstupní nebo assetový uzel, takže se v daném okamžiku naplní pouze jedna z odpovídajících vlastností ID.
GraphPackage	Definuje graf modulů, které tvoří řešení strojového učení.
GraphParameter	Definuje globální parametr v grafu.
GraphParameterLink	Propojení přidružení globálního parametru grafu k uzlu v grafu
InputPort	Vstupní port assetu
InputPortType	Datový typ portu.
MachineLearningWorkspace	Informace o pracovním prostoru strojového učení obsahujícím experiment, který je zdrojem webové služby.
ModeValueInfo	Definice vnořeného parametru
ModuleAssetParameter	Definice parametru pro asset modulu
OutputPort	Výstupní port prostředku
OutputPortType	Datový typ portu.
ParameterType	Typ parametru grafu
ProvisioningState	Jen pro čtení: Stav zřizování webové služby. Platné hodnoty jsou Neznámé, Zřizování, Úspěšné a Neúspěšné.
RealtimeConfiguration	Obsahuje dostupné možnosti konfigurace pro koncový bod webové služby Azure ML.
ServiceInputOutputSpecification	Schéma swaggeru 2.0 popisující vstupy nebo výstupy služby. Viz specifikace Swaggeru: http://swagger.io/specification/
StorageAccount	Přístup k informacím o účtu úložiště
TableSpecification	Schéma swaggeru 2.0 popisující jeden vstup nebo výstup služby. Viz specifikace Swaggeru: http://swagger.io/specification/
WebService	Instance prostředku webové služby Azure ML
WebServiceKeys	Přístupové klíče pro volání webové služby
WebServicePropertiesForGraph	Vlastnosti specifické pro webovou službu založenou na Graphu

AssetItem

Objekt

Informace o prostředku přidruženém k webové službě

Name	Typ	Description
id	string	ID aktiva.
inputPorts	<string,  InputPort>	Informace o vstupních portech prostředku
locationInfo	AssetLocation	Přístup k informacím o prostředku
metadata	object	Pokud je prostředek vlastním modulem, bude obsahovat metadata modulu.
name	string	Popisný název aktiva
outputPorts	<string,  OutputPort>	Informace o výstupních portech prostředku
parameters	ModuleAssetParameter[]	Pokud je asset vlastním modulem, obsahuje parametry modulu.
type	AssetType	Typ aktiva.

AssetLocation

Objekt

Popisuje umístění přístupu pro prostředek webové služby.

Name	Typ	Description
credentials	string	Přístup k přihlašovacím údajům k prostředku( pokud je k dispozici (například prostředek určený připojovacím řetězcem účtu úložiště + identifikátor URI objektu blob)
uri	string (url)	Identifikátor URI, ze kterého je prostředek přístupný (např. aml://abc pro systémové prostředky nebo https://xyz uživatelských prostředků

AssetType

Výčet

Typ aktiva.

Hodnota	Description
Module
Resource

ColumnFormat

Výčet

Další informace o formátu datového typu

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

ColumnSpecification

Objekt

Schéma Swaggeru 2.0 pro sloupec v tabulce dat představující vstup nebo výstup webové služby Viz specifikace Swaggeru: http://swagger.io/specification/

Name	Typ	Description
enum	object[]	Pokud je datový typ kategorický, zobrazí se seznam přijatých kategorií.
format	ColumnFormat	Další informace o formátu datového typu
type	ColumnType	Datový typ sloupce
x-ms-isnullable	boolean	Příznak označující, jestli typ podporuje hodnoty null nebo ne.
x-ms-isordered	boolean	Příznak označující, jestli se kategorie považují za seřazenou sadu nebo ne, pokud se jedná o sloupec kategorií.

ColumnType

Výčet

Datový typ sloupce

Hodnota	Description
Boolean
Integer
Number
String

CommitmentPlan

Objekt

Informace o plánu závazku strojového učení přidruženého k webové službě

Name	Typ	Description
id	string	Určuje ID Azure Resource Manageru plánu závazku přidruženého k webové službě.

DiagnosticsConfiguration

Objekt

Nastavení diagnostiky pro webovou službu Azure ML

Name	Typ	Description
expiry	string (date-time)	Určuje datum a čas, kdy se protokolování zastaví. Pokud je hodnota null, kolekce diagnostiky není časově omezená.
level	DiagnosticsLevel	Určuje úroveň podrobností výstupu diagnostiky. Platné hodnoty jsou: Žádné – zakáže trasování; Chyba – shromažďuje pouze trasování chyb (stderr); Vše – shromažďuje všechny trasování (stdout a stderr).

DiagnosticsLevel

Výčet

Určuje úroveň podrobností výstupu diagnostiky. Platné hodnoty jsou: Žádné – zakáže trasování; Chyba – shromažďuje pouze trasování chyb (stderr); Vše – shromažďuje všechny trasování (stdout a stderr).

Hodnota	Description
None
Error
All

ExampleRequest

Objekt

Ukázková vstupní data pro vstupy služby

Name	Typ	Description
globalParameters	object	Ukázková vstupní data pro globální parametry webové služby
inputs	object	Ukázková vstupní data pro vstupy webové služby zadané jako vstupní název pro ukázkovou maticovou matici vstupních hodnot

GraphEdge

Objekt

Definuje okraj v grafu webové služby.

Name	Typ	Description
sourceNodeId	string	Identifikátor uzlu zdrojového grafu.
sourcePortId	string	Identifikátor portu zdrojového uzlu, ze kterého se hraniční zařízení připojuje.
targetNodeId	string	Identifikátor cílového uzlu grafu.
targetPortId	string	Identifikátor portu cílového uzlu, ke kterému se hraniční zařízení připojuje.

GraphNode

Objekt

Určuje uzel v grafu webové služby. Uzel může být vstupní, výstupní nebo assetový uzel, takže se v daném okamžiku naplní pouze jedna z odpovídajících vlastností ID.

Name	Typ	Description
assetId	string	ID prostředku reprezentované tímto uzlem.
inputId	string	ID vstupního prvku reprezentované tímto uzlem.
outputId	string	ID výstupního prvku reprezentované tímto uzlem.
parameters	object	Pokud je to možné, parametry uzlu. Globální parametry grafu se namapují na tyto hodnoty s hodnotami nastavenými za běhu.

GraphPackage

Objekt

Definuje graf modulů, které tvoří řešení strojového učení.

Name	Typ	Description
edges	GraphEdge[]	Seznam hran, které tvoří graf.
graphParameters	<string,  GraphParameter>	Kolekce globálních parametrů grafu, která je uvedena jako globální název parametru pro mapu GraphParameter. Každý parametr má zde shodu 1:1 s mapou hodnot globálních parametrů deklarovanou na úrovni WebServiceProperties.
nodes	<string,  GraphNode>	Sada uzlů, které tvoří graf, který se poskytuje jako nodeId na mapě GraphNode

GraphParameter

Objekt

Definuje globální parametr v grafu.

Name	Typ	Description
description	string	Popis tohoto parametru grafu
links	GraphParameterLink[]	Propojení přidružení pro tento parametr k uzlům v grafu
type	ParameterType	Typ parametru grafu

GraphParameterLink

Objekt

Propojení přidružení globálního parametru grafu k uzlu v grafu

Name	Typ	Description
nodeId	string	Identifikátor uzlu grafu
parameterKey	string	Identifikátor parametru uzlu, na který se globální parametr mapuje.

InputPort

Objekt

Vstupní port assetu

Name	Typ	Default value	Description
type	InputPortType	Dataset	Datový typ portu.

InputPortType

Výčet

Datový typ portu.

Hodnota	Description
Dataset

MachineLearningWorkspace

Objekt

Informace o pracovním prostoru strojového učení obsahujícím experiment, který je zdrojem webové služby.

Name	Typ	Description
id	string	Určuje ID pracovního prostoru pracovního prostoru strojového učení přidruženého k webové službě.

ModeValueInfo

Objekt

Definice vnořeného parametru

Name	Typ	Description
interfaceString	string	Název řetězce rozhraní pro vnořený parametr.
parameters	ModuleAssetParameter[]	Definice parametru.

ModuleAssetParameter

Objekt

Definice parametru pro asset modulu

Name	Typ	Description
modeValuesInfo	<string,  ModeValueInfo>	Definice parametrů vnořeného rozhraní, pokud se jedná o komplexní parametr modulu.
name	string	Název parametru.
parameterType	string	Typ parametru.

OutputPort

Objekt

Výstupní port prostředku

Name	Typ	Default value	Description
type	OutputPortType	Dataset	Datový typ portu.

OutputPortType

Výčet

Datový typ portu.

Hodnota	Description
Dataset

ParameterType

Výčet

Typ parametru grafu

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

ProvisioningState

Výčet

Jen pro čtení: Stav zřizování webové služby. Platné hodnoty jsou Neznámé, Zřizování, Úspěšné a Neúspěšné.

Hodnota	Description
Unknown
Provisioning
Succeeded
Failed

RealtimeConfiguration

Objekt

Obsahuje dostupné možnosti konfigurace pro koncový bod webové služby Azure ML.

Name	Typ	Description
maxConcurrentCalls	integer minimum: 4 maximum: 200	Určuje maximální počet souběžných volání, která lze provést do webové služby. Minimální hodnota: 4, Maximální hodnota: 200.

ServiceInputOutputSpecification

Objekt

Schéma swaggeru 2.0 popisující vstupy nebo výstupy služby. Viz specifikace Swaggeru: http://swagger.io/specification/

Name	Typ	Default value	Description
description	string		Popis schématu Swagger.
properties	<string,  TableSpecification>		Určuje kolekci, která obsahuje schéma sloupců pro každý vstup nebo výstup webové služby. Další informace najdete ve specifikaci Swaggeru.
title	string		Název schématu Swagger.
type	string	object	Typ entity popsané ve swaggeru. Vždy "objekt".

StorageAccount

Objekt

Přístup k informacím o účtu úložiště

Name	Typ	Description
key	string	Určuje klíč použitý pro přístup k účtu úložiště.
name	string	Určuje název účtu úložiště.

TableSpecification

Objekt

Schéma swaggeru 2.0 popisující jeden vstup nebo výstup služby. Viz specifikace Swaggeru: http://swagger.io/specification/

Name	Typ	Default value	Description
description	string		Popis schématu Swaggeru
format	string		Formát, pokud 'type' není 'object'
properties	<string,  ColumnSpecification>		Sada sloupců v tabulce dat.
title	string		Název schématu Swaggeru
type	string	object	Typ entity popsané ve swaggeru.

WebService

Objekt

Instance prostředku webové služby Azure ML

Name	Typ	Description
id	string	Určuje ID prostředku.
location	string	Určuje umístění prostředku.
name	string	Určuje název prostředku.
properties	WebServiceProperties: WebServicePropertiesForGraph	Obsahuje datovou část vlastnosti, která popisuje webovou službu.
tags	object	Obsahuje značky prostředků definované jako páry klíč/hodnota.
type	string	Určuje typ prostředku.

WebServiceKeys

Objekt

Přístupové klíče pro volání webové služby

Name	Typ	Description
primary	string	Primární přístupový klíč.
secondary	string	Sekundární přístupový klíč.

WebServicePropertiesForGraph

Objekt

Vlastnosti specifické pro webovou službu založenou na Graphu

Name	Typ	Description
assets	<string,  AssetItem>	Obsahuje uživatelem definované vlastnosti popisující prostředky webové služby. Vlastnosti jsou vyjádřeny jako páry klíč/hodnota.
commitmentPlan	CommitmentPlan	Obsahuje plán závazku přidružený k této webové službě. Nastavte při vytváření. Po nastavení nelze tuto hodnotu změnit. Poznámka: Plán závazku se nevrátí z volání operací GET.
createdOn	string (date-time)	Jen pro čtení: Datum a čas vytvoření webové služby.
description	string	Popis webové služby.
diagnostics	DiagnosticsConfiguration	Nastavení řídí kolekci trasování diagnostiky pro webovou službu.
exampleRequest	ExampleRequest	Definuje ukázková vstupní data pro jeden nebo více vstupů služby.
exposeSampleData	boolean	Pokud je nastavená hodnota true, ukázková data se zahrnou do definice swaggeru webové služby. Výchozí hodnota je true.
input	ServiceInputOutputSpecification	Obsahuje schéma Swagger 2.0 popisující jeden nebo více vstupů webové služby. Další informace najdete ve specifikaci Swaggeru.
keys	WebServiceKeys	Obsahuje klíče zřizování webové služby. Pokud nezadáte zřizovací klíče, systém Azure Machine Learning je za vás vygeneruje. Poznámka: Klíče se nevrácejí z volání operací GET.
machineLearningWorkspace	MachineLearningWorkspace	Určuje pracovní prostor Machine Learning obsahující experiment, který je zdrojem webové služby.
modifiedOn	string (date-time)	Jen pro čtení: Datum a čas poslední změny webové služby.
output	ServiceInputOutputSpecification	Obsahuje schéma Swaggeru 2.0 popisující jeden nebo více výstupů webové služby. Další informace najdete ve specifikaci Swaggeru.
package	GraphPackage	Definice balíčku grafu, který tvoří tuto webovou službu.
packageType	string: Graph	Určuje typ balíčku. Platné hodnoty jsou Graph (určuje webovou službu publikovanou prostřednictvím nástroje Machine Learning Studio) a Code (určuje webovou službu publikovanou pomocí kódu, jako je Python). Poznámka: Kód se v tuto chvíli nepodporuje.
parameters	object	Sada hodnot globálních parametrů definovaných pro webovou službu, která je uvedena jako globální název parametru na výchozí mapování hodnot. Pokud není zadána žádná výchozí hodnota, parametr se považuje za povinný.
provisioningState	ProvisioningState	Jen pro čtení: Stav zřizování webové služby. Platné hodnoty jsou Neznámé, Zřizování, Úspěšné a Neúspěšné.
readOnly	boolean	Pokud je nastavená hodnota true, znamená to, že webová služba je určená jen pro čtení a nelze ji aktualizovat ani opravit, pouze ji odebrat. Výchozí hodnota je false. Poznámka: Po nastavení na hodnotu True nelze změnit její hodnotu.
realtimeConfiguration	RealtimeConfiguration	Obsahuje nastavení konfigurace pro koncový bod webové služby.
storageAccount	StorageAccount	Určuje účet úložiště, který Azure Machine Learning používá k ukládání informací o webové službě. Z volání operací GET se vrátí jenom název účtu úložiště. Při aktualizaci informací o účtu úložiště musíte zajistit, aby byly v novém účtu úložiště k dispozici všechny potřebné prostředky nebo že volání webové služby selžou.
swaggerLocation	string	Jen pro čtení: Obsahuje identifikátor URI specifikace swaggeru přidružených k této webové službě.
title	string	Název webové služby.