azure_streaming_analytics_function Resource

[edit on GitHub]

Use the azure_streaming_analytics_function InSpec audit resource to test 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. The api_version can be defined as a resource parameter. If not provided, this resource uses the latest version. For more information, refer to the azure_generic_resource document.

Unless defined, this resource uses the azure_cloud global endpoint and default values for the HTTP client. For more information, refer to the resource pack README.

Installation

This resource is available in the Chef InSpec Azure resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

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 that the targeted resource resides in.

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, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.), eg. 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 InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

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

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.