azure_power_bi_embedded_capacities Resource

[edit on GitHub]

Use the azure_power_bi_embedded_capacities InSpec audit resource to test the properties related to all Azure Power BI Embedded Capacities within a project.

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_embedded_capacities resource block returns all Azure Power BI Embedded Capacities within a project.

describe azure_power_bi_embedded_capacities do
  #...
end

Parameters

account_name

The Azure Storage account name.

dns_suffix

The DNS suffix for the Azure Data Lake Storage endpoint.

The following parameters are optional,account_name and dns_suffix.

Properties

ids

A list of Power BI dedicated resources.

Field: id

names

The names of all the Power BI dedicated resources.

Field: name

locations

A location list of all the Power BI dedicated resources.

Field: location

modes

A list of all the capacity modes.

Field: mode

provisioningStates

A list of all provisioning states.

Field: provisioningState

states

The current state of all Power BI dedicated resources.

Field: state

sku_names

The SKU name of the Power BI dedicated resource.

Field: sku_name

sku_tiers

The SKU tier of the Power BI dedicated resource.

Field: sku_tier

sku_capacities

The SKU capacities of the Power BI dedicated resource.

Field: sku_capacity

administration_members

A collection of dedicated capacity administrators.

Field: administration_members

Examples

Loop through Power BI Embedded Capacities by their names

azure_power_bi_embedded_capacities.names.each do |name|
  describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: name) do
    it { should exist }
  end
end

Test to ensure Power BI Embedded Capacities where sku_capacities greater than 1

describe azure_power_bi_embedded_capacities.where(sku_capacity > 1 ) 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

# Should exist if the filter returns at least one Migrate Assessment in the project and the resource group.

describe azure_power_bi_embedded_capacities do
  it { should exist }
end

not_exists

# Should not exist if no Power BI Embedded Capacities are present in the project and the resource group.

describe azure_power_bi_embedded_capacities do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.