Dela via


Servers - Name Availability - Check Name Availability

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

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/checkNameAvailability?api-version=2014-04-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

Namnet vars tillgänglighet ska kontrolleras.

type True

CheckNameAvailabilityResourceType

Den typ av resurs som används som omfång för tillgänglighetskontrollen.

Svar

Name Typ Description
200 OK

CheckNameAvailabilityResponse

OK

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=2014-04-01

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

Exempelsvar

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

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=2014-04-01

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

Exempelsvar

{
  "name": "server1",
  "available": true,
  "reason": null,
  "message": null
}

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=2014-04-01

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

Exempelsvar

{
  "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 null om namnet är tillgängligt.

CheckNameAvailabilityRequest

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

CheckNameAvailabilityResourceType

Den typ av resurs som används som omfång för tillgänglighetskontrollen.

CheckNameAvailabilityResponse

Ett svar som anger om det angivna namnet för en resurs är tillgängligt.

CheckNameAvailabilityReason

Orsakskoden som förklarar varför namnet inte är tillgängligt. Kommer att vara null 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

Namnet vars tillgänglighet ska kontrolleras.

type

CheckNameAvailabilityResourceType

Den typ av resurs som används som omfång för tillgänglighetskontrollen.

CheckNameAvailabilityResourceType

Den typ av resurs som används som omfång för tillgänglighetskontrollen.

Name Typ Description
Microsoft.Sql/servers

string

CheckNameAvailabilityResponse

Ett svar som anger om det angivna namnet för en resurs är tillgängligt.

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