azure_synapse_workspace resource

Use the azure_synapse_workspace InSpec audit resource to test the properties related to an Azure Synapse workspace.

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

describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do
  it                                      { should exist }
  its('type')                             { should eq 'Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups' }
  its('location')                         { should eq 'eastus' }
end

describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do
  it  { should exist }
end

Parameters

name (required)

Name of the Azure Synapse workspace to test.

resource_group (required)

Azure resource group where the targeted resource resides.

Properties

id

Resource ID.

name

Resource name.

type

Resource type. Microsoft.Synapse/workspaces.

location

The Geo-location where the resource lives.

properties

The properties of the Synapse workspaces.

properties.provisioningState

State of the resource.

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.

Examples

Test that the Synapse workspaces are provisioned successfully:

describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do
  its('properties.provisioningState') { should eq 'Succeeded' }
end

Matchers

This resource has the following special matchers.

exists

# If a Synapse workspace is found, it will exist.

describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do
  it { should exist }
end

not_exists

# If Synapse workspaces are not found, it will not exist.

describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do
  it { should_not exist }
end

Azure permissions

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