azure_power_bi_capacity_refreshable Resource

[edit on GitHub]

Use the azure_power_bi_capacity_refreshable InSpec audit resource to test the properties of an Azure Power BI Capacity refreshable.

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

describe azure_power_bi_capacity_refreshable(capacity_id: 'CAPACITY_ID', name: 'REFRESHABLE_ID') do
  it { should exist }
end

describe azure_power_bi_capacity_refreshable(capacity_id: 'CAPACITY_ID', name: 'REFRESHABLE_ID')  do
  it { should exist }
end

Parameters

name (required)

The refreshable ID.

capacity_id (required)

The capacity ID.

Properties

id

The object ID of the refreshable.

kind

The refreshable kind.

name

Display refreshable name.

startTime

The start time of the window for which summary data exists.

endTime

The end time of the window for which summary data exists.

refreshCount

The number of refreshes within the summary time window.

refreshFailures

The number of refresh failures within the summary time window.

refreshesPerDay

The number of refreshes (schedule+onDemand) per day within the summary time window with at most 60.

refreshSchedule.days

Days to execute the refresh.

refreshSchedule.enabled

Is the refresh enabled.

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 Capacity refreshable schedule is enabled

describe azure_power_bi_capacity_refreshable(capacity_id: 'CAPACITY_ID', name: 'REFRESHABLE_ID')  do
  its('refreshSchedules.enabled') { should be_truthy }
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 Capacity refreshable is found, it will exist.

describe azure_power_bi_capacity_refreshable(capacity_id: 'CAPACITY_ID', name: 'REFRESHABLE_ID')  do
  it { should exist }
end

not_exists

# if the Power BI Capacity refreshable is not found, it will not exist.
describe azure_power_bi_capacity_refreshable(capacity_id: 'CAPACITY_ID', name: 'REFRESHABLE_ID')  do
  it { should_not 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.