azure_power_bi_embedded_capacity Resource

[edit on GitHub]

azure_power_bi_embedded_capacity

Use the azure_power_bi_embedded_capacity InSpec audit resource to test the properties related to Azure Power BI Embedded Capacity.

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

name and resource_group are required parameters.

describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: 'POWER_BI_EMBEDDED') do
  it  { should exist }
end

describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: 'POWER_BI_EMBEDDED')  do
  it  { should exist }
end

Parameters

name

Name of the Power BI Embedded Capacity to test.

resource_group

Azure Resource Group.

The parameter set for a valid query that should be provided are name and account_name.

Properties

id

An identifier that represents the PowerBI Dedicated resource.

location

Location of the PowerBI Dedicated resource.

name

The name of the PowerBI Dedicated resource.

properties.administration

A collection of Dedicated capacity administrators.

properties.mode

The capacity mode.

properties.state

The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning.

sku

The SKU of the PowerBI Dedicated resource.

tags

Key-value pairs of additional resource provisioning properties.

type

The type of the PowerBI Dedicated resource.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available.

Examples

Test that the Power BI Embedded Capacity.

describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: 'POWER_BI_EMBEDDED')  do
  its('count') { should eq 1.0 }
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

# If the Power BI Embedded Capacity is found, it will exist
describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: 'POWER_BI_EMBEDDED')  do
  it { should exist }
end
# if the Power BI Embedded Capacity is not found, it will not exist
describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: 'POWER_BI_EMBEDDED')  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.