Namespaces - CheckName Availability - Check Name Availability

Service:

Service Bus

Version d'API:

2024-01-01

Vérifiez la disponibilité du nom de l’espace de noms.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
name	True	string	Nom permettant de vérifier la disponibilité du nom de l’espace de noms et le nom de l’espace de noms ne peut contenir que des lettres, des chiffres et des traits d’union. L’espace de noms doit commencer par une lettre, et il doit se terminer par une lettre ou un nombre.

Réponses

Nom	Type	Description
200 OK	CheckNameAvailabilityResult	vérifier la disponibilité retournée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur ServiceBus décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

NameSpaceCheckNameAvailability

Exemple de requête

HTTP

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

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ServiceBus.Models;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json
// this example is just showing the usage of "Namespaces_CheckNameAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
ServiceBusNameAvailabilityContent content = new ServiceBusNameAvailabilityContent("sdk-Namespace-2924");
ServiceBusNameAvailabilityResult result = await subscriptionResource.CheckServiceBusNamespaceNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

Exemple de réponse

Code d’état:

200

{
  "nameAvailable": true,
  "reason": "None",
  "message": ""
}

Définitions

Nom	Description
CheckNameAvailability	Description d’une requête de demande de disponibilité Check Name.
CheckNameAvailabilityResult	Description d’une requête de demande de disponibilité Check Name.
Error	Objet d’erreur.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur de gestion des ressources.
UnavailableReason	Spécifie la raison de l’indisponibilité du service.

CheckNameAvailability

Object

Description d’une requête de demande de disponibilité Check Name.

Nom	Type	Description
name	string	Nom permettant de vérifier la disponibilité du nom de l’espace de noms et le nom de l’espace de noms ne peut contenir que des lettres, des chiffres et des traits d’union. L’espace de noms doit commencer par une lettre, et il doit se terminer par une lettre ou un nombre.

CheckNameAvailabilityResult

Object

Description d’une requête de demande de disponibilité Check Name.

Nom	Type	Description
message	string	Informations détaillées concernant la raison associée à l’espace de noms.
nameAvailable	boolean	Valeur indiquant que l’espace de noms est disponible, true si l’espace de noms est disponible ; sinon, false.
reason	UnavailableReason	Raison de l’indisponibilité d’un espace de noms.

Error

Object

Objet d’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorResponse

Object

Réponse d’erreur de gestion des ressources.

Nom	Type	Description
error	Error	Objet d’erreur.

UnavailableReason

Énumération

Spécifie la raison de l’indisponibilité du service.

Valeur	Description
InvalidName
NameInLockdown
NameInUse
None
SubscriptionIsDisabled
TooManyNamespaceInCurrentSubscription