Dela via

Apps - Check Name Availability

Tjänst:
IoT Central
API-version:
2021-06-01

Kontrollera om ett IoT Central-programnamn är tillgängligt.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability?api-version=2021-06-01

URI-parametrar

Name I Obligatorisk Typ Description
subscriptionId
 path True

string

Prenumerationsidentifieraren.
api-version
 query True

string

Versionen av API:et.

Begärandetext

Name Obligatorisk Typ Description
name True

string

Namnet på den IoT Central-programinstans som ska kontrolleras.
type

string

Typen av IoT Central-resurs som ska frågas.

Svar

Name Typ Description
200 OK

AppAvailabilityInfo

Det här är en synkron åtgärd. Brödtexten innehåller ett JSON-serialiserat svar som anger om IoT Central-programnamnet är tillgängligt. Om namnet inte är tillgängligt innehåller brödtexten orsaken.
Other Status Codes

CloudError

DefaultErrorResponse

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

Apps_CheckNameAvailability

Exempelbegäran

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.IoTCentral/checkNameAvailability?api-version=2021-06-01

{
  "name": "myiotcentralapp",
  "type": "IoTApps"
}

Exempelsvar

Statuskod:
200 
code: 200
{
  "nameAvailable": true
}
Statuskod:
default 
{
  "error": {
    "code": "Error code",
    "message": "Error message",
    "target": "Error target"
  }
}

Definitioner

Name Description
AppAvailabilityInfo

Egenskaperna som anger om ett angivet IoT Central-programnamn eller underdomän är tillgängligt.
CloudError

Felinformation.
CloudErrorBody

Information om felsvar.
OperationInputs

Indatavärden.

AppAvailabilityInfo

Objekt

Egenskaperna som anger om ett angivet IoT Central-programnamn eller underdomän är tillgängligt.

Name Typ Description
message

string

Det detaljerade orsaksmeddelandet.
nameAvailable

boolean

Värdet som anger om det angivna namnet är tillgängligt.
reason

string

Orsaken till otillgänglighet.

CloudError

Objekt

Felinformation.

Name Typ Description
error.code

string

Felkoden.
error.details

CloudErrorBody[]

En lista med ytterligare information om felet.
error.message

string

Felmeddelandet.
error.target

string

Målet för det specifika felet.

CloudErrorBody

Objekt

Information om felsvar.

Name Typ Description
code

string

Felkoden.
details

CloudErrorBody[]

En lista med ytterligare information om felet.
message

string

Felmeddelandet.
target

string

Målet för det specifika felet.

OperationInputs

Objekt

Indatavärden.

Name Typ Standardvärde Description
name

string

Namnet på den IoT Central-programinstans som ska kontrolleras.
type

string

IoTApps

Typen av IoT Central-resurs som ska frågas.