azure_synapse_workspaces Resource

[edit on GitHub]

Use the azure_synapse_workspaces InSpec audit resource to test the properties related to all Azure Synapse workspaces.

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

An azure_synapse_workspaces resource block returns all Azure Synapse workspaces.

describe azure_synapse_workspaces do
  #...
end

Parameters

resource_group (optional)

Azure resource group where the targeted resource resides.

Properties

ids

A list of resource IDs.

Field: id

names

A list of resource names.

Field: name

types

A list of the resource types.

Field: type

properties

A list of properties for all the Synapse workspaces.

Field: properties

locations

A list of the Geo-locations.

Field: location

provisioningStates

A list of provisioning states of the Synapse workspaces.

Field: provisioningState

Examples

Loop through Synapse workspaces by their names

azure_synapse_workspaces.names.each do |name|
  describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: name) do
    it { should exist }
  end
end

Test that there are Synapse workspaces that are successfully provisioned

describe azure_synapse_workspaces(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do
  it { should exist }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exists

# Should not exist if no Synapse workspaces are present.

describe azure_synapse_workspaces(resource_group: 'RESOURCE_GROUP') do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one Synapse workspace.

describe azure_synapse_workspaces(resource_group: 'RESOURCE_GROUP') do
  it { should exist }
end

Azure Permissions

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