Web Services - Patch

Служба:

ML Studio (classic)

Версия API:

2016-05-01-preview

Изменяет существующий ресурс веб-службы. Вызов API PATCH — это асинхронная операция. Чтобы определить, успешно ли оно выполнено, необходимо выполнить операцию 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	Имя группы ресурсов, в которой находится веб-служба.
subscriptionId	path	True	string	Идентификатор подписки Azure.
webServiceName	path	True	string	Имя веб-службы.
api-version	query	True	string	Используемая версия API поставщика ресурсов Microsoft.MachineLearning.

Текст запроса

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

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

Ответы

Имя	Тип	Описание
200 OK	WebService	Успех. Полезные данные ответа идентичны полезным данным ответа, возвращаемым операцией GET. Ответ включает состояние подготовки и заголовок 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 — отключает трассировку; Ошибка — собирает только трассировки ошибок (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

Object

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

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

AssetLocation

Object

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

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

AssetType

Перечисление

Тип ресурса.

Значение	Описание
Module
Resource

ColumnFormat

Перечисление

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

Значение	Описание
Byte
Char
Complex64
Complex128
Date-time
Date-timeOffset
Double
Duration
Float
Int8
Int16
Int32
Int64
Uint8
Uint16
Uint32
Uint64

ColumnSpecification

Object

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

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

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

DiagnosticsConfiguration

Object

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

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

DiagnosticsLevel

Перечисление

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

Значение	Описание
None
Error
All

ExampleRequest

Object

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

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

GraphEdge

Object

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

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

GraphNode

Object

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

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

GraphPackage

Object

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

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

GraphParameter

Object

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

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

GraphParameterLink

Object

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

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

InputPort

Object

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

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

InputPortType

Перечисление

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

Значение	Описание
Dataset

MachineLearningWorkspace

Object

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

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

ModeValueInfo

Object

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

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

ModuleAssetParameter

Object

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

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

OutputPort

Object

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

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

OutputPortType

Перечисление

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

Значение	Описание
Dataset

ParameterType

Перечисление

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

Значение	Описание
String
Int
Float
Enumerated
Script
Mode
Credential
Boolean
Double
ColumnPicker
ParameterRange
DataGatewayName

ProvisioningState

Перечисление

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

Значение	Описание
Unknown
Provisioning
Succeeded
Failed

RealtimeConfiguration

Object

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

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

ServiceInputOutputSpecification

Object

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

Object

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

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

TableSpecification

Object

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

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

WebService

Object

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

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

WebServiceKeys

Object

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

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

WebServicePropertiesForGraph

Object

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

Имя	Тип	Описание
assets	<string,  AssetItem>	Содержит пользовательские свойства, описывающие ресурсы веб-службы. Свойства выражаются как пары "Ключ-значение".
commitmentPlan	CommitmentPlan	Содержит план обязательств, связанный с этой веб-службой. Установка во время создания. После установки это значение не может быть изменено. Примечание. План обязательств не возвращается из вызовов операций GET.
createdOn	string (date-time)	Только чтение: дата и время создания веб-службы.
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 (date-time)	Только чтение: дата и время последнего изменения веб-службы.
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	Название веб-службы.