`azurerm_log_analytics_workspace`: allow changing `sku` between `CapacityReservation` and `PerGB2018` #22597

ziyeqf · 2023-07-19T09:07:10Z

changing between CapacityReservation and PerGB2018 does not force new resource to be created, but it will lead to a 31-days commitment period during which it could not be changed to lower pricing tier. https://learn.microsoft.com/en-us/azure/azure-monitor/logs/cost-logs#commitment-tiers)

test

❯ tftest loganalytics TestAccLogAnalyticsWorkspace    
=== RUN   TestAccLogAnalyticsWorkspace_basic
=== PAUSE TestAccLogAnalyticsWorkspace_basic
=== RUN   TestAccLogAnalyticsWorkspace_requiresImport
=== PAUSE TestAccLogAnalyticsWorkspace_requiresImport
=== RUN   TestAccLogAnalyticsWorkspace_complete
=== PAUSE TestAccLogAnalyticsWorkspace_complete
=== RUN   TestAccLogAnalyticsWorkspace_freeTier
    log_analytics_workspace_resource_test.go:95: `TestAccLogAnalyticsWorkspace_freeTier` due to subscription pricing tier configuration (e.g. Pricing tier doesn't match the subscription's billing model.)
--- SKIP: TestAccLogAnalyticsWorkspace_freeTier (0.00s)
=== RUN   TestAccLogAnalyticsWorkspace_withDefaultSku
=== PAUSE TestAccLogAnalyticsWorkspace_withDefaultSku
=== RUN   TestAccLogAnalyticsWorkspace_withVolumeCap
=== PAUSE TestAccLogAnalyticsWorkspace_withVolumeCap
=== RUN   TestAccLogAnalyticsWorkspace_removeVolumeCap
=== PAUSE TestAccLogAnalyticsWorkspace_removeVolumeCap
=== RUN   TestAccLogAnalyticsWorkspace_withInternetIngestionEnabled
=== PAUSE TestAccLogAnalyticsWorkspace_withInternetIngestionEnabled
=== RUN   TestAccLogAnalyticsWorkspace_withInternetQueryEnabled
=== PAUSE TestAccLogAnalyticsWorkspace_withInternetQueryEnabled
=== RUN   TestAccLogAnalyticsWorkspace_withCapacityReservation
=== PAUSE TestAccLogAnalyticsWorkspace_withCapacityReservation
=== RUN   TestAccLogAnalyticsWorkspace_negativeOne
=== PAUSE TestAccLogAnalyticsWorkspace_negativeOne
=== RUN   TestAccLogAnalyticsWorkspace_cmkForQueryForced
=== PAUSE TestAccLogAnalyticsWorkspace_cmkForQueryForced
=== RUN   TestAccLogAnalyticsWorkspace_ToggleAllowOnlyResourcePermission
=== PAUSE TestAccLogAnalyticsWorkspace_ToggleAllowOnlyResourcePermission
=== RUN   TestAccLogAnalyticsWorkspace_ToggleDisableLocalAuth
=== PAUSE TestAccLogAnalyticsWorkspace_ToggleDisableLocalAuth
=== RUN   TestAccLogAnalyticsWorkspace_updateSku
=== PAUSE TestAccLogAnalyticsWorkspace_updateSku
=== CONT  TestAccLogAnalyticsWorkspace_basic
=== CONT  TestAccLogAnalyticsWorkspace_withInternetQueryEnabled
=== CONT  TestAccLogAnalyticsWorkspace_ToggleAllowOnlyResourcePermission
=== CONT  TestAccLogAnalyticsWorkspace_withVolumeCap
=== CONT  TestAccLogAnalyticsWorkspace_negativeOne
=== CONT  TestAccLogAnalyticsWorkspace_requiresImport
=== CONT  TestAccLogAnalyticsWorkspace_withDefaultSku
=== CONT  TestAccLogAnalyticsWorkspace_complete
=== NAME  TestAccLogAnalyticsWorkspace_withInternetQueryEnabled
    testcase.go:113: Error running init: exit status 1
        
        Error: Failed to install provider
        
        Error while installing hashicorp/azuread v2.8.0: read tcp
        198.18.0.1:52300->198.18.0.44:443: read: operation timed out
        
--- PASS: TestAccLogAnalyticsWorkspace_requiresImport (146.76s)
=== CONT  TestAccLogAnalyticsWorkspace_updateSku
=== CONT  TestAccLogAnalyticsWorkspace_withInternetIngestionEnabled
--- FAIL: TestAccLogAnalyticsWorkspace_withInternetQueryEnabled (148.63s)
--- PASS: TestAccLogAnalyticsWorkspace_withDefaultSku (166.74s)
=== CONT  TestAccLogAnalyticsWorkspace_ToggleDisableLocalAuth
--- PASS: TestAccLogAnalyticsWorkspace_complete (173.74s)
=== CONT  TestAccLogAnalyticsWorkspace_cmkForQueryForced
--- PASS: TestAccLogAnalyticsWorkspace_negativeOne (214.52s)
=== CONT  TestAccLogAnalyticsWorkspace_withCapacityReservation
--- PASS: TestAccLogAnalyticsWorkspace_basic (229.89s)
=== CONT  TestAccLogAnalyticsWorkspace_removeVolumeCap
--- PASS: TestAccLogAnalyticsWorkspace_withVolumeCap (250.41s)
--- PASS: TestAccLogAnalyticsWorkspace_ToggleAllowOnlyResourcePermission (316.67s)
--- PASS: TestAccLogAnalyticsWorkspace_updateSku (183.77s)
--- PASS: TestAccLogAnalyticsWorkspace_withInternetIngestionEnabled (186.86s)
--- PASS: TestAccLogAnalyticsWorkspace_ToggleDisableLocalAuth (177.66s)
--- PASS: TestAccLogAnalyticsWorkspace_cmkForQueryForced (176.09s)
--- PASS: TestAccLogAnalyticsWorkspace_withCapacityReservation (209.43s)
--- PASS: TestAccLogAnalyticsWorkspace_removeVolumeCap (216.31s)
FAIL
FAIL    github.com/hashicorp/terraform-provider-azurerm/internal/services/loganalytics  446.273s
FAIL

rerun the failed one

❯ tftest loganalytics TestAccLogAnalyticsWorkspace_withInternetQueryEnabled
=== RUN   TestAccLogAnalyticsWorkspace_withInternetQueryEnabled
=== PAUSE TestAccLogAnalyticsWorkspace_withInternetQueryEnabled
=== CONT  TestAccLogAnalyticsWorkspace_withInternetQueryEnabled
--- PASS: TestAccLogAnalyticsWorkspace_withInternetQueryEnabled (144.83s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/loganalytics  144.886s

Signed-off-by: ziyeqf <51212351+ziyeqf@users.noreply.github.com>

manicminer

Thanks @ziyeqf, this is off to a good start, however we'll need to avoid using d.GetRawConfig(). If you can update this then we'll circle back for re-review and testing. Thanks!

manicminer · 2023-07-19T21:57:09Z

internal/services/loganalytics/log_analytics_workspace_resource.go

-	capacityReservationLevel, ok := d.GetOk(propName)
-	if ok {
+	// read from raw config as it's an optional + computed property, GetOk() will read value from state.
+	capacityReservationLevel := d.GetRawConfig().AsValueMap()[propName]


Please do not use GetRawConfig as this will not translate to terraform-plugin-framework

manicminer · 2023-07-19T22:00:17Z

website/docs/r/log_analytics_workspace.html.markdown

@@ -45,6 +45,8 @@ The following arguments are supported:

 ~> **NOTE:** A new pricing model took effect on `2018-04-03`, which requires the SKU `PerGB2018`. If you're provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about [the Pricing SKUs is available at the following URI](https://aka.ms/PricingTierWarning).

+~> **NOTE:** Changing `sku` forces a new Log Analytics Workspace to be created, except changing between `PerGB2018` and `CapacityReservation`, but changing it to `CapacityReservation` or changing `reservation_capacity_in_gb_per_day` to a higher tier will lead to a 31-days commitment period, during which the sku could not be changed to a lower one. More information about [the commitment perioud](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/cost-logs#commitment-tiers)


Suggested change

~> **NOTE:** Changing `sku` forces a new Log Analytics Workspace to be created, except changing between `PerGB2018` and `CapacityReservation`, but changing it to `CapacityReservation` or changing `reservation_capacity_in_gb_per_day` to a higher tier will lead to a 31-days commitment period, during which the sku could not be changed to a lower one. More information about [the commitment perioud](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/cost-logs#commitment-tiers)

~> **NOTE:** Changing `sku` forces a new Log Analytics Workspace to be created, except when changing between `PerGB2018` and `CapacityReservation`. However, changing `sku` to `CapacityReservation` or changing `reservation_capacity_in_gb_per_day` to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to [official documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/cost-logs#commitment-tiers) for further information.

Signed-off-by: ziyeqf <51212351+ziyeqf@users.noreply.github.com>

ziyeqf · 2023-07-20T02:13:21Z

we might need to note reservation_capacity_in_gb_per_day is not computed ~~yet~~ anymore in changelog?

katbyte · 2023-08-01T15:59:39Z

@ziyeqf - what do you mean by reservation_capacity_in_gb_per_day is not computed yet ?

ziyeqf · 2023-08-02T01:47:50Z

@ziyeqf - what do you mean by reservation_capacity_in_gb_per_day is not computed yet ?

oh, I mean it's not computed anymore.

tombuildsstuff

LGTM 👍

ziyeqf · 2023-08-07T02:08:33Z

kindly ping for merge :)

github-actions · 2024-05-18T02:10:12Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

allow changing sku between CapacityReservation and PerGB2018

14e1eae

Signed-off-by: ziyeqf <51212351+ziyeqf@users.noreply.github.com>

github-actions bot added documentation service/log-analytics size/S labels Jul 19, 2023

manicminer requested changes Jul 19, 2023

View reviewed changes

github-actions bot added the waiting-response label Jul 19, 2023

ziyeqf added 2 commits July 20, 2023 10:10

update per comment

2a89540

Signed-off-by: ziyeqf <51212351+ziyeqf@users.noreply.github.com>

update document

2bb4a9b

Signed-off-by: ziyeqf <51212351+ziyeqf@users.noreply.github.com>

github-actions bot removed the waiting-response label Jul 20, 2023

ziyeqf requested a review from manicminer August 1, 2023 03:03

katbyte added the waiting-response label Aug 1, 2023

github-actions bot removed the waiting-response label Aug 2, 2023

tombuildsstuff approved these changes Aug 3, 2023

View reviewed changes

stephybun added the enhancement label Aug 7, 2023

stephybun merged commit a03cc3f into hashicorp:main Aug 7, 2023
23 checks passed

github-actions bot added this to the v3.69.0 milestone Aug 7, 2023

ziyeqf deleted the issue/log_workspace_sku branch August 7, 2023 14:11

ziyeqf mentioned this pull request Aug 7, 2023

azurerm_log_analytics_workspace: on change of "sku", terraform incorrectly wants to rebuild workspace #12177

Closed

stephybun added a commit that referenced this pull request Aug 7, 2023

Update for #22597 #22665 #22811 #22814 #22832 #22844

5f2d336

github-actions bot locked as resolved and limited conversation to collaborators May 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`azurerm_log_analytics_workspace`: allow changing `sku` between `CapacityReservation` and `PerGB2018` #22597

`azurerm_log_analytics_workspace`: allow changing `sku` between `CapacityReservation` and `PerGB2018` #22597

ziyeqf commented Jul 19, 2023

manicminer left a comment •

edited

Loading

manicminer Jul 19, 2023

manicminer Jul 19, 2023

ziyeqf commented Jul 20, 2023 •

edited

Loading

katbyte commented Aug 1, 2023

ziyeqf commented Aug 2, 2023

tombuildsstuff left a comment

ziyeqf commented Aug 7, 2023

github-actions bot commented May 18, 2024

		@@ -45,6 +45,8 @@ The following arguments are supported:

		~> NOTE: A new pricing model took effect on `2018-04-03`, which requires the SKU `PerGB2018`. If you're provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about [the Pricing SKUs is available at the following URI](https://aka.ms/PricingTierWarning).

		~> NOTE: Changing `sku` forces a new Log Analytics Workspace to be created, except changing between `PerGB2018` and `CapacityReservation`, but changing it to `CapacityReservation` or changing `reservation_capacity_in_gb_per_day` to a higher tier will lead to a 31-days commitment period, during which the sku could not be changed to a lower one. More information about [the commitment perioud](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/cost-logs#commitment-tiers)

azurerm_log_analytics_workspace: allow changing sku between CapacityReservation and PerGB2018 #22597

azurerm_log_analytics_workspace: allow changing sku between CapacityReservation and PerGB2018 #22597

Conversation

ziyeqf commented Jul 19, 2023

test

manicminer left a comment • edited Loading

Choose a reason for hiding this comment

manicminer Jul 19, 2023

Choose a reason for hiding this comment

manicminer Jul 19, 2023

Choose a reason for hiding this comment

ziyeqf commented Jul 20, 2023 • edited Loading

katbyte commented Aug 1, 2023

ziyeqf commented Aug 2, 2023

tombuildsstuff left a comment

Choose a reason for hiding this comment

ziyeqf commented Aug 7, 2023

github-actions bot commented May 18, 2024

`azurerm_log_analytics_workspace`: allow changing `sku` between `CapacityReservation` and `PerGB2018` #22597

`azurerm_log_analytics_workspace`: allow changing `sku` between `CapacityReservation` and `PerGB2018` #22597

manicminer left a comment •

edited

Loading

ziyeqf commented Jul 20, 2023 •

edited

Loading