Servers - Check Name Availability

Tjänst:

SQL Database

API-version:

2023-08-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=2023-08-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	ErrorResponse	Felsvar: *** 400 InvalidNameAvailabilityRequest – begäran om tillgänglighet för kontrollnamn är ogiltig. 400 UnknownNameType – Okänd resurstyp som angetts för en tillgänglighetskontroll för 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

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

200

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

Check for a server name that is available

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

200

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

Check for a server name that is invalid

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

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 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	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
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
AlreadyExists
Invalid

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

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

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

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

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.