Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"api-version": "2018-09-01",
"operationInputs": {
"nameAvailabilityInputs": {
"name": "myIoTCentralApp"
}
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"api-version": "2018-09-01",
"subdomainAvailabilityInputs": {
"subdomain": "myIoTCentralApp"
}
},
"responses": {
"200": {
"headers": {},
"body": {
"nameAvailable": true
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -338,20 +338,66 @@
"$ref": "#/parameters/subscriptionId"
},
{
"name": "operationInputs",
"name": "nameAvailabilityInputs",
"in": "body",
"description": "Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check.",
"description": "Set the name parameter in the NameAvailabilityInputs structure to the name of the IoT Central application to check.",
"required": true,
"schema": {
"$ref": "#/definitions/OperationInputs"
"$ref": "#/definitions/NameAvailabilityInputs"
}
}
],
"responses": {
"200": {
"description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT Central application name is available. If the name is not available, the body contains the reason.",
"schema": {
"$ref": "#/definitions/AppNameAvailabilityInfo"
"$ref": "#/definitions/AppAvailabilityInfo"
}
},
"default": {
"description": "DefaultErrorResponse",
"schema": {
"$ref": "#/definitions/ErrorDetails"
}
}
},
"deprecated": false
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkSubdomainAvailability": {
"post": {
"tags": [
"Apps"
],
"description": "Check if an IoT Central application subdomain is available.",
"operationId": "Apps_CheckSubdomainAvailability",
"x-ms-examples": {
"Apps_SubdomainAvailability": {
"$ref": "./examples/Apps_CheckSubdomainAvailability.json"
}
},
"parameters": [
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/subscriptionId"
},
{
"name": "subdomainAvailabilityInputs",
"in": "body",
"description": "Set the subdomain parameter in the SubdomainAvailabilityInputs structure to the subdomain of the IoT Central application to check.",
"required": true,
"schema": {
"$ref": "#/definitions/SubdomainAvailabilityInputs"
}
}
],
"responses": {
"200": {
"description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT Central application subdomain is available. If the subdomain is not available, the body contains the reason.",
"schema": {
"$ref": "#/definitions/AppAvailabilityInfo"
}
},
"default": {
Expand Down Expand Up @@ -537,22 +583,37 @@
},
"ErrorDetails": {
"description": "Error details.",
"properties": {
"error": {
"$ref": "#/definitions/ErrorResponseBody"
}
}
},
"ErrorResponseBody": {
"description": "Details of error response.",
"type": "object",
"properties": {
"code": {
"description": "The error code.",
"type": "string",
"description": "Error code, intended to be consumed programmatically.",
"readOnly": true
},
"message": {
"description": "The error message.",
"type": "string",
"description": "Description of the error, intended for display in user interface.",
"readOnly": true
},
"target": {
"description": "The target of the particular error.",
"type": "string",
"description": "Target of the particular error, for example name of the property.",
"readOnly": true
},
"details": {
"type": "array",
"description": "A list of additional details about the error.",
"items": {
"$ref": "#/definitions/ErrorResponseBody"
}
}
}
},
Expand Down Expand Up @@ -632,21 +693,40 @@
}
}
},
"OperationInputs": {
"NameAvailabilityInputs": {
"description": "Input values.",
"type": "object",
"properties": {
"name": {
"description": "The name of the IoT Central application instance to check.",
"type": "string"
"type": "string",
"pattern": "^[a-z0-9-]{1,63}$"
},
"type": {
"description": "The name of the IoT Central resource name to query.",
"type": "string",
"default": "IoTApps"
}
},
"required": [
"name"
]
}
},
"SubdomainAvailabilityInputs": {
"description": "Input values.",
"type": "object",
"properties": {
"subdomain": {
"description": "The subdomain of the IoT Central application instance to check.",
"type": "string",
"pattern": "^[a-z0-9-]{1,63}$"
},
"type": {
"description": "The name of the IoT Central resource name to query.",
"type": "string",
"default": "IoTApps"
}
}
},
"AppNameAvailabilityInfo": {
"description": "The properties indicating whether a given IoT Central application name is available.",
"AppAvailabilityInfo": {
"description": "The properties indicating whether a given IoT Central application information is available.",
"type": "object",
"properties": {
"nameAvailable": {
Expand All @@ -656,20 +736,13 @@
},
"reason": {
"description": "The reason for unavailability.",
"enum": [
"Invalid",
"AlreadyExists"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "AppNameUnavailabilityReason",
"modelAsString": false
}
"readOnly": true
},
"message": {
"description": "The detailed reason message.",
"type": "string"
"type": "string",
"readOnly": true
}
}
}
Expand Down