Check Name Availability - Check Name Availability

Referensi

Service:: CDN

API Version:: 2024-02-01

Periksa ketersediaan nama sumber daya. Ini diperlukan untuk sumber daya di mana nama unik secara global, seperti titik akhir CDN.

POST https://management.azure.com/providers/Microsoft.Cdn/checkNameAvailability?api-version=2024-02-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2024-02-01.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
name	True	string	Nama sumber daya untuk divalidasi.
type	True	ResourceType	Jenis sumber daya yang namanya akan divalidasi.

Respons

Nama	Jenis	Deskripsi
200 OK	CheckNameAvailabilityOutput	OK. Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan CDN yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

CheckNameAvailability

Sample Request

POST https://management.azure.com/providers/Microsoft.Cdn/checkNameAvailability?api-version=2024-02-01

{
  "name": "sampleName",
  "type": "Microsoft.Cdn/Profiles/Endpoints"
}

package armcdn_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/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CheckNameAvailability.json
func ExampleManagementClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagementClient().CheckNameAvailability(ctx, armcdn.CheckNameAvailabilityInput{
		Name: to.Ptr("sampleName"),
		Type: to.Ptr(armcdn.ResourceTypeMicrosoftCdnProfilesEndpoints),
	}, 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.CheckNameAvailabilityOutput = armcdn.CheckNameAvailabilityOutput{
	// 	Message: to.Ptr("Name not available"),
	// 	NameAvailable: to.Ptr(false),
	// 	Reason: to.Ptr("Name is already in use"),
	// }
}

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

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

/**
 * This sample demonstrates how to Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.
 *
 * @summary Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CheckNameAvailability.json
 */
async function checkNameAvailability() {
  const subscriptionId =
    process.env["CDN_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const checkNameAvailabilityInput = {
    name: "sampleName",
    type: "Microsoft.Cdn/Profiles/Endpoints",
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.checkNameAvailability(checkNameAvailabilityInput);
  console.log(result);
}

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": false,
  "reason": "Name is already in use",
  "message": "Name not available"
}

Definisi

Nama	Deskripsi
CheckNameAvailabilityInput	Input of CheckNameAvailability API.
CheckNameAvailabilityOutput	Output api ketersediaan nama pemeriksaan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
ResourceType	Jenis sumber daya CDN yang digunakan dalam CheckNameAvailability.

CheckNameAvailabilityInput

Input of CheckNameAvailability API.

Nama	Jenis	Deskripsi
name	string	Nama sumber daya untuk divalidasi.
type	ResourceType	Jenis sumber daya yang namanya akan divalidasi.

CheckNameAvailabilityOutput

Output api ketersediaan nama pemeriksaan.

Nama	Jenis	Deskripsi
message	string	Pesan kesalahan terperinci yang menjelaskan mengapa nama tidak tersedia.
nameAvailable	boolean	Menunjukkan apakah nama tersebut tersedia.
reason	string	Alasan mengapa nama tidak tersedia.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ResourceType

Jenis sumber daya CDN yang digunakan dalam CheckNameAvailability.

Nama	Jenis	Deskripsi
Microsoft.Cdn/Profiles/AfdEndpoints	string
Microsoft.Cdn/Profiles/Endpoints	string

Share via