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 매개 변수

Name	In(다음 안에)	필수	형식	Description
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	필수	형식	Description
name	True	string	네임스페이스 이름 가용성을 확인할 이름 및 네임스페이스 이름에는 문자, 숫자 및 하이픈만 포함될 수 있습니다. 네임스페이스는 문자로 시작해야 하며 문자 또는 숫자로 끝나야 합니다.

응답

Name	형식	Description
200 OK	CheckNameAvailabilityResult	성공적으로 반환된 가용성을 확인합니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 ServiceBus 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
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": ""
}

정의

Name	Description
CheckNameAvailability	Check Name 가용성 요청 속성에 대한 설명입니다.
CheckNameAvailabilityResult	Check Name 가용성 요청 속성에 대한 설명입니다.
Error	오류 개체입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorResponse	리소스 관리 오류 응답입니다.
UnavailableReason	서비스를 사용할 수 없는 이유를 지정합니다.

CheckNameAvailability

Object

Check Name 가용성 요청 속성에 대한 설명입니다.

Name	형식	Description
name	string	네임스페이스 이름 가용성을 확인할 이름 및 네임스페이스 이름에는 문자, 숫자 및 하이픈만 포함될 수 있습니다. 네임스페이스는 문자로 시작해야 하며 문자 또는 숫자로 끝나야 합니다.

CheckNameAvailabilityResult

Object

Check Name 가용성 요청 속성에 대한 설명입니다.

Name	형식	Description
message	string	네임스페이스와 관련된 이유에 대한 자세한 정보입니다.
nameAvailable	boolean	네임스페이스를 사용할 수 있는 경우 네임스페이스가 가용성임을 나타내는 값입니다. 그렇지 않으면 false입니다.
reason	UnavailableReason	네임스페이스를 사용할 수 없는 이유입니다.

Error

Object

오류 개체입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorResponse[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorResponse

Object

리소스 관리 오류 응답입니다.

Name	형식	Description
error	Error	오류 개체입니다.

UnavailableReason

열거형

서비스를 사용할 수 없는 이유를 지정합니다.

값	Description
InvalidName
NameInLockdown
NameInUse
None
SubscriptionIsDisabled
TooManyNamespaceInCurrentSubscription