azure_power_bi_gateway Resource

[edit on GitHub]

Use the azure_power_bi_gateway InSpec audit resource to test the properties related to Azure Power BI gateway.

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

gateway_id is a required parameter.

describe azure_power_bi_gateway(gateway_id: 'GATEWAY_ID') do
  it  { should exist }
end

Parameters

gateway_id (required)

The gateway ID.

Properties

id

The gateway ID.

name

The gateway name.

type

The gateway type.

publicKey.exponent

The public key exponent.

publicKey.modulus

The public key modulus.

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 gateway’s exponent is AQAB.

describe azure_power_bi_gateway(gateway_id: 'GATEWAY_ID')  do
  its('publicKey.exponent') { should eq 'AQAB' }
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 Azure Power BI gateway is found, it will exist
describe azure_power_bi_gateway(gateway_id: 'GATEWAY_ID')  do
  it { should exist }
end
# if the Azure Power BI gateway is not found, it will not exist
describe azure_power_bi_gateway(gateway_id: 'GATEWAY_ID')  do
  it { should_not 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.