Check Name Availability - Check Name Availability

Serviço:

Data Replication

Versão da API:

2021-02-16-preview

Executa a verificação de disponibilidade do nome do recurso.
Verifica a disponibilidade do nome do recurso.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DataReplication/locations/{location}/checkNameAvailability?api-version=2021-02-16-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
location	path	True	string minLength: 1	O nome da região do Azure.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
name	string	Obtém ou define o nome do recurso.
type	string	Obtém ou define o tipo de recurso.

Respostas

Nome	Tipo	Description
200 OK	CheckNameAvailabilityResponseModel	Êxito
Other Status Codes	ErrorResponse	Erro

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

CheckNameAvailability

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/930CEC23-4430-4513-B855-DBA237E2F3BF/providers/Microsoft.DataReplication/locations/trfqtbtmusswpibw/checkNameAvailability?api-version=2021-02-16-preview

{
  "name": "updkdcixs",
  "type": "gngmcancdauwhdixjjvqnfkvqc"
}

Java

import com.azure.resourcemanager.recoveryservicesdatareplication.models.CheckNameAvailabilityModel;

/**
 * Samples for ResourceProvider CheckNameAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/preview/2021-02-16-
     * preview/examples/CheckNameAvailability.json
     */
    /**
     * Sample code: CheckNameAvailability.
     * 
     * @param manager Entry point to RecoveryServicesDataReplicationManager.
     */
    public static void checkNameAvailability(
        com.azure.resourcemanager.recoveryservicesdatareplication.RecoveryServicesDataReplicationManager manager) {
        manager.resourceProviders().checkNameAvailabilityWithResponse("trfqtbtmusswpibw",
            new CheckNameAvailabilityModel().withName("updkdcixs").withType("gngmcancdauwhdixjjvqnfkvqc"),
            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.recoveryservicesdatareplication import RecoveryServicesDataReplicationMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesdatareplication
# USAGE
    python 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 = RecoveryServicesDataReplicationMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="930CEC23-4430-4513-B855-DBA237E2F3BF",
    )

    response = client.check_name_availability(
        location="trfqtbtmusswpibw",
    )
    print(response)


# x-ms-original-file: specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/preview/2021-02-16-preview/examples/CheckNameAvailability.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 armrecoveryservicesdatareplication_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/recoveryservicesdatareplication/armrecoveryservicesdatareplication"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/3066a973f4baf2e2bf072a013b585a820bb10146/specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/preview/2021-02-16-preview/examples/CheckNameAvailability.json
func ExampleAzureSiteRecoveryManagementServiceAPIClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesdatareplication.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAzureSiteRecoveryManagementServiceAPIClient().CheckNameAvailability(ctx, "trfqtbtmusswpibw", &armrecoveryservicesdatareplication.AzureSiteRecoveryManagementServiceAPIClientCheckNameAvailabilityOptions{Body: &armrecoveryservicesdatareplication.CheckNameAvailabilityModel{
		Name: to.Ptr("updkdcixs"),
		Type: to.Ptr("gngmcancdauwhdixjjvqnfkvqc"),
	},
	})
	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.CheckNameAvailabilityResponseModel = armrecoveryservicesdatareplication.CheckNameAvailabilityResponseModel{
	// 	Message: to.Ptr("gddmrunlrhtuhm"),
	// 	NameAvailable: to.Ptr(true),
	// 	Reason: to.Ptr("wwbvswyrmghbmv"),
	// }
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.RecoveryServicesDataReplication.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.RecoveryServicesDataReplication;

// Generated from example definition: specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/preview/2021-02-16-preview/examples/CheckNameAvailability.json
// this example is just showing the usage of "CheckNameAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "930CEC23-4430-4513-B855-DBA237E2F3BF";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("trfqtbtmusswpibw");
DataReplicationNameAvailabilityContent content = new DataReplicationNameAvailabilityContent
{
    Name = "updkdcixs",
    ResourceType = new ResourceType("gngmcancdauwhdixjjvqnfkvqc"),
};
DataReplicationNameAvailabilityResult result = await subscriptionResource.CheckDataReplicationNameAvailabilityAsync(location, content: content);

Console.WriteLine($"Succeeded: {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 de exemplo

Código de status:

200

{
  "nameAvailable": true,
  "reason": "wwbvswyrmghbmv",
  "message": "gddmrunlrhtuhm"
}

Definições

Nome	Description
CheckNameAvailabilityModel	Verifique o modelo de disponibilidade do nome.
CheckNameAvailabilityResponseModel	Verifique o modelo de resposta de disponibilidade do nome.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

CheckNameAvailabilityModel

Objeto

Verifique o modelo de disponibilidade do nome.

Nome	Tipo	Description
name	string	Obtém ou define o nome do recurso.
type	string	Obtém ou define o tipo de recurso.

CheckNameAvailabilityResponseModel

Objeto

Verifique o modelo de resposta de disponibilidade do nome.

Nome	Tipo	Description
message	string	Obtém ou define a mensagem para indisponibilidade do nome do recurso.
nameAvailable	boolean	Obtém ou define um valor que indica se o nome do recurso está disponível ou não.
reason	string	Obtém ou define o motivo da indisponibilidade do nome do recurso.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.