Servers - Check Name Availability

Service:

SQL Database

API Version:

2021-11-01

Avgör om en resurs kan skapas med det angivna namnet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Begärandetext

Name	Obligatorisk	Typ	Description
name	True	string
type	True	CheckNameAvailabilityResourceType

Svar

Name	Typ	Description
200 OK	CheckNameAvailabilityResponse	Tillgänglighetskontrollen har slutförts.
Other Status Codes		Felsvar: *** 400 InvalidNameAvailabilityRequest – begäran om tillgänglighet för kontrollnamnet är ogiltig. 400 UnknownNameType – Okänd resurstyp har angetts för en tillgänglighetskontroll för namn på prenumerationsnivå.

Exempel

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

Definitioner

Name	Description
CheckNameAvailabilityReason	Orsakskoden som förklarar varför namnet inte är tillgängligt. Kommer att vara odefinierad om namnet är tillgängligt.
CheckNameAvailabilityRequest	En begäran om att kontrollera om det angivna namnet för en resurs är tillgängligt.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Resultatet av en namntillgänglighetskontroll.

CheckNameAvailabilityReason

Orsakskoden som förklarar varför namnet inte är tillgängligt. Kommer att vara odefinierad om namnet är tillgängligt.

Name	Typ	Description
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

En begäran om att kontrollera om det angivna namnet för en resurs är tillgängligt.

Name	Typ	Description
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Name	Typ	Description
Microsoft.Sql/servers	string

CheckNameAvailabilityResponse

Resultatet av en namntillgänglighetskontroll.

Name	Typ	Description
available	boolean	Sant om namnet är tillgängligt, annars falskt.
message	string	Ett meddelande som förklarar varför namnet inte är tillgängligt. Kommer att vara odefinierad om namnet är tillgängligt.
name	string	Namnet vars tillgänglighet kontrollerades.
reason	CheckNameAvailabilityReason	Orsakskoden som förklarar varför namnet inte är tillgängligt. Kommer att vara odefinierad om namnet är tillgängligt.