azure_power_bi_gateways resource

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. 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

An azure_power_bi_gateways resource block returns all Azure Power BI gateways.

describe azure_power_bi_gateways do
  #...
end

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

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

Also, see the 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

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

exists

# Should not exist if no Power BI gateways are present.

describe azure_power_bi_gateways do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one Power BI gateway.

describe azure_power_bi_gateways do
  it { should exist }
end

Azure permissions

Your service principal must have the Dataset.Read.All role on the Azure Power BI Workspace you wish to test.