Fabric Capacities - Check Name Availability

服務:

Fabric

API 版本:

2023-11-01

實作本機 CheckNameAvailability 作業

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Fabric/locations/{location}/checkNameAvailability?api-version=2023-11-01

URI 參數

名稱	位於	必要	類型	Description
location	path	True	string minLength: 1	Azure 區域的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
name	string	需要檢查可用性的資源名稱。
type	string	資源類型。

回應

名稱	類型	Description
200 OK	CheckNameAvailabilityResponse	要求已成功。
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	模擬您的用戶帳戶

範例

Check name availability of a capacity

範例要求

HTTP

POST https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/checkNameAvailability?api-version=2023-11-01

{
  "name": "azsdktest",
  "type": "Microsoft.Fabric/capacities"
}

Java

import com.azure.resourcemanager.fabric.models.CheckNameAvailabilityRequest;

/**
 * Samples for FabricCapacities CheckNameAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: 2023-11-01/FabricCapacities_CheckNameAvailability.json
     */
    /**
     * Sample code: Check name availability of a capacity.
     * 
     * @param manager Entry point to FabricManager.
     */
    public static void checkNameAvailabilityOfACapacity(com.azure.resourcemanager.fabric.FabricManager manager) {
        manager.fabricCapacities().checkNameAvailabilityWithResponse("westcentralus",
            new CheckNameAvailabilityRequest().withName("azsdktest").withType("Microsoft.Fabric/capacities"),
            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

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_check_name_availability.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.check_name_availability(
        location="westcentralus",
        body={"name": "azsdktest", "type": "Microsoft.Fabric/capacities"},
    )
    print(response)


# x-ms-original-file: 2023-11-01/FabricCapacities_CheckNameAvailability.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_CheckNameAvailability.json
func ExampleCapacitiesClient_CheckNameAvailability() {
	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)
	}
	res, err := clientFactory.NewCapacitiesClient().CheckNameAvailability(ctx, "westcentralus", armfabric.CheckNameAvailabilityRequest{
		Name: to.Ptr("azsdktest"),
		Type: to.Ptr("Microsoft.Fabric/capacities"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.CapacitiesClientCheckNameAvailabilityResponse{
	// 	CheckNameAvailabilityResponse: &armfabric.CheckNameAvailabilityResponse{
	// 		NameAvailable: to.Ptr(true),
	// 	},
	// }
}

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 implements local CheckNameAvailability operations
 *
 * @summary implements local CheckNameAvailability operations
 * x-ms-original-file: 2023-11-01/FabricCapacities_CheckNameAvailability.json
 */
async function checkNameAvailabilityOfACapacity() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "548B7FB7-3B2A-4F46-BB02-66473F1FC22C";
  const client = new FabricClient(credential, subscriptionId);
  const result = await client.fabricCapacities.checkNameAvailability("westcentralus", {
    name: "azsdktest",
    type: "Microsoft.Fabric/capacities",
  });
  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

範例回覆

狀態碼:

200

{
  "nameAvailable": true
}

定義

名稱	Description
CheckNameAvailabilityReason	指定名稱無法使用的原因。
CheckNameAvailabilityRequest	檢查可用性要求本文。
CheckNameAvailabilityResponse	檢查可用性結果。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應

CheckNameAvailabilityReason

列舉型別

指定名稱無法使用的原因。

值	Description
AlreadyExists
Invalid

CheckNameAvailabilityRequest

Object

檢查可用性要求本文。

名稱	類型	Description
name	string	需要檢查可用性的資源名稱。
type	string	資源類型。

CheckNameAvailabilityResponse

Object

檢查可用性結果。

名稱	類型	Description
message	string	提供指定名稱的詳細原因。
nameAvailable	boolean	指出資源名稱是否可用。
reason	CheckNameAvailabilityReason	指定名稱無法使用的原因。

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 物件。