Namespaces - CheckName Availability - Check Name Availability

Служба:

Service Bus

Версия API:

2024-01-01

Проверьте доступность имени пространства имен.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Обязательно	Тип	Описание
name	True	string	Имя для проверки доступности имени пространства имен и имя пространства имен может содержать только буквы, цифры и дефисы. Пространство имен должно начинаться с буквы, и оно должно заканчиваться буквой или номером.

Ответы

Имя	Тип	Описание
200 OK	CheckNameAvailabilityResult	Проверка доступности успешно возвращена.
Other Status Codes	ErrorResponse	Ответ об ошибке ServiceBus, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

NameSpaceCheckNameAvailability

Образец запроса

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

Пример ответа

Код состояния:

200

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

Определения

Имя	Описание
CheckNameAvailability	Описание свойств запроса проверки доступности имени.
CheckNameAvailabilityResult	Описание свойств запроса проверки доступности имени.
Error	Объект ошибки.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Ответ об ошибке управления ресурсами.
UnavailableReason	Указывает причину недоступности службы.

CheckNameAvailability

Object

Описание свойств запроса проверки доступности имени.

Имя	Тип	Описание
name	string	Имя для проверки доступности имени пространства имен и имя пространства имен может содержать только буквы, цифры и дефисы. Пространство имен должно начинаться с буквы, и оно должно заканчиваться буквой или номером.

CheckNameAvailabilityResult

Object

Описание свойств запроса проверки доступности имени.

Имя	Тип	Описание
message	string	Подробные сведения о причине, связанной с пространством имен.
nameAvailable	boolean	Значение, указывающее, что пространство имен является доступностью, значение true, если пространство имен доступно; в противном случае значение false.
reason	UnavailableReason	Причина недоступности пространства имен.

Error

Object

Объект ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorResponse[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorResponse

Object

Ответ об ошибке управления ресурсами.

Имя	Тип	Описание
error	Error	Объект ошибки.

UnavailableReason

Перечисление

Указывает причину недоступности службы.

Значение	Описание
InvalidName
NameInLockdown
NameInUse
None
SubscriptionIsDisabled
TooManyNamespaceInCurrentSubscription