Storage Accounts - Check Name Availability

Referência

Serviço:: Storage Resource Provider

Versão da API:: 2023-05-01

Verifica se o nome da conta de armazenamento é válido e ainda não está em uso.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
name	True	string	O nome da conta de armazenamento.
type	True	Type	O tipo de recurso, Microsoft.Storage/storageAccounts

Respostas

Name	Tipo	Description
200 OK	CheckNameAvailabilityResult	OK -- A operação para verificar a disponibilidade do nome da conta de armazenamento foi bem-sucedida.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

StorageAccountCheckNameAvailability

Pedido de amostra

POST https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Storage/checkNameAvailability?api-version=2023-05-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-05-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 typing import Any, IO, Union

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-05-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/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-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-05-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

Resposta da amostra

Código de estado:: 200

{
  "nameAvailable": true
}

Definições

Name	Description
CheckNameAvailabilityResult	A resposta da operação CheckNameAvailability.
Reason	Obtém o motivo pelo qual um nome de conta de armazenamento não pôde ser usado. O elemento Reason só será retornado se NameAvailable for false.
StorageAccountCheckNameAvailabilityParameters	Os parâmetros usados para verificar a disponibilidade do nome da conta de armazenamento.
Type	O tipo de recurso, Microsoft.Storage/storageAccounts

CheckNameAvailabilityResult

A resposta da operação CheckNameAvailability.

Name	Tipo	Description
message	string	Obtém uma mensagem de erro explicando o valor Reason com mais detalhes.
nameAvailable	boolean	Obtém um valor booleano que indica se o nome está disponível para uso. Se verdadeiro, o nome está disponível. Se falso, o nome já foi retirado ou é inválido e não pode ser usado.
reason	Reason	Obtém o motivo pelo qual um nome de conta de armazenamento não pôde ser usado. O elemento Reason só será retornado se NameAvailable for false.

Reason

Obtém o motivo pelo qual um nome de conta de armazenamento não pôde ser usado. O elemento Reason só será retornado se NameAvailable for false.

Name	Tipo	Description
AccountNameInvalid	string
AlreadyExists	string

StorageAccountCheckNameAvailabilityParameters

Os parâmetros usados para verificar a disponibilidade do nome da conta de armazenamento.

Name	Tipo	Description
name	string	O nome da conta de armazenamento.
type	Type	O tipo de recurso, Microsoft.Storage/storageAccounts

Type

O tipo de recurso, Microsoft.Storage/storageAccounts

Name	Tipo	Description
Microsoft.Storage/storageAccounts	string

Partilhar via

Storage Accounts - Check Name Availability

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

StorageAccountCheckNameAvailability

Pedido de amostra

Resposta da amostra

Definições

CheckNameAvailabilityResult

Reason

StorageAccountCheckNameAvailabilityParameters

Type

Recursos adicionais