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.

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"
      ]
    }
  }
}

Java

import com.azure.resourcemanager.fabric.models.CapacityAdministration;
import com.azure.resourcemanager.fabric.models.FabricCapacity;
import com.azure.resourcemanager.fabric.models.FabricCapacityUpdateProperties;
import com.azure.resourcemanager.fabric.models.RpSku;
import com.azure.resourcemanager.fabric.models.RpSkuTier;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for FabricCapacities Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2023-11-01/FabricCapacities_Update.json
     */
    /**
     * Sample code: Update capacity properties.
     * 
     * @param manager Entry point to FabricManager.
     */
    public static void updateCapacityProperties(com.azure.resourcemanager.fabric.FabricManager manager) {
        FabricCapacity resource = manager.fabricCapacities()
            .getByResourceGroupWithResponse("TestRG", "azsdktest", com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf("testKey", "fakeTokenPlaceholder"))
            .withSku(new RpSku().withName("F8").withTier(RpSkuTier.FABRIC))
            .withProperties(new FabricCapacityUpdateProperties().withAdministration(
                new CapacityAdministration().withMembers(Arrays.asList("azsdktest2@microsoft.com"))))
            .apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.fabric import FabricMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-fabric
# USAGE
    python fabric_capacities_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = FabricMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.fabric_capacities.begin_update(
        resource_group_name="TestRG",
        capacity_name="azsdktest",
        properties={
            "properties": {"administration": {"members": ["azsdktest2@microsoft.com"]}},
            "sku": {"name": "F8", "tier": "Fabric"},
            "tags": {"testKey": "testValue"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2023-11-01/FabricCapacities_Update.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armfabric_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/fabric/armfabric"
)

// Generated from example definition: D:/w/Azure/azure-sdk-for-go/sdk/resourcemanager/fabric/armfabric/TempTypeSpecFiles/Microsoft.Fabric.Management/examples/2023-11-01/FabricCapacities_Update.json
func ExampleCapacitiesClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armfabric.NewClientFactory("548B7FB7-3B2A-4F46-BB02-66473F1FC22C", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewCapacitiesClient().BeginUpdate(ctx, "TestRG", "azsdktest", armfabric.CapacityUpdate{
		SKU: &armfabric.RpSKU{
			Name: to.Ptr("F8"),
			Tier: to.Ptr(armfabric.RpSKUTierFabric),
		},
		Tags: map[string]*string{
			"testKey": to.Ptr("testValue"),
		},
		Properties: &armfabric.CapacityUpdateProperties{
			Administration: &armfabric.CapacityAdministration{
				Members: []*string{
					to.Ptr("azsdktest2@microsoft.com"),
				},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armfabric.CapacitiesClientUpdateResponse{
	// 	Capacity: &armfabric.Capacity{
	// 		Properties: &armfabric.CapacityProperties{
	// 			ProvisioningState: to.Ptr(armfabric.ProvisioningStateUpdating),
	// 			State: to.Ptr(armfabric.ResourceStatePreparing),
	// 			Administration: &armfabric.CapacityAdministration{
	// 				Members: []*string{
	// 					to.Ptr("azsdktest2@microsoft.com"),
	// 				},
	// 			},
	// 		},
	// 		SKU: &armfabric.RpSKU{
	// 			Name: to.Ptr("F8"),
	// 			Tier: to.Ptr(armfabric.RpSKUTierFabric),
	// 		},
	// 		Tags: map[string]*string{
	// 			"testKey": to.Ptr("testValue"),
	// 		},
	// 		Location: to.Ptr("westcentralus"),
	// 		ID: to.Ptr("/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest"),
	// 		Name: to.Ptr("azsdktest"),
	// 		Type: to.Ptr("Microsoft.Fabric/capacities"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { FabricClient } = require("@azure/arm-fabric");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to update a FabricCapacity
 *
 * @summary update a FabricCapacity
 * x-ms-original-file: 2023-11-01/FabricCapacities_Update.json
 */
async function updateCapacityProperties() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "548B7FB7-3B2A-4F46-BB02-66473F1FC22C";
  const client = new FabricClient(credential, subscriptionId);
  const result = await client.fabricCapacities.update("TestRG", "azsdktest", {
    sku: { name: "F8", tier: "Fabric" },
    tags: { testKey: "testValue" },
    properties: { administration: { members: ["azsdktest2@microsoft.com"] } },
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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
Application
Key
ManagedIdentity
User

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
Canceled	Resource creation was canceled.
Deleting	Resource is deleting
Failed	Resource creation failed.
Provisioning	Resource is provisioning
Succeeded	Resource has been created.
Updating	Resource is updating

ResourceState

Enumeration

The state of the Fabric capacity resource.

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

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.