Namespaces - CheckName Availability - Check Name Availability

Servicio:

Service Bus

Versión de la API:

2024-01-01

Compruebe la disponibilidad del nombre del espacio de nombres para asignar.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	El nombre para comprobar la disponibilidad del nombre del espacio de nombres y el nombre del espacio de nombres solo puede contener letras, números y guiones. El espacio de nombres debe comenzar con una letra y debe terminar con una letra o un número.

Respuestas

Nombre	Tipo	Description
200 OK	CheckNameAvailabilityResult	compruebe la disponibilidad devuelta correctamente.
Other Status Codes	ErrorResponse	Respuesta de error de ServiceBus que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

NameSpaceCheckNameAvailability

Solicitud de ejemplo

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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
CheckNameAvailability	Descripción de las propiedades de la solicitud de disponibilidad Check Name.
CheckNameAvailabilityResult	Descripción de las propiedades de la solicitud de disponibilidad Check Name.
Error	Objeto de error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error de administración de recursos.
UnavailableReason	Especifica el motivo de la falta de disponibilidad del servicio.

CheckNameAvailability

Object

Descripción de las propiedades de la solicitud de disponibilidad Check Name.

Nombre	Tipo	Description
name	string	El nombre para comprobar la disponibilidad del nombre del espacio de nombres y el nombre del espacio de nombres solo puede contener letras, números y guiones. El espacio de nombres debe comenzar con una letra y debe terminar con una letra o un número.

CheckNameAvailabilityResult

Object

Descripción de las propiedades de la solicitud de disponibilidad Check Name.

Nombre	Tipo	Description
message	string	Información detallada sobre el motivo asociado al espacio de nombres.
nameAvailable	boolean	Valor que indica la disponibilidad del espacio de nombres, true si el espacio de nombres está disponible; de lo contrario, false.
reason	UnavailableReason	Motivo de falta de disponibilidad de un espacio de nombres.

Error

Object

Objeto de error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Object

Respuesta de error de administración de recursos.

Nombre	Tipo	Description
error	Error	Objeto de error.

UnavailableReason

Enumeración

Especifica el motivo de la falta de disponibilidad del servicio.

Valor	Description
InvalidName
NameInLockdown
NameInUse
None
SubscriptionIsDisabled
TooManyNamespaceInCurrentSubscription