Functions - Update

  • Referenz
Service:
Stream Analytics
API Version:
2020-03-01

Updates einer vorhandenen Funktion unter einem vorhandenen Streamingauftrag. Dies kann verwendet werden, um eine Funktion teilweise zu aktualisieren (also eine oder zwei Eigenschaften zu aktualisieren), ohne den Rest der Auftrags- oder Funktionsdefinition zu beeinträchtigen.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}?api-version=2020-03-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
functionName
 path True

string

Der Name der Funktion.
jobName
 path True

string

Der Name des Streamingauftrags.
resourceGroupName
 path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

Regex pattern: ^[-\w\._\(\)]+$
subscriptionId
 path True

string

Hierbei handelt es sich um die ID des Zielabonnements.
api-version
 query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match

string

Das ETag der Funktion. Lassen Sie diesen Wert aus, um die aktuelle Funktion immer zu überschreiben. Geben Sie den zuletzt angezeigten ETag-Wert an, um zu verhindern, dass gleichzeitige Änderungen versehentlich überschrieben werden.

Anforderungstext

Name Typ Beschreibung
name

string

Ressourcenname
properties FunctionProperties:

Die Eigenschaften, die einer Funktion zugeordnet sind.

Antworten

Name Typ Beschreibung
200 OK

Function

Die Funktion wurde erfolgreich aktualisiert.

Headers

ETag: string
Other Status Codes

Error

Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Update a JavaScript function
Update an Azure ML function

Update a JavaScript function

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg1637/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197?api-version=2020-03-01

{
  "properties": {
    "type": "Scalar",
    "properties": {
      "binding": {
        "type": "Microsoft.StreamAnalytics/JavascriptUdf",
        "properties": {
          "script": "function (a, b) { return a * b; }"
        }
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: 94a512d5-2f59-4e39-b9c8-bca4abd74b7e
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg1637/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197",
  "name": "function8197",
  "type": "Microsoft.StreamAnalytics/streamingjobs/functions",
  "properties": {
    "type": "Scalar",
    "properties": {
      "inputs": [
        {
          "dataType": "Any"
        }
      ],
      "output": {
        "dataType": "Any"
      },
      "binding": {
        "type": "Microsoft.StreamAnalytics/JavascriptUdf",
        "properties": {
          "script": "function (a, b) { return a * b; }"
        }
      }
    }
  }
}

Update an Azure ML function

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg7/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588?api-version=2020-03-01

{
  "properties": {
    "type": "Scalar",
    "properties": {
      "binding": {
        "type": "Microsoft.MachineLearning/WebService",
        "properties": {
          "batchSize": 5000
        }
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: 281cbf11-cd50-4a44-b833-cf170ce74748
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588",
  "name": "function588",
  "type": "Microsoft.StreamAnalytics/streamingjobs/functions",
  "properties": {
    "type": "Scalar",
    "properties": {
      "inputs": [
        {
          "dataType": "nvarchar(max)"
        }
      ],
      "output": {
        "dataType": "nvarchar(max)"
      },
      "binding": {
        "type": "Microsoft.MachineLearning/WebService",
        "properties": {
          "endpoint": "someAzureMLEndpointURL",
          "inputs": {
            "name": "input1",
            "columnNames": [
              {
                "name": "tweet",
                "dataType": "string",
                "mapTo": 0
              }
            ]
          },
          "outputs": [
            {
              "name": "Sentiment",
              "dataType": "string"
            }
          ],
          "batchSize": 5000
        }
      }
    }
  }
}

Definitionen

Name Beschreibung
AggregateFunctionProperties

Die Eigenschaften, die einer Aggregatfunktion zugeordnet sind.
AzureMachineLearningWebServiceFunctionBinding

Die Bindung an einen Azure Machine Learning-Webdienst.
AzureMachineLearningWebServiceInputColumn

Beschreibt eine Eingabespalte für den Azure Machine Learning-Webdienstendpunkt.
AzureMachineLearningWebServiceInputs

Die Eingaben für den Azure Machine Learning-Webdienstendpunkt.
AzureMachineLearningWebServiceOutputColumn

Beschreibt eine Ausgabespalte für den Azure Machine Learning-Webdienstendpunkt.
Error

Häufige Fehlerdarstellung.
Function

Ein Funktionsobjekt, das alle Informationen enthält, die der benannten Funktion zugeordnet sind. Alle Funktionen sind unter einem Streamingauftrag enthalten.
FunctionInput

Beschreibt einen Eingabeparameter einer Funktion.
FunctionOutput

Beschreibt die Ausgabe einer Funktion.
JavaScriptFunctionBinding

Die Bindung an eine JavaScript-Funktion.
ScalarFunctionProperties

Die Eigenschaften, die einer Skalarfunktion zugeordnet sind.

AggregateFunctionProperties

Die Eigenschaften, die einer Aggregatfunktion zugeordnet sind.

Name Typ Beschreibung
etag

string

Das aktuelle Entitätstag für die Funktion. Dies ist eine undurchsichtige Zeichenfolge. Sie können damit erkennen, ob sich die Ressource zwischen Anforderungen geändert hat. Sie können sie auch im If-Match- oder If-None-Match-Header für Schreibvorgänge verwenden, um eine optimistische Parallelität zu erzielen.
properties.binding FunctionBinding:

Die physische Bindung der Funktion. Im Fall des Azure Machine Learning-Webdiensts beschreibt dies beispielsweise den Endpunkt.
properties.inputs

FunctionInput[]

Beschreibt einen Eingabeparameter einer Funktion.
properties.output

FunctionOutput

Beschreibt die Ausgabe einer Funktion.
type string:

Aggregate

Gibt den Typ der Funktion an.

AzureMachineLearningWebServiceFunctionBinding

Die Bindung an einen Azure Machine Learning-Webdienst.

Name Typ Beschreibung
properties.apiKey

string

Der API-Schlüssel, der für die Authentifizierung bei Request-Response Endpunkt verwendet wird.
properties.batchSize

integer

Zahl zwischen 1 und 10000, die die maximale Anzahl von Zeilen für jede Azure ML RRS-Ausführungsanforderung beschreibt. Der Standard ist 1000.
properties.endpoint

string

Der Request-Response Ausführungsendpunkt des Azure Machine Learning-Webdiensts. Weitere Informationen finden Sie hier: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
properties.inputs

AzureMachineLearningWebServiceInputs

Die Eingaben für den Azure Machine Learning-Webdienstendpunkt.
properties.outputs

AzureMachineLearningWebServiceOutputColumn[]

Eine Liste der Ausgaben der Ausführung des Azure Machine Learning-Webdienst-Endpunkts.
type string:

Microsoft.MachineLearning/WebService

Gibt den Funktionsbindungstyp an.

AzureMachineLearningWebServiceInputColumn

Beschreibt eine Eingabespalte für den Azure Machine Learning-Webdienstendpunkt.

Name Typ Beschreibung
dataType

string

Der (von Azure Machine Learning unterstützte) Datentyp der Eingabespalte. Eine Liste der gültigen Azure Machine Learning-Datentypen wird unter https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx beschrieben.
mapTo

integer

Der nullbasierte Index des Funktionsparameters, dem diese Eingabe zugeordnet ist.
name

string

Der Name der Eingabespalte.

AzureMachineLearningWebServiceInputs

Die Eingaben für den Azure Machine Learning-Webdienstendpunkt.

Name Typ Beschreibung
columnNames

AzureMachineLearningWebServiceInputColumn[]

Eine Liste der Eingabespalten für den Azure Machine Learning-Webdienstendpunkt.
name

string

Der Name der Eingabe. Dies ist der Name, der beim Erstellen des Endpunkts angegeben wird.

AzureMachineLearningWebServiceOutputColumn

Beschreibt eine Ausgabespalte für den Azure Machine Learning-Webdienstendpunkt.

Name Typ Beschreibung
dataType

string

Der (von Azure Machine Learning unterstützte) Datentyp der Ausgabespalte. Eine Liste der gültigen Azure Machine Learning-Datentypen wird unter https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx beschrieben.
name

string

Der Name der Ausgabespalte.

Error

Häufige Fehlerdarstellung.

Name Typ Beschreibung
error

Error

Fehlerdefinitionseigenschaften.

Function

Ein Funktionsobjekt, das alle Informationen enthält, die der benannten Funktion zugeordnet sind. Alle Funktionen sind unter einem Streamingauftrag enthalten.

Name Typ Beschreibung
id

string

Ressourcen-ID
name

string

Ressourcenname
properties FunctionProperties:

Die Eigenschaften, die einer Funktion zugeordnet sind.
type

string

Ressourcentyp

FunctionInput

Beschreibt einen Eingabeparameter einer Funktion.

Name Typ Beschreibung
dataType

string

Der (von Azure Stream Analytics unterstützte) Datentyp des Funktionseingabeparameters. Eine Liste der gültigen Azure Stream Analytics-Datentypen wird unter beschrieben. https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
isConfigurationParameter

boolean

Ein Flag, das angibt, ob der Parameter ein Konfigurationsparameter ist. True, wenn von diesem Eingabeparameter erwartet wird, dass er eine Konstante ist. Der Standardwert ist "false".

FunctionOutput

Beschreibt die Ausgabe einer Funktion.

Name Typ Beschreibung
dataType

string

Der (von Azure Stream Analytics unterstützte) Datentyp der Funktionsausgabe. Eine Liste der gültigen Azure Stream Analytics-Datentypen wird unter beschrieben. https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx

JavaScriptFunctionBinding

Die Bindung an eine JavaScript-Funktion.

Name Typ Beschreibung
properties.script

string

Der JavaScript-Code, der eine einzelne Funktionsdefinition enthält. Beispiel: 'Function (x, y) { return x + y; }'
type string:

Microsoft.StreamAnalytics/JavascriptUdf

Gibt den Funktionsbindungstyp an.

ScalarFunctionProperties

Die Eigenschaften, die einer Skalarfunktion zugeordnet sind.

Name Typ Beschreibung
etag

string

Das aktuelle Entitätstag für die Funktion. Dies ist eine undurchsichtige Zeichenfolge. Sie können damit erkennen, ob sich die Ressource zwischen Anforderungen geändert hat. Sie können sie auch im If-Match- oder If-None-Match-Header für Schreibvorgänge verwenden, um eine optimistische Parallelität zu erzielen.
properties.binding FunctionBinding:

Die physische Bindung der Funktion. Im Fall des Azure Machine Learning-Webdiensts beschreibt dies beispielsweise den Endpunkt.
properties.inputs

FunctionInput[]

Beschreibt einen Eingabeparameter einer Funktion.
properties.output

FunctionOutput

Beschreibt die Ausgabe einer Funktion.
type string:

Scalar

Gibt den Typ der Funktion an.