Check Name Availability - Check Name Availability

Dienst:

Data Replication

API-Version:

2021-02-16-preview

Führt die Verfügbarkeitsprüfung des Ressourcennamens aus.
Überprüft die Verfügbarkeit des Ressourcennamens.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
location	path	True	string minLength: 1	Der Name der Azure-Region.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
name	string	Dient zum Abrufen oder Festlegen des Ressourcennamens.
type	string	Dient zum Abrufen oder Festlegen des Ressourcentyps.

Antworten

Name	Typ	Beschreibung
200 OK	CheckNameAvailabilityResponseModel	Erfolg
Other Status Codes	ErrorResponse	Fehler

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CheckNameAvailability

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
CheckNameAvailabilityModel	Überprüfen Des Namensverfügbarkeitsmodells.
CheckNameAvailabilityResponseModel	Überprüfen sie das Antwortmodell für die Namensverfügbarkeit.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort

CheckNameAvailabilityModel

Objekt

Überprüfen Des Namensverfügbarkeitsmodells.

Name	Typ	Beschreibung
name	string	Dient zum Abrufen oder Festlegen des Ressourcennamens.
type	string	Dient zum Abrufen oder Festlegen des Ressourcentyps.

CheckNameAvailabilityResponseModel

Objekt

Überprüfen sie das Antwortmodell für die Namensverfügbarkeit.

Name	Typ	Beschreibung
message	string	Dient zum Abrufen oder Festlegen der Meldung für die Nichtverfügbarkeit des Ressourcennamens.
nameAvailable	boolean	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der Ressourcenname verfügbar ist oder nicht.
reason	string	Dient zum Abrufen oder Festlegen des Grunds für die Nichtverfügbarkeit des Ressourcennamens.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.