azure_synapse_notebooks Resource
Use the azure_synapse_notebooks
InSpec audit resource to test the properties related to all Azure Synapse notebooks in a Synapse Analytics workspace.
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_synapse_notebooks
resource block returns all Azure Synapse notebooks within a Synapse workspace.
describe azure_synapse_notebooks(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT') do
#...
end
Parameters
This resource requires the endpoint
parameter for a valid query.
endpoint
- The Azure Synapse workspace development endpoint.
Properties
ids
- A list of the unique fully qualified resource IDs.
Field:
id
names
- A list of names for all the Synapse notebooks.
Field:
name
types
- A list of types for all the resources.
Field:
type
properties
- A list of properties for all the notebooks.
Field:
properties
etags
- A list of resource Etags.
Field:
tags
Note
Examples
Loop through Synapse Notebooks by their names
azure_synapse_notebooks(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT').names.each do |name|
describe azure_synapse_notebook(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT', name: name) do
it { should exist }
end
end
Test that there are Synapse Notebooks that include a certain string in their names (Client Side Filtering)
describe azure_synapse_notebooks(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT').where { name.include?('analytics-trends') } do
it { should exist }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exists
# Should not exist if there aren't any Synapse notebooks in the resource group.
describe azure_synapse_notebooks(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT') do
it { should_not exist }
end
not_exists
# Should exist if the filter returns at least one Synapse notebook.
describe azure_synapse_notebooks(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT') do
it { should exist }
end
Azure Permissions
Your Service Principal must be set up with at least a contributor
role on the subscription you wish to test.