1. Packages
  2. Azure Native
  3. API Docs
  4. streamanalytics
  5. getFunction
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

azure-native.streamanalytics.getFunction

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

    Gets details about the specified function. Azure REST API version: 2020-03-01.

    Other available API versions: 2016-03-01, 2021-10-01-preview.

    Using getFunction

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFunction(args: GetFunctionArgs, opts?: InvokeOptions): Promise<GetFunctionResult>
    function getFunctionOutput(args: GetFunctionOutputArgs, opts?: InvokeOptions): Output<GetFunctionResult>
    def get_function(function_name: Optional[str] = None,
                     job_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetFunctionResult
    def get_function_output(function_name: Optional[pulumi.Input[str]] = None,
                     job_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetFunctionResult]
    func LookupFunction(ctx *Context, args *LookupFunctionArgs, opts ...InvokeOption) (*LookupFunctionResult, error)
    func LookupFunctionOutput(ctx *Context, args *LookupFunctionOutputArgs, opts ...InvokeOption) LookupFunctionResultOutput

    > Note: This function is named LookupFunction in the Go SDK.

    public static class GetFunction 
    {
        public static Task<GetFunctionResult> InvokeAsync(GetFunctionArgs args, InvokeOptions? opts = null)
        public static Output<GetFunctionResult> Invoke(GetFunctionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFunctionResult> getFunction(GetFunctionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:streamanalytics:getFunction
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FunctionName string
    The name of the function.
    JobName string
    The name of the streaming job.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    FunctionName string
    The name of the function.
    JobName string
    The name of the streaming job.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    functionName String
    The name of the function.
    jobName String
    The name of the streaming job.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    functionName string
    The name of the function.
    jobName string
    The name of the streaming job.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    function_name str
    The name of the function.
    job_name str
    The name of the streaming job.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    functionName String
    The name of the function.
    jobName String
    The name of the streaming job.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getFunction Result

    The following output properties are available:

    Id string
    Resource Id
    Properties AggregateFunctionPropertiesResponse | ScalarFunctionPropertiesResponse
    The properties that are associated with a function.
    Type string
    Resource type
    Name string
    Resource name
    id String
    Resource Id
    properties AggregateFunctionPropertiesResponse | ScalarFunctionPropertiesResponse
    The properties that are associated with a function.
    type String
    Resource type
    name String
    Resource name
    id string
    Resource Id
    properties AggregateFunctionPropertiesResponse | ScalarFunctionPropertiesResponse
    The properties that are associated with a function.
    type string
    Resource type
    name string
    Resource name
    id str
    Resource Id
    properties AggregateFunctionPropertiesResponse | ScalarFunctionPropertiesResponse
    The properties that are associated with a function.
    type str
    Resource type
    name str
    Resource name
    id String
    Resource Id
    properties Property Map | Property Map
    The properties that are associated with a function.
    type String
    Resource type
    name String
    Resource name

    Supporting Types

    AggregateFunctionPropertiesResponse

    Etag string
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    Binding Pulumi.AzureNative.StreamAnalytics.Inputs.AzureMachineLearningWebServiceFunctionBindingResponse | Pulumi.AzureNative.StreamAnalytics.Inputs.JavaScriptFunctionBindingResponse
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    Inputs List<Pulumi.AzureNative.StreamAnalytics.Inputs.FunctionInputResponse>
    Output Pulumi.AzureNative.StreamAnalytics.Inputs.FunctionOutputResponse
    Describes the output of a function.
    Etag string
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    Binding AzureMachineLearningWebServiceFunctionBindingResponse | JavaScriptFunctionBindingResponse
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    Inputs []FunctionInputResponse
    Output FunctionOutputResponse
    Describes the output of a function.
    etag String
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    binding AzureMachineLearningWebServiceFunctionBindingResponse | JavaScriptFunctionBindingResponse
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    inputs List<FunctionInputResponse>
    output FunctionOutputResponse
    Describes the output of a function.
    etag string
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    binding AzureMachineLearningWebServiceFunctionBindingResponse | JavaScriptFunctionBindingResponse
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    inputs FunctionInputResponse[]
    output FunctionOutputResponse
    Describes the output of a function.
    etag str
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    binding AzureMachineLearningWebServiceFunctionBindingResponse | JavaScriptFunctionBindingResponse
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    inputs Sequence[FunctionInputResponse]
    output FunctionOutputResponse
    Describes the output of a function.
    etag String
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    binding Property Map | Property Map
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    inputs List<Property Map>
    output Property Map
    Describes the output of a function.

    AzureMachineLearningWebServiceFunctionBindingResponse

    ApiKey string
    The API key used to authenticate with Request-Response endpoint.
    BatchSize int
    Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000.
    Endpoint string
    The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
    Inputs Pulumi.AzureNative.StreamAnalytics.Inputs.AzureMachineLearningWebServiceInputsResponse
    The inputs for the Azure Machine Learning web service endpoint.
    Outputs List<Pulumi.AzureNative.StreamAnalytics.Inputs.AzureMachineLearningWebServiceOutputColumnResponse>
    A list of outputs from the Azure Machine Learning web service endpoint execution.
    ApiKey string
    The API key used to authenticate with Request-Response endpoint.
    BatchSize int
    Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000.
    Endpoint string
    The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
    Inputs AzureMachineLearningWebServiceInputsResponse
    The inputs for the Azure Machine Learning web service endpoint.
    Outputs []AzureMachineLearningWebServiceOutputColumnResponse
    A list of outputs from the Azure Machine Learning web service endpoint execution.
    apiKey String
    The API key used to authenticate with Request-Response endpoint.
    batchSize Integer
    Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000.
    endpoint String
    The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
    inputs AzureMachineLearningWebServiceInputsResponse
    The inputs for the Azure Machine Learning web service endpoint.
    outputs List<AzureMachineLearningWebServiceOutputColumnResponse>
    A list of outputs from the Azure Machine Learning web service endpoint execution.
    apiKey string
    The API key used to authenticate with Request-Response endpoint.
    batchSize number
    Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000.
    endpoint string
    The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
    inputs AzureMachineLearningWebServiceInputsResponse
    The inputs for the Azure Machine Learning web service endpoint.
    outputs AzureMachineLearningWebServiceOutputColumnResponse[]
    A list of outputs from the Azure Machine Learning web service endpoint execution.
    api_key str
    The API key used to authenticate with Request-Response endpoint.
    batch_size int
    Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000.
    endpoint str
    The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
    inputs AzureMachineLearningWebServiceInputsResponse
    The inputs for the Azure Machine Learning web service endpoint.
    outputs Sequence[AzureMachineLearningWebServiceOutputColumnResponse]
    A list of outputs from the Azure Machine Learning web service endpoint execution.
    apiKey String
    The API key used to authenticate with Request-Response endpoint.
    batchSize Number
    Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000.
    endpoint String
    The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
    inputs Property Map
    The inputs for the Azure Machine Learning web service endpoint.
    outputs List<Property Map>
    A list of outputs from the Azure Machine Learning web service endpoint execution.

    AzureMachineLearningWebServiceInputColumnResponse

    DataType string
    The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    MapTo int
    The zero based index of the function parameter this input maps to.
    Name string
    The name of the input column.
    DataType string
    The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    MapTo int
    The zero based index of the function parameter this input maps to.
    Name string
    The name of the input column.
    dataType String
    The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    mapTo Integer
    The zero based index of the function parameter this input maps to.
    name String
    The name of the input column.
    dataType string
    The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    mapTo number
    The zero based index of the function parameter this input maps to.
    name string
    The name of the input column.
    data_type str
    The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    map_to int
    The zero based index of the function parameter this input maps to.
    name str
    The name of the input column.
    dataType String
    The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    mapTo Number
    The zero based index of the function parameter this input maps to.
    name String
    The name of the input column.

    AzureMachineLearningWebServiceInputsResponse

    ColumnNames List<Pulumi.AzureNative.StreamAnalytics.Inputs.AzureMachineLearningWebServiceInputColumnResponse>
    A list of input columns for the Azure Machine Learning web service endpoint.
    Name string
    The name of the input. This is the name provided while authoring the endpoint.
    ColumnNames []AzureMachineLearningWebServiceInputColumnResponse
    A list of input columns for the Azure Machine Learning web service endpoint.
    Name string
    The name of the input. This is the name provided while authoring the endpoint.
    columnNames List<AzureMachineLearningWebServiceInputColumnResponse>
    A list of input columns for the Azure Machine Learning web service endpoint.
    name String
    The name of the input. This is the name provided while authoring the endpoint.
    columnNames AzureMachineLearningWebServiceInputColumnResponse[]
    A list of input columns for the Azure Machine Learning web service endpoint.
    name string
    The name of the input. This is the name provided while authoring the endpoint.
    column_names Sequence[AzureMachineLearningWebServiceInputColumnResponse]
    A list of input columns for the Azure Machine Learning web service endpoint.
    name str
    The name of the input. This is the name provided while authoring the endpoint.
    columnNames List<Property Map>
    A list of input columns for the Azure Machine Learning web service endpoint.
    name String
    The name of the input. This is the name provided while authoring the endpoint.

    AzureMachineLearningWebServiceOutputColumnResponse

    DataType string
    The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    Name string
    The name of the output column.
    DataType string
    The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    Name string
    The name of the output column.
    dataType String
    The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    name String
    The name of the output column.
    dataType string
    The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    name string
    The name of the output column.
    data_type str
    The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    name str
    The name of the output column.
    dataType String
    The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .
    name String
    The name of the output column.

    FunctionInputResponse

    DataType string
    The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
    IsConfigurationParameter bool
    A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false.
    DataType string
    The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
    IsConfigurationParameter bool
    A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false.
    dataType String
    The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
    isConfigurationParameter Boolean
    A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false.
    dataType string
    The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
    isConfigurationParameter boolean
    A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false.
    data_type str
    The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
    is_configuration_parameter bool
    A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false.
    dataType String
    The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
    isConfigurationParameter Boolean
    A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false.

    FunctionOutputResponse

    DataType string
    The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
    DataType string
    The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
    dataType String
    The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
    dataType string
    The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
    data_type str
    The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx
    dataType String
    The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx

    JavaScriptFunctionBindingResponse

    Script string
    The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'
    Script string
    The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'
    script String
    The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'
    script string
    The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'
    script str
    The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'
    script String
    The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'

    ScalarFunctionPropertiesResponse

    Etag string
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    Binding Pulumi.AzureNative.StreamAnalytics.Inputs.AzureMachineLearningWebServiceFunctionBindingResponse | Pulumi.AzureNative.StreamAnalytics.Inputs.JavaScriptFunctionBindingResponse
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    Inputs List<Pulumi.AzureNative.StreamAnalytics.Inputs.FunctionInputResponse>
    Output Pulumi.AzureNative.StreamAnalytics.Inputs.FunctionOutputResponse
    Describes the output of a function.
    Etag string
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    Binding AzureMachineLearningWebServiceFunctionBindingResponse | JavaScriptFunctionBindingResponse
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    Inputs []FunctionInputResponse
    Output FunctionOutputResponse
    Describes the output of a function.
    etag String
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    binding AzureMachineLearningWebServiceFunctionBindingResponse | JavaScriptFunctionBindingResponse
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    inputs List<FunctionInputResponse>
    output FunctionOutputResponse
    Describes the output of a function.
    etag string
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    binding AzureMachineLearningWebServiceFunctionBindingResponse | JavaScriptFunctionBindingResponse
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    inputs FunctionInputResponse[]
    output FunctionOutputResponse
    Describes the output of a function.
    etag str
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    binding AzureMachineLearningWebServiceFunctionBindingResponse | JavaScriptFunctionBindingResponse
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    inputs Sequence[FunctionInputResponse]
    output FunctionOutputResponse
    Describes the output of a function.
    etag String
    The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
    binding Property Map | Property Map
    The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.
    inputs List<Property Map>
    output Property Map
    Describes the output of a function.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi