capacities

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

Overview

Name	capacities
Type	Resource
Id	azure.fabric.capacities

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
sku	object	The SKU details
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
sku	object	The SKU details
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
sku	object	The SKU details
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, capacityName		Get a FabricCapacity
list_by_resource_group	select	subscriptionId, resourceGroupName		List FabricCapacity resources by resource group
list_by_subscription	select	subscriptionId		List FabricCapacity resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, capacityName, data__properties, data__sku		Create a FabricCapacity
update	update	subscriptionId, resourceGroupName, capacityName		Update a FabricCapacity
delete	delete	subscriptionId, resourceGroupName, capacityName		Delete a FabricCapacity
check_name_availability	exec	subscriptionId, location		Implements local CheckNameAvailability operations
resume	exec	subscriptionId, resourceGroupName, capacityName		Resume operation of the specified Fabric capacity instance.
suspend	exec	subscriptionId, resourceGroupName, capacityName		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
capacityName	string	The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
location	string	The name of the Azure region.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a FabricCapacity

SELECT
location,
properties,
sku,
tags
FROM azure.fabric.capacities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND capacityName = '{{ capacityName }}' -- required
;

list_by_resource_group

List FabricCapacity resources by resource group

SELECT
location,
properties,
sku,
tags
FROM azure.fabric.capacities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List FabricCapacity resources by subscription ID

SELECT
location,
properties,
sku,
tags
FROM azure.fabric.capacities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a FabricCapacity

INSERT INTO azure.fabric.capacities (
data__properties,
data__sku,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
capacityName
)
SELECT 
'{{ properties }}' /* required */,
'{{ sku }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ capacityName }}'
RETURNING
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: capacities
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the capacities resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the capacities resource.
    - name: capacityName
      value: string
      description: Required parameter for the capacities resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: sku
      value: object
      description: |
        The SKU details
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a FabricCapacity

UPDATE azure.fabric.capacities
SET 
data__sku = '{{ sku }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND capacityName = '{{ capacityName }}' --required
RETURNING
location,
properties,
sku,
tags;

DELETE examples

delete

Delete a FabricCapacity

DELETE FROM azure.fabric.capacities
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND capacityName = '{{ capacityName }}' --required
;

Lifecycle Methods

check_name_availability

Implements local CheckNameAvailability operations

EXEC azure.fabric.capacities.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

resume

Resume operation of the specified Fabric capacity instance.

EXEC azure.fabric.capacities.resume 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@capacityName='{{ capacityName }}' --required
;

suspend

Suspend operation of the specified Fabric capacity instance.

EXEC azure.fabric.capacities.suspend 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@capacityName='{{ capacityName }}' --required
;