Servers - Check Name Availability

Service:

SQL Database

API-versie:

2021-11-01

Bepaalt of een resource kan worden gemaakt met de opgegeven naam.

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

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Aanvraagbody

Name	Vereist	Type	Description
name	True	string
type	True	CheckNameAvailabilityResourceType

Antwoorden

Name	Type	Description
200 OK	CheckNameAvailabilityResponse	De beschikbaarheidscontrole is voltooid.
Other Status Codes		Foutreacties: *** 400 InvalidNameAvailabilityRequest: de aanvraag voor beschikbaarheid van de controlenaam is ongeldig. 400 UnknownNameType - Onbekend resourcetype dat is opgegeven voor de beschikbaarheidscontrole van een naam op abonnementsniveau.

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

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

Check for a server name that is available

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

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

Check for a server name that is invalid

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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."
}

Definities

Name	Description
CheckNameAvailabilityReason	De redencode waarin wordt uitgelegd waarom de naam niet beschikbaar is. Wordt niet gedefinieerd als de naam beschikbaar is.
CheckNameAvailabilityRequest	Een aanvraag om te controleren of de opgegeven naam voor een resource beschikbaar is.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Het resultaat van een controle op de beschikbaarheid van namen.

CheckNameAvailabilityReason

De redencode waarin wordt uitgelegd waarom de naam niet beschikbaar is. Wordt niet gedefinieerd als de naam beschikbaar is.

Name	Type	Description
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

Een aanvraag om te controleren of de opgegeven naam voor een resource beschikbaar is.

Name	Type	Description
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Name	Type	Description
Microsoft.Sql/servers	string

CheckNameAvailabilityResponse

Het resultaat van een controle op de beschikbaarheid van namen.

Name	Type	Description
available	boolean	Waar als de naam beschikbaar is, anders onwaar.
message	string	Een bericht waarin wordt uitgelegd waarom de naam niet beschikbaar is. Wordt niet gedefinieerd als de naam beschikbaar is.
name	string	De naam waarvan de beschikbaarheid is gecontroleerd.
reason	CheckNameAvailabilityReason	De redencode waarin wordt uitgelegd waarom de naam niet beschikbaar is. Wordt niet gedefinieerd als de naam beschikbaar is.