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. 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_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, refer to Azure documentation for other properties available.

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 be set up with a Capacity.Read.All role on the Azure Power BI Capacity you wish to test.