azure_streaming_analytics_function resource

Use the azure_streaming_analytics_function InSpec audit resource to test the properties and configuration of an Azure Streaming Analytics function.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

resource_group,job_name/name, and function_name are required parameters.

describe azure_streaming_analytics_function(resource_group: 'RESOURCE_GROUP', job_name: 'JOB_NAME', function_name: 'FUNCTION_NAME') do
  it { should exist }
end

Parameters

resource_group

Azure resource group where the targeted resource resides.

job_name

Name of the job.

function_name

Name of the function made in the job mentioned.

All three parameters are required for a valid query.

Properties

properties.binding

The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.

properties.inputs

A list of inputs describing the parameters of the function.

properties.binding

The output of the function.

etag

The current entity tag for the function.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, see the Azure documentation for other available properties. You can access any attribute in the response with the key names separated by dots (.). For example, properties.<attribute>.

Examples

Test that a resource group has the specified type:

describe azure_streaming_analytics_function(resource_group: 'RESOURCE_GROUP', job_name: 'JOB_NAME', function_name: 'FUNCTION_NAME') do
  it { should exist }
  its('type')                                         { should cmp 'Microsoft.StreamAnalytics/streamingjobs/functions' }
  its('properties.type')                              { should cmp 'Scalar' }
end

Matchers

This resource has the following special matchers.

Test streaming function to ensure it’s using Javascript UDF:

describe azure_streaming_analytics_function(resource_group: 'RESOURCE_GROUP', job_name: 'JOB_NAME', function_name: 'FUNCTION_NAME') do
  its('properties.binding.type')                              { should cmp 'Microsoft.StreamAnalytics/JavascriptUdf' }
end

exists

If we expect a resource to always exist.

describe azure_streaming_analytics_function(resource_group: 'RESOURCE_GROUP', job_name: 'JOB_NAME', function_name: 'FUNCTION_NAME') do
  it { should exist }
end

not_exists

If we expect a resource to never exist.

describe azure_streaming_analytics_function(resource_group: 'RESOURCE_GROUP', job_name: 'JOB_NAME', function_name: 'FUNCTION_NAME') do
  it { should_not exist }
end

Azure permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.