azure_power_bi_capacity_workloads resource

Use the azure_power_bi_capacity_workloads InSpec audit resource to test the properties related to all Azure Power BI Capacity workloads.

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

An azure_power_bi_capacity_workloads resource block returns all Azure Power BI Capacity workloads.

describe azure_power_bi_capacity_workloads(capacity_id: 'CAPACITY_ID') do
  #...
end

Parameters

capacity_id: The capacity ID.

Properties

states: List of all Power Bi Capacity Workload IDs.
Field: state
names: List of all the Power Bi Capacity Workload names.
Field: name
maxMemoryPercentageSetByUsers: List of all the Power Bi Capacity Workload Kinds.
Field: maxMemoryPercentageSetByUser

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

Also, see the Azure documentation for other available properties.

Examples

Test to ensure Power BI Capacity Workload is enabled:

describe azure_power_bi_capacity_workloads(capacity_id: 'CAPACITY_ID').where(state: 'Enabled') 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 no Power BI Capacity Workloads are present.

describe azure_power_bi_capacity_workloads(capacity_id: 'CAPACITY_ID') do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one Power BI Capacity Workloads.

describe azure_power_bi_capacity_workloads(capacity_id: 'CAPACITY_ID') do
  it { should exist }
end

Azure permissions

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