azure_power_bi_gateways Resource

[edit on GitHub]

Use the azure_power_bi_gateways InSpec audit resource to test the properties related to all Azure Power BI gateways.

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

describe azure_power_bi_gateways do
  #...
end

Parameters

Properties

ids

List of all gateway IDs.

Field: id

names

List of all the gateway names.

Field: name

types

List of all the gateway types.

Field: type

exponents

List of all public key exponents.

Field: exponent

modulus

List of all public key modulus.

Field: modulus

Also, refer to Azure documentation for other available properties.

Examples

Loop through Power BI gateways by their IDs.

azure_power_bi_gateways.ids.each do |id|
  describe azure_power_bi_gateway(gateway_id: id) do
    it { should exist }
  end
end

Test to ensure all Power BI gateways exponent is AQAB.

describe azure_power_bi_gateways.where(exponent: 'AQAB') 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 not exist if no Power BI gateways are present

describe azure_power_bi_gateways do
  it { should_not exist }
end
# Should exist if the filter returns at least one Power BI gateways

describe azure_power_bi_gateways do
  it { should exist }
end

Azure Permissions

Your Service Principal must be set up with a Dataset.Read.All role on the Azure Power BI Workspace you wish to test.