Namespaces - Check Name Availability

Service:

Relay

API Version:

2017-04-01

Periksa ketersediaan nama namespace yang ditentukan.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability?api-version=2017-04-01

Parameter URI

Name	In	Required	Type	Description
subscriptionId	path	True	string	Kredensial 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 namespace untuk memeriksa ketersediaan. 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	Periksa ketersediaan yang berhasil dikembalikan.
Other Status Codes	ErrorResponse	Respons kesalahan relai 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

RelayCheckNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.Relay/checkNameAvailability?api-version=2017-04-01

{
  "name": "sdk-Namespace1321"
}

Java

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

/** Samples for Namespaces CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/NameSpaces/RelayNameSpaceCheckNameAvailability.json
     */
    /**
     * Sample code: RelayCheckNameAvailability.
     *
     * @param manager Entry point to RelayManager.
     */
    public static void relayCheckNameAvailability(com.azure.resourcemanager.relay.RelayManager manager) {
        manager
            .namespaces()
            .checkNameAvailabilityWithResponse(new CheckNameAvailability().withName("sdk-Namespace1321"), Context.NONE);
    }
}

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

Go

package armrelay_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/relay/armrelay"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/NameSpaces/RelayNameSpaceCheckNameAvailability.json
func ExampleNamespacesClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armrelay.NewNamespacesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.CheckNameAvailability(ctx,
		armrelay.CheckNameAvailability{
			Name: to.Ptr("<name>"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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

JavaScript

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

/**
 * This sample demonstrates how to Check the specified namespace name availability.
 *
 * @summary Check the specified namespace name availability.
 * x-ms-original-file: specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/NameSpaces/RelayNameSpaceCheckNameAvailability.json
 */
async function relayCheckNameAvailability() {
  const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const parameters = { name: "sdk-Namespace1321" };
  const credential = new DefaultAzureCredential();
  const client = new RelayAPI(credential, subscriptionId);
  const result = await client.namespaces.checkNameAvailability(parameters);
  console.log(result);
}

relayCheckNameAvailability().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 nama pemeriksaan.
CheckNameAvailabilityResult	Deskripsi properti permintaan ketersediaan nama pemeriksaan.
ErrorResponse	Respons kesalahan menunjukkan layanan Relay tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.
UnavailableReason	Menentukan alasan tidak tersedianya layanan.

CheckNameAvailability

Deskripsi properti permintaan ketersediaan nama pemeriksaan.

Name	Type	Description
name	string	Nama namespace untuk memeriksa ketersediaan. 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 nama pemeriksaan.

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

ErrorResponse

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

Name	Type	Description
code	string	Kode Kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

UnavailableReason

Menentukan alasan tidak tersedianya layanan.

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