azure_power_bi_app_capacities Resource

[edit on GitHub]

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. 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.

Installation

This resource is available in the Chef InSpec Azure resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

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

Also, refer to Azure documentation for other properties available.

Examples

Test to ensure Power BI capacities are active.

describe azure_power_bi_app_capacities.where(state: 'Active') do
  it { should exist }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exists

Use should to test that the entity exists.

describe azure_power_bi_app_capacities do
  it { should exist }
end

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