Namespaces - CheckName Availability - Check Name Availability

Service:

Service Bus

API Version:

2021-11-01

Ellenőrizze a névtérnév rendelkezésre állását.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability?api-version=2021-11-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
name	True	string	A névtérnév rendelkezésre állását ellenőrző Név és A névtér neve csak betűket, számokat és kötőjeleket tartalmazhat. A névtérnek betűvel kell kezdődnie, és betűvel vagy számmal kell végződnie.

Válaszok

Name	Típus	Description
200 OK	CheckNameAvailabilityResult	ellenőrizze, hogy a rendelkezésre állás sikeresen vissza van-e adva.
Other Status Codes	ErrorResponse	ServiceBus-hibaválasz, amely leírja, hogy miért hiúsult meg a művelet.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

NameSpaceCheckNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/providers/Microsoft.ServiceBus/CheckNameAvailability?api-version=2021-11-01

{
  "name": "sdk-Namespace-2924"
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.servicebus.models.CheckNameAvailability;

/** Samples for Namespaces CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/
     * SBNameSpaceCheckNameAvailability.json
     */
    /**
     * Sample code: NameSpaceCheckNameAvailability.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void nameSpaceCheckNameAvailability(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getNamespaces().checkNameAvailabilityWithResponse(
            new CheckNameAvailability().withName("sdk-Namespace-2924"), 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.servicebus import ServiceBusManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicebus
# USAGE
    python sb_name_space_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 = ServiceBusManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.namespaces.check_name_availability(
        parameters={"name": "sdk-Namespace-2924"},
    )
    print(response)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceCheckNameAvailability.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 armservicebus_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/servicebus/armservicebus"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json
func ExampleNamespacesClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armservicebus.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNamespacesClient().CheckNameAvailability(ctx, armservicebus.CheckNameAvailability{
		Name: to.Ptr("sdk-Namespace-2924"),
	}, 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.CheckNameAvailabilityResult = armservicebus.CheckNameAvailabilityResult{
	// 	Message: to.Ptr(""),
	// 	NameAvailable: to.Ptr(true),
	// 	Reason: to.Ptr(armservicebus.UnavailableReasonNone),
	// }
}

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 { ServiceBusManagementClient } = require("@azure/arm-servicebus");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Check the give namespace name availability.
 *
 * @summary Check the give namespace name availability.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json
 */
async function nameSpaceCheckNameAvailability() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const parameters = { name: "sdk-Namespace-2924" };
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.namespaces.checkNameAvailability(parameters);
  console.log(result);
}

nameSpaceCheckNameAvailability().catch(console.error);

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,
  "reason": "None",
  "message": ""
}

Definíciók

Name	Description
CheckNameAvailability	A Név ellenőrzése rendelkezésreállási kérelem tulajdonságainak leírása.
CheckNameAvailabilityResult	A Név ellenőrzése rendelkezésreállási kérelem tulajdonságainak leírása.
Error	A hibaobjektum.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Az erőforrás-kezelési hibaválasz.
UnavailableReason	Megadja a szolgáltatás elérhetetlenségének okát.

CheckNameAvailability

A Név ellenőrzése rendelkezésreállási kérelem tulajdonságainak leírása.

Name	Típus	Description
name	string	A névtérnév rendelkezésre állását ellenőrző Név és A névtér neve csak betűket, számokat és kötőjeleket tartalmazhat. A névtérnek betűvel kell kezdődnie, és betűvel vagy számmal kell végződnie.

CheckNameAvailabilityResult

A Név ellenőrzése rendelkezésreállási kérelem tulajdonságainak leírása.

Name	Típus	Description
message	string	A névtérhez társított ok részletes információja.
nameAvailable	boolean	A névtér rendelkezésre állását jelző érték igaz, ha a névtér elérhető; ellenkező esetben hamis.
reason	UnavailableReason	A névtér elérhetetlenségének oka.

Error

A hibaobjektum.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorResponse

Az erőforrás-kezelési hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

UnavailableReason

Megadja a szolgáltatás elérhetetlenségének okát.

Name	Típus	Description
InvalidName	string
NameInLockdown	string
NameInUse	string
None	string
SubscriptionIsDisabled	string
TooManyNamespaceInCurrentSubscription	string