az powerbi embedded-capacity

  • Preview
  • Reference

Note

This reference is part of the powerbidedicated extension for the Azure CLI (version 2.56.0 or higher). The extension will automatically install the first time you run an az powerbi embedded-capacity command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage PowerBI embedded capacity.

Commands

Name Description Type Status
az powerbi embedded-capacity create

Create a new PowerBI embedded capacity.

 Extension Preview
az powerbi embedded-capacity delete

Delete the specified PowerBI embedded capacity.

 Extension Preview
az powerbi embedded-capacity list

List all the embedded capacities for the given resource group.

 Extension Preview
az powerbi embedded-capacity list-sku

List eligible SKUs for a PowerBI Dedicated resource.

 Extension Preview
az powerbi embedded-capacity show

Get details about the specified PowerBI embedded capacity.

 Extension Preview
az powerbi embedded-capacity update

Update the specified PowerBI embedded capacity.

 Extension Preview
az powerbi embedded-capacity wait

Place the CLI in a waiting state until a condition is met.

 Extension Preview

az powerbi embedded-capacity create

Preview

Command group 'powerbi embedded-capacity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a new PowerBI embedded capacity.

az powerbi embedded-capacity create --name
                                    --resource-group
                                    --sku-name
                                    [--administration-members]
                                    [--location]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--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

--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/. Allowed values: A1, A2, A3, A4, A5, A6.

Optional Parameters

--administration-members

An array of administrator user identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>. When not specified, the location of the resource group will be used.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az powerbi embedded-capacity delete

Preview

Command group 'powerbi embedded-capacity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the specified PowerBI embedded capacity.

az powerbi embedded-capacity delete [--ids]
                                    [--name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--subscription]
                                    [--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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

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

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az powerbi embedded-capacity list

Preview

Command group 'powerbi embedded-capacity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az powerbi embedded-capacity list-sku

Preview

Command group 'powerbi embedded-capacity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List eligible SKUs for a PowerBI Dedicated resource.

az powerbi embedded-capacity list-sku [--dedicated-capacity-name]
                                      [--ids]
                                      [--resource-group]
                                      [--subscription]

Optional Parameters

--dedicated-capacity-name --name -n

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az powerbi embedded-capacity show

Preview

Command group 'powerbi embedded-capacity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get details about the specified PowerBI embedded capacity.

az powerbi embedded-capacity show [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]

Examples

Get details of a capacity

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--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>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az powerbi embedded-capacity update

Preview

Command group 'powerbi embedded-capacity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the specified PowerBI embedded capacity.

az powerbi embedded-capacity update [--add]
                                    [--administration-members]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--ids]
                                    [--name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--remove]
                                    [--resource-group]
                                    [--set]
                                    [--sku-name]
                                    [--sku-tier {PBIE_Azure}]
                                    [--subscription]
                                    [--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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--administration-members

An array of administrator user identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

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

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--sku-name

Name of the SKU level. For more information, please refer to https://azure.microsoft.com/en- us/pricing/details/power-bi-embedded/. Allowed 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
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az powerbi embedded-capacity wait

Preview

Command group 'powerbi embedded-capacity' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

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

Optional Parameters

--created

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

default value: False
--custom

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--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>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.