Web Services - Get

Dienst:

ML Studio (classic)

API-Version:

2016-05-01-preview

Ruft die Webdienstdefinition ab, wie durch ein Abonnement, eine Ressourcengruppe und einen Namen angegeben. Beachten Sie, dass die Speicheranmeldeinformationen und Webdienstschlüssel von diesem Aufruf nicht zurückgegeben werden. Rufen Sie Listenschlüssel auf, um die Webdienstzugriffsschlüssel abzurufen.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Name der Ressourcengruppe, in der sich der Webdienst befindet.
subscriptionId	path	True	string	Die Azure-Abonnement-ID.
webServiceName	path	True	string	Der Name des Webdiensts.
api-version	query	True	string	Die Version der zu verwendenden Microsoft.MachineLearning-Ressourcenanbieter-API.

Antworten

Name	Typ	Beschreibung
200 OK	WebService	Erfolg. Die Antwort enthält den Bereitstellungsstatus und den Azure-AsyncOperation-Header. Um den Fortschritt des Vorgangs abzurufen, rufen Sie get-Vorgang für die URL in Azure-AsyncOperation Kopfzeilenfeld auf. Weitere Informationen zu asynchronen Vorgängen finden Sie unter https://msdn.microsoft.com/en-us/library/mt742920.aspx. Media Types: "application/json", "text/json"

Definitionen

Name	Beschreibung
AssetItem	Informationen zu einer Ressource, die dem Webdienst zugeordnet ist.
AssetLocation	Beschreibt den Zugriffsort für ein Webdienstobjekt.
AssetType	Der Typ des Medienobjekts.
ColumnFormat	Zusätzliche Formatinformationen für den Datentyp.
ColumnSpecification	Swagger 2.0-Schema für eine Spalte in der Datentabelle, die eine Webdiensteingabe oder -ausgabe darstellt. Siehe Swagger-Spezifikation: http://swagger.io/specification/
ColumnType	Datentyp der Spalte.
CommitmentPlan	Informationen zum Machine Learning-Verpflichtungsplan, der dem Webdienst zugeordnet ist.
DiagnosticsConfiguration	Diagnoseeinstellungen für einen Azure ML-Webdienst.
DiagnosticsLevel	Gibt die Ausführlichkeit der Diagnoseausgabe an. Gültige Werte sind: None – deaktiviert die Ablaufverfolgung; Fehler: Sammelt nur Fehlerablaufverfolgungen (stderr). All: Sammelt alle Ablaufverfolgungen (stdout und stderr).
ExampleRequest	Beispieleingabedaten für die Eingaben des Diensts.
GraphEdge	Definiert einen Edge im Diagramm des Webdiensts.
GraphNode	Gibt einen Knoten im Webdienstdiagramm an. Der Knoten kann entweder ein Eingabe-, Ausgabe- oder Ressourcenknoten sein, sodass nur eine der entsprechenden ID-Eigenschaften zu einem bestimmten Zeitpunkt aufgefüllt wird.
GraphPackage	Definiert das Diagramm der Module, aus dem die Machine Learning-Lösung besteht.
GraphParameter	Definiert einen globalen Parameter im Diagramm.
GraphParameterLink	Zuordnungslink für einen globalen Graphparameter zu einem Knoten im Graphen.
InputPort	Medienobjekteingabeport
InputPortType	Portdatentyp.
MachineLearningWorkspace	Informationen zum Machine Learning-Arbeitsbereich, der das Experiment enthält, das die Quelle für den Webdienst ist.
ModeValueInfo	Definition geschachtelter Parameter.
ModuleAssetParameter	Parameterdefinition für ein Modulobjekt.
OutputPort	Medienobjektausgabeport
OutputPortType	Portdatentyp.
ParameterType	Der Typ des Graph-Parameters.
ProvisioningState	Schreibgeschützt: Der Bereitstellungsstatus des Webdiensts. Gültige Werte sind Unbekannt, Bereitstellung, Erfolgreich und Fehler.
RealtimeConfiguration	Enthält die verfügbaren Konfigurationsoptionen für einen Azure ML-Webdienstendpunkt.
ServiceInputOutputSpecification	Das swagger 2.0-Schema, das die Ein- oder Ausgaben des Diensts beschreibt. Siehe Swagger-Spezifikation: http://swagger.io/specification/
StorageAccount	Zugreifen auf Informationen für ein Speicherkonto.
TableSpecification	Das swagger 2.0-Schema, das eine einzelne Diensteingabe oder -ausgabe beschreibt. Siehe Swagger-Spezifikation: http://swagger.io/specification/
WebService	Instanz einer Azure ML-Webdienstressource.
WebServiceKeys	Zugriffsschlüssel für die Webdienstaufrufe.
WebServicePropertiesForGraph	Eigenschaften, die für einen Graph-basierten Webdienst spezifisch sind.

AssetItem

Informationen zu einer Ressource, die dem Webdienst zugeordnet ist.

Name	Typ	Beschreibung
id	string	Die Id des Ressourcenobjekts.
inputPorts	<string,  InputPort>	Informationen zu den Eingabeports des Medienobjekts.
locationInfo	AssetLocation	Zugriffsinformationen für das Asset.
metadata	object	Wenn es sich bei dem Objekt um ein benutzerdefiniertes Modul handelt, enthält dies die Metadaten des Moduls.
name	string	Anzeigename des Assets.
outputPorts	<string,  OutputPort>	Informationen zu den Ausgabeports des Assets.
parameters	ModuleAssetParameter[]	Wenn es sich bei dem Asset um ein benutzerdefiniertes Modul handelt, enthält dieses die Parameter des Moduls.
type	AssetType	Der Typ des Assets.

AssetLocation

Beschreibt den Zugriffsort für ein Webdienstobjekt.

Name	Typ	Beschreibung
credentials	string	Zugriffsanmeldeinformationen für das Medienobjekt( falls zutreffend) (z. B. Durch Speicherkonto Verbindungszeichenfolge + Blob-URI angegebene Ressource)
uri	string	Der URI, von dem aus auf das Medienobjekt zugegriffen werden kann (z. B. aml://abc für Systemressourcen oder https://xyz für Benutzerressourcen

AssetType

Der Typ des Medienobjekts.

Name	Typ	Beschreibung
Module	string
Resource	string

ColumnFormat

Zusätzliche Formatinformationen für den Datentyp.

Name	Typ	Beschreibung
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 für eine Spalte in der Datentabelle, die eine Webdiensteingabe oder -ausgabe darstellt. Siehe Swagger-Spezifikation: http://swagger.io/specification/

Name	Typ	Beschreibung
enum	object[]	Wenn der Datentyp kategorisch ist, wird die Liste der akzeptierten Kategorien bereitgestellt.
format	ColumnFormat	Zusätzliche Formatinformationen für den Datentyp.
type	ColumnType	Datentyp der Spalte.
x-ms-isnullable	boolean	Flag, das angibt, ob der Typ NULL-Werte unterstützt oder nicht.
x-ms-isordered	boolean	Flag, das angibt, ob die Kategorien als sortierte Menge behandelt werden oder nicht, wenn dies eine kategorische Spalte ist.

ColumnType

Datentyp der Spalte.

Name	Typ	Beschreibung
Boolean	string
Integer	string
Number	string
String	string

CommitmentPlan

Informationen zum Machine Learning-Verpflichtungsplan, der dem Webdienst zugeordnet ist.

Name	Typ	Beschreibung
id	string	Gibt die Azure Resource Manager-ID des Dem Webdienst zugeordneten Verpflichtungsplans an.

DiagnosticsConfiguration

Diagnoseeinstellungen für einen Azure ML-Webdienst.

Name	Typ	Beschreibung
expiry	string	Gibt das Datum und die Uhrzeit an, an dem die Protokollierung beendet wird. Wenn NULL ist, ist die Diagnosesammlung nicht zeitlimitiert.
level	DiagnosticsLevel	Gibt die Ausführlichkeit der Diagnoseausgabe an. Gültige Werte sind: None – deaktiviert die Ablaufverfolgung; Fehler: Erfasst nur Fehlerablaufverfolgungen (stderr). Alle – sammelt alle Ablaufverfolgungen (stdout und stderr).

DiagnosticsLevel

Gibt die Ausführlichkeit der Diagnoseausgabe an. Gültige Werte sind: None – deaktiviert die Ablaufverfolgung; Fehler: Sammelt nur Fehlerablaufverfolgungen (stderr). All: Sammelt alle Ablaufverfolgungen (stdout und stderr).

Name	Typ	Beschreibung
All	string
Error	string
None	string

ExampleRequest

Beispieleingabedaten für die Eingaben des Diensts.

Name	Typ	Beschreibung
globalParameters	object	Beispieleingabedaten für die globalen Parameter des Webdiensts
inputs	object	Beispieleingabedaten für die Eingaben des Webdiensts, die als Eingabename für die Matrixzuordnung von Beispieleingabewerten angegeben werden.

GraphEdge

Definiert einen Edge im Diagramm des Webdiensts.

Name	Typ	Beschreibung
sourceNodeId	string	Der Bezeichner des Quellgraphknotens.
sourcePortId	string	Der Bezeichner des Ports des Quellknotens, über den der Edge eine Verbindung herstellt.
targetNodeId	string	Der Bezeichner des Zieldiagrammknotens.
targetPortId	string	Der Bezeichner des Port des Zielknotens, mit dem der Edge eine Verbindung herstellt.

GraphNode

Gibt einen Knoten im Webdienstdiagramm an. Der Knoten kann entweder ein Eingabe-, Ausgabe- oder Ressourcenknoten sein, sodass nur eine der entsprechenden ID-Eigenschaften zu einem bestimmten Zeitpunkt aufgefüllt wird.

Name	Typ	Beschreibung
assetId	string	Die ID des durch diesen Knoten dargestellten Assets.
inputId	string	Die ID des eingabeelements, das von diesem Knoten dargestellt wird.
outputId	string	Die ID des ausgabeelements, das von diesem Knoten dargestellt wird.
parameters	object	Falls zutreffend, Parameter des Knotens. Globale Graphparameter werden diesen zugeordnet, wobei werte zur Laufzeit festgelegt sind.

GraphPackage

Definiert das Diagramm der Module, aus dem die Machine Learning-Lösung besteht.

Name	Typ	Beschreibung
edges	GraphEdge[]	Die Liste der Kanten, aus der das Diagramm besteht.
graphParameters	<string,  GraphParameter>	Die Auflistung der globalen Parameter für das Diagramm, die als globaler Parametername für die GraphParameter-Zuordnung angegeben wird. Jeder Parameter hat hier eine 1:1-Übereinstimmung mit den globalen Parameterwerten, die auf der WebServiceProperties-Ebene deklariert wurden.
nodes	<string,  GraphNode>	Der Satz von Knoten, aus dem das Diagramm besteht, wird als nodeId zur GraphNode-Zuordnung bereitgestellt.

GraphParameter

Definiert einen globalen Parameter im Diagramm.

Name	Typ	Beschreibung
description	string	Beschreibung dieses Graphparameters.
links	GraphParameterLink[]	Zuordnungslinks für diesen Parameter zu Knoten im Graphen.
type	ParameterType	Der Typ des Graph-Parameters.

GraphParameterLink

Zuordnungslink für einen globalen Graphparameter zu einem Knoten im Graphen.

Name	Typ	Beschreibung
nodeId	string	Der Bezeichner des Graphknotens
parameterKey	string	Der Bezeichner des Knotenparameters, dem der globale Parameter zugeordnet ist.

InputPort

Medienobjekteingabeport

Name	Typ	Standardwert	Beschreibung
type	InputPortType	Dataset	Portdatentyp.

InputPortType

Portdatentyp.

Name	Typ	Beschreibung
Dataset	string

MachineLearningWorkspace

Informationen zum Machine Learning-Arbeitsbereich, der das Experiment enthält, das die Quelle für den Webdienst ist.

Name	Typ	Beschreibung
id	string	Gibt die Arbeitsbereichs-ID des Machine Learning-Arbeitsbereichs an, der dem Webdienst zugeordnet ist.

ModeValueInfo

Definition geschachtelter Parameter.

Name	Typ	Beschreibung
interfaceString	string	Der Name der Schnittstellenzeichenfolge für den geschachtelten Parameter.
parameters	ModuleAssetParameter[]	Die Definition des Parameters.

ModuleAssetParameter

Parameterdefinition für ein Modulobjekt.

Name	Typ	Beschreibung
modeValuesInfo	<string,  ModeValueInfo>	Definitionen für geschachtelte Schnittstellenparameter, wenn dies ein komplexer Modulparameter ist.
name	string	Parametername.
parameterType	string	Der Parametertyp.

OutputPort

Medienobjektausgabeport

Name	Typ	Standardwert	Beschreibung
type	OutputPortType	Dataset	Portdatentyp.

OutputPortType

Portdatentyp.

Name	Typ	Beschreibung
Dataset	string

ParameterType

Der Typ des Graph-Parameters.

Name	Typ	Beschreibung
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

Schreibgeschützt: Der Bereitstellungsstatus des Webdiensts. Gültige Werte sind Unbekannt, Bereitstellung, Erfolgreich und Fehler.

Name	Typ	Beschreibung
Failed	string
Provisioning	string
Succeeded	string
Unknown	string

RealtimeConfiguration

Enthält die verfügbaren Konfigurationsoptionen für einen Azure ML-Webdienstendpunkt.

Name	Typ	Beschreibung
maxConcurrentCalls	integer	Gibt die maximale Anzahl gleichzeitiger Aufrufe an, die an den Webdienst ausgeführt werden können. Mindestwert: 4, Maximalwert: 200.

ServiceInputOutputSpecification

Das swagger 2.0-Schema, das die Ein- oder Ausgaben des Diensts beschreibt. Siehe Swagger-Spezifikation: http://swagger.io/specification/

Name	Typ	Standardwert	Beschreibung
description	string		Die Beschreibung des Swagger-Schemas.
properties	<string,  TableSpecification>		Gibt eine Auflistung an, die das Spaltenschema für jede Eingabe oder Ausgabe des Webdiensts enthält. Weitere Informationen finden Sie in der Swagger-Spezifikation.
title	string		Der Titel Ihres Swagger-Schemas.
type	string	object	Der In swagger beschriebene Entitätstyp. Immer "objekt".

StorageAccount

Zugreifen auf Informationen für ein Speicherkonto.

Name	Typ	Beschreibung
key	string	Gibt den Schlüssel an, der für den Zugriff auf das Speicherkonto verwendet wird.
name	string	Gibt den Namen des Speicherkontos an.

TableSpecification

Das swagger 2.0-Schema, das eine einzelne Diensteingabe oder -ausgabe beschreibt. Siehe Swagger-Spezifikation: http://swagger.io/specification/

Name	Typ	Standardwert	Beschreibung
description	string		Beschreibung des Swagger-Schemas.
format	string		Das Format, wenn "type" nicht "object" ist
properties	<string,  ColumnSpecification>		Der Satz von Spalten in der Datentabelle.
title	string		Titel des Swagger-Schemas.
type	string	object	Der Typ der in swagger beschriebenen Entität.

WebService

Instanz einer Azure ML-Webdienstressource.

Name	Typ	Beschreibung
id	string	Gibt die Ressourcen-ID an.
location	string	Gibt den Speicherort der Ressource an.
name	string	Gibt den Namen der Ressource an.
properties	WebServiceProperties: WebServicePropertiesForGraph	Enthält die Nutzlast der Eigenschaft, die den Webdienst beschreibt.
tags	object	Enthält Ressourcentags, die als Schlüssel-Wert-Paare definiert sind.
type	string	Gibt den Typ der Ressource an.

WebServiceKeys

Zugriffsschlüssel für die Webdienstaufrufe.

Name	Typ	Beschreibung
primary	string	Der primäre Zugriffsschlüssel.
secondary	string	Der sekundäre Zugriffsschlüssel.

WebServicePropertiesForGraph

Eigenschaften, die für einen Graph-basierten Webdienst spezifisch sind.

Name	Typ	Beschreibung
assets	<string,  AssetItem>	Enthält benutzerdefinierte Eigenschaften, die Webdienstressourcen beschreiben. Eigenschaften werden als Schlüssel-Wert-Paare ausgedrückt.
commitmentPlan	CommitmentPlan	Enthält den Verpflichtungsplan, der diesem Webdienst zugeordnet ist. Legen Sie zur Erstellungszeit fest. Nach dem Festlegen kann dieser Wert nicht mehr geändert werden. Hinweis: Der Verpflichtungsplan wird nicht von Aufrufen von GET-Vorgängen zurückgegeben.
createdOn	string	Schreibgeschützt: Das Datum und die Uhrzeit der Erstellung des Webdiensts.
description	string	Die Beschreibung des Webdiensts.
diagnostics	DiagnosticsConfiguration	Einstellungen, die die Diagnose Auflistung von Ablaufverfolgungen für den Webdienst steuern.
exampleRequest	ExampleRequest	Definiert Beispieleingabedaten für eine oder mehrere Eingaben des Diensts.
exposeSampleData	boolean	Wenn sie auf true festgelegt sind, sind Beispieldaten in der Swaggerdefinition des Webdiensts enthalten. Der Standardwert lautet „true“.
input	ServiceInputOutputSpecification	Enthält das Swagger 2.0-Schema, das eine oder mehrere Eingaben des Webdiensts beschreibt. Weitere Informationen finden Sie in der Swagger-Spezifikation.
keys	WebServiceKeys	Enthält die Webdienstbereitstellungsschlüssel. Wenn Sie keine Bereitstellungsschlüssel angeben, generiert das Azure Machine Learning-System diese für Sie. Hinweis: Die Schlüssel werden nicht von Aufrufen von GET-Vorgängen zurückgegeben.
machineLearningWorkspace	MachineLearningWorkspace	Gibt den Machine Learning-Arbeitsbereich an, der das Experiment enthält, das die Quelle für den Webdienst ist.
modifiedOn	string	Schreibgeschützt: Das Datum und die Uhrzeit der letzten Änderung des Webdiensts.
output	ServiceInputOutputSpecification	Enthält das Swagger 2.0-Schema, das eine oder mehrere Ausgaben des Webdiensts beschreibt. Weitere Informationen finden Sie in der Swagger-Spezifikation.
package	GraphPackage	Die Definition des Graphpakets, aus dem dieser Webdienst besteht.
packageType	string: Graph	Gibt den Pakettyp an. Gültige Werte sind Graph (Gibt einen Webdienst an, der über Machine Learning Studio veröffentlicht wird) und Code (Gibt einen Webdienst an, der mithilfe von Code wie Python veröffentlicht wurde). Hinweis: Code wird derzeit nicht unterstützt.
parameters	object	Der Satz von globalen Parameterwerten, die für den Webdienst definiert sind und als globaler Parametername zur Standardwertzuordnung angegeben werden. Wenn kein Standardwert angegeben wird, gilt der Parameter als erforderlich.
provisioningState	ProvisioningState	Schreibgeschützt: Der Bereitstellungsstatus des Webdiensts. Gültige Werte sind Unbekannt, Bereitstellung, Erfolgreich und Fehler.
readOnly	boolean	Wenn dieser Wert auf true festgelegt ist, gibt an, dass der Webdienst schreibgeschützt ist und nicht mehr aktualisiert oder gepatcht, nur entfernt werden kann. Der Standardwert ist false. Hinweis: Nach dem Festlegen auf true können Sie den Wert nicht mehr ändern.
realtimeConfiguration	RealtimeConfiguration	Enthält die Konfigurationseinstellungen für den Webdienstendpunkt.
storageAccount	StorageAccount	Gibt das Speicherkonto an, das Azure Machine Learning zum Speichern von Informationen zum Webdienst verwendet. Nur der Name des Speicherkontos wird von Aufrufen von GET-Vorgängen zurückgegeben. Wenn Sie die Speicherkontoinformationen aktualisieren, müssen Sie sicherstellen, dass alle erforderlichen Ressourcen im neuen Speicherkonto verfügbar sind, oder dass Aufrufe Ihres Webdiensts fehlschlagen.
swaggerLocation	string	Schreibgeschützt: Enthält den URI der Swagger-Spezifikation, die diesem Webdienst zugeordnet ist.
title	string	Der Titel des Webdiensts.