SignalR - Check Name Availability

Szolgáltatás:

SignalR Service

API-verzió:

2024-03-01

Ellenőrzi, hogy az erőforrás neve érvényes-e, és még nincs használatban.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability?api-version=2024-03-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
location	path	True	string	a régió
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
name	True	string	Az érvényesítendő erőforrás neve. pl. "my-resource-name"
type	True	string	Az erőforrás típusa. Lehet "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" vagy "Microsoft.SignalRService/WebPubSub/replicas"

Válaszok

Name	Típus	Description
200 OK	NameAvailability	Siker. A válasz a név rendelkezésre állását ismerteti.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

SignalR_CheckNameAvailability

Mintakérelem

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/checkNameAvailability?api-version=2024-03-01

{
  "type": "Microsoft.SignalRService/SignalR",
  "name": "mySignalRService"
}

Mintaválasz

Állapotkód:

200

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "The name is already taken. Please try a different name."
}

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
NameAvailability	A név rendelkezésre állásának ellenőrzésére irányuló kérés eredménye. Jelölőt és a hiba lehetséges okát tartalmazza.
NameAvailabilityParameters	A névmegfelelhetőségi műveletre post-edált adatok

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

NameAvailability

Objektum

A név rendelkezésre állásának ellenőrzésére irányuló kérés eredménye. Jelölőt és a hiba lehetséges okát tartalmazza.

Name	Típus	Description
message	string	A művelet üzenete.
nameAvailable	boolean	Azt jelzi, hogy a név elérhető-e vagy sem.
reason	string	A rendelkezésre állás oka. Ha a név nem érhető el, kötelező megadni.

NameAvailabilityParameters

Objektum

A névmegfelelhetőségi műveletre post-edált adatok

Name	Típus	Description
name	string	Az érvényesítendő erőforrás neve. pl. "my-resource-name"
type	string	Az erőforrás típusa. Lehet "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" vagy "Microsoft.SignalRService/WebPubSub/replicas"