azure_power_bi_gateway resource

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

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

The 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, see the Azure documentation for other available properties.

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

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

not_exists

# 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 have the Dataset.Read.All role on the Azure Power BI Workspace you wish to test.