Web Pub Sub - Check Name Availability
Zkontroluje, jestli je název prostředku platný a že se ještě nepoužívá.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability?api-version=2024-03-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
location
|
path | True |
string |
oblast |
subscription
|
path | True |
string uuid |
ID cílového předplatného. Hodnota musí být UUID. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
name | True |
string |
Název prostředku, který se má ověřit. například my-resource-name |
type | True |
string |
Typ prostředku. Může to být Microsoft.SignalRService/SignalR, Microsoft.SignalRService/WebPubSub, Microsoft.SignalRService/SignalR/replicas nebo Microsoft.SignalRService/WebPubSub/replicas. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Úspěch. Odpověď popisuje dostupnost názvu. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
WebPubSub_CheckNameAvailability
Ukázkový požadavek
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/WebPubSub",
"name": "myWebPubSubService"
}
Ukázková odpověď
{
"nameAvailable": false,
"reason": "AlreadyExists",
"message": "The name is already taken. Please try a different name."
}
Definice
Name | Description |
---|---|
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě. |
Error |
Odpověď na chybu |
Name |
Výsledek žádosti o kontrolu dostupnosti názvu Obsahuje příznak a možný důvod selhání. |
Name |
Data posted to the nameAvailability action |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Další typ informací. |
ErrorDetail
Podrobnosti o chybě.
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Odpověď na chybu
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
NameAvailability
Výsledek žádosti o kontrolu dostupnosti názvu Obsahuje příznak a možný důvod selhání.
Name | Typ | Description |
---|---|---|
message |
string |
Zpráva operace. |
nameAvailable |
boolean |
Určuje, jestli je název dostupný nebo ne. |
reason |
string |
Důvod dostupnosti. Povinný argument, pokud název není k dispozici. |
NameAvailabilityParameters
Data posted to the nameAvailability action
Name | Typ | Description |
---|---|---|
name |
string |
Název prostředku, který se má ověřit. například my-resource-name |
type |
string |
Typ prostředku. Může to být Microsoft.SignalRService/SignalR, Microsoft.SignalRService/WebPubSub, Microsoft.SignalRService/SignalR/replicas nebo Microsoft.SignalRService/WebPubSub/replicas. |