-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
RESOURCE-149 Support azure power bi capacity refreshables (#533)
* support power BI capacity refreshable(s) Signed-off-by: Sathish <sbabu@progress.com> * unit test power BI capacity refreshable(s) Signed-off-by: Sathish <sbabu@progress.com> * integral test power BI capacity refreshable(s) Signed-off-by: Sathish <sbabu@progress.com> * document power BI capacity refreshable(s) Signed-off-by: Sathish <sbabu@progress.com> * update power BI capacity refreshable(s) Signed-off-by: Sathish <sbabu@progress.com> * Docs edits Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> Co-authored-by: Ian Maddaus <ian.maddaus@progress.com>
- Loading branch information
1 parent
053914c
commit c040509
Showing
9 changed files
with
309 additions
and
146 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| --- | ||
| title: About the azure_power_bi_capacity_refreshable Resource | ||
| platform: azure | ||
| --- | ||
|
|
||
| # azure_power_bi_capacity_refreshable | ||
|
|
||
| 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` is defined as a resource parameter. | ||
| If not provided, the latest version is used. For more information, refer to [`azure_generic_resource`](azure_generic_resource.md). | ||
|
|
||
| Unless defined, `azure_cloud` global endpoint and default values for the HTTP client are used. For more information, refer to the resource pack [README](../../README.md). | ||
|
|
||
| ## Availability | ||
|
|
||
| ### Installation | ||
|
|
||
| This resource is available in the [InSpec Azure resource pack](https://github.com/inspec/inspec-azure). For an example, `inspec.yml` file and how to set up your Azure credentials, refer to resource pack [README](../../README.md#Service-Principal). | ||
|
|
||
| ## Syntax | ||
|
|
||
| ```ruby | ||
| describe azure_power_bi_capacity_refreshable(capacity_id: 'CAPACITY_ID', name: 'REFRESHABLE_ID') do | ||
| it { should exist } | ||
| end | ||
| ``` | ||
|
|
||
| ```ruby | ||
| 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 | ||
|
|
||
| | Property | Description | | ||
| |----------------------------|------------------------------------------------------------------| | ||
| | id | The object ID of the refreshable. | | ||
| | kind | The refreshable kind. | | ||
| | name | Display name of refreshable. | | ||
| | 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`](azure_generic_resource.md#properties). | ||
|
|
||
| Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/capacities/get-refreshable-for-capacity) for other properties available. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Test that the Power BI Capacity refreshable schedule is enabled | ||
|
|
||
| ```ruby | ||
| 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](/inspec/matchers/). | ||
|
|
||
| ### exists | ||
|
|
||
| ```ruby | ||
| # 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 | ||
| # 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](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `Capacity.Read.All` role on the Azure Power BI Capacity you wish to test. |
Oops, something went wrong.