你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Functions - Retrieve Default Definition

参考

服务:: Stream Analytics

API 版本:: 2020-03-01

根据指定的参数检索函数的默认定义。

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

URI 参数

名称	在	必需	类型	说明
functionName	path	True	string	函数的名称。
jobName	path	True	string	流式处理作业的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

请求正文可以为下列任一内容：

名称	说明
AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters	检索 Azure 机器学习 Web 服务函数的默认函数定义所需的参数。
JavaScriptFunctionRetrieveDefaultDefinitionParameters	检索 JavaScript 函数的默认函数定义所需的参数。

AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters

检索 Azure 机器学习 Web 服务函数的默认函数定义所需的参数。

名称	必需	类型	说明
bindingType	True	string: Microsoft.MachineLearning/WebService	指示函数绑定类型。
bindingRetrievalProperties.executeEndpoint		string	Request-Response Azure 机器学习 Web 服务的执行终结点。在此处了解详细信息：https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
bindingRetrievalProperties.udfType		UdfType	函数类型。

JavaScriptFunctionRetrieveDefaultDefinitionParameters

检索 JavaScript 函数的默认函数定义所需的参数。

名称	必需	类型	说明
bindingType	True	string: Microsoft.StreamAnalytics/JavascriptUdf	指示函数绑定类型。
bindingRetrievalProperties.script		string	包含单个函数定义的 JavaScript 代码。例如：“function （x， y） { return x + y; }”。
bindingRetrievalProperties.udfType		UdfType	函数类型。

响应

名称	类型	说明
200 OK	Function	已成功检索函数的默认定义。
Other Status Codes	Error	错误。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Retrieve the default definition for an Azure ML function

示例请求

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

{
  "bindingType": "Microsoft.MachineLearning/WebService",
  "bindingRetrievalProperties": {
    "executeEndpoint": "someAzureMLExecuteEndpointUrl",
    "udfType": "Scalar"
  }
}


import com.azure.resourcemanager.streamanalytics.models.AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters;
import com.azure.resourcemanager.streamanalytics.models.UdfType;

/**
 * Samples for Functions RetrieveDefaultDefinition.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/
     * Function_RetrieveDefaultDefinition_AzureML.json
     */
    /**
     * Sample code: Retrieve the default definition for an Azure ML function.
     * 
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void retrieveTheDefaultDefinitionForAnAzureMLFunction(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.functions().retrieveDefaultDefinitionWithResponse("sjrg7", "sj9093", "function588",
            new AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters()
                .withExecuteEndpoint("someAzureMLExecuteEndpointUrl").withUdfType(UdfType.SCALAR),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_RetrieveDefaultDefinition_AzureML.json
func ExampleFunctionsClient_RetrieveDefaultDefinition() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewFunctionsClient().RetrieveDefaultDefinition(ctx, "sjrg7", "sj9093", "function588", &armstreamanalytics.FunctionsClientRetrieveDefaultDefinitionOptions{FunctionRetrieveDefaultDefinitionParameters: &armstreamanalytics.AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters{
		BindingType: to.Ptr("Microsoft.MachineLearning/WebService"),
		BindingRetrievalProperties: &armstreamanalytics.AzureMachineLearningWebServiceFunctionBindingRetrievalProperties{
			ExecuteEndpoint: to.Ptr("someAzureMLExecuteEndpointUrl"),
			UdfType:         to.Ptr("Scalar"),
		},
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Function = armstreamanalytics.Function{
	// 	Name: to.Ptr("function588"),
	// 	Properties: &armstreamanalytics.ScalarFunctionProperties{
	// 		Type: to.Ptr("Scalar"),
	// 		Properties: &armstreamanalytics.FunctionConfiguration{
	// 			Binding: &armstreamanalytics.AzureMachineLearningWebServiceFunctionBinding{
	// 				Type: to.Ptr("Microsoft.MachineLearning/WebService"),
	// 				Properties: &armstreamanalytics.AzureMachineLearningWebServiceFunctionBindingProperties{
	// 					BatchSize: to.Ptr[int32](1000),
	// 					Endpoint: to.Ptr("someAzureMLExecuteEndpointUrl"),
	// 					Inputs: &armstreamanalytics.AzureMachineLearningWebServiceInputs{
	// 						Name: to.Ptr("input1"),
	// 						ColumnNames: []*armstreamanalytics.AzureMachineLearningWebServiceInputColumn{
	// 							{
	// 								Name: to.Ptr("tweet"),
	// 								DataType: to.Ptr("string"),
	// 								MapTo: to.Ptr[int32](0),
	// 						}},
	// 					},
	// 					Outputs: []*armstreamanalytics.AzureMachineLearningWebServiceOutputColumn{
	// 						{
	// 							Name: to.Ptr("Sentiment"),
	// 							DataType: to.Ptr("string"),
	// 					}},
	// 				},
	// 			},
	// 			Inputs: []*armstreamanalytics.FunctionInput{
	// 				{
	// 					DataType: to.Ptr("nvarchar(max)"),
	// 			}},
	// 			Output: &armstreamanalytics.FunctionOutput{
	// 				DataType: to.Ptr("nvarchar(max)"),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Retrieves the default definition of a function based on the parameters specified.
 *
 * @summary Retrieves the default definition of a function based on the parameters specified.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_RetrieveDefaultDefinition_AzureML.json
 */
async function retrieveTheDefaultDefinitionForAnAzureMlFunction() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const resourceGroupName = "sjrg7";
  const jobName = "sj9093";
  const functionName = "function588";
  const functionRetrieveDefaultDefinitionParameters = {
    bindingType: "Microsoft.MachineLearning/WebService",
    executeEndpoint: "someAzureMLExecuteEndpointUrl",
    udfType: "Scalar",
  };
  const options = {
    functionRetrieveDefaultDefinitionParameters,
  };
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.functions.retrieveDefaultDefinition(
    resourceGroupName,
    jobName,
    functionName,
    options
  );
  console.log(result);
}

retrieveTheDefaultDefinitionForAnAzureMlFunction().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "name": "function588",
  "properties": {
    "type": "Scalar",
    "properties": {
      "inputs": [
        {
          "dataType": "nvarchar(max)"
        }
      ],
      "output": {
        "dataType": "nvarchar(max)"
      },
      "binding": {
        "type": "Microsoft.MachineLearning/WebService",
        "properties": {
          "endpoint": "someAzureMLExecuteEndpointUrl",
          "inputs": {
            "name": "input1",
            "columnNames": [
              {
                "name": "tweet",
                "dataType": "string",
                "mapTo": 0
              }
            ]
          },
          "outputs": [
            {
              "name": "Sentiment",
              "dataType": "string"
            }
          ],
          "batchSize": 1000
        }
      }
    }
  }
}

定义

名称	说明
AggregateFunctionProperties	与聚合函数关联的属性。
AzureMachineLearningWebServiceFunctionBinding	绑定到 Azure 机器学习 Web 服务。
AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters	检索 Azure 机器学习 Web 服务函数的默认函数定义所需的参数。
AzureMachineLearningWebServiceInputColumn	描述 Azure 机器学习 Web 服务终结点的输入列。
AzureMachineLearningWebServiceInputs	Azure 机器学习 Web 服务终结点的输入。
AzureMachineLearningWebServiceOutputColumn	描述 Azure 机器学习 Web 服务终结点的输出列。
Error	常见的错误表示形式。
Function	一个函数对象，包含与命名函数关联的所有信息。所有函数都包含在流式处理作业下。
FunctionInput	描述函数的一个输入参数。
FunctionOutput	描述函数的输出。
JavaScriptFunctionBinding	绑定到 JavaScript 函数。
JavaScriptFunctionRetrieveDefaultDefinitionParameters	检索 JavaScript 函数的默认函数定义所需的参数。
ScalarFunctionProperties	与标量函数关联的属性。
UdfType	函数类型。

AggregateFunctionProperties

Object

与聚合函数关联的属性。

名称	类型	说明
etag	string	函数的当前实体标记。这是一个不透明的字符串。可以使用它来检测资源是否在请求之间发生了更改。还可以在 If-Match 或 If-None-Match 标头中使用它，以便进行乐观并发的写入作。
properties.binding	FunctionBinding: AzureMachineLearningWebServiceFunctionBinding JavaScriptFunctionBinding	函数的物理绑定。例如，在 Azure 机器学习 Web 服务的情况下，这描述了终结点。
properties.inputs	FunctionInput[]	描述函数的一个输入参数。
properties.output	FunctionOutput	描述函数的输出。
type	string: Aggregate	指示函数的类型。

AzureMachineLearningWebServiceFunctionBinding

Object

绑定到 Azure 机器学习 Web 服务。

名称	类型	说明
properties.apiKey	string	用于对 Request-Response 终结点进行身份验证的 API 密钥。
properties.batchSize	integer (int32)	描述每个 Azure ML RRS 执行请求的最大行数的 1 到 10000 之间的数字。默认值为 1000。
properties.endpoint	string	Request-Response Azure 机器学习 Web 服务的执行终结点。在此处了解详细信息：https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
properties.inputs	AzureMachineLearningWebServiceInputs	Azure 机器学习 Web 服务终结点的输入。
properties.outputs	AzureMachineLearningWebServiceOutputColumn[]	Azure 机器学习 Web 服务终结点执行的输出列表。
type	string: Microsoft.MachineLearning/WebService	指示函数绑定类型。

AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters

Object

检索 Azure 机器学习 Web 服务函数的默认函数定义所需的参数。

名称	类型	说明
bindingRetrievalProperties.executeEndpoint	string	Request-Response Azure 机器学习 Web 服务的执行终结点。在此处了解详细信息：https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
bindingRetrievalProperties.udfType	UdfType	函数类型。
bindingType	string: Microsoft.MachineLearning/WebService	指示函数绑定类型。

AzureMachineLearningWebServiceInputColumn

Object

描述 Azure 机器学习 Web 服务终结点的输入列。

名称	类型	说明
dataType	string	输入列的（Azure 机器学习支持）数据类型。 https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx 介绍了有效的 Azure 机器学习数据类型的列表。
mapTo	integer (int32)	此输入映射到的函数参数的从零开始的索引。
name	string	输入列的名称。

AzureMachineLearningWebServiceInputs

Object

Azure 机器学习 Web 服务终结点的输入。

名称	类型	说明
columnNames	AzureMachineLearningWebServiceInputColumn[]	Azure 机器学习 Web 服务终结点的输入列列表。
name	string	输入的名称。这是创作终结点时提供的名称。

AzureMachineLearningWebServiceOutputColumn

Object

描述 Azure 机器学习 Web 服务终结点的输出列。

名称	类型	说明
dataType	string	输出列的（Azure 机器学习支持的）数据类型。 https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx 介绍了有效的 Azure 机器学习数据类型的列表。
name	string	输出列的名称。

Error

Object

常见的错误表示形式。

名称	类型	说明
error	Error	错误定义属性。

Function

Object

一个函数对象，包含与命名函数关联的所有信息。所有函数都包含在流式处理作业下。

名称	类型	说明
id	string	资源 ID
name	string	资源名称
properties	FunctionProperties: AggregateFunctionProperties ScalarFunctionProperties	与函数关联的属性。
type	string	资源类型

FunctionInput

Object

描述函数的一个输入参数。

名称	类型	说明
dataType	string	函数输入参数的（支持 Azure 流分析）数据类型。 https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx 介绍了有效的 Azure 流分析数据类型列表
isConfigurationParameter	boolean	指示参数是否为配置参数的标志。如此如果此输入参数应为常量。默认值为 false。

FunctionOutput

Object

描述函数的输出。

名称	类型	说明
dataType	string	函数输出的（Azure 流分析支持）数据类型。 https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx 介绍了有效的 Azure 流分析数据类型列表

JavaScriptFunctionBinding

Object

绑定到 JavaScript 函数。

名称	类型	说明
properties.script	string	包含单个函数定义的 JavaScript 代码。例如：“function （x， y） { return x + y; }'
type	string: Microsoft.StreamAnalytics/JavascriptUdf	指示函数绑定类型。

JavaScriptFunctionRetrieveDefaultDefinitionParameters

Object

检索 JavaScript 函数的默认函数定义所需的参数。

名称	类型	说明
bindingRetrievalProperties.script	string	包含单个函数定义的 JavaScript 代码。例如：“function （x， y） { return x + y; }”。
bindingRetrievalProperties.udfType	UdfType	函数类型。
bindingType	string: Microsoft.StreamAnalytics/JavascriptUdf	指示函数绑定类型。

ScalarFunctionProperties

Object

与标量函数关联的属性。

名称	类型	说明
etag	string	函数的当前实体标记。这是一个不透明的字符串。可以使用它来检测资源是否在请求之间发生了更改。还可以在 If-Match 或 If-None-Match 标头中使用它，以便进行乐观并发的写入作。
properties.binding	FunctionBinding: AzureMachineLearningWebServiceFunctionBinding JavaScriptFunctionBinding	函数的物理绑定。例如，在 Azure 机器学习 Web 服务的情况下，这描述了终结点。
properties.inputs	FunctionInput[]	描述函数的一个输入参数。
properties.output	FunctionOutput	描述函数的输出。
type	string: Scalar	指示函数的类型。

UdfType

枚举

函数类型。

值	说明
Scalar

通过

Functions - Retrieve Default Definition

URI 参数

请求正文

AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters

JavaScriptFunctionRetrieveDefaultDefinitionParameters

响应

安全性

azure_auth

作用域

示例

Retrieve the default definition for an Azure ML function

示例请求

示例响应

定义

AggregateFunctionProperties

AzureMachineLearningWebServiceFunctionBinding

AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters

AzureMachineLearningWebServiceInputColumn

AzureMachineLearningWebServiceInputs

AzureMachineLearningWebServiceOutputColumn

Error

Function

FunctionInput

FunctionOutput

JavaScriptFunctionBinding

JavaScriptFunctionRetrieveDefaultDefinitionParameters

ScalarFunctionProperties

UdfType