{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-iotcentral","description":"IotCentralClient","version":"2018-09-01","base_url":"https://management.azure.com","endpoints":10,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api IotCentralClient\n@base https://management.azure.com\n@version 2018-09-01\n@auth OAuth2\n@common_fields {api-version: any # The version of the API.}\n@endpoints 10\n@toc subscriptions(9), providers(1)\n\n@group subscriptions\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}\n@desc Get the metadata of an IoT Central application.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the IoT Central application., resourceName: any # The ARM resource name of the IoT Central application.}\n@returns(200) The body contains all the non-security properties of the IoT Central application. Security-related properties are set to null.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}\n@desc Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the IoT Central application.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the IoT Central application., resourceName: any # The ARM resource name of the IoT Central application., App: map # The IoT Central application metadata and security metadata.}\n@returns(200) This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.\n@returns(201) This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.\n@returns(202) Accepted - Put request accepted; the operation will complete asynchronously.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}\n@desc Update the metadata of an IoT Central application.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the IoT Central application., resourceName: any # The ARM resource name of the IoT Central application., AppPatch: map # The IoT Central application metadata and security metadata.}\n@returns(200) This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.\n@returns(202) Accepted - Put request accepted; the operation will complete asynchronously.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}\n@desc Delete an IoT Central application.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the IoT Central application., resourceName: any # The ARM resource name of the IoT Central application.}\n@returns(200) This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state.\n@returns(202) Accepted - Delete request accepted; the operation will complete asynchronously.\n@returns(204) Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the IoT Central application metadata in the service and the status of the delete operation is set to a completed state.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/iotApps\n@desc Get all IoT Central Applications in a subscription.\n@required {subscriptionId: any # The subscription identifier.}\n@returns(200) This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT Central Applications in the subscription.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps\n@desc Get all the IoT Central Applications in a resource group.\n@required {subscriptionId: any # The subscription identifier., resourceGroupName: any # The name of the resource group that contains the IoT Central application.}\n@returns(200) This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT Central Applications in the resource group.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability\n@desc Check if an IoT Central application name is available.\n@required {subscriptionId: any # The subscription identifier., operationInputs: map # Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check.}\n@returns(200) 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.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkSubdomainAvailability\n@desc Check if an IoT Central application subdomain is available.\n@required {subscriptionId: any # The subscription identifier., operationInputs: map # Set the name parameter in the OperationInputs structure to the subdomain of the IoT Central application to check.}\n@returns(200) 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.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/appTemplates\n@desc Get all available application templates.\n@required {subscriptionId: any # The subscription identifier.}\n@returns(200) The body contains all the IoT Central application templates.\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/Microsoft.IoTCentral/operations\n@desc Lists all of the available IoT Central application REST API operations.\n@returns(200) OK. The request has succeeded.\n\n@endgroup\n\n@end\n"}