fabric_capacities

Creates, updates, deletes, gets or lists a fabric_capacities resource.

Overview

Name	fabric_capacities
Type	Resource
Id	azure.fabric.fabric_capacities

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
administration	object	The capacity administration. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current deployment state of Microsoft Fabric resource. The provisioningState is to indicate states for resource provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", "Provisioning", and "Updating". (Succeeded, Failed, Canceled, Deleting, Provisioning, Updating)
sku	object	The SKU details. Required.
state	string	The current state of Microsoft Fabric resource. The state is to indicate more states outside of resource provisioning. Known values are: "Active", "Provisioning", "Failed", "Updating", "Deleting", "Suspending", "Suspended", "Pausing", "Paused", "Resuming", "Scaling", and "Preparing". (Active, Provisioning, Failed, Updating, Deleting, Suspending, Suspended, Pausing, Paused, Resuming, Scaling, Preparing)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
administration	object	The capacity administration. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current deployment state of Microsoft Fabric resource. The provisioningState is to indicate states for resource provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", "Provisioning", and "Updating". (Succeeded, Failed, Canceled, Deleting, Provisioning, Updating)
sku	object	The SKU details. Required.
state	string	The current state of Microsoft Fabric resource. The state is to indicate more states outside of resource provisioning. Known values are: "Active", "Provisioning", "Failed", "Updating", "Deleting", "Suspending", "Suspended", "Pausing", "Paused", "Resuming", "Scaling", and "Preparing". (Active, Provisioning, Failed, Updating, Deleting, Suspending, Suspended, Pausing, Paused, Resuming, Scaling, Preparing)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

check_name_availability

Name	Datatype	Description
message	string	Detailed reason why the given name is not available.
nameAvailable	boolean	Indicates if the resource name is available.
reason	string	The reason why the given name is not available. Known values are: "Invalid" and "AlreadyExists". (Invalid, AlreadyExists)

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
administration	object	The capacity administration. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current deployment state of Microsoft Fabric resource. The provisioningState is to indicate states for resource provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", "Provisioning", and "Updating". (Succeeded, Failed, Canceled, Deleting, Provisioning, Updating)
sku	object	The SKU details. Required.
state	string	The current state of Microsoft Fabric resource. The state is to indicate more states outside of resource provisioning. Known values are: "Active", "Provisioning", "Failed", "Updating", "Deleting", "Suspending", "Suspended", "Pausing", "Paused", "Resuming", "Scaling", and "Preparing". (Active, Provisioning, Failed, Updating, Deleting, Suspending, Suspended, Pausing, Paused, Resuming, Scaling, Preparing)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, capacity_name, subscription_id		Get a FabricCapacity.
list_by_resource_group	select	resource_group_name, subscription_id		List FabricCapacity resources by resource group.
check_name_availability	select	location, subscription_id		Implements local CheckNameAvailability operations.
list_by_subscription	select	subscription_id		List FabricCapacity resources by subscription ID.
create_or_update	insert	resource_group_name, capacity_name, subscription_id, location, properties, sku		Create a FabricCapacity.
update	update	resource_group_name, capacity_name, subscription_id		Update a FabricCapacity.
create_or_update	replace	resource_group_name, capacity_name, subscription_id, location, properties, sku		Create a FabricCapacity.
delete	delete	resource_group_name, capacity_name, subscription_id		Delete a FabricCapacity.
list_skus_for_capacity	exec	resource_group_name, capacity_name, subscription_id		List eligible SKUs for a Microsoft Fabric resource.
list_skus	exec	subscription_id		List eligible SKUs for Microsoft Fabric resource provider.
resume	exec	resource_group_name, capacity_name, subscription_id		Resume operation of the specified Fabric capacity instance.
suspend	exec	resource_group_name, capacity_name, subscription_id		Suspend operation of the specified Fabric capacity instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
capacity_name	string	The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63. Required.
location	string	The name of the Azure region. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a FabricCapacity.

SELECT
id,
name,
administration,
location,
provisioningState,
sku,
state,
systemData,
tags,
type
FROM azure.fabric.fabric_capacities
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND capacity_name = '{{ capacity_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List FabricCapacity resources by resource group.

SELECT
id,
name,
administration,
location,
provisioningState,
sku,
state,
systemData,
tags,
type
FROM azure.fabric.fabric_capacities
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

check_name_availability

Implements local CheckNameAvailability operations.

SELECT
message,
nameAvailable,
reason
FROM azure.fabric.fabric_capacities
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List FabricCapacity resources by subscription ID.

SELECT
id,
name,
administration,
location,
provisioningState,
sku,
state,
systemData,
tags,
type
FROM azure.fabric.fabric_capacities
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a FabricCapacity.

INSERT INTO azure.fabric.fabric_capacities (
tags,
location,
properties,
sku,
resource_group_name,
capacity_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ sku }}' /* required */,
'{{ resource_group_name }}',
'{{ capacity_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: fabric_capacities
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the fabric_capacities resource.
  - name: capacity_name
    value: "{{ capacity_name }}"
    description: Required parameter for the fabric_capacities resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the fabric_capacities resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      state: "{{ state }}"
      administration:
        members:
          - "{{ members }}"
  - name: sku
    description: |
      The SKU details. Required.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"

UPDATE examples

update

Update a FabricCapacity.

UPDATE azure.fabric.fabric_capacities
SET 
sku = '{{ sku }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND capacity_name = '{{ capacity_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a FabricCapacity.

REPLACE azure.fabric.fabric_capacities
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND capacity_name = '{{ capacity_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND sku = '{{ sku }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Delete a FabricCapacity.

DELETE FROM azure.fabric.fabric_capacities
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND capacity_name = '{{ capacity_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_skus_for_capacity

List eligible SKUs for a Microsoft Fabric resource.

EXEC azure.fabric.fabric_capacities.list_skus_for_capacity 
@resource_group_name='{{ resource_group_name }}' --required, 
@capacity_name='{{ capacity_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_skus

List eligible SKUs for Microsoft Fabric resource provider.

EXEC azure.fabric.fabric_capacities.list_skus 
@subscription_id='{{ subscription_id }}' --required
;

resume

Resume operation of the specified Fabric capacity instance.

EXEC azure.fabric.fabric_capacities.resume 
@resource_group_name='{{ resource_group_name }}' --required, 
@capacity_name='{{ capacity_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

suspend

Suspend operation of the specified Fabric capacity instance.

EXEC azure.fabric.fabric_capacities.suspend 
@resource_group_name='{{ resource_group_name }}' --required, 
@capacity_name='{{ capacity_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;