Namespaces - CheckName Availability - Check Name Availability

Service:

Service Bus

API Version:

2021-11-01

名前空間名の可用性を確認します。

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

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API バージョン。

要求本文

名前	必須	型	説明
name	True	string	名前空間名の可用性をチェックする名前と名前空間名には、文字、数字、ハイフンのみを含めることができます。 名前空間は文字で始まる必要があり、末尾は文字または数字である必要があります。

応答

名前	型	説明
200 OK	CheckNameAvailabilityResult	チェック可用性が正常に返されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する ServiceBus エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

NameSpaceCheckNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/providers/Microsoft.ServiceBus/CheckNameAvailability?api-version=2021-11-01

{
  "name": "sdk-Namespace-2924"
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.servicebus.models.CheckNameAvailability;

/** Samples for Namespaces CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/
     * SBNameSpaceCheckNameAvailability.json
     */
    /**
     * Sample code: NameSpaceCheckNameAvailability.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void nameSpaceCheckNameAvailability(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getNamespaces().checkNameAvailabilityWithResponse(
            new CheckNameAvailability().withName("sdk-Namespace-2924"), Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicebus import ServiceBusManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicebus
# USAGE
    python sb_name_space_check_name_availability.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceBusManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.namespaces.check_name_availability(
        parameters={"name": "sdk-Namespace-2924"},
    )
    print(response)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armservicebus_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/servicebus/armservicebus"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json
func ExampleNamespacesClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armservicebus.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNamespacesClient().CheckNameAvailability(ctx, armservicebus.CheckNameAvailability{
		Name: to.Ptr("sdk-Namespace-2924"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameAvailabilityResult = armservicebus.CheckNameAvailabilityResult{
	// 	Message: to.Ptr(""),
	// 	NameAvailable: to.Ptr(true),
	// 	Reason: to.Ptr(armservicebus.UnavailableReasonNone),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ServiceBusManagementClient } = require("@azure/arm-servicebus");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Check the give namespace name availability.
 *
 * @summary Check the give namespace name availability.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json
 */
async function nameSpaceCheckNameAvailability() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const parameters = { name: "sdk-Namespace-2924" };
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.namespaces.checkNameAvailability(parameters);
  console.log(result);
}

nameSpaceCheckNameAvailability().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

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

定義

名前	説明
CheckNameAvailability	Check Name 可用性要求プロパティの説明。
CheckNameAvailabilityResult	Check Name 可用性要求プロパティの説明。
Error	error オブジェクト。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	リソース管理エラー応答。
UnavailableReason	サービスが利用できない理由を指定します。

CheckNameAvailability

Check Name 可用性要求プロパティの説明。

名前	型	説明
name	string	名前空間名の可用性をチェックする名前と名前空間名には、文字、数字、ハイフンのみを含めることができます。 名前空間は文字で始まる必要があり、末尾は文字または数字である必要があります。

CheckNameAvailabilityResult

Check Name 可用性要求プロパティの説明。

名前	型	説明
message	string	名前空間に関連付けられている理由に関する詳細情報。
nameAvailable	boolean	名前空間が可用性であることを示す値。名前空間が使用可能な場合は true。それ以外の場合は false。
reason	UnavailableReason	名前空間が使用できない理由。

Error

error オブジェクト。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorResponse[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorResponse

リソース管理エラー応答。

名前	型	説明
error	Error	error オブジェクト。

UnavailableReason

サービスが利用できない理由を指定します。

名前	型	説明
InvalidName	string
NameInLockdown	string
NameInUse	string
None	string
SubscriptionIsDisabled	string
TooManyNamespaceInCurrentSubscription	string