Check Name Availability - Namespaces - Check Name Availability

Service:

Event Hubs

API Version:

2021-11-01

Periksa ketersediaan beri nama Namespace.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/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

Respons

Name	Type	Description
200 OK	CheckNameAvailabilityResult	ketersediaan pemeriksaan berhasil dikembalikan.
Other Status Codes	ErrorResponse	Respons kesalahan Eventhub 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

NamespacesCheckNameAvailability

Sample Request

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.eventhubs.models.CheckNameAvailabilityParameter;

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

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

Go

package armeventhub_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/eventhub/armeventhub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2021-11-01/examples/NameSpaces/EHNameSpaceCheckNameAvailability.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 := armeventhub.NewNamespacesClient("5f750a97-50d9-4e36-8081-c9ee4c0210d4", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CheckNameAvailability(ctx,
		armeventhub.CheckNameAvailabilityParameter{
			Name: to.Ptr("sdk-Namespace-8458"),
		},
		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 { EventHubManagementClient } = require("@azure/arm-eventhub");
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/eventhub/resource-manager/Microsoft.EventHub/stable/2021-11-01/examples/NameSpaces/EHNameSpaceCheckNameAvailability.json
 */
async function namespacesCheckNameAvailability() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const parameters = {
    name: "sdk-Namespace-8458",
  };
  const credential = new DefaultAzureCredential();
  const client = new EventHubManagementClient(credential, subscriptionId);
  const result = await client.namespaces.checkNameAvailability(parameters);
  console.log(result);
}

namespacesCheckNameAvailability().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

CheckNameAvailabilityParameter	Parameter yang disediakan untuk memeriksa operasi ketersediaan nama Namespace
CheckNameAvailabilityResult	Hasil operasi CheckNameAvailability
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan menunjukkan layanan Event Hub tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.
UnavailableReason	Menentukan alasan tidak tersedianya layanan.

CheckNameAvailabilityParameter

Parameter yang disediakan untuk memeriksa operasi ketersediaan nama Namespace

Name	Type	Description
name	string	Nama untuk memeriksa ketersediaan nama namespace

CheckNameAvailabilityResult

Hasil operasi CheckNameAvailability

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

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

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

ErrorDetail

Detail kesalahan.

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

ErrorResponse

Respons kesalahan menunjukkan layanan Event Hub tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Name	Type	Description
error	ErrorDetail	Objek kesalahan.

UnavailableReason

Menentukan alasan tidak tersedianya layanan.

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