Web Services - Get

Serviço:

ML Studio (classic)

Versão da API:

2016-05-01-preview

Obtém a definição de serviço Web conforme especificado por uma assinatura, grupo de recursos e nome. Observe que as credenciais de armazenamento e as chaves de serviço Web não são retornadas por essa chamada. Para obter as chaves de acesso do serviço Web, chame List Keys.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	Nome do grupo de recursos no qual o serviço Web está localizado.
subscriptionId	path	True	string	A ID de assinatura do Azure.
webServiceName	path	True	string	O nome do serviço Web.
api-version	query	True	string	A versão da API do provedor de recursos Microsoft.MachineLearning a ser usada.

Respostas

Name	Tipo	Description
200 OK	WebService	Sucesso. A resposta inclui o Estado de Provisionamento e o cabeçalho Azure-AsyncOperation. Para obter o progresso da operação, chame a operação GET no URL Azure-AsyncOperation campo de cabeçalho. Para obter mais informaçõesPara obter mais informações sobre operações assíncronas, consulte https://msdn.microsoft.com/en-us/library/mt742920.aspx. Media Types: "application/json", "text/json"

Definições

Name	Description
AssetItem	Informações sobre um ativo associado ao serviço Web.
AssetLocation	Descreve o local de acesso para um ativo de serviço Web.
AssetType	Tipo de ativo.
ColumnFormat	Informações de formato adicionais para o tipo de dados.
ColumnSpecification	Esquema do Swagger 2.0 para uma coluna dentro da tabela de dados que representa uma entrada ou saída de serviço Web. Consulte a especificação Swagger: http://swagger.io/specification/
ColumnType	Tipo de dados da coluna.
CommitmentPlan	Informações sobre o plano de compromisso de aprendizado de máquina associado ao serviço Web.
DiagnosticsConfiguration	Configurações de diagnóstico para um serviço Web do Azure ML.
DiagnosticsLevel	Especifica a detalhamento da saída de diagnóstico. Os valores válidos são: Nenhum - desativa o rastreio; Erro - recolhe apenas rastreamentos de erro (stderr); Tudo - recolhe todos os vestígios (stdout e stderr).
ExampleRequest	Dados de entrada de exemplo para a(s) entrada(s) do serviço.
GraphEdge	Define uma borda dentro do gráfico do serviço Web.
GraphNode	Especifica um nó no gráfico do serviço Web. O nó pode ser um nó de entrada, saída ou ativo, portanto, apenas uma das propriedades de id correspondentes é preenchida a qualquer momento.
GraphPackage	Define o gráfico dos módulos que compõem a solução de aprendizado de máquina.
GraphParameter	Define um parâmetro global no gráfico.
GraphParameterLink	Link de associação para um parâmetro global do gráfico a um nó no gráfico.
InputPort	Porta de entrada de ativos
InputPortType	Tipo de dados de porta.
MachineLearningWorkspace	Informações sobre o espaço de trabalho de aprendizado de máquina que contém o experimento que é a origem do serviço Web.
ModeValueInfo	Definição de parâmetro aninhado.
ModuleAssetParameter	Definição de parâmetros para um ativo de módulo.
OutputPort	Porta de saída de ativos
OutputPortType	Tipo de dados de porta.
ParameterType	Tipo de parâmetro gráfico.
ProvisioningState	Somente leitura: O estado de provisão do serviço Web. Os valores válidos são Unknown, Provisioning, Succeeded, and Failed.
RealtimeConfiguration	Contém as opções de configuração disponíveis para um ponto de extremidade do serviço Web do Azure ML.
ServiceInputOutputSpecification	O esquema swagger 2.0 que descreve as entradas ou saídas do serviço. Consulte a especificação Swagger: http://swagger.io/specification/
StorageAccount	Acessar informações para uma conta de armazenamento.
TableSpecification	O esquema swagger 2.0 que descreve uma única entrada ou saída de serviço. Consulte a especificação Swagger: http://swagger.io/specification/
WebService	Instância de um recurso de serviço Web do Azure ML.
WebServiceKeys	Chaves de acesso para as chamadas de serviço Web.
WebServicePropertiesForGraph	Propriedades específicas de um serviço Web baseado em gráfico.

AssetItem

Object

Informações sobre um ativo associado ao serviço Web.

Name	Tipo	Description
id	string	Id do ativo.
inputPorts	<string,  InputPort>	Informações sobre as portas de entrada do ativo.
locationInfo	AssetLocation	Acesse informações para o ativo.
metadata	object	Se o ativo for um módulo personalizado, ele armazenará os metadados do módulo.
name	string	Nome amigável do ativo.
outputPorts	<string,  OutputPort>	Informações sobre as portas de saída do ativo.
parameters	ModuleAssetParameter[]	Se o ativo for um módulo personalizado, isso manterá os parâmetros do módulo.
type	AssetType	Tipo de ativo.

AssetLocation

Object

Descreve o local de acesso para um ativo de serviço Web.

Name	Tipo	Description
credentials	string	Credenciais de acesso para o ativo, se aplicável (por exemplo, ativo especificado pela cadeia de conexão da conta de armazenamento + URI de blob)
uri	string (url)	O URI a partir do qual o ativo é acessível (por exemplo, aml://abc para ativos do sistema ou https://xyz para ativos do usuário

AssetType

Enumeração

Tipo de ativo.

Valor	Description
Module
Resource

ColumnFormat

Enumeração

Informações de formato adicionais para o tipo de dados.

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

ColumnSpecification

Object

Esquema do Swagger 2.0 para uma coluna dentro da tabela de dados que representa uma entrada ou saída de serviço Web. Consulte a especificação Swagger: http://swagger.io/specification/

Name	Tipo	Description
enum	object[]	Se o tipo de dados for categórico, isso fornecerá a lista de categorias aceitas.
format	ColumnFormat	Informações de formato adicionais para o tipo de dados.
type	ColumnType	Tipo de dados da coluna.
x-ms-isnullable	boolean	Sinalizador que indica se o tipo suporta valores nulos ou não.
x-ms-isordered	boolean	Sinalizador que indica se as categorias são tratadas como um conjunto ordenado ou não, se esta é uma coluna categórica.

ColumnType

Enumeração

Tipo de dados da coluna.

Valor	Description
Boolean
Integer
Number
String

CommitmentPlan

Object

Informações sobre o plano de compromisso de aprendizado de máquina associado ao serviço Web.

Name	Tipo	Description
id	string	Especifica a ID do Azure Resource Manager do plano de compromisso associado ao serviço Web.

DiagnosticsConfiguration

Object

Configurações de diagnóstico para um serviço Web do Azure ML.

Name	Tipo	Description
expiry	string (date-time)	Especifica a data e a hora em que o registro em log será interrompido. Se nulo, a coleta de diagnóstico não é limitada no tempo.
level	DiagnosticsLevel	Especifica a detalhamento da saída de diagnóstico. Os valores válidos são: Nenhum - desativa o rastreio; Erro - recolhe apenas rastreamentos de erro (stderr); Tudo - recolhe todos os vestígios (stdout e stderr).

DiagnosticsLevel

Enumeração

Especifica a detalhamento da saída de diagnóstico. Os valores válidos são: Nenhum - desativa o rastreio; Erro - recolhe apenas rastreamentos de erro (stderr); Tudo - recolhe todos os vestígios (stdout e stderr).

Valor	Description
All
Error
None

ExampleRequest

Object

Dados de entrada de exemplo para a(s) entrada(s) do serviço.

Name	Tipo	Description
globalParameters	object	Dados de entrada de exemplo para os parâmetros globais do serviço Web
inputs	object	Dados de entrada de exemplo para a(s) entrada(s) do serviço Web fornecidos como um nome de entrada para o mapa da matriz de valores de entrada de exemplo.

GraphEdge

Object

Define uma borda dentro do gráfico do serviço Web.

Name	Tipo	Description
sourceNodeId	string	O identificador do nó do gráfico de origem.
sourcePortId	string	O identificador da porta do nó de origem a partir da qual a borda se conecta.
targetNodeId	string	O identificador do nó do gráfico de destino.
targetPortId	string	O identificador da porta do nó de destino ao qual a borda se conecta.

GraphNode

Object

Especifica um nó no gráfico do serviço Web. O nó pode ser um nó de entrada, saída ou ativo, portanto, apenas uma das propriedades de id correspondentes é preenchida a qualquer momento.

Name	Tipo	Description
assetId	string	A id do ativo representado por este nó.
inputId	string	A id do elemento de entrada representado por este nó.
outputId	string	A id do elemento de saída representado por este nó.
parameters	object	Se aplicável, parâmetros do nó. Os parâmetros do gráfico global são mapeados para estes, com valores definidos em tempo de execução.

GraphPackage

Object

Define o gráfico dos módulos que compõem a solução de aprendizado de máquina.

Name	Tipo	Description
edges	GraphEdge[]	A lista de arestas que compõem o gráfico.
graphParameters	<string,  GraphParameter>	A coleção de parâmetros globais para o gráfico, dado como um nome de parâmetro global para o mapa GraphParameter. Cada parâmetro aqui tem uma correspondência de 1:1 com o mapa de valores de parâmetros globais declarado no nível WebServiceProperties.
nodes	<string,  GraphNode>	O conjunto de nós que compõem o gráfico, fornecido como um nodeId para o mapa GraphNode

GraphParameter

Object

Define um parâmetro global no gráfico.

Name	Tipo	Description
description	string	Descrição deste parâmetro gráfico.
links	GraphParameterLink[]	Links de associação para este parâmetro para nós no gráfico.
type	ParameterType	Tipo de parâmetro gráfico.

GraphParameterLink

Object

Link de associação para um parâmetro global do gráfico a um nó no gráfico.

Name	Tipo	Description
nodeId	string	O identificador do nó do gráfico
parameterKey	string	O identificador do parâmetro de nó para o qual o parâmetro global é mapeado.

InputPort

Object

Porta de entrada de ativos

Name	Tipo	Default value	Description
type	InputPortType	Dataset	Tipo de dados de porta.

InputPortType

Enumeração

Tipo de dados de porta.

Valor	Description
Dataset

MachineLearningWorkspace

Object

Informações sobre o espaço de trabalho de aprendizado de máquina que contém o experimento que é a origem do serviço Web.

Name	Tipo	Description
id	string	Especifica a ID do espaço de trabalho do espaço de trabalho de aprendizado de máquina associado ao serviço Web

ModeValueInfo

Object

Definição de parâmetro aninhado.

Name	Tipo	Description
interfaceString	string	O nome da cadeia de caracteres da interface para o parâmetro aninhado.
parameters	ModuleAssetParameter[]	A definição do parâmetro.

ModuleAssetParameter

Object

Definição de parâmetros para um ativo de módulo.

Name	Tipo	Description
modeValuesInfo	<string,  ModeValueInfo>	Definições para parâmetros de interface aninhados se este for um parâmetro de módulo complexo.
name	string	Nome do parâmetro.
parameterType	string	Tipo de parâmetro.

OutputPort

Object

Porta de saída de ativos

Name	Tipo	Default value	Description
type	OutputPortType	Dataset	Tipo de dados de porta.

OutputPortType

Enumeração

Tipo de dados de porta.

Valor	Description
Dataset

ParameterType

Enumeração

Tipo de parâmetro gráfico.

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

ProvisioningState

Enumeração

Somente leitura: O estado de provisão do serviço Web. Os valores válidos são Unknown, Provisioning, Succeeded, and Failed.

Valor	Description
Failed
Provisioning
Succeeded
Unknown

RealtimeConfiguration

Object

Contém as opções de configuração disponíveis para um ponto de extremidade do serviço Web do Azure ML.

Name	Tipo	Description
maxConcurrentCalls	integer minimum: 4 maximum: 200	Especifica o máximo de chamadas simultâneas que podem ser feitas para o serviço Web. Valor mínimo: 4, Valor máximo: 200.

ServiceInputOutputSpecification

Object

O esquema swagger 2.0 que descreve as entradas ou saídas do serviço. Consulte a especificação Swagger: http://swagger.io/specification/

Name	Tipo	Default value	Description
description	string		A descrição do esquema Swagger.
properties	<string,  TableSpecification>		Especifica uma coleção que contém o esquema de coluna para cada entrada ou saída do serviço Web. Para obter mais informações, consulte a especificação Swagger.
title	string		O título do seu esquema Swagger.
type	string	object	O tipo da entidade descrita em swagger. Sempre 'objeto'.

StorageAccount

Object

Acessar informações para uma conta de armazenamento.

Name	Tipo	Description
key	string	Especifica a chave usada para acessar a conta de armazenamento.
name	string	Especifica o nome da conta de armazenamento.

TableSpecification

Object

O esquema swagger 2.0 que descreve uma única entrada ou saída de serviço. Consulte a especificação Swagger: http://swagger.io/specification/

Name	Tipo	Default value	Description
description	string		Descrição do esquema Swagger.
format	string		O formato, se 'tipo' não é 'objeto'
properties	<string,  ColumnSpecification>		O conjunto de colunas dentro da tabela de dados.
title	string		Título do esquema Swagger.
type	string	object	O tipo da entidade descrita em swagger.

WebService

Object

Instância de um recurso de serviço Web do Azure ML.

Name	Tipo	Description
id	string	Especifica a ID do recurso.
location	string	Especifica o local do recurso.
name	string	Especifica o nome do recurso.
properties	WebServiceProperties: WebServicePropertiesForGraph	Contém a carga útil da propriedade que descreve o serviço Web.
tags	object	Contém tags de recursos definidas como pares chave/valor.
type	string	Especifica o tipo do recurso.

WebServiceKeys

Object

Chaves de acesso para as chamadas de serviço Web.

Name	Tipo	Description
primary	string	A chave de acesso primária.
secondary	string	A chave de acesso secundária.

WebServicePropertiesForGraph

Object

Propriedades específicas de um serviço Web baseado em gráfico.

Name	Tipo	Description
assets	<string,  AssetItem>	Contém propriedades definidas pelo usuário que descrevem ativos de serviço Web. As propriedades são expressas como pares Chave/Valor.
commitmentPlan	CommitmentPlan	Contém o plano de compromisso associado a este serviço Web. Definido no momento da criação. Uma vez definido, esse valor não pode ser alterado. Nota: O plano de compromisso não é devolvido de chamadas para operações GET.
createdOn	string (date-time)	Somente leitura: a data e a hora em que o serviço Web foi criado.
description	string	A descrição do serviço Web.
diagnostics	DiagnosticsConfiguration	Configurações que controlam a coleta de rastreamentos de diagnóstico para o serviço Web.
exampleRequest	ExampleRequest	Define dados de entrada de exemplo para uma ou mais entradas do serviço.
exposeSampleData	boolean	Quando definido como true, os dados de exemplo são incluídos na definição swagger do serviço Web. O valor padrão é true.
input	ServiceInputOutputSpecification	Contém o esquema Swagger 2.0 que descreve uma ou mais entradas do serviço Web. Para obter mais informações, consulte a especificação Swagger.
keys	WebServiceKeys	Contém as chaves de provisionamento do serviço Web. Se você não especificar chaves de provisionamento, o sistema Azure Machine Learning as gerará para você. Nota: As chaves não são retornadas de chamadas para operações GET.
machineLearningWorkspace	MachineLearningWorkspace	Especifica o espaço de trabalho do Aprendizado de Máquina que contém o experimento que é a origem do serviço Web.
modifiedOn	string (date-time)	Somente leitura: a data e a hora em que o serviço Web foi modificado pela última vez.
output	ServiceInputOutputSpecification	Contém o esquema Swagger 2.0 que descreve uma ou mais saídas do serviço Web. Para obter mais informações, consulte a especificação Swagger.
package	GraphPackage	A definição do pacote gráfico que compõe este serviço Web.
packageType	string: Graph	Especifica o tipo de pacote. Os valores válidos são Graph (Especifica um serviço Web publicado através do Machine Learning Studio) e Code (Especifica um serviço Web publicado usando código como Python). Nota: O código não é suportado neste momento.
parameters	object	O conjunto de valores de parâmetros globais definidos para o serviço Web, dado como um nome de parâmetro global para o mapa de valor padrão. Se nenhum valor padrão for especificado, o parâmetro será considerado necessário.
provisioningState	ProvisioningState	Somente leitura: O estado de provisão do serviço Web. Os valores válidos são Unknown, Provisioning, Succeeded, and Failed.
readOnly	boolean	Quando definido como true, indica que o serviço Web é somente leitura e não pode mais ser atualizado ou corrigido, apenas removido. O padrão é falso. Nota: Uma vez definido como true, você não pode alterar seu valor.
realtimeConfiguration	RealtimeConfiguration	Contém as definições de configuração para o ponto de extremidade do serviço Web.
storageAccount	StorageAccount	Especifica a conta de armazenamento que o Aprendizado de Máquina do Azure usa para armazenar informações sobre o serviço Web. Somente o nome da conta de armazenamento é retornado de chamadas para operações GET. Ao atualizar as informações da conta de armazenamento, você deve garantir que todos os ativos necessários estejam disponíveis na nova conta de armazenamento ou as chamadas para o serviço Web falharão.
swaggerLocation	string	Somente leitura: contém o URI da especificação swagger associada a este serviço Web.
title	string	O título do serviço Web.