Skip to content

Commit

Permalink
fix: Update to readme & module to publish version (Azure#3743)
Browse files Browse the repository at this point in the history
## Description

Update to readme & module to publish version

## Pipeline Reference

<!-- Insert your Pipeline Status Badge below -->

| Pipeline |
| -------- |
|
[![avm.ptn.data.private-analytical-workspace](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.ptn.data.private-analytical-workspace.yml/badge.svg?branch=users%2Falsehr%2FprivateAnalyticalFollowUp&event=workflow_dispatch)](https://github.com/Azure/bicep-registry-modules/actions/workflows/avm.ptn.data.private-analytical-workspace.yml)
|

## Type of Change

<!-- Use the checkboxes [x] on the options that are relevant. -->

- [ ] Update to CI Environment or utilities (Non-module affecting
changes)
- [ ] Azure Verified Module updates:
- [x] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [ ] Update to documentation
  • Loading branch information
AlexanderSehr authored Nov 6, 2024
1 parent de5cf39 commit 02d3604
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 31 deletions.
43 changes: 29 additions & 14 deletions avm/ptn/data/private-analytical-workspace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1439,43 +1439,57 @@ This parameter allows you to specify additional settings for Azure Key Vault if

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`createMode`](#parameter-advancedoptionskeyvaultcreatemode) | string | The vault's create mode to indicate whether the vault need to be recovered or not. - 'recover' or 'default'. The dafult value is: 'default'. |
| [`enablePurgeProtection`](#parameter-advancedoptionskeyvaultenablepurgeprotection) | bool | Provide 'true' to enable Key Vault's purge protection feature. The dafult value is: 'true'. |
| [`enableSoftDelete`](#parameter-advancedoptionskeyvaultenablesoftdelete) | bool | Switch to enable/disable Key Vault's soft delete feature. The dafult value is: 'true'. |
| [`sku`](#parameter-advancedoptionskeyvaultsku) | string | Specifies the SKU for the vault. - 'premium' or 'standard'. The dafult value is: 'premium'. |
| [`softDeleteRetentionInDays`](#parameter-advancedoptionskeyvaultsoftdeleteretentionindays) | int | Soft delete data retention days. It accepts >=7 and <=90. The dafult value is: '90'. |
| [`createMode`](#parameter-advancedoptionskeyvaultcreatemode) | string | The vault's create mode to indicate whether the vault need to be recovered or not. The default value is: 'default'. |
| [`enablePurgeProtection`](#parameter-advancedoptionskeyvaultenablepurgeprotection) | bool | Provide 'true' to enable Key Vault's purge protection feature. The default value is: 'true'. |
| [`enableSoftDelete`](#parameter-advancedoptionskeyvaultenablesoftdelete) | bool | Switch to enable/disable Key Vault's soft delete feature. The default value is: 'true'. |
| [`sku`](#parameter-advancedoptionskeyvaultsku) | string | Specifies the SKU for the vault. The default value is: 'premium'. |
| [`softDeleteRetentionInDays`](#parameter-advancedoptionskeyvaultsoftdeleteretentionindays) | int | Soft delete data retention days. It accepts >=7 and <=90. The default value is: '90'. |

### Parameter: `advancedOptions.keyVault.createMode`

The vault's create mode to indicate whether the vault need to be recovered or not. - 'recover' or 'default'. The dafult value is: 'default'.
The vault's create mode to indicate whether the vault need to be recovered or not. The default value is: 'default'.

- Required: No
- Type: string
- Allowed:
```Bicep
[
'default'
'recover'
]
```

### Parameter: `advancedOptions.keyVault.enablePurgeProtection`

Provide 'true' to enable Key Vault's purge protection feature. The dafult value is: 'true'.
Provide 'true' to enable Key Vault's purge protection feature. The default value is: 'true'.

- Required: No
- Type: bool

### Parameter: `advancedOptions.keyVault.enableSoftDelete`

Switch to enable/disable Key Vault's soft delete feature. The dafult value is: 'true'.
Switch to enable/disable Key Vault's soft delete feature. The default value is: 'true'.

- Required: No
- Type: bool

### Parameter: `advancedOptions.keyVault.sku`

Specifies the SKU for the vault. - 'premium' or 'standard'. The dafult value is: 'premium'.
Specifies the SKU for the vault. The default value is: 'premium'.

- Required: No
- Type: string
- Allowed:
```Bicep
[
'premium'
'standard'
]
```

### Parameter: `advancedOptions.keyVault.softDeleteRetentionInDays`

Soft delete data retention days. It accepts >=7 and <=90. The dafult value is: '90'.
Soft delete data retention days. It accepts >=7 and <=90. The default value is: '90'.

- Required: No
- Type: int
Expand All @@ -1491,19 +1505,19 @@ This parameter allows you to specify additional settings for Azure Log Analytics

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`dailyQuotaGb`](#parameter-advancedoptionsloganalyticsworkspacedailyquotagb) | int | The workspace daily quota for ingestion. The dafult value is: '-1' (not limited). |
| [`dataRetention`](#parameter-advancedoptionsloganalyticsworkspacedataretention) | int | Number of days data will be retained for. The dafult value is: '365'. |
| [`dailyQuotaGb`](#parameter-advancedoptionsloganalyticsworkspacedailyquotagb) | int | The workspace daily quota for ingestion. The default value is: '-1' (not limited). |
| [`dataRetention`](#parameter-advancedoptionsloganalyticsworkspacedataretention) | int | Number of days data will be retained for. The default value is: '365'. |

### Parameter: `advancedOptions.logAnalyticsWorkspace.dailyQuotaGb`

The workspace daily quota for ingestion. The dafult value is: '-1' (not limited).
The workspace daily quota for ingestion. The default value is: '-1' (not limited).

- Required: No
- Type: int

### Parameter: `advancedOptions.logAnalyticsWorkspace.dataRetention`

Number of days data will be retained for. The dafult value is: '365'.
Number of days data will be retained for. The default value is: '365'.

- Required: No
- Type: int
Expand Down Expand Up @@ -1710,6 +1724,7 @@ This section gives you an overview of all local-referenced module files (i.e., o
| `br/public:avm/res/network/private-dns-zone:0.6.0` | Remote reference |
| `br/public:avm/res/network/virtual-network:0.5.0` | Remote reference |
| `br/public:avm/res/operational-insights/workspace:0.7.1` | Remote reference |
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |

## Notes

Expand Down
18 changes: 9 additions & 9 deletions avm/ptn/data/private-analytical-workspace/main.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -825,31 +825,31 @@ type virtualNetworkType = {

@export()
type logAnalyticsWorkspaceType = {
@description('Optional. Number of days data will be retained for. The dafult value is: \'365\'.')
@description('Optional. Number of days data will be retained for. The default value is: \'365\'.')
@minValue(0)
@maxValue(730)
dataRetention: int?

@description('Optional. The workspace daily quota for ingestion. The dafult value is: \'-1\' (not limited).')
@description('Optional. The workspace daily quota for ingestion. The default value is: \'-1\' (not limited).')
@minValue(-1)
dailyQuotaGb: int?
}

@export()
type keyVaultType = {
@description('Optional. The vault\'s create mode to indicate whether the vault need to be recovered or not. - \'recover\' or \'default\'. The dafult value is: \'default\'.')
createMode: string?
@description('Optional. The vault\'s create mode to indicate whether the vault need to be recovered or not. The default value is: \'default\'.')
createMode: ('default' | 'recover')?

@description('Optional. Specifies the SKU for the vault. - \'premium\' or \'standard\'. The dafult value is: \'premium\'.')
sku: string?
@description('Optional. Specifies the SKU for the vault. The default value is: \'premium\'.')
sku: ('standard' | 'premium')?

@description('Optional. Switch to enable/disable Key Vault\'s soft delete feature. The dafult value is: \'true\'.')
@description('Optional. Switch to enable/disable Key Vault\'s soft delete feature. The default value is: \'true\'.')
enableSoftDelete: bool?

@description('Optional. Soft delete data retention days. It accepts >=7 and <=90. The dafult value is: \'90\'.')
@description('Optional. Soft delete data retention days. It accepts >=7 and <=90. The default value is: \'90\'.')
softDeleteRetentionInDays: int?

@description('Optional. Provide \'true\' to enable Key Vault\'s purge protection feature. The dafult value is: \'true\'.')
@description('Optional. Provide \'true\' to enable Key Vault\'s purge protection feature. The default value is: \'true\'.')
enablePurgeProtection: bool?
}

Expand Down
24 changes: 16 additions & 8 deletions avm/ptn/data/private-analytical-workspace/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"_generator": {
"name": "bicep",
"version": "0.30.23.60470",
"templateHash": "928189945777087235"
"templateHash": "4437449109602171238"
},
"name": "private-analytical-workspace",
"description": "This pattern module enables you to use Azure services that are typical for data analytics solutions. The goal is to help data scientists establish an environment for data analysis simply. It is secure by default for enterprise use. Data scientists should not spend much time on how to build infrastructure solution. They should mainly concentrate on the data analytics components they require for the solution.",
Expand Down Expand Up @@ -79,15 +79,15 @@
"minValue": 0,
"maxValue": 730,
"metadata": {
"description": "Optional. Number of days data will be retained for. The dafult value is: '365'."
"description": "Optional. Number of days data will be retained for. The default value is: '365'."
}
},
"dailyQuotaGb": {
"type": "int",
"nullable": true,
"minValue": -1,
"metadata": {
"description": "Optional. The workspace daily quota for ingestion. The dafult value is: '-1' (not limited)."
"description": "Optional. The workspace daily quota for ingestion. The default value is: '-1' (not limited)."
}
}
},
Expand All @@ -100,37 +100,45 @@
"properties": {
"createMode": {
"type": "string",
"allowedValues": [
"default",
"recover"
],
"nullable": true,
"metadata": {
"description": "Optional. The vault's create mode to indicate whether the vault need to be recovered or not. - 'recover' or 'default'. The dafult value is: 'default'."
"description": "Optional. The vault's create mode to indicate whether the vault need to be recovered or not. The default value is: 'default'."
}
},
"sku": {
"type": "string",
"allowedValues": [
"premium",
"standard"
],
"nullable": true,
"metadata": {
"description": "Optional. Specifies the SKU for the vault. - 'premium' or 'standard'. The dafult value is: 'premium'."
"description": "Optional. Specifies the SKU for the vault. The default value is: 'premium'."
}
},
"enableSoftDelete": {
"type": "bool",
"nullable": true,
"metadata": {
"description": "Optional. Switch to enable/disable Key Vault's soft delete feature. The dafult value is: 'true'."
"description": "Optional. Switch to enable/disable Key Vault's soft delete feature. The default value is: 'true'."
}
},
"softDeleteRetentionInDays": {
"type": "int",
"nullable": true,
"metadata": {
"description": "Optional. Soft delete data retention days. It accepts >=7 and <=90. The dafult value is: '90'."
"description": "Optional. Soft delete data retention days. It accepts >=7 and <=90. The default value is: '90'."
}
},
"enablePurgeProtection": {
"type": "bool",
"nullable": true,
"metadata": {
"description": "Optional. Provide 'true' to enable Key Vault's purge protection feature. The dafult value is: 'true'."
"description": "Optional. Provide 'true' to enable Key Vault's purge protection feature. The default value is: 'true'."
}
}
},
Expand Down

0 comments on commit 02d3604

Please sign in to comment.