az fabric capacity
Note
This reference is part of the microsoft-fabric extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az fabric capacity command. Learn more about extensions.
Manage Microsoft Fabric capacities.
Commands
Name | Description | Type | Status |
---|---|---|---|
az fabric capacity check-name-availability |
Implements local CheckNameAvailability operations. |
Extension | GA |
az fabric capacity create |
Create a FabricCapacity. |
Extension | GA |
az fabric capacity delete |
Delete a FabricCapacity. |
Extension | GA |
az fabric capacity list |
List FabricCapacity resources by subscription ID. |
Extension | GA |
az fabric capacity list-skus |
List eligible SKUs for Microsoft Fabric resource provider. |
Extension | GA |
az fabric capacity list-skus-for-capacity |
List eligible SKUs for a Microsoft Fabric resource. |
Extension | GA |
az fabric capacity resume |
Resume operation of the specified Fabric capacity instance. |
Extension | GA |
az fabric capacity show |
Get a FabricCapacity. |
Extension | GA |
az fabric capacity suspend |
Suspend operation of the specified Fabric capacity instance. |
Extension | GA |
az fabric capacity update |
Update a FabricCapacity. |
Extension | GA |
az fabric capacity wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az fabric capacity check-name-availability
Implements local CheckNameAvailability operations.
az fabric capacity check-name-availability [--ids]
[--location]
[--name]
[--subscription]
[--type]
Examples
Check name availability of a capacity
az fabric capacity check-name-availability --location westcentralus --name azsdktest --type Microsoft.Fabric/capacities
Optional Parameters
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.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
The name of the resource for which availability needs to be checked.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The resource type.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az fabric capacity create
Create a FabricCapacity.
az fabric capacity create --capacity-name
--resource-group
--sku
[--administration]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--tags]
Examples
Create or update a capacity
az fabric capacity create --resource-group TestRG --capacity-name azsdktest --administration "{members:[azsdktest@microsoft.com,azsdktest2@microsoft.com]}" --sku "{name:F2,tier:Fabric}" --location westcentralus
Required Parameters
The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The SKU details Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Optional Parameters
The capacity administration Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az fabric capacity delete
Delete a FabricCapacity.
az fabric capacity delete [--capacity-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete a capacity
az fabric capacity delete --resource-group TestRG --capacity-name azsdktest
Optional Parameters
The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az fabric capacity list
List FabricCapacity resources by subscription ID.
az fabric capacity list [--max-items]
[--next-token]
[--resource-group]
Examples
List capacities by subscription
az fabric capacity list
List capacities by resource group
az fabric capacity list --resource-group TestRG
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token
argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az fabric capacity list-skus
List eligible SKUs for Microsoft Fabric resource provider.
az fabric capacity list-skus [--max-items]
[--next-token]
Examples
List eligible SKUs for a new capacity
az fabric capacity list-skus
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token
argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az fabric capacity list-skus-for-capacity
List eligible SKUs for a Microsoft Fabric resource.
az fabric capacity list-skus-for-capacity --capacity-name
--resource-group
[--max-items]
[--next-token]
Examples
List eligible SKUs for an existing capacity
az fabric capacity list-skus-for-capacity --resource-group TestRG --capacity-name azsdktest
Required Parameters
The name of the capacity.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token
argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az fabric capacity resume
Resume operation of the specified Fabric capacity instance.
az fabric capacity resume [--capacity-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Resume capacity
az fabric capacity resume --resource-group TestRG --capacity-name azsdktest
Optional Parameters
The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az fabric capacity show
Get a FabricCapacity.
az fabric capacity show [--capacity-name]
[--ids]
[--resource-group]
[--subscription]
Examples
Get a capacity
az fabric capacity show --resource-group TestRG --capacity-name azsdktest
Optional Parameters
The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
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 of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az fabric capacity suspend
Suspend operation of the specified Fabric capacity instance.
az fabric capacity suspend [--capacity-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Suspend capacity
az fabric capacity suspend --resource-group TestRG --capacity-name azsdktest
Optional Parameters
The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az fabric capacity update
Update a FabricCapacity.
az fabric capacity update [--add]
[--administration]
[--capacity-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--sku]
[--subscription]
[--tags]
Examples
Update capacity properties
az fabric capacity update --resource-group TestRG --capacity-name azsdktest --administration "{members:[azsdktest@microsoft.com,azsdktest2@microsoft.com]}" --sku "{name:F4,tier:Fabric}"
Optional Parameters
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>
.
The capacity administration Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
The SKU details Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az fabric capacity wait
Place the CLI in a waiting state until a condition is met.
az fabric capacity wait [--capacity-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.