azure_streaming_analytics_functions Resource
Use the azure_streaming_analytics_functions
InSpec audit resource to test the properties and configuration of multiple Azure Streaming Analytics functions.
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.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
Syntax
An azure_streaming_analytics_functions
resource block returns all functions under a job.
describe azure_streaming_analytics_functions(resource_group: "RESOURCE_GROUP", job_name: "AZURE_STREAMING_JOB_NAME") do
#...
end
Parameters
resource_group
(required)Azure resource group where the targeted resource resides.
job_name
(required)Name of the job.
Properties
ids
- A list of the unique resource IDs.
Field:
id
names
- A list of names of all the resources being interrogated.
Field:
name
tags
- A list of
tag:value
pairs defined on the resources being interrogated. Field:
tags
properties
- A list of properties for all the resources being interrogated.
Field:
properties
Also, refer to Azure documentation for other properties available.
Any attribute in the response may be accessed with the key names separated by dots (.
). For example, properties.<attribute>
.
Note
Examples
Test that the names should be an array
describe azure_streaming_analytics_functions(resource_group: "RESOURCE_GROUP", job_name: "AZURE_STREAMING_JOB_NAME") do
its('names') { should be_an(Array) }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exists
The control passes if the filter returns at least one result.
describe azure_streaming_analytics_functions(resource_group: "RESOURCE_GROUP", job_name: "AZURE_STREAMING_JOB_NAME") do
it { should exist }
end
not_exists
Use should_not
if you expect zero matches.
describe azure_streaming_analytics_functions(resource_group: "RESOURCE_GROUP", job_name: "AZURE_STREAMING_JOB_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.