Dela via

Web Pub Sub - Check Name Availability

Tjänst:
Azure Web PubSub Service
API-version:
2024-03-01

Kontrollerar att resursnamnet är giltigt och inte redan används.

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

URI-parametrar

Name I Obligatorisk Typ Description
location
 path True

string

regionen
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

Resursnamnet som ska verifieras. t.ex. "my-resource-name"
type True

string

Resurstypen. Kan vara "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" eller "Microsoft.SignalRService/WebPubSub/replicas"

Svar

Name Typ Description
200 OK

NameAvailability

Framgång. Svaret beskriver namntillgängligheten.
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

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

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

WebPubSub_CheckNameAvailability

Exempelbegäran

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"
}

Exempelsvar

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

Definitioner

Name Description
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
NameAvailability

Resultatet av begäran om att kontrollera namntillgängligheten. Den innehåller en flagga och en möjlig orsak till felet.
NameAvailabilityParameters

Post-ed-data till åtgärden nameAvailability

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.

NameAvailability

Objekt

Resultatet av begäran om att kontrollera namntillgängligheten. Den innehåller en flagga och en möjlig orsak till felet.

Name Typ Description
message

string

Meddelandet om åtgärden.
nameAvailable

boolean

Anger om namnet är tillgängligt eller inte.
reason

string

Orsaken till tillgängligheten. Krävs om namnet inte är tillgängligt.

NameAvailabilityParameters

Objekt

Post-ed-data till åtgärden nameAvailability

Name Typ Description
name

string

Resursnamnet som ska verifieras. t.ex. "my-resource-name"
type

string

Resurstypen. Kan vara "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" eller "Microsoft.SignalRService/WebPubSub/replicas"