Web Services - Get

Служба:

ML Studio (classic)

Версия API:

2016-05-01-preview

Возвращает определение веб-службы, указанное подпиской, группой ресурсов и именем. Обратите внимание, что учетные данные хранилища и ключи веб-службы не возвращаются этим вызовом. Чтобы получить ключи доступа к веб-службе, вызовите ключи списка.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов, в которой находится веб-служба.
subscriptionId	path	True	string	Идентификатор подписки Azure.
webServiceName	path	True	string	Имя веб-службы.
api-version	query	True	string	Используемая версия API поставщика ресурсов Microsoft.MachineLearning.

Ответы

Имя	Тип	Описание
200 OK	WebService	Успешно. Ответ содержит состояние подготовки и заголовок Azure-AsyncOperation. Чтобы получить сведения о ходе выполнения операции, вызовите операцию GET по URL-адресу в поле заголовка Azure-AsyncOperation. Дополнительные сведения Об асинхронных операциях см. в разделе https://msdn.microsoft.com/en-us/library/mt742920.aspx. Media Types: "application/json", "text/json"

Определения

Имя	Описание
AssetItem	Сведения об активе, связанном с веб-службой.
AssetLocation	Описывает расположение доступа для ресурса веб-службы.
AssetType	Тип ресурса.
ColumnFormat	Дополнительные сведения о формате для типа данных.
ColumnSpecification	Схема Swagger 2.0 для столбца в таблице данных, представляющего входные или выходные данные веб-службы. См. спецификацию Swagger: http://swagger.io/specification/
ColumnType	Тип данных столбца.
CommitmentPlan	Сведения о плане обязательств машинного обучения, связанном с веб-службой.
DiagnosticsConfiguration	Параметры диагностики для веб-службы Машинного обучения Azure.
DiagnosticsLevel	Указывает детализацию выходных данных диагностики. Допустимые значения: None — отключает трассировку; Error — собирает только трассировки ошибок (stderr); All — собирает все трассировки (stdout и stderr).
ExampleRequest	Пример входных данных для входных данных службы.
GraphEdge	Определяет ребро в графе веб-службы.
GraphNode	Указывает узел в графе веб-службы. Узел может быть входным, выходным или ресурсным узлом, поэтому в любой момент времени заполняется только одно из соответствующих свойств идентификатора.
GraphPackage	Определяет граф модулей, составляющих решение машинного обучения.
GraphParameter	Определяет глобальный параметр в графе.
GraphParameterLink	Связь глобального параметра графа с узлом в графе.
InputPort	Порт ввода ресурса
InputPortType	Тип данных порта.
MachineLearningWorkspace	Сведения о рабочей области машинного обучения, содержащей эксперимент, который является источником для веб-службы.
ModeValueInfo	Определение вложенного параметра.
ModuleAssetParameter	Определение параметра для ресурса модуля.
OutputPort	Порт вывода ресурсов
OutputPortType	Тип данных порта.
ParameterType	Тип параметра Graph.
ProvisioningState	Только для чтения: состояние подготовки веб-службы. Допустимые значения: Unknown, Provisioning, Succeeded и Failed.
RealtimeConfiguration	Содержит доступные параметры конфигурации для конечной точки веб-службы Машинного обучения Azure.
ServiceInputOutputSpecification	Схема swagger 2.0, описывающая входные или выходные данные службы. См. спецификацию Swagger: http://swagger.io/specification/
StorageAccount	Доступ к сведениям для учетной записи хранения.
TableSpecification	Схема swagger 2.0, описывающая один вход или выход службы. См. спецификацию Swagger: http://swagger.io/specification/
WebService	Экземпляр ресурса веб-службы Машинного обучения Azure.
WebServiceKeys	Ключи доступа для вызовов веб-службы.
WebServicePropertiesForGraph	Свойства, относящиеся к веб-службе на основе Graph.

AssetItem

Сведения об активе, связанном с веб-службой.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
inputPorts	<string,  InputPort>	Сведения о входных портах ресурса.
locationInfo	AssetLocation	Сведения о доступе к ресурсу.
metadata	object	Если ресурс является пользовательским модулем, он содержит метаданные модуля.
name	string	Понятное имя ресурса.
outputPorts	<string,  OutputPort>	Сведения о портах вывода ресурса.
parameters	ModuleAssetParameter[]	Если ресурс является пользовательским модулем, он содержит параметры модуля.
type	AssetType	Тип ресурса.

AssetLocation

Описывает расположение доступа для ресурса веб-службы.

Имя	Тип	Описание
credentials	string	Доступ к учетным данным для ресурса , если применимо (например, ресурс, указанный учетной записью хранения строка подключения + URI BLOB-объекта)
uri	string	Универсальный код ресурса (URI), из которого доступен ресурс (например, aml://abc для системных ресурсов или https://xyz ресурсов пользователей.

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

Схема 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

Сведения о плане обязательств машинного обучения, связанном с веб-службой.

Имя	Тип	Описание
id	string	Указывает идентификатор Resource Manager Azure плана обязательств, связанного с веб-службой.

DiagnosticsConfiguration

Параметры диагностики для веб-службы Машинного обучения Azure.

Имя	Тип	Описание
expiry	string	Указывает дату и время прекращения ведения журнала. Если значение равно NULL, сбор диагностических данных не ограничен по времени.
level	DiagnosticsLevel	Указывает детализацию выходных данных диагностики. Допустимые значения: None — отключает трассировку; Error — собирает только трассировки ошибок (stderr); All — собирает все трассировки (stdout и stderr).

DiagnosticsLevel

Указывает детализацию выходных данных диагностики. Допустимые значения: None — отключает трассировку; Error — собирает только трассировки ошибок (stderr); All — собирает все трассировки (stdout и stderr).

Имя	Тип	Описание
All	string
Error	string
None	string

ExampleRequest

Пример входных данных для входных данных службы.

Имя	Тип	Описание
globalParameters	object	Пример входных данных для глобальных параметров веб-службы
inputs	object	Пример входных данных для входных данных веб-службы, указанных в качестве имени входных данных для матрицы примеров входных значений.

GraphEdge

Определяет ребро в графе веб-службы.

Имя	Тип	Описание
sourceNodeId	string	Идентификатор узла исходного графа.
sourcePortId	string	Идентификатор порта исходного узла, с которым подключается ребро.
targetNodeId	string	Идентификатор конечного узла графа.
targetPortId	string	Идентификатор порта конечного узла, к которому подключается ребро.

GraphNode

Указывает узел в графе веб-службы. Узел может быть входным, выходным или ресурсным узлом, поэтому в любой момент времени заполняется только одно из соответствующих свойств идентификатора.

Имя	Тип	Описание
assetId	string	Идентификатор ресурса, представленного этим узлом.
inputId	string	Идентификатор входного элемента, представленного этим узлом.
outputId	string	Идентификатор выходного элемента, представленного этим узлом.
parameters	object	Если применимо, параметры узла. Глобальные параметры графа сопоставляют их со значениями, заданными во время выполнения.

GraphPackage

Определяет граф модулей, составляющих решение машинного обучения.

Имя	Тип	Описание
edges	GraphEdge[]	Список ребер, составляющих граф.
graphParameters	<string,  GraphParameter>	Коллекция глобальных параметров для графа, задаваемая в качестве имени глобального параметра для карты GraphParameter. Каждый параметр здесь соответствует 1:1 с картой значений глобальных параметров, объявленной на уровне WebServiceProperties.
nodes	<string,  GraphNode>	Набор узлов, составляющих граф, предоставляемый в виде nodeId для сопоставления GraphNode

GraphParameter

Определяет глобальный параметр в графе.

Имя	Тип	Описание
description	string	Описание этого параметра графа.
links	GraphParameterLink[]	Связь для этого параметра с узлами в графе.
type	ParameterType	Тип параметра Graph.

GraphParameterLink

Связь глобального параметра графа с узлом в графе.

Имя	Тип	Описание
nodeId	string	Идентификатор узла графа
parameterKey	string	Идентификатор параметра узла, с которым сопоставляется глобальный параметр.

InputPort

Порт ввода ресурса

Имя	Тип	Default value	Описание
type	InputPortType	Dataset	Тип данных порта.

InputPortType

Тип данных порта.

Имя	Тип	Описание
Dataset	string

MachineLearningWorkspace

Сведения о рабочей области машинного обучения, содержащей эксперимент, который является источником для веб-службы.

Имя	Тип	Описание
id	string	Указывает идентификатор рабочей области машинного обучения, связанной с веб-службой.

ModeValueInfo

Определение вложенного параметра.

Имя	Тип	Описание
interfaceString	string	Имя строки интерфейса для вложенного параметра.
parameters	ModuleAssetParameter[]	Определение параметра .

ModuleAssetParameter

Определение параметра для ресурса модуля.

Имя	Тип	Описание
modeValuesInfo	<string,  ModeValueInfo>	Определения параметров вложенного интерфейса, если это сложный параметр модуля.
name	string	Имя параметра.
parameterType	string	Тип параметра.

OutputPort

Порт вывода ресурсов

Имя	Тип	Default value	Описание
type	OutputPortType	Dataset	Тип данных порта.

OutputPortType

Тип данных порта.

Имя	Тип	Описание
Dataset	string

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

Только для чтения: состояние подготовки веб-службы. Допустимые значения: Unknown, Provisioning, Succeeded и Failed.

Имя	Тип	Описание
Failed	string
Provisioning	string
Succeeded	string
Unknown	string

RealtimeConfiguration

Содержит доступные параметры конфигурации для конечной точки веб-службы Машинного обучения Azure.

Имя	Тип	Описание
maxConcurrentCalls	integer	Указывает максимальное количество одновременных вызовов веб-службы. Минимальное значение: 4, максимальное значение: 200.

ServiceInputOutputSpecification

Схема swagger 2.0, описывающая входные или выходные данные службы. См. спецификацию Swagger: http://swagger.io/specification/

Имя	Тип	Default value	Описание
description	string		Описание схемы Swagger.
properties	<string,  TableSpecification>		Указывает коллекцию, содержащую схему столбца для каждого входного или выходного веб-службы. Дополнительные сведения см. в спецификации Swagger.
title	string		Заголовок схемы Swagger.
type	string	object	Тип сущности, описанной в swagger. Всегда "объект".

StorageAccount

Доступ к сведениям для учетной записи хранения.

Имя	Тип	Описание
key	string	Указывает ключ, используемый для доступа к учетной записи хранения.
name	string	Указывает имя учетной записи хранилища.

TableSpecification

Схема swagger 2.0, описывающая один вход или выход службы. См. спецификацию Swagger: http://swagger.io/specification/

Имя	Тип	Default value	Описание
description	string		Описание схемы Swagger.
format	string		Формат , если "type" не является "object"
properties	<string,  ColumnSpecification>		Набор столбцов в таблице данных.
title	string		Заголовок схемы Swagger.
type	string	object	Тип сущности, описанной в swagger.

WebService

Экземпляр ресурса веб-службы Машинного обучения Azure.

Имя	Тип	Описание
id	string	Указывает идентификатор ресурса.
location	string	Указывает расположение ресурса.
name	string	Указывает имя ресурса.
properties	WebServiceProperties: WebServicePropertiesForGraph	Содержит полезные данные свойства, описывающие веб-службу.
tags	object	Содержит теги ресурсов, определенные как пары "ключ-значение".
type	string	Указывает тип ресурса.

WebServiceKeys

Ключи доступа для вызовов веб-службы.

Имя	Тип	Описание
primary	string	Первичный ключ доступа.
secondary	string	Вторичный ключ доступа.

WebServicePropertiesForGraph

Свойства, относящиеся к веб-службе на основе Graph.

Имя	Тип	Описание
assets	<string,  AssetItem>	Содержит определяемые пользователем свойства, описывающие ресурсы веб-службы. Свойства выражаются в виде пар "ключ-значение".
commitmentPlan	CommitmentPlan	Содержит план обязательств, связанный с этой веб-службой. Задать во время создания. После установки это значение нельзя изменить. Примечание. План обязательств не возвращается из вызовов операций GET.
createdOn	string	Только для чтения: дата и время создания веб-службы.
description	string	Описание веб-службы.
diagnostics	DiagnosticsConfiguration	Параметры, управляющие сбором трассировок диагностика для веб-службы.
exampleRequest	ExampleRequest	Определяет пример входных данных для одного или нескольких входных данных службы.
exposeSampleData	boolean	Если задано значение true, образец данных включается в определение swagger веб-службы. Значение по умолчанию — true.
input	ServiceInputOutputSpecification	Содержит схему Swagger 2.0, описывающую один или несколько входных данных веб-службы. Дополнительные сведения см. в спецификации Swagger.
keys	WebServiceKeys	Содержит ключи подготовки веб-службы. Если вы не укажете ключи подготовки, система машинного обучения Azure создаст их автоматически. Примечание. Ключи не возвращаются из вызовов операций GET.
machineLearningWorkspace	MachineLearningWorkspace	Указывает рабочую область Машинного обучения, содержащую эксперимент, который является источником для веб-службы.
modifiedOn	string	Только для чтения: дата и время последнего изменения веб-службы.
output	ServiceInputOutputSpecification	Содержит схему Swagger 2.0, описывающую один или несколько выходных данных веб-службы. Дополнительные сведения см. в спецификации Swagger.
package	GraphPackage	Определение пакета графа, в который состоит эта веб-служба.
packageType	string: Graph	Указывает тип пакета. Допустимые значения: Graph (Указывает веб-службу, опубликованную в Студии машинного обучения) и Code (указывает веб-службу, опубликованную с помощью кода, например Python). Примечание. В настоящее время код не поддерживается.
parameters	object	Набор глобальных значений параметров, определенных для веб-службы, заданный в качестве имени глобального параметра для сопоставления значений по умолчанию. Если значение по умолчанию не указано, параметр считается обязательным.
provisioningState	ProvisioningState	Только для чтения: состояние подготовки веб-службы. Допустимые значения: Unknown, Provisioning, Succeeded и Failed.
readOnly	boolean	Если задано значение true, означает, что веб-служба доступна только для чтения и больше не может быть обновлена или исправлена, а только удалена. Значение по умолчанию — false. Примечание. Если задано значение true, изменить его значение нельзя.
realtimeConfiguration	RealtimeConfiguration	Содержит параметры конфигурации для конечной точки веб-службы.
storageAccount	StorageAccount	Указывает учетную запись хранения, которая используется Машинным обучением Azure для хранения сведений о веб-службе. Из вызовов операций GET возвращается только имя учетной записи хранения. При обновлении сведений об учетной записи хранения необходимо убедиться, что все необходимые ресурсы доступны в новой учетной записи хранения, иначе вызовы веб-службы завершатся ошибкой.
swaggerLocation	string	Только для чтения. Содержит универсальный код ресурса (URI) спецификации swagger, связанной с этой веб-службой.
title	string	Название веб-службы.