Fabric Capacities - Update

Service:: Fabric

API Version:: 2023-11-01

Update a FabricCapacity

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}?api-version=2023-11-01

URI Parameters

Name	In	Required	Type	Description
capacityName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
properties.administration	CapacityAdministration	The capacity administration
sku	RpSku	The SKU details
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	FabricCapacity	Azure operation completed successfully.
202 Accepted		Resource update request accepted. Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Name

Type

Description

200 OK

FabricCapacity

Azure operation completed successfully.

202 Accepted

Resource update request accepted.

Headers

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Update capacity properties

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest?api-version=2023-11-01

{
  "sku": {
    "name": "F8",
    "tier": "Fabric"
  },
  "tags": {
    "testKey": "testValue"
  },
  "properties": {
    "administration": {
      "members": [
        "azsdktest2@microsoft.com"
      ]
    }
  }
}

Sample response

Status code:: 200

{
  "properties": {
    "provisioningState": "Updating",
    "state": "Preparing",
    "administration": {
      "members": [
        "azsdktest2@microsoft.com"
      ]
    }
  },
  "sku": {
    "name": "F8",
    "tier": "Fabric"
  },
  "tags": {
    "testKey": "testValue"
  },
  "___location": "westcentralus",
  "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest",
  "name": "azsdktest",
  "type": "Microsoft.Fabric/capacities"
}

Status code:: 202

Location: https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-
Azure-AsyncOperation: https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-

Definitions

Name	Description
CapacityAdministration	The administration properties of the Fabric capacity resource
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
FabricCapacity	Fabric Capacity resource
FabricCapacityUpdate	The type used for update operations of the FabricCapacity.
ProvisioningState	The provisioning state of the Fabric capacity resource.
ResourceState	The state of the Fabric capacity resource.
RpSku	Represents the SKU name and Azure pricing tier for Microsoft Fabric capacity resource.
RpSkuTier	The name of the Azure pricing tier to which the SKU applies.
systemData	Metadata pertaining to creation and last modification of the resource.

CapacityAdministration

Object

The administration properties of the Fabric capacity resource

Name	Type	Description
members	string[]	An array of administrator user identities.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

FabricCapacity

Object

Fabric Capacity resource

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
___location	string	The geo-___location where the resource lives
name	string	The name of the resource
properties.administration	CapacityAdministration	The capacity administration
properties.provisioningState	ProvisioningState	The current deployment state of Microsoft Fabric resource. The provisioningState is to indicate states for resource provisioning.
properties.state	ResourceState	The current state of Microsoft Fabric resource. The state is to indicate more states outside of resource provisioning.
sku	RpSku	The SKU details
systemData	systemData	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"

FabricCapacityUpdate

Object

The type used for update operations of the FabricCapacity.

Name	Type	Description
properties.administration	CapacityAdministration	The capacity administration
sku	RpSku	The SKU details
tags	object	Resource tags.

ProvisioningState

Enumeration

The provisioning state of the Fabric capacity resource.

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
Deleting	Resource is deleting
Provisioning	Resource is provisioning
Updating	Resource is updating

ResourceState

Enumeration

The state of the Fabric capacity resource.

Value	Description
Active	Resource is active
Provisioning	Resource is provisioning
Failed	Resource is failed
Updating	Resource is updating
Deleting	Resource is deleting
Suspending	Resource is suspending
Suspended	Resource is suspended
Pausing	Resource is pausing
Paused	Resource is paused
Resuming	Resource is resuming
Scaling	Resource is scaling
Preparing	Resource is preparing

RpSku

Object

Represents the SKU name and Azure pricing tier for Microsoft Fabric capacity resource.

Name	Type	Description
name	string	The name of the SKU level.
tier	RpSkuTier	The name of the Azure pricing tier to which the SKU applies.

RpSkuTier

Enumeration

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

Value	Description
Fabric	Fabric tier

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Fabric Capacities - Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Update capacity properties

Sample request

Sample response

Definitions

CapacityAdministration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FabricCapacity

FabricCapacityUpdate

ProvisioningState

ResourceState

RpSku

RpSkuTier

systemData