azure_power_bi_capacity_workload resource

Use the azure_power_bi_capacity_workload InSpec audit resource to test the properties related to Azure Power BI Capacity workload.

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

name and capacity_id are required parameters.

describe azure_power_bi_capacity_workload(capacity_id: 'CAPACITY_ID', name: 'WORKLOAD_NAME') do
  it  { should exist }
end

describe azure_power_bi_capacity_workload(capacity_id: 'CAPACITY_ID', name: 'WORKLOAD_NAME')  do
  it  { should exist }
end

Parameters

name (required)

The workload Name.

capacity_id (required)

The capacity ID.

Properties

name

The workload name.

state

The capacity workload state.

maxMemoryPercentageSetByUser

The memory percentage maximum Limit set by the user.

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 Power BI Capacity workload is enabled:

describe azure_power_bi_capacity_workload(capacity_id: 'CAPACITY_ID', name: 'WORKLOAD_NAME')  do
  its('state') { should eq 'Enabled' }
end

Matchers

This resource has the following special matchers.

exists

# If the Power BI Capacity workload is found, it will exist.

describe azure_power_bi_capacity_workload(capacity_id: 'CAPACITY_ID', name: 'WORKLOAD_NAME')  do
  it { should exist }
end

not_exists

# if the Power BI Capacity workload is not found, it will not exist.

describe azure_power_bi_capacity_workload(capacity_id: 'CAPACITY_ID', name: 'WORKLOAD_NAME')  do
  it { should_not exist }
end

Azure permissions

Your service principal must have the Capacity.Read.All role on the Azure Power BI Capacity you wish to test.