Fabric Capacities - Check Name Availability

Service:

Fabric

API Version:

2023-11-01

Implements local CheckNameAvailability operations

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

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	The name of the Azure region.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
name	string	The name of the resource for which availability needs to be checked.
type	string	The resource type.

Responses

Name	Type	Description
200 OK	CheckNameAvailabilityResponse	The request has succeeded.
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

Check name availability of a capacity

Sample request

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

Sample response

Status code:

200

{
  "nameAvailable": true
}

Definitions

Name	Description
CheckNameAvailabilityReason	The reason why the given name is not available.
CheckNameAvailabilityRequest	The check availability request body.
CheckNameAvailabilityResponse	The check availability result.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

CheckNameAvailabilityReason

The reason why the given name is not available.

Name	Type	Description
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

The check availability request body.

Name	Type	Description
name	string	The name of the resource for which availability needs to be checked.
type	string	The resource type.

CheckNameAvailabilityResponse

The check availability result.

Name	Type	Description
message	string	Detailed reason why the given name is available.
nameAvailable	boolean	Indicates if the resource name is available.
reason	CheckNameAvailabilityReason	The reason why the given name is not available.

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.