Add new resource & data source: azurerm_powerbi_embedded #5152

neil-yechenwei · 2019-12-13T03:21:20Z

This PR is the code implement of the issue #5188

(fixes #5188)

tombuildsstuff

Thanks for this PR - I've taken a look through and left some comments inline but it appears this wants renaming to be clearer as to what it actually provisions?

Thanks!

azurerm/data_source_powerbidedicated_capacity.go

azurerm/internal/clients/client.go

azurerm/internal/services/powerbidedicated/validation.go

azurerm/resource_arm_powerbidedicated_capacity.go

tombuildsstuff · 2019-12-13T17:46:29Z

azurerm/resource_arm_powerbidedicated_capacity.go

+			Create: schema.DefaultTimeout(30 * time.Minute),
+			Read:   schema.DefaultTimeout(5 * time.Minute),
+			Update: schema.DefaultTimeout(30 * time.Minute),
+			Delete: schema.DefaultTimeout(30 * time.Minute),


what are these timeouts based on?

Actually, azure sdk and related document doesn't explicitly point out the timeout. So I just pasted code here from other resources. Before I tried to remove this block and use the default timeout, but I failed on the CI check and threw below errors so that I have to use them here.
--- FAIL: TestResourcesSupportCustomTimeouts (0.01s)
245 --- FAIL: TestResourcesSupportCustomTimeouts/Resource/azurerm_powerbi_dedicated_capacity (0.00s)
246 provider_test.go:86: [DEBUG] Testing Resource "azurerm_powerbi_dedicated_capacity"..
247 provider_test.go:89: Resource "azurerm_powerbi_dedicated_capacity" has no timeouts block defined!

website/docs/r/powerbidedicated_capacity.html.markdown

tombuildsstuff · 2019-12-13T18:01:34Z

website/docs/r/powerbidedicated_capacity.html.markdown

+
+## Import
+
+PowerBIDedicated Capacities can be imported using the `resource id`, e.g.


Suggested change

PowerBIDedicated Capacities can be imported using the `resource id`, e.g.

PowerBI Dedicated instances can be imported using the `resource id`, e.g.

Same as above reason

tombuildsstuff · 2019-12-13T18:01:39Z

website/docs/r/powerbidedicated_capacity.html.markdown

+
+The following attributes are exported:
+
+* `id` - The ID of the PowerBIDedicated Capacity.


Suggested change

* `id` - The ID of the PowerBIDedicated Capacity.

* `id` - The ID of the PowerBI Dedicated instance.

Same as above reason

azurerm/internal/services/powerbidedicated/validation_test.go

tombuildsstuff · 2019-12-13T18:05:23Z

azurerm/resource_arm_powerbidedicated_capacity.go

+		Tags: tags.Expand(t),
+	}
+
+	future, err := client.Update(ctx, resourceGroup, name, parameters)


since there's a separate update function presumably this supports delta updates?

Yes. I think you should be correct since it can update property "sku", "administrators" and "tags" successfully without attribute "ForceNew".

neil-yechenwei · 2019-12-17T05:41:27Z

Hi @tombuildsstuff , Thanks for your comments. I've updated code per your comments. For your concern, I am glad to introduce this resource here. This resource is provisioning capacity which is the feature of PowerBI Dedicated. The capacity is the container to load power bi report and dataset and also can be referenced by other apps.
The affected package is "Microsoft.PowerBIDedicated".
The affected resource is "azurerm_powerbi_dedicated_capacity"
See more details from below links:
Overview of Power BI Dedicated: https://docs.microsoft.com/en-us/azure/power-bi-embedded/
Rest api of Capacity: https://docs.microsoft.com/en-us/rest/api/power-bi-embedded/capacities/create
azure-rest-api-spec repo: https://github.com/Azure/azure-rest-api-specs/blob/master/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json

katbyte

Thank for the revisions @neil-yechenwei, overall this is looking good but i have some questions around the naming. i'm not sure why its called a power bi dedicated capcity as a quick google shows up nothing and the portal seems to indicate it is a power BI embedded project? I think we should align with the portal and docs as that is what the user is likey familiar with rather then the API & SDK.

katbyte · 2020-03-03T20:23:39Z

azurerm/internal/clients/client.go

@@ -118,6 +119,7 @@ type Client struct {
 	Portal           *portal.Client
 	Postgres         *postgres.Client
 	PrivateDns       *privatedns.Client
+	PowerBIDedicated *powerBIDedicated.Client


What is this API for? looking in the portali just see "Power BI Embedded" and no mention of dedicated? Maybe this just wants to be

Suggested change

PowerBIDedicated *powerBIDedicated.Client

PowerBI *powerBIDedicated.Client

This Capacity API would create the PowerBI Embedded resource which is actually a capacity as container to load the power bi report and dataset. Seems service owner wants to distinguish between powerbi capacity and powerbi workspace from api perspective. But they all are associated with PowerBI. So I think your answer is reasonable. We should align with the portal and docs as that is what the user is likey familiar with rather then the API & SDK. So I will update name from PowerBIDedicated to PowerBI. Does it make sense?

Below is my summary:

azure docs:
power bi embedded -> capacity (https://docs.microsoft.com/en-us/power-bi/developer/azure-pbie-create-capacity)
power bi workspace (Premium) -> workspace (https://docs.microsoft.com/en-us/power-bi/service-create-the-new-workspaces)

azure api spec:
PowerBI Dedicated -> capacity (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json)
PowerBI embedded -> workspace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/powerbiembedded/resource-manager/Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json)

azure portal:
PowerBI embedded -> capacity (https://ms.portal.azure.com/#create/Microsoft.PowerBIDedicated)

azurerm/internal/services/powerbidedicated/registration.go

katbyte · 2020-03-03T20:26:53Z

azurerm/internal/services/powerbidedicated/registration.go

+// SupportedResources returns the supported Resources supported by this Service
+func (r Registration) SupportedResources() map[string]*schema.Resource {
+	return map[string]*schema.Resource{
+		"azurerm_powerbi_dedicated_capacity": resourceArmPowerBIDedicatedCapacity()}


Looking there seems to be premium and embedded but not dedicated, so what should go here?

Suggested change

"azurerm_powerbi_dedicated_capacity": resourceArmPowerBIDedicatedCapacity()}

"azurerm_powerbi_????_capacity": resourceArmPowerBIDedicatedCapacity()}

Also is capacity the right term, again looking at the portal:

it seems like this is a powerbi_embeded_project regardless of what the API is calling it?

yes. it's the powerbi embedded project. I think we should update to "azurerm_powerbi_embedded" if we don't consider of what the API is calling. And this resource created in azure portal is called "Power BI Embedded". So my understanding is that "PowerBI Embedded" in azure doc means "PowerBI Dedicated Capacity" in azure api spec. Does it make sense?

Below is my understanding according by azure docs regardless of api spec:
power bi:
-> Premium (which means workspace)
-> Embedded (which means capacity)

Also refers TOC of rest api spec:

azurerm/internal/services/powerbidedicated/resource_arm_powerbi_dedicated_capacity.go

...erm/internal/services/powerbidedicated/tests/resource_arm_powerbi_dedicated_capacity_test.go

website/docs/r/powerbi_dedicated_capacity.html.markdown

…cated

katbyte · 2020-03-05T02:11:40Z

After poking around some more the error i now get is:

Error: Error creating PowerBI Embedded "acctestpowerbi200305020513348527" (Resource Group "acctestRG-powerbi-200305020513348527"): powerbidedicated.CapacitiesClient#Create: Failure sending request: StatusCode=401 -- Original Error: Code="Unauthorized" Message="Unable to authorize with Azure Active Directory." Details=[{"code":"RootActivityId","message":"fc17e3fc-d438-4ec4-97db-30c5fea95984"}]

so it does seem like there is additional steps required to get this to work on a tenant/subscription that should be documented

neil-yechenwei · 2020-03-05T03:10:42Z

@katbyte , I found a site (https://docs.microsoft.com/en-us/power-bi/developer/register-app) which maybe can solve this issue. I cannot try it by myself since I never encountered this error. Could you try to follow the steps in this site and rerun the test cases?

katbyte · 2020-03-05T03:38:12Z

@neil-yechenwei, I tried to follow the instructions there but it still doesn't seem like power BI is enabled or accessible for our subscription:

neil-yechenwei · 2020-03-05T04:05:24Z

@neil-yechenwei, I tried to follow the instructions there but it still doesn't seem like power BI is enabled or accessible for our subscription:

There is a similar issue here (https://docs.microsoft.com/en-us/power-bi/developer/embedded-troubleshoot):

Maybe you also can follow the link "sign up for power bi" in your screenshot to register.

…cated

neil-yechenwei · 2020-03-05T12:58:20Z

@katbyte , I already raised the problem to service owner. They provided below answer. So I think you just need to follow "STEP 1" in the site "https://dev.powerbi.com/apps" or just go to "app.powerbi.com" and sign-up. After login, you can rerun test case. I think it should be able to pass now. If you still have problem, please let me know.

The answer from service owner:
The reason for the error is because PBI service principal is not provisioned in your test user’s tenant.
The best thing would be if you would sign-in with your test user to PBI and hopefully this will resolve your auth issue.

katbyte · 2020-03-05T13:08:17Z

@neil-yechenwei, i did follow the link and sign up as my user.. however we use SP auth for tests an do not log in with a user. Can you ask the service owner how to authorize a given SP for the API? thanks!

neil-yechenwei · 2020-03-05T13:30:40Z

@katbyte , My understanding is you should be able to create capacity successfully now if you have signed in to PowerBI successfully with your user account, and your user account and your test Service Principal under the same tenant id. So could you double check whether your user account and test service principal are under the same tenant id? And could you rerun the basic test case to create the power bi embedded after your sign-in to PBI? Please let me know the test result. Thanks.

Check tenant id for your user account:
az login
az account show

Check tenant id for service principal:
az login --service-principal --username <ARM_CLIENT_ID> --password <ARM_CLIENT_SECRET> --tenant <ARM_TENANT_ID>

katbyte · 2020-03-05T14:04:38Z

@neil-yechenwei,

after signing in to power BI and enabling a free trial i still cannot create an embedded capacity via the portal, nor via the test SP in CI.

neil-yechenwei · 2020-03-05T14:09:36Z

@katbyte , may I know your email address?

katbyte · 2020-03-05T14:12:20Z

@neil-yechenwei, its [email protected]

neil-yechenwei · 2020-03-06T04:31:57Z

@katbyte , I've involved you in the email.

katbyte

Thanks @neil-yechenwei, tests pass and this LGTM now 👍

ghost · 2020-03-19T00:01:15Z

This has been released in version 2.2.0 of the provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. As an example:

provider "azurerm" {
    version = "~> 2.2.0"
}
# ... other configuration ...

ghost · 2020-04-17T14:50:01Z

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 [email protected]. Thanks!

ghost · 2020-04-18T14:51:06Z

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 [email protected]. Thanks!

Add new resource & data source: azurerm_powerbidedicated_capacity

b334d39

ghost added size/XL documentation labels Dec 13, 2019

Update package

f79bd8e

ghost added dependencies size/XXL and removed size/XL labels Dec 13, 2019

neil-yechenwei added 3 commits December 13, 2019 12:54

update code

7f19222

update codee

ee3932c

update code

c17eb3d

tombuildsstuff suggested changes Dec 13, 2019

View reviewed changes

tombuildsstuff added the waiting-response label Dec 13, 2019

neil-yechenwei changed the title ~~Add new resource & data source: azurerm_powerbidedicated_capacity~~ Add new resource & data source: azurerm_powerbi_dedicated_capacity Dec 17, 2019

v-cheye added 3 commits December 17, 2019 12:15

Update code per comments

edb4786

update code

b1af2be

update code

dce439b

ghost removed the waiting-response label Dec 17, 2019

neil-yechenwei requested a review from tombuildsstuff December 17, 2019 05:41

neil-yechenwei added 3 commits December 18, 2019 13:46

Update code

7be3a16

Update code

483f30d

Update code

91f0c7d

tombuildsstuff added new-resource service/power-bi labels Jan 2, 2020

Update code

05e90ad

katbyte requested changes Mar 3, 2020

View reviewed changes

katbyte added the waiting-response label Mar 3, 2020

neil-yechenwei added 3 commits March 4, 2020 13:52

Update code

4a280e3

Merge remote-tracking branch 'upstream/master' into patch_powerbidedi…

37030f2

…cated

Update code

165e949

Update code

834c307

katbyte changed the title ~~Add new resource & data source: azurerm_powerbi_dedicated_capacity~~ Add new resource & data source: azurerm_powerbi_embedded Mar 5, 2020

Merge remote-tracking branch 'upstream/master' into patch_powerbidedi…

b001212

…cated

katbyte added the waiting-response label Mar 5, 2020

ghost removed the waiting-response label Mar 5, 2020

katbyte added the waiting-response label Mar 5, 2020

ghost removed the waiting-response label Mar 5, 2020

katbyte added the waiting-response label Mar 5, 2020

ghost removed the waiting-response label Mar 6, 2020

katbyte added the waiting-response label Mar 9, 2020

katbyte approved these changes Mar 17, 2020

View reviewed changes

katbyte added this to the v2.2.0 milestone Mar 17, 2020

katbyte merged commit baa13b0 into hashicorp:master Mar 17, 2020

katbyte added a commit that referenced this pull request Mar 17, 2020

update CHANGELOG,md to include #5152

38badb5

ghost removed the waiting-response label Mar 19, 2020

ghost locked and limited conversation to collaborators Apr 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new resource & data source: azurerm_powerbi_embedded #5152

Add new resource & data source: azurerm_powerbi_embedded #5152

neil-yechenwei commented Dec 13, 2019 •

edited by katbyte

Loading

tombuildsstuff left a comment

tombuildsstuff Dec 13, 2019

neil-yechenwei Dec 17, 2019 •

edited

Loading

tombuildsstuff Dec 13, 2019

neil-yechenwei Dec 17, 2019 •

edited

Loading

tombuildsstuff Dec 13, 2019

neil-yechenwei Dec 17, 2019 •

edited

Loading

tombuildsstuff Dec 13, 2019

neil-yechenwei Dec 17, 2019

neil-yechenwei commented Dec 17, 2019

katbyte left a comment

katbyte Mar 3, 2020

neil-yechenwei Mar 4, 2020 •

edited

Loading

katbyte Mar 3, 2020

katbyte Mar 3, 2020

neil-yechenwei Mar 4, 2020 •

edited

Loading

katbyte commented Mar 5, 2020

neil-yechenwei commented Mar 5, 2020 •

edited

Loading

katbyte commented Mar 5, 2020

neil-yechenwei commented Mar 5, 2020 •

edited

Loading

neil-yechenwei commented Mar 5, 2020 •

edited

Loading

katbyte commented Mar 5, 2020

neil-yechenwei commented Mar 5, 2020 •

edited

Loading

katbyte commented Mar 5, 2020

neil-yechenwei commented Mar 5, 2020 •

edited

Loading

katbyte commented Mar 5, 2020

neil-yechenwei commented Mar 6, 2020

katbyte left a comment

ghost commented Mar 19, 2020

ghost commented Apr 17, 2020

ghost commented Apr 18, 2020


		## Import

		PowerBIDedicated Capacities can be imported using the `resource id`, e.g.

	PowerBIDedicated Capacities can be imported using the `resource id`, e.g.
	PowerBI Dedicated instances can be imported using the `resource id`, e.g.


		The following attributes are exported:

		* `id` - The ID of the PowerBIDedicated Capacity.

	* `id` - The ID of the PowerBIDedicated Capacity.
	* `id` - The ID of the PowerBI Dedicated instance.

	PowerBIDedicated *powerBIDedicated.Client
	PowerBI *powerBIDedicated.Client

	"azurerm_powerbi_dedicated_capacity": resourceArmPowerBIDedicatedCapacity()}
	"azurerm_powerbi_????_capacity": resourceArmPowerBIDedicatedCapacity()}

Add new resource & data source: azurerm_powerbi_embedded #5152

Add new resource & data source: azurerm_powerbi_embedded #5152

Conversation

neil-yechenwei commented Dec 13, 2019 • edited by katbyte Loading

tombuildsstuff left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neil-yechenwei Dec 17, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neil-yechenwei Dec 17, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neil-yechenwei Dec 17, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neil-yechenwei commented Dec 17, 2019

katbyte left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neil-yechenwei Mar 4, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neil-yechenwei Mar 4, 2020 • edited Loading

Choose a reason for hiding this comment

katbyte commented Mar 5, 2020

neil-yechenwei commented Mar 5, 2020 • edited Loading

katbyte commented Mar 5, 2020

neil-yechenwei commented Mar 5, 2020 • edited Loading

neil-yechenwei commented Mar 5, 2020 • edited Loading

katbyte commented Mar 5, 2020

neil-yechenwei commented Mar 5, 2020 • edited Loading

katbyte commented Mar 5, 2020

neil-yechenwei commented Mar 5, 2020 • edited Loading

katbyte commented Mar 5, 2020

neil-yechenwei commented Mar 6, 2020

katbyte left a comment

Choose a reason for hiding this comment

ghost commented Mar 19, 2020

ghost commented Apr 17, 2020

ghost commented Apr 18, 2020

neil-yechenwei commented Dec 13, 2019 •

edited by katbyte

Loading

neil-yechenwei Dec 17, 2019 •

edited

Loading

neil-yechenwei Dec 17, 2019 •

edited

Loading

neil-yechenwei Dec 17, 2019 •

edited

Loading

neil-yechenwei Mar 4, 2020 •

edited

Loading

neil-yechenwei Mar 4, 2020 •

edited

Loading

neil-yechenwei commented Mar 5, 2020 •

edited

Loading

neil-yechenwei commented Mar 5, 2020 •

edited

Loading

neil-yechenwei commented Mar 5, 2020 •

edited

Loading

neil-yechenwei commented Mar 5, 2020 •

edited

Loading

neil-yechenwei commented Mar 5, 2020 •

edited

Loading