azure_power_bi_app_capacities resource

Use the azure_power_bi_app_capacities InSpec audit resource to test the properties related to all Azure Power BI capacities.

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_app_capacities resource block returns all Azure Power BI capacities.

describe azure_power_bi_app_capacities do
  #...
end

Parameters

This resource does not require any parameters.

Properties

ids: List of all Power BI capacity IDs.
Field: id
displayNames: List of all the Power BI capacity names.
Field: displayName
admins: An array of capacity admins.
Field: admin
skus: List of all capacity SKUs.
Field: sku
states: List of the capacity states.
Field: state
regions: List of the Azure regions where the capacity is provisioned.
Field: region
capacityUserAccessRights: List of access rights user has on the capacity.
Field: capacityUserAccessRight

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 capacities are active:

describe azure_power_bi_app_capacities.where(state: 'Active') 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

Use should to test that the entity exists.

describe azure_power_bi_app_capacities do
  it { should exist }
end

not_exists

Use should_not to test that the entity does not exist.

describe azure_power_bi_app_capacities do
  it { should_not exist }
end

Azure permissions

This API does not support service principal authentication. Instead, use an Active Directory account access token to access this resource. Your Active Directory account must have the Capacity.Read.All role on the Azure Power BI workspace you wish to test.