Namespaces - Check Name Availability

Dienst:

Relay

API-Version:

2024-01-01

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

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
parameters	CheckNameAvailability	Parameter zum Überprüfen der Verfügbarkeit des angegebenen Namespacenamens.

Antworten

Name	Typ	Beschreibung
200 OK	CheckNameAvailabilityResult	Überprüfen Sie die Verfügbarkeit, die erfolgreich zurückgegeben wurde.
Other Status Codes	ErrorResponse	Relayfehlerantwort, 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

RelayCheckNameAvailability

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.Relay/checkNameAvailability?api-version=2024-01-01

{
  "name": "example-RelayNamespace1321"
}

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
CheckNameAvailability	Parameter zum Überprüfen der Verfügbarkeit des angegebenen Namespacenamens.
CheckNameAvailabilityResult	Beschreibung der Eigenschaften der Überprüfungsnamenverfügbarkeitsanforderung.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
UnavailableReason	Der Grund für die Nichtverfügbarkeit eines Namespaces.

CheckNameAvailability

Objekt

Parameter zum Überprüfen der Verfügbarkeit des angegebenen Namespacenamens.

Name	Typ	Beschreibung
name	string	Der Namespacename, der auf Verfügbarkeit überprüft werden soll. 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 Überprüfungsnamenverfügbarkeitsanforderung.

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. Gibt true zurück, wenn der Namespace verfügbar ist; andernfalls "false".
reason	UnavailableReason	Der Grund für die Nichtverfügbarkeit eines Namespaces.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

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

ErrorDetail

Objekt

Das Fehlerdetails.

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

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

UnavailableReason

Enumeration

Der Grund für die Nichtverfügbarkeit eines Namespaces.

Wert	Beschreibung
InvalidName
NameInLockdown
NameInUse
None
SubscriptionIsDisabled
TooManyNamespaceInCurrentSubscription