Storage Accounts - Check Name Availability

Service:

Storage Resource Provider

API Version:

2023-01-01

Memeriksa apakah nama akun penyimpanan valid dan belum digunakan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
name	True	string	Nama akun penyimpanan.
type	True	Type	Jenis sumber daya, Microsoft.Storage/storageAccounts

Respons

Nama	Jenis	Deskripsi
200 OK	CheckNameAvailabilityResult	OK -- Operasi untuk memeriksa ketersediaan nama akun penyimpanan berhasil.

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

StorageAccountCheckNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Storage/checkNameAvailability?api-version=2023-01-01

{
  "name": "sto3363",
  "type": "Microsoft.Storage/storageAccounts"
}

Java

import com.azure.resourcemanager.storage.models.StorageAccountCheckNameAvailabilityParameters;

/** Samples for StorageAccounts CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/
     * StorageAccountCheckNameAvailability.json
     */
    /**
     * Sample code: StorageAccountCheckNameAvailability.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountCheckNameAvailability(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().checkNameAvailabilityWithResponse(
            new StorageAccountCheckNameAvailabilityParameters().withName("sto3363"), com.azure.core.util.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.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python storage_account_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 = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.storage_accounts.check_name_availability(
        account_name={"name": "sto3363", "type": "Microsoft.Storage/storageAccounts"},
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountCheckNameAvailability.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 armstorage_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/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountCheckNameAvailability.json
func ExampleAccountsClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().CheckNameAvailability(ctx, armstorage.AccountCheckNameAvailabilityParameters{
		Name: to.Ptr("sto3363"),
		Type: to.Ptr("Microsoft.Storage/storageAccounts"),
	}, 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 = armstorage.CheckNameAvailabilityResult{
	// 	NameAvailable: to.Ptr(true),
	// }
}

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 { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Checks that the storage account name is valid and is not already in use.
 *
 * @summary Checks that the storage account name is valid and is not already in use.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountCheckNameAvailability.json
 */
async function storageAccountCheckNameAvailability() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const accountName = {
    name: "sto3363",
    type: "Microsoft.Storage/storageAccounts",
  };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.checkNameAvailability(accountName);
  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": true
}

Definisi

Nama	Deskripsi
CheckNameAvailabilityResult	Respons operasi CheckNameAvailability.
Reason	Mendapatkan alasan bahwa nama akun penyimpanan tidak dapat digunakan. Elemen Reason hanya dikembalikan jika NameAvailable false.
StorageAccountCheckNameAvailabilityParameters	Parameter yang digunakan untuk memeriksa ketersediaan nama akun penyimpanan.
Type	Jenis sumber daya, Microsoft.Storage/storageAccounts

CheckNameAvailabilityResult

Respons operasi CheckNameAvailability.

Nama	Jenis	Deskripsi
message	string	Mendapatkan pesan kesalahan yang menjelaskan nilai Alasan secara lebih rinci.
nameAvailable	boolean	Mendapatkan nilai boolean yang menunjukkan apakah nama tersedia untuk Anda gunakan. Jika true, nama tersedia. Jika false, nama telah diambil atau tidak valid dan tidak dapat digunakan.
reason	Reason	Mendapatkan alasan bahwa nama akun penyimpanan tidak dapat digunakan. Elemen Reason hanya dikembalikan jika NameAvailable false.

Reason

Mendapatkan alasan bahwa nama akun penyimpanan tidak dapat digunakan. Elemen Reason hanya dikembalikan jika NameAvailable false.

Nama	Jenis	Deskripsi
AccountNameInvalid	string
AlreadyExists	string

StorageAccountCheckNameAvailabilityParameters

Parameter yang digunakan untuk memeriksa ketersediaan nama akun penyimpanan.

Nama	Jenis	Deskripsi
name	string	Nama akun penyimpanan.
type	Type	Jenis sumber daya, Microsoft.Storage/storageAccounts

Type

Jenis sumber daya, Microsoft.Storage/storageAccounts

Nama	Jenis	Deskripsi
Microsoft.Storage/storageAccounts	string