Fabric Capacities - List By Resource Group

參考

服務:: Fabric

API 版本:: 2023-11-01

依資源群組列出 FabricCapacity 資源

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	FabricCapacityListResult	Azure 作業已順利完成。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List capacities by resource group

範例要求

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


/**
 * Samples for FabricCapacities ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2023-11-01/FabricCapacities_ListByResourceGroup.json
     */
    /**
     * Sample code: List capacities by resource group.
     * 
     * @param manager Entry point to FabricManager.
     */
    public static void listCapacitiesByResourceGroup(com.azure.resourcemanager.fabric.FabricManager manager) {
        manager.fabricCapacities().listByResourceGroup("TestRG", com.azure.core.util.Context.NONE);
    }
}

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

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_list_by_resource_group.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.list_by_resource_group(
        resource_group_name="TestRG",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2023-11-01/FabricCapacities_ListByResourceGroup.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

package armfabric_test

import (
	"context"
	"log"

	"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_ListByResourceGroup.json
func ExampleCapacitiesClient_NewListByResourceGroupPager() {
	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)
	}
	pager := clientFactory.NewCapacitiesClient().NewListByResourceGroupPager("TestRG", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armfabric.CapacitiesClientListByResourceGroupResponse{
		// 	CapacityListResult: armfabric.CapacityListResult{
		// 		Value: []*armfabric.Capacity{
		// 			{
		// 				Properties: &armfabric.CapacityProperties{
		// 					ProvisioningState: to.Ptr(armfabric.ProvisioningStateSucceeded),
		// 					State: to.Ptr(armfabric.ResourceStateActive),
		// 					Administration: &armfabric.CapacityAdministration{
		// 						Members: []*string{
		// 							to.Ptr("azsdktest@microsoft.com"),
		// 						},
		// 					},
		// 				},
		// 				SKU: &armfabric.RpSKU{
		// 					Name: to.Ptr("F2"),
		// 					Tier: to.Ptr(armfabric.RpSKUTierFabric),
		// 				},
		// 				Tags: map[string]*string{
		// 				},
		// 				Location: to.Ptr("West Central US"),
		// 				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"),
		// 			},
		// 			{
		// 				Properties: &armfabric.CapacityProperties{
		// 					ProvisioningState: to.Ptr(armfabric.ProvisioningStateProvisioning),
		// 					State: to.Ptr(armfabric.ResourceStateProvisioning),
		// 					Administration: &armfabric.CapacityAdministration{
		// 						Members: []*string{
		// 							to.Ptr("azsdktest@microsoft.com"),
		// 						},
		// 					},
		// 				},
		// 				SKU: &armfabric.RpSKU{
		// 					Name: to.Ptr("F4"),
		// 					Tier: to.Ptr(armfabric.RpSKUTierFabric),
		// 				},
		// 				Tags: map[string]*string{
		// 					"testKey": to.Ptr("testValue"),
		// 				},
		// 				Location: to.Ptr("West Central US"),
		// 				ID: to.Ptr("/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest2"),
		// 				Name: to.Ptr("azsdktest2"),
		// 				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

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

/**
 * This sample demonstrates how to list FabricCapacity resources by resource group
 *
 * @summary list FabricCapacity resources by resource group
 * x-ms-original-file: 2023-11-01/FabricCapacities_ListByResourceGroup.json
 */
async function listCapacitiesByResourceGroup() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "548B7FB7-3B2A-4F46-BB02-66473F1FC22C";
  const client = new FabricClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.fabricCapacities.listByResourceGroup("TestRG")) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "state": "Active",
        "administration": {
          "members": [
            "azsdktest@microsoft.com"
          ]
        }
      },
      "sku": {
        "name": "F2",
        "tier": "Fabric"
      },
      "tags": {},
      "location": "West Central US",
      "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest",
      "name": "azsdktest",
      "type": "Microsoft.Fabric/capacities"
    },
    {
      "properties": {
        "provisioningState": "Provisioning",
        "state": "Provisioning",
        "administration": {
          "members": [
            "azsdktest@microsoft.com"
          ]
        }
      },
      "sku": {
        "name": "F4",
        "tier": "Fabric"
      },
      "tags": {
        "testKey": "testValue"
      },
      "location": "West Central US",
      "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest2",
      "name": "azsdktest2",
      "type": "Microsoft.Fabric/capacities"
    }
  ]
}

定義

名稱	Description
CapacityAdministration	Fabric 容量資源的系統管理屬性
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
FabricCapacity	網狀架構容量資源
FabricCapacityListResult	FabricCapacity 清單作業的回應。
ProvisioningState	網狀架構容量資源的布建狀態。
ResourceState	網狀架構容量資源的狀態。
RpSku	代表 Microsoft Fabric 容量資源的 SKU 名稱和 Azure 定價層。
RpSkuTier	套用 SKU 的 Azure 定價層名稱。
systemData	與建立和上次修改資源相關的元數據。

CapacityAdministration

Object

Fabric 容量資源的系統管理屬性

名稱	類型	Description
members	string[]	系統管理員使用者身分識別的陣列。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

FabricCapacity

Object

網狀架構容量資源

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	資源所在的地理位置
name	string	資源的名稱
properties.administration	CapacityAdministration	容量管理
properties.provisioningState	ProvisioningState	Microsoft Fabric 資源的目前部署狀態。 provisioningState是指出資源布建的狀態。
properties.state	ResourceState	Microsoft Fabric 資源的目前狀態。狀態是指出資源布建以外的更多狀態。
sku	RpSku	SKU 詳細數據
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
tags	object	資源標籤。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

FabricCapacityListResult

Object

FabricCapacity 清單作業的回應。

名稱	類型	Description
nextLink	string (uri)	專案下一頁的連結
value	FabricCapacity[]	此頁面上的 FabricCapacity 專案

ProvisioningState

列舉型別

網狀架構容量資源的布建狀態。

值	Description
Canceled	已取消資源建立。
Deleting	正在刪除資源
Failed	資源建立失敗。
Provisioning	資源正在布建
Succeeded	已建立資源。
Updating	資源正在更新

ResourceState

列舉型別

網狀架構容量資源的狀態。

值	Description
Active	資源為使用中
Deleting	正在刪除資源
Failed	資源失敗
Paused	資源已暫停
Pausing	資源正在暫停
Preparing	資源正在準備中
Provisioning	資源正在布建
Resuming	資源正在繼續
Scaling	資源正在調整
Suspended	資源已暫止
Suspending	資源正在暫停
Updating	資源正在更新

RpSku

Object

代表 Microsoft Fabric 容量資源的 SKU 名稱和 Azure 定價層。

名稱	類型	Description
name	string	SKU 層級的名稱。
tier	RpSkuTier	套用 SKU 的 Azure 定價層名稱。

RpSkuTier

列舉型別

套用 SKU 的 Azure 定價層名稱。

值	Description
Fabric	網狀架構層

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

共用方式為

Fabric Capacities - List By Resource Group

URI 參數

回應

安全性

azure_auth

範圍

範例

List capacities by resource group

範例要求

範例回覆

定義

CapacityAdministration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FabricCapacity

FabricCapacityListResult

ProvisioningState

ResourceState

RpSku

RpSkuTier

systemData