Servers - Check Name Availability

Service:

SQL Database

API Version:

2021-11-01

Détermine si une ressource peut être créée avec le nom spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Obligatoire	Type	Description
name	True	string
type	True	CheckNameAvailabilityResourceType

Réponses

Nom	Type	Description
200 OK	CheckNameAvailabilityResponse	La case activée de disponibilité a été terminée.
Other Status Codes		Réponses d’erreur : *** 400 InvalidNameAvailabilityRequest : la demande de disponibilité de nom case activée n’est pas valide. 400 UnknownNameType : type de ressource inconnu spécifié pour une case activée de disponibilité de nom au niveau de l’abonnement.

Exemples

Check for a server name that already exists

Check for a server name that is available

Check for a server name that is invalid

Check for a server name that already exists

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2021-11-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/** Samples for Servers CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * CheckNameAvailabilityServerAlreadyExists.json
     */
    /**
     * Sample code: Check for a server name that already exists.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkForAServerNameThatAlreadyExists(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers()
            .checkNameAvailabilityWithResponse(new CheckNameAvailabilityRequest().withName("server1"), 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

Sample Response

Status code:

200

{
  "name": "server1",
  "available": false,
  "reason": "AlreadyExists",
  "message": "Specified server name is already used"
}

Check for a server name that is available

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2021-11-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/** Samples for Servers CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CheckNameAvailabilityServerAvailable.
     * json
     */
    /**
     * Sample code: Check for a server name that is available.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkForAServerNameThatIsAvailable(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers()
            .checkNameAvailabilityWithResponse(new CheckNameAvailabilityRequest().withName("server1"), 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

Sample Response

Status code:

200

{
  "name": "server1",
  "available": true
}

Check for a server name that is invalid

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2021-11-01

{
  "name": "SERVER1",
  "type": "Microsoft.Sql/servers"
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/** Samples for Servers CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CheckNameAvailabilityServerInvalid.
     * json
     */
    /**
     * Sample code: Check for a server name that is invalid.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkForAServerNameThatIsInvalid(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers()
            .checkNameAvailabilityWithResponse(new CheckNameAvailabilityRequest().withName("SERVER1"), 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

Sample Response

Status code:

200

{
  "name": "SERVER1",
  "available": false,
  "reason": "Invalid",
  "message": "Specified server name contains unsupported characters or is too long. Server name must be no longer than 63 characters long, contain only lower-case characters or digits, cannot contain '.' or '_' characters and can't start or end with '-' character."
}

Définitions

Nom	Description
CheckNameAvailabilityReason	Code de raison expliquant pourquoi le nom n’est pas disponible. Ne sera pas défini si le nom est disponible.
CheckNameAvailabilityRequest	Une demande de case activée si le nom spécifié pour une ressource est disponible.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Résultat d’une case activée de disponibilité de nom.

CheckNameAvailabilityReason

Code de raison expliquant pourquoi le nom n’est pas disponible. Ne sera pas défini si le nom est disponible.

Nom	Type	Description
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

Une demande de case activée si le nom spécifié pour une ressource est disponible.

Nom	Type	Description
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Nom	Type	Description
Microsoft.Sql/servers	string

CheckNameAvailabilityResponse

Résultat d’une case activée de disponibilité de nom.

Nom	Type	Description
available	boolean	True si le nom est disponible, sinon false.
message	string	Message expliquant pourquoi le nom n’est pas disponible. Ne sera pas défini si le nom est disponible.
name	string	Nom dont la disponibilité a été vérifiée.
reason	CheckNameAvailabilityReason	Code de raison expliquant pourquoi le nom n’est pas disponible. Ne sera pas défini si le nom est disponible.