Namespaces - CheckName Availability - Check Name Availability

Dienst:

Service Bus

API-Version:

2024-01-01

Überprüfen Sie die Verfügbarkeit des Namespacenamens.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Der Name, um die Verfügbarkeit des Namespacenamens zu überprüfen, und der Namespacename darf nur Buchstaben, Zahlen und Bindestriche enthalten. Der Namespace muss mit einem Buchstaben beginnen und muss mit einem Buchstaben oder einer Zahl enden.

Antworten

Name	Typ	Beschreibung
200 OK	CheckNameAvailabilityResult	Die Verfügbarkeit wurde erfolgreich überprüft.
Other Status Codes	ErrorResponse	ServiceBus-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

NameSpaceCheckNameAvailability

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
CheckNameAvailability	Beschreibung der Eigenschaften der Verfügbarkeitsanforderung "Überprüfen".
CheckNameAvailabilityResult	Beschreibung der Eigenschaften der Verfügbarkeitsanforderung "Überprüfen".
Error	Das Fehlerobjekt.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Die Fehlerantwort für die Ressourcenverwaltung.
UnavailableReason	Gibt den Grund für die Nichtverfügbarkeit des Diensts an.

CheckNameAvailability

Objekt

Beschreibung der Eigenschaften der Verfügbarkeitsanforderung "Überprüfen".

Name	Typ	Beschreibung
name	string	Der Name, um die Verfügbarkeit des Namespacenamens zu überprüfen, und der Namespacename darf nur Buchstaben, Zahlen und Bindestriche enthalten. Der Namespace muss mit einem Buchstaben beginnen und muss mit einem Buchstaben oder einer Zahl enden.

CheckNameAvailabilityResult

Objekt

Beschreibung der Eigenschaften der Verfügbarkeitsanforderung "Überprüfen".

Name	Typ	Beschreibung
message	string	Die detaillierten Informationen zu dem Grund, der dem Namespace zugeordnet ist.
nameAvailable	boolean	Wert, der angibt, dass namespace verfügbar ist, true, wenn der Namespace verfügbar ist; andernfalls "false".
reason	UnavailableReason	Der Grund für die Nichtverfügbarkeit eines Namespaces.

Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Objekt

Die Fehlerantwort für die Ressourcenverwaltung.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

UnavailableReason

Enumeration

Gibt den Grund für die Nichtverfügbarkeit des Diensts an.

Wert	Beschreibung
InvalidName
NameInLockdown
NameInUse
None
SubscriptionIsDisabled
TooManyNamespaceInCurrentSubscription