Storage Accounts - Check Name Availability

リファレンス

Service:: Storage Resource Provider

API Version:: 2023-01-01

ストレージアカウント名が有効であり、まだ使用されていないことを確認します。

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

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
name	True	string	ストレージアカウント名。
type	True	Type	リソースの種類である Microsoft.Storage/storageAccounts

応答

名前	型	説明
200 OK	CheckNameAvailabilityResult	OK -- ストレージアカウント名の可用性をチェックする操作が成功しました。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

StorageAccountCheckNameAvailability

Sample Request

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

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


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

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

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

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
}

定義

名前	説明
CheckNameAvailabilityResult	CheckNameAvailability 操作の応答。
Reason	ストレージアカウント名を使用できなかった理由を取得します。 Reason 要素は、NameAvailable が false の場合にのみ返されます。
StorageAccountCheckNameAvailabilityParameters	ストレージアカウント名の可用性をチェックするために使用されるパラメーター。
Type	リソースの種類である Microsoft.Storage/storageAccounts

CheckNameAvailabilityResult

CheckNameAvailability 操作の応答。

名前	型	説明
message	string	Reason 値の詳細を説明するエラーメッセージを取得します。
nameAvailable	boolean	名前を使用できるかどうかを示すブール値を取得します。 true の場合は、名前を使用できます。 false の場合、名前は既に取得されているか、無効であり、使用できません。
reason	Reason	ストレージアカウント名を使用できなかった理由を取得します。 Reason 要素は、NameAvailable が false の場合にのみ返されます。

Reason

ストレージアカウント名を使用できなかった理由を取得します。 Reason 要素は、NameAvailable が false の場合にのみ返されます。

名前	型	説明
AccountNameInvalid	string
AlreadyExists	string

StorageAccountCheckNameAvailabilityParameters

ストレージアカウント名の可用性をチェックするために使用されるパラメーター。

名前	型	説明
name	string	ストレージアカウント名。
type	Type	リソースの種類である Microsoft.Storage/storageAccounts

Type

リソースの種類である Microsoft.Storage/storageAccounts

名前	型	説明
Microsoft.Storage/storageAccounts	string

Storage Accounts - Check Name Availability

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

Scopes

例

StorageAccountCheckNameAvailability

Sample Request

Sample Response

定義

CheckNameAvailabilityResult

Reason

StorageAccountCheckNameAvailabilityParameters

Type

その他のリソース