Servers - Check Name Availability

Tjänst:: SQL Database

API-version:: 2025-01-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=2025-01-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
name	True	string
type	True	CheckNameAvailabilityResourceType

Svar

Name	Typ	Description
200 OK	CheckNameAvailabilityResponse	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

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

Exempelbegäran

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

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


import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/**
 * Samples for Servers CheckNameAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/CheckNameAvailabilityServerAlreadyExists.json
     */
    /**
     * Sample code: Check for a server name that already exists.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void checkForAServerNameThatAlreadyExists(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getServers().checkNameAvailabilityWithResponse(
            new CheckNameAvailabilityRequest().withName("server1"), 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python check_name_availability_server_already_exists.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 = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.servers.check_name_availability(
        parameters={"name": "server1", "type": "Microsoft.Sql/servers"},
    )
    print(response)


# x-ms-original-file: 2025-01-01/CheckNameAvailabilityServerAlreadyExists.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

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to determines whether a resource can be created with the specified name.
 *
 * @summary determines whether a resource can be created with the specified name.
 * x-ms-original-file: 2025-01-01/CheckNameAvailabilityServerAlreadyExists.json
 */
async function checkForAServerNameThatAlreadyExists() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.servers.checkNameAvailability({
    name: "server1",
    type: "Microsoft.Sql/servers",
  });
  console.log(result);
}

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

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/CheckNameAvailabilityServerAlreadyExists.json
// this example is just showing the usage of "Servers_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 = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SqlNameAvailabilityContent content = new SqlNameAvailabilityContent("server1");
SqlNameAvailabilityResponse result = await subscriptionResource.CheckSqlServerNameAvailabilityAsync(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

Exempelsvar

Statuskod:: 200

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

Check for a server name that is available

Exempelbegäran

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

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


import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/**
 * Samples for Servers CheckNameAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/CheckNameAvailabilityServerAvailable.json
     */
    /**
     * Sample code: Check for a server name that is available.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void checkForAServerNameThatIsAvailable(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getServers().checkNameAvailabilityWithResponse(
            new CheckNameAvailabilityRequest().withName("server1"), 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python check_name_availability_server_available.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 = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.servers.check_name_availability(
        parameters={"name": "server1", "type": "Microsoft.Sql/servers"},
    )
    print(response)


# x-ms-original-file: 2025-01-01/CheckNameAvailabilityServerAvailable.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

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to determines whether a resource can be created with the specified name.
 *
 * @summary determines whether a resource can be created with the specified name.
 * x-ms-original-file: 2025-01-01/CheckNameAvailabilityServerAvailable.json
 */
async function checkForAServerNameThatIsAvailable() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.servers.checkNameAvailability({
    name: "server1",
    type: "Microsoft.Sql/servers",
  });
  console.log(result);
}

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

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/CheckNameAvailabilityServerAvailable.json
// this example is just showing the usage of "Servers_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 = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SqlNameAvailabilityContent content = new SqlNameAvailabilityContent("server1");
SqlNameAvailabilityResponse result = await subscriptionResource.CheckSqlServerNameAvailabilityAsync(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

Exempelsvar

Statuskod:: 200

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

Check for a server name that is invalid

Exempelbegäran

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

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


import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/**
 * Samples for Servers CheckNameAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/CheckNameAvailabilityServerInvalid.json
     */
    /**
     * Sample code: Check for a server name that is invalid.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void checkForAServerNameThatIsInvalid(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getServers().checkNameAvailabilityWithResponse(
            new CheckNameAvailabilityRequest().withName("SERVER1"), 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python check_name_availability_server_invalid.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 = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.servers.check_name_availability(
        parameters={"name": "SERVER1", "type": "Microsoft.Sql/servers"},
    )
    print(response)


# x-ms-original-file: 2025-01-01/CheckNameAvailabilityServerInvalid.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

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to determines whether a resource can be created with the specified name.
 *
 * @summary determines whether a resource can be created with the specified name.
 * x-ms-original-file: 2025-01-01/CheckNameAvailabilityServerInvalid.json
 */
async function checkForAServerNameThatIsInvalid() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.servers.checkNameAvailability({
    name: "SERVER1",
    type: "Microsoft.Sql/servers",
  });
  console.log(result);
}

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

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/CheckNameAvailabilityServerInvalid.json
// this example is just showing the usage of "Servers_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 = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SqlNameAvailabilityContent content = new SqlNameAvailabilityContent("SERVER1");
SqlNameAvailabilityResponse result = await subscriptionResource.CheckSqlServerNameAvailabilityAsync(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

Exempelsvar

Statuskod:: 200

{
  "name": "SERVER1",
  "available": false,
  "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.",
  "reason": "Invalid"
}

Definitioner

Name	Description
CheckNameAvailabilityReason	Orsakskoden som förklarar varför namnet inte är tillgängligt. Kommer att vara odefinierat om namnet är tillgängligt.
CheckNameAvailabilityRequest	En begäran om att kontrollera om det angivna namnet på en resurs är tillgängligt.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Resultatet av en namntillgänglighetskontroll.
ErrorAdditionalInfo	Resurshanteringsfelet ytterligare information.
ErrorDetail	Detaljerna om felet.
ErrorResponse	Felsvar

CheckNameAvailabilityReason

Uppräkning

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

Värde	Description
Invalid	Ogiltig
AlreadyExists	AlreadyExists

CheckNameAvailabilityRequest

Objekt

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

Name	Typ	Description
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Uppräkning

Värde	Description
Microsoft.Sql/servers	Microsoft. SQL/servrar

CheckNameAvailabilityResponse

Objekt

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 odefinierat 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 odefinierat om namnet är tillgängligt.

ErrorAdditionalInfo

Objekt

Resurshanteringsfelet ytterligare information.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Detaljerna om felet.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felet objektet.