Web Services - Get

  • Ссылка
Service:
ML Studio (classic)
API Version:
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

Name In Required Type Description
resourceGroupName
 path True
  • string

Имя группы ресурсов, в которой находится веб-служба.
subscriptionId
 path True
  • string

Идентификатор подписки Azure.
webServiceName
 path True
  • string

Имя веб-службы.
api-version
 query True
  • string

Используемая версия API поставщика ресурсов Microsoft.MachineLearning.

Ответы

Name Type Description
200 OK

Успешно. Ответ включает состояние подготовки и заголовок 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

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

Указывает детализацию диагностических выходных данных. Допустимые значения: None — отключает трассировку; Ошибка — собирает только трассировки ошибок (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 ML.
ServiceInputOutputSpecification

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

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

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

Экземпляр ресурса веб-службы ML Azure.
WebServiceKeys

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

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

AssetItem

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

Name Type Description
id
  • string

Идентификатор ресурса.
inputPorts

Сведения о входных портах ресурса.
locationInfo

Доступ к сведениям о ресурсе.
metadata
  • object

Если ресурс является пользовательским модулем, он содержит метаданные модуля.
name
  • string

Понятное имя ресурса.
outputPorts

Сведения о портах вывода ресурса.
parameters

Если ресурс является пользовательским модулем, он содержит параметры модуля.
type

Тип ресурса.

AssetLocation

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

Name Type Description
credentials
  • string

Доступ к учетным данным для ресурса, если применимо (например, ресурс, указанный учетной записью хранения строка подключения + URI BLOB-объекта).
uri
  • string

URI, из которого доступен ресурс (например, aml://abc для системных ресурсов или https://xyz ресурсов пользователей.

AssetType

Тип ресурса.

Name Type Description
Module
  • string
Resource
  • string

ColumnFormat

Дополнительные сведения о формате для типа данных.

Name Type Description
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/

Name Type Description
enum
  • object[]

Если тип данных категориальный, он содержит список принятых категорий.
format

Дополнительные сведения о формате для типа данных.
type

Тип данных столбца.
x-ms-isnullable
  • boolean

Флаг, указывающий, поддерживает ли тип значения NULL.
x-ms-isordered
  • boolean

Флаг, указывающий, рассматриваются ли категории как упорядоченный набор или нет, если это категориальный столбец.

ColumnType

Тип данных столбца.

Name Type Description
Boolean
  • string
Integer
  • string
Number
  • string
String
  • string

CommitmentPlan

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

Name Type Description
id
  • string

Указывает идентификатор azure Resource Manager плана обязательств, связанного с веб-службой.

DiagnosticsConfiguration

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

Name Type Description
expiry
  • string

Указывает дату и время прекращения ведения журнала. Если значение равно NULL, то коллекция диагностики не ограничена временем.
level

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

DiagnosticsLevel

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

Name Type Description
All
  • string
Error
  • string
None
  • string

ExampleRequest

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

Name Type Description
globalParameters
  • object

Пример входных данных для глобальных параметров веб-службы
inputs
  • object

Пример входных данных для входных данных веб-службы, заданных в качестве имени входных данных для сопоставления матрицы входных значений.

GraphEdge

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

Name Type Description
sourceNodeId
  • string

Идентификатор узла исходного графа.
sourcePortId
  • string

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

Идентификатор конечного узла графа.
targetPortId
  • string

Идентификатор порта конечного узла, к которому подключается ребра.

GraphNode

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

Name Type Description
assetId
  • string

Идентификатор ресурса, представленного этим узлом.
inputId
  • string

Идентификатор входного элемента, представленного этим узлом.
outputId
  • string

Идентификатор выходного элемента, представленного этим узлом.
parameters
  • object

Если применимо, параметры узла. Глобальные параметры графа сопоставляют с этими параметрами со значениями, заданными во время выполнения.

GraphPackage

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

Name Type Description
edges

Список ребер, составляющих граф.
graphParameters

Коллекция глобальных параметров для графа, присвоенная в качестве имени глобального параметра карте GraphParameter. Каждый параметр здесь имеет совпадение 1:1 с картой глобальных параметров, объявленной на уровне WebServiceProperties.
nodes

Набор узлов, составляющих граф, предоставленный как nodeId для карты GraphNode.

GraphParameter

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

Name Type Description
description
  • string

Описание этого параметра графа.
links

Связи для этого параметра с узлами в графе.
type

Graph тип параметра.

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

Name Type Description
nodeId
  • string

Идентификатор узла графа
parameterKey
  • string

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

InputPort

Входной порт ресурса

Name Type Default Value Description
type Dataset

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

InputPortType

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

Name Type Description
Dataset
  • string

MachineLearningWorkspace

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

Name Type Description
id
  • string

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

ModeValueInfo

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

Name Type Description
interfaceString
  • string

Имя строки интерфейса для вложенного параметра.
parameters

Определение параметра.

ModuleAssetParameter

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

Name Type Description
modeValuesInfo

Определения параметров вложенного интерфейса, если это сложный параметр модуля.
name
  • string

Имя параметра.
parameterType
  • string

Тип параметра.

OutputPort

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

Name Type Default Value Description
type Dataset

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

OutputPortType

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

Name Type Description
Dataset
  • string

ParameterType

Graph тип параметра.

Name Type Description
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.

Name Type Description
Failed
  • string
Provisioning
  • string
Succeeded
  • string
Unknown
  • string

RealtimeConfiguration

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

Name Type Description
maxConcurrentCalls
  • integer

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

ServiceInputOutputSpecification

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

Name Type Default Value Description
description
  • string

Описание схемы Swagger.
properties

Указывает коллекцию, содержащую схему столбцов для каждого входного или выходного объекта веб-службы. Дополнительные сведения см. в спецификации Swagger.
title
  • string

Заголовок схемы Swagger.
type
  • string
object

Тип сущности, описанной в swagger. Всегда "object".

StorageAccount

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

Name Type Description
key
  • string

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

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

TableSpecification

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

Name Type Default Value Description
description
  • string

Описание схемы Swagger.
format
  • string

Формат, если "тип" не является "object"
properties

Набор столбцов в таблице данных.
title
  • string

Заголовок схемы Swagger.
type
  • string
object

Тип сущности, описанной в swagger.

WebService

Экземпляр ресурса веб-службы ML Azure.

Name Type Description
id
  • string

Указывает идентификатор ресурса.
location
  • string

Указывает расположение ресурса.
name
  • string

Указывает имя ресурса.
properties WebServiceProperties:

Содержит полезные данные свойства, описывающие веб-службу.
tags
  • object

Содержит теги ресурсов, определенные как пары "ключ—значение".
type
  • string

Указывает тип ресурса.

WebServiceKeys

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

Name Type Description
primary
  • string

Первичный ключ доступа.
secondary
  • string

Вторичный ключ доступа.

WebServicePropertiesForGraph

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

Name Type Description
assets

Содержит пользовательские свойства, описывающие ресурсы веб-службы. Свойства выражаются как пары "ключ—значение".
commitmentPlan

Содержит план обязательств, связанный с этой веб-службой. Установка во время создания. После установки это значение нельзя изменить. Примечание. План обязательств не возвращается из вызовов операций GET.
createdOn
  • string

Только для чтения: дата и время создания веб-службы.
description
  • string

Описание веб-службы.
diagnostics

Параметры управление коллекцией трассировок диагностики для веб-службы.
exampleRequest

Определяет образец входных данных для одного или нескольких входных данных службы.
exposeSampleData
  • boolean

Если задано значение true, примеры данных включаются в определение swagger веб-службы. Значение по умолчанию — true.
input

Содержит схему Swagger 2.0, описывающую один или несколько входных данных веб-службы. Дополнительные сведения см. в спецификации Swagger.
keys

Содержит ключи подготовки веб-службы. Если ключи подготовки не указаны, система Машинное обучение Azure создает их автоматически. Примечание. Ключи не возвращаются из вызовов операций GET.
machineLearningWorkspace

Указывает рабочую область Машинное обучение, содержащую эксперимент, который является источником для веб-службы.
modifiedOn
  • string

Только для чтения: дата и время последнего изменения веб-службы.
output

Содержит схему Swagger 2.0, описывающую один или несколько выходных данных веб-службы. Дополнительные сведения см. в спецификации Swagger.
package

Определение пакета графа, составляющих эту веб-службу.
packageType string:
  • Graph

Указывает тип пакета. Допустимые значения: Graph (указывает веб-службу, опубликованную через Машинное обучение Studio) и code (указывает веб-службу, опубликованную с помощью кода, например Python). Примечание. В настоящее время код не поддерживается.
parameters
  • object

Набор значений глобальных параметров, определенных для веб-службы, заданный в качестве имени глобального параметра для сопоставления значений по умолчанию. Если значение по умолчанию не указано, параметр считается обязательным.
provisioningState

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

Если задано значение true, указывает, что веб-служба доступна только для чтения и больше не может быть обновлена или исправлена, только удалена. Значение по умолчанию — false. Примечание. Если задано значение true, его значение изменить нельзя.
realtimeConfiguration

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

Указывает учетную запись хранения, которая Машинное обучение Azure используется для хранения сведений о веб-службе. Только имя учетной записи хранения возвращается из вызовов операций GET. При обновлении сведений об учетной записи хранения необходимо убедиться, что все необходимые ресурсы доступны в новой учетной записи хранения или вызовы веб-службы завершаются ошибкой.
swaggerLocation
  • string

Только для чтения: содержит универсальный код ресурса (URI) спецификации Swagger, связанной с этой веб-службой.
title
  • string

Заголовок веб-службы.