az powerbi embedded-capacity

Manage PowerBI embedded capacity.

Commands

az powerbi embedded-capacity create

Create a new PowerBI embedded capacity.

az powerbi embedded-capacity delete

Delete the specified PowerBI embedded capacity.

az powerbi embedded-capacity list

List all the embedded capacities for the given resource group.

az powerbi embedded-capacity show

Get details about the specified PowerBI embedded capacity.

az powerbi embedded-capacity update

Update the specified PowerBI embedded capacity.

az powerbi embedded-capacity wait

Place the CLI in a waiting state until a condition of PowerBI embedded capacity is met.

az powerbi embedded-capacity create

Create a new PowerBI embedded capacity.

az powerbi embedded-capacity create --location
                                    --name
                                    --resource-group
                                    --sku-name {A1, A2, A3, A4, A5, A6}
                                    [--administration-members]
                                    [--no-wait]
                                    [--sku-tier {PBIE_Azure}]
                                    [--tags]

Examples

Create a new PowerBI embedded capacity.

az powerbi embedded-capacity create --resource-group "TestRG" --name "azsdktest" \
--location eastus --sku-name "A1" --sku-tier "PBIE_Azure" --administration-members \
"azsdktest@microsoft.com" "azsdktest2@microsoft.com"

Create a new PowerBI embedded capacity without waiting.

az powerbi embedded-capacity create --resource-group "TestRG" --name "azsdktest" \
--location eastus --sku-name "A1" --sku-tier "PBIE_Azure" --administration-members \
"azsdktest@microsoft.com" "azsdktest2@microsoft.com" --no-wait

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sku-name

Name of the SKU level. For more information, please refer to https://azure.microsoft.com/en-us/pricing/details/power-bi-embedded/.

accepted values: A1, A2, A3, A4, A5, A6

Optional Parameters

--administration-members

An array of administrator user identities.

--no-wait

Do not wait for the long-running operation to finish.

--sku-tier

The name of the Azure pricing tier to which the SKU applies.

accepted values: PBIE_Azure
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az powerbi embedded-capacity delete

Delete the specified PowerBI embedded capacity.

az powerbi embedded-capacity delete --name
                                    --resource-group
                                    [--no-wait]
                                    [--yes]

Examples

Delete a capacity in specified resource group.

az powerbi embedded-capacity delete --resource-group "TestRG" --name "azsdktest"

Delete a capacity in specified resource group without prompt.

az powerbi embedded-capacity delete --resource-group "TestRG" --name "azsdktest" -y

Delete a capacity in specified resource group without waiting.

az powerbi embedded-capacity delete --resource-group "TestRG" --name "azsdktest" --no-wait

Required Parameters

--name -n

The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

--yes -y

Do not prompt for confirmation.

az powerbi embedded-capacity list

List all the embedded capacities for the given resource group.

az powerbi embedded-capacity list [--resource-group]

Examples

List capacities in resource group

az powerbi embedded-capacity list --resource-group "TestRG"

List all capacities in default subscription.

az powerbi embedded-capacity list

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az powerbi embedded-capacity show

Get details about the specified PowerBI embedded capacity.

az powerbi embedded-capacity show --name
                                  --resource-group

Examples

Get details of a capacity

az powerbi embedded-capacity show --resource-group "TestRG" --name "azsdktest"

Required Parameters

--name -n

The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az powerbi embedded-capacity update

Update the specified PowerBI embedded capacity.

az powerbi embedded-capacity update --name
                                    --resource-group
                                    [--administration-members]
                                    [--no-wait]
                                    [--sku-name {A1, A2, A3, A4, A5, A6}]
                                    [--sku-tier {PBIE_Azure}]
                                    [--tags]

Examples

Update sku name for the specified PowerBI embedded capacity.

az powerbi embedded-capacity update --resource-group "TestRG" --name "azsdktest" --sku-name "A1"

Update administrator members the specified PowerBI embedded capacity without waiting.

az powerbi embedded-capacity update --resource-group "TestRG" --name "azsdktest" \
--sku-name "A1" --administration-members "azsdktest3@microsoft.com" --no-wait

Required Parameters

--name -n

The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--administration-members

An array of administrator user identities.

--no-wait

Do not wait for the long-running operation to finish.

--sku-name

Name of the SKU level. For more information, please refer to https://azure.microsoft.com/en-us/pricing/details/power-bi-embedded/.

accepted values: A1, A2, A3, A4, A5, A6
--sku-tier

The name of the Azure pricing tier to which the SKU applies.

accepted values: PBIE_Azure
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az powerbi embedded-capacity wait

Place the CLI in a waiting state until a condition of PowerBI embedded capacity is met.

az powerbi embedded-capacity wait --name
                                  --resource-group
                                  [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--interval]
                                  [--timeout]
                                  [--updated]

Examples

Place the CLI in a waiting state until the powerbi embedded capacity is created.

az powerbi embedded-capacity wait --resource-group "TestRG" --name "azsdktest" --created

Required Parameters

--name -n

The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.