Namespaces - CheckName Availability - Check Name Availability

Service:

Service Bus

API Version:

2021-11-01

Periksa ketersediaan nama namespace layanan pemberian.

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

Parameter URI

Name	In	Required	Type	Description
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API klien.

Isi Permintaan

Name	Required	Type	Description
name	True	string	Nama untuk memeriksa ketersediaan nama namespace dan Nama namespace hanya boleh berisi huruf, angka, dan tanda hubung. Namespace harus dimulai dengan huruf, dan harus diakhir dengan huruf atau angka.

Respons

Name	Type	Description
200 OK	CheckNameAvailabilityResult	ketersediaan pemeriksaan berhasil dikembalikan.
Other Status Codes	ErrorResponse	Respons kesalahan ServiceBus yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

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"
}

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/tree/main/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()
	client, err := armservicebus.NewNamespacesClient("5f750a97-50d9-4e36-8081-c9ee4c0210d4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CheckNameAvailability(ctx,
		armservicebus.CheckNameAvailability{
			Name: to.Ptr("sdk-Namespace-2924"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

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

Definisi

CheckNameAvailability	Deskripsi properti permintaan ketersediaan Periksa Nama.
CheckNameAvailabilityResult	Deskripsi properti permintaan ketersediaan Periksa Nama.
Error	Objek kesalahan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorResponse	Respons kesalahan manajemen sumber daya.
UnavailableReason	Menentukan alasan tidak tersedianya layanan.

CheckNameAvailability

Deskripsi properti permintaan ketersediaan Periksa Nama.

Name	Type	Description
name	string	Nama untuk memeriksa ketersediaan nama namespace dan Nama namespace hanya boleh berisi huruf, angka, dan tanda hubung. Namespace harus dimulai dengan huruf, dan harus diakhir dengan huruf atau angka.

CheckNameAvailabilityResult

Deskripsi properti permintaan ketersediaan Periksa Nama.

Name	Type	Description
message	string	Info terperinci mengenai alasan yang terkait dengan namespace layanan.
nameAvailable	boolean	Nilai yang menunjukkan namespace adalah ketersediaan, benar jika namespace tersedia; jika tidak, salah.
reason	UnavailableReason	Alasan tidak tersedianya namespace.

Error

Objek kesalahan.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorResponse[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Name	Type	Description
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorResponse

Respons kesalahan manajemen sumber daya.

Name	Type	Description
error	Error	Objek kesalahan.

UnavailableReason

Menentukan alasan tidak tersedianya layanan.

Name	Type	Description
InvalidName	string
NameInLockdown	string
NameInUse	string
None	string
SubscriptionIsDisabled	string
TooManyNamespaceInCurrentSubscription	string