Web Services - List By Resource Group
Gets the web services in the specified resource group.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices?api-version=2016-05-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices?$skiptoken={$skiptoken}&api-version=2016-05-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Name of the resource group in which the web service is located. |
subscription
|
path | True |
string |
The Azure subscription ID. |
api-version
|
query | True |
string |
The version of the Microsoft.MachineLearning resource provider API to use. |
$skiptoken
|
query |
string |
Continuation token for pagination. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success. The response includes a paginated array of web service objects and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/. Note that the web service objects are sparsely populated to conserve space in the response content. To get the full web service object, call the GET operation on the web service. Media Types: "application/json", "text/json" |
Definitions
Name | Description |
---|---|
Asset |
Information about an asset associated with the web service. |
Asset |
Describes the access location for a web service asset. |
Asset |
Asset's type. |
Column |
Additional format information for the data type. |
Column |
Swagger 2.0 schema for a column within the data table representing a web service input or output. See Swagger specification: http://swagger.io/specification/ |
Column |
Data type of the column. |
Commitment |
Information about the machine learning commitment plan associated with the web service. |
Diagnostics |
Diagnostics settings for an Azure ML web service. |
Diagnostics |
Specifies the verbosity of the diagnostic output. Valid values are: None - disables tracing; Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr). |
Example |
Sample input data for the service's input(s). |
Graph |
Defines an edge within the web service's graph. |
Graph |
Specifies a node in the web service graph. The node can either be an input, output or asset node, so only one of the corresponding id properties is populated at any given time. |
Graph |
Defines the graph of modules making up the machine learning solution. |
Graph |
Defines a global parameter in the graph. |
Graph |
Association link for a graph global parameter to a node in the graph. |
Input |
Asset input port |
Input |
Port data type. |
Machine |
Information about the machine learning workspace containing the experiment that is source for the web service. |
Mode |
Nested parameter definition. |
Module |
Parameter definition for a module asset. |
Output |
Asset output port |
Output |
Port data type. |
Paginated |
Paginated list of web services. |
Parameter |
Graph parameter's type. |
Provisioning |
Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. |
Realtime |
Holds the available configuration options for an Azure ML web service endpoint. |
Service |
The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/ |
Storage |
Access information for a storage account. |
Table |
The swagger 2.0 schema describing a single service input or output. See Swagger specification: http://swagger.io/specification/ |
Web |
Instance of an Azure ML web service resource. |
Web |
Access keys for the web service calls. |
Web |
Properties specific to a Graph based web service. |
AssetItem
Information about an asset associated with the web service.
Name | Type | Description |
---|---|---|
id |
string |
Asset's Id. |
inputPorts |
<string,
Input |
Information about the asset's input ports. |
locationInfo |
Access information for the asset. |
|
metadata |
object |
If the asset is a custom module, this holds the module's metadata. |
name |
string |
Asset's friendly name. |
outputPorts |
<string,
Output |
Information about the asset's output ports. |
parameters |
If the asset is a custom module, this holds the module's parameters. |
|
type |
Asset's type. |
AssetLocation
Describes the access location for a web service asset.
Name | Type | Description |
---|---|---|
credentials |
string |
Access credentials for the asset, if applicable (e.g. asset specified by storage account connection string + blob URI) |
uri |
string |
The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user assets |
AssetType
Asset's type.
Name | Type | Description |
---|---|---|
Module |
string |
|
Resource |
string |
ColumnFormat
Additional format information for the data type.
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 schema for a column within the data table representing a web service input or output. See Swagger specification: http://swagger.io/specification/
Name | Type | Description |
---|---|---|
enum |
object[] |
If the data type is categorical, this provides the list of accepted categories. |
format |
Additional format information for the data type. |
|
type |
Data type of the column. |
|
x-ms-isnullable |
boolean |
Flag indicating if the type supports null values or not. |
x-ms-isordered |
boolean |
Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column. |
ColumnType
Data type of the column.
Name | Type | Description |
---|---|---|
Boolean |
string |
|
Integer |
string |
|
Number |
string |
|
String |
string |
CommitmentPlan
Information about the machine learning commitment plan associated with the web service.
Name | Type | Description |
---|---|---|
id |
string |
Specifies the Azure Resource Manager ID of the commitment plan associated with the web service. |
DiagnosticsConfiguration
Diagnostics settings for an Azure ML web service.
Name | Type | Description |
---|---|---|
expiry |
string |
Specifies the date and time when the logging will cease. If null, diagnostic collection is not time limited. |
level |
Specifies the verbosity of the diagnostic output. Valid values are: None - disables tracing; Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr). |
DiagnosticsLevel
Specifies the verbosity of the diagnostic output. Valid values are: None - disables tracing; Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr).
Name | Type | Description |
---|---|---|
All |
string |
|
Error |
string |
|
None |
string |
ExampleRequest
Sample input data for the service's input(s).
Name | Type | Description |
---|---|---|
globalParameters |
object |
Sample input data for the web service's global parameters |
inputs |
object |
Sample input data for the web service's input(s) given as an input name to sample input values matrix map. |
GraphEdge
Defines an edge within the web service's graph.
Name | Type | Description |
---|---|---|
sourceNodeId |
string |
The source graph node's identifier. |
sourcePortId |
string |
The identifier of the source node's port that the edge connects from. |
targetNodeId |
string |
The destination graph node's identifier. |
targetPortId |
string |
The identifier of the destination node's port that the edge connects into. |
GraphNode
Specifies a node in the web service graph. The node can either be an input, output or asset node, so only one of the corresponding id properties is populated at any given time.
Name | Type | Description |
---|---|---|
assetId |
string |
The id of the asset represented by this node. |
inputId |
string |
The id of the input element represented by this node. |
outputId |
string |
The id of the output element represented by this node. |
parameters |
object |
If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime. |
GraphPackage
Defines the graph of modules making up the machine learning solution.
Name | Type | Description |
---|---|---|
edges |
The list of edges making up the graph. |
|
graphParameters |
<string,
Graph |
The collection of global parameters for the graph, given as a global parameter name to GraphParameter map. Each parameter here has a 1:1 match with the global parameters values map declared at the WebServiceProperties level. |
nodes |
<string,
Graph |
The set of nodes making up the graph, provided as a nodeId to GraphNode map |
GraphParameter
Defines a global parameter in the graph.
Name | Type | Description |
---|---|---|
description |
string |
Description of this graph parameter. |
links |
Association links for this parameter to nodes in the graph. |
|
type |
Graph parameter's type. |
GraphParameterLink
Association link for a graph global parameter to a node in the graph.
Name | Type | Description |
---|---|---|
nodeId |
string |
The graph node's identifier |
parameterKey |
string |
The identifier of the node parameter that the global parameter maps to. |
InputPort
Asset input port
Name | Type | Default value | Description |
---|---|---|---|
type | Dataset |
Port data type. |
InputPortType
Port data type.
Name | Type | Description |
---|---|---|
Dataset |
string |
MachineLearningWorkspace
Information about the machine learning workspace containing the experiment that is source for the web service.
Name | Type | Description |
---|---|---|
id |
string |
Specifies the workspace ID of the machine learning workspace associated with the web service |
ModeValueInfo
Nested parameter definition.
Name | Type | Description |
---|---|---|
interfaceString |
string |
The interface string name for the nested parameter. |
parameters |
The definition of the parameter. |
ModuleAssetParameter
Parameter definition for a module asset.
Name | Type | Description |
---|---|---|
modeValuesInfo |
<string,
Mode |
Definitions for nested interface parameters if this is a complex module parameter. |
name |
string |
Parameter name. |
parameterType |
string |
Parameter type. |
OutputPort
Asset output port
Name | Type | Default value | Description |
---|---|---|---|
type | Dataset |
Port data type. |
OutputPortType
Port data type.
Name | Type | Description |
---|---|---|
Dataset |
string |
PaginatedWebServicesList
Paginated list of web services.
Name | Type | Description |
---|---|---|
nextLink |
string |
A continuation link (absolute URI) to the next page of results in the list. |
value |
An array of web service objects. |
ParameterType
Graph parameter's type.
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
Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed.
Name | Type | Description |
---|---|---|
Failed |
string |
|
Provisioning |
string |
|
Succeeded |
string |
|
Unknown |
string |
RealtimeConfiguration
Holds the available configuration options for an Azure ML web service endpoint.
Name | Type | Description |
---|---|---|
maxConcurrentCalls |
integer |
Specifies the maximum concurrent calls that can be made to the web service. Minimum value: 4, Maximum value: 200. |
ServiceInputOutputSpecification
The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/
Name | Type | Default value | Description |
---|---|---|---|
description |
string |
The description of the Swagger schema. |
|
properties |
<string,
Table |
Specifies a collection that contains the column schema for each input or output of the web service. For more information, see the Swagger specification. |
|
title |
string |
The title of your Swagger schema. |
|
type |
string |
object |
The type of the entity described in swagger. Always 'object'. |
StorageAccount
Access information for a storage account.
Name | Type | Description |
---|---|---|
key |
string |
Specifies the key used to access the storage account. |
name |
string |
Specifies the name of the storage account. |
TableSpecification
The swagger 2.0 schema describing a single service input or output. See Swagger specification: http://swagger.io/specification/
Name | Type | Default value | Description |
---|---|---|---|
description |
string |
Swagger schema description. |
|
format |
string |
The format, if 'type' is not 'object' |
|
properties |
<string,
Column |
The set of columns within the data table. |
|
title |
string |
Swagger schema title. |
|
type |
string |
object |
The type of the entity described in swagger. |
WebService
Instance of an Azure ML web service resource.
Name | Type | Description |
---|---|---|
id |
string |
Specifies the resource ID. |
location |
string |
Specifies the location of the resource. |
name |
string |
Specifies the name of the resource. |
properties | WebServiceProperties: |
Contains the property payload that describes the web service. |
tags |
object |
Contains resource tags defined as key/value pairs. |
type |
string |
Specifies the type of the resource. |
WebServiceKeys
Access keys for the web service calls.
Name | Type | Description |
---|---|---|
primary |
string |
The primary access key. |
secondary |
string |
The secondary access key. |
WebServicePropertiesForGraph
Properties specific to a Graph based web service.
Name | Type | Description |
---|---|---|
assets |
<string,
Asset |
Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs. |
commitmentPlan |
Contains the commitment plan associated with this web service. Set at creation time. Once set, this value cannot be changed. Note: The commitment plan is not returned from calls to GET operations. |
|
createdOn |
string |
Read Only: The date and time when the web service was created. |
description |
string |
The description of the web service. |
diagnostics |
Settings controlling the diagnostics traces collection for the web service. |
|
exampleRequest |
Defines sample input data for one or more of the service's inputs. |
|
exposeSampleData |
boolean |
When set to true, sample data is included in the web service's swagger definition. The default value is true. |
input |
Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more information, see the Swagger specification. |
|
keys |
Contains the web service provisioning keys. If you do not specify provisioning keys, the Azure Machine Learning system generates them for you. Note: The keys are not returned from calls to GET operations. |
|
machineLearningWorkspace |
Specifies the Machine Learning workspace containing the experiment that is source for the web service. |
|
modifiedOn |
string |
Read Only: The date and time when the web service was last modified. |
output |
Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more information, see the Swagger specification. |
|
package |
The definition of the graph package making up this web service. |
|
packageType |
string:
Graph |
Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time. |
parameters |
object |
The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required. |
provisioningState |
Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. |
|
readOnly |
boolean |
When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value. |
realtimeConfiguration |
Contains the configuration settings for the web service endpoint. |
|
storageAccount |
Specifies the storage account that Azure Machine Learning uses to store information about the web service. Only the name of the storage account is returned from calls to GET operations. When updating the storage account information, you must ensure that all necessary assets are available in the new storage account or calls to your web service will fail. |
|
swaggerLocation |
string |
Read Only: Contains the URI of the swagger spec associated with this web service. |
title |
string |
The title of the web service. |