Namespaces - CheckName Availability - Check Name Availability

Služba:

Service Bus

Verze rozhraní API:

2024-01-01

Zkontrolujte dostupnost názvu oboru názvů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
name	True	string	Název, který zkontroluje dostupnost názvu oboru názvů a název oboru názvů může obsahovat pouze písmena, číslice a pomlčky. Obor názvů musí začínat písmenem a musí končit písmenem nebo číslicí.

Odpovědi

Name	Typ	Description
200 OK	CheckNameAvailabilityResult	kontrola dostupnosti byla úspěšně vrácena.
Other Status Codes	ErrorResponse	Odpověď na chybu ServiceBus popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

NameSpaceCheckNameAvailability

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
CheckNameAvailability	Popis vlastností žádosti o dostupnost kontroly názvu
CheckNameAvailabilityResult	Popis vlastností žádosti o dostupnost kontroly názvu
Error	Objekt chyby.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu správy prostředků.
UnavailableReason	Určuje důvod nedostupnosti služby.

CheckNameAvailability

Objekt

Popis vlastností žádosti o dostupnost kontroly názvu

Name	Typ	Description
name	string	Název, který zkontroluje dostupnost názvu oboru názvů a název oboru názvů může obsahovat pouze písmena, číslice a pomlčky. Obor názvů musí začínat písmenem a musí končit písmenem nebo číslicí.

CheckNameAvailabilityResult

Objekt

Popis vlastností žádosti o dostupnost kontroly názvu

Name	Typ	Description
message	string	Podrobné informace týkající se důvodu spojeného s oborem názvů.
nameAvailable	boolean	Hodnota indikující dostupnost oboru názvů je true, pokud je obor názvů k dispozici; jinak nepravda.
reason	UnavailableReason	Důvod nedostupnosti oboru názvů

Error

Objekt

Objekt chyby.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorResponse[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorResponse

Objekt

Odpověď na chybu správy prostředků.

Name	Typ	Description
error	Error	Objekt chyby.

UnavailableReason

Výčet

Určuje důvod nedostupnosti služby.

Hodnota	Description
InvalidName
NameInLockdown
NameInUse
None
SubscriptionIsDisabled
TooManyNamespaceInCurrentSubscription