openapi-directory/api/azure.com/iotcentral.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Use this API to manage IoT Central Applications in your Azure subscription.","title":"IotCentralClient","version":"2018-09-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"iotcentral","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.IoTCentral/operations":{"get":{"deprecated":false,"description":"Lists all of the available IoT Central application REST API operations.","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationListResult"},"examples":{"Operations_List":{"$ref":"#/components/examples/Operations_List"}}}}},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"},"examples":{"Operations_List":{"$ref":"#/components/examples/Operations_List"}}}}}},"tags":["Operations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/IoTApps":{"get":{"deprecated":false,"description":"Get all IoT Central Applications in a subscription.","operationId":"Apps_ListBySubscription","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"responses":{"200":{"description":"This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT Central Applications in the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppListResult"},"examples":{"Apps_ListBySubscription":{"$ref":"#/components/examples/Apps_ListBySubscription"}}}}},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"}}}}},"tags":["Apps"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/appTemplates":{"post":{"deprecated":false,"description":"Get all available application templates.","operationId":"Apps_ListTemplates","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"responses":{"200":{"description":"The body contains all the IoT Central application templates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppTemplatesResult"},"examples":{"Apps_ListTemplates":{"$ref":"#/components/examples/Apps_ListTemplates"}}}}},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"}}}}},"tags":["Apps"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability":{"post":{"deprecated":false,"description":"Check if an IoT Central application name is available.","operationId":"Apps_CheckNameAvailability","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationInputs"}}},"description":"Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check.","required":true},"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppAvailabilityInfo"},"examples":{"Apps_CheckNameAvailability":{"$ref":"#/components/examples/Apps_CheckNameAvailability"}}}}},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"},"examples":{"Apps_CheckNameAvailability":{"$ref":"#/components/examples/Apps_CheckNameAvailability"}}}}}},"tags":["Apps"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkSubdomainAvailability":{"post":{"deprecated":false,"description":"Check if an IoT Central application subdomain is available.","operationId":"Apps_CheckSubdomainAvailability","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationInputs"}}},"description":"Set the name parameter in the OperationInputs structure to the subdomain of the IoT Central application to check.","required":true},"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppAvailabilityInfo"},"examples":{"Apps_SubdomainAvailability":{"$ref":"#/components/examples/Apps_SubdomainAvailability"}}}}},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"},"examples":{"Apps_SubdomainAvailability":{"$ref":"#/components/examples/Apps_SubdomainAvailability"}}}}}},"tags":["Apps"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/IoTApps":{"get":{"deprecated":false,"description":"Get all the IoT Central Applications in a resource group.","operationId":"Apps_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/resourceGroupName"}],"responses":{"200":{"description":"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppListResult"},"examples":{"Apps_ListByResourceGroup":{"$ref":"#/components/examples/Apps_ListByResourceGroup"}}}}},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"},"examples":{"Apps_ListByResourceGroup":{"$ref":"#/components/examples/Apps_ListByResourceGroup"}}}}}},"tags":["Apps"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/IoTApps/{resourceName}":{"delete":{"description":"Delete an IoT Central application.","operationId":"Apps_Delete","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/resourceGroupName"},{"$ref":"#/components/parameters/resourceName"}],"responses":{"200":{"description":"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."},"202":{"description":"Accepted - Delete request accepted; the operation will complete asynchronously."},"204":{"description":"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."},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"},"examples":{"Apps_Delete":{"$ref":"#/components/examples/Apps_Delete"}}}}}},"tags":["Apps"],"x-ms-long-running-operation":true},"get":{"deprecated":false,"description":"Get the metadata of an IoT Central application.","operationId":"Apps_Get","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/resourceGroupName"},{"$ref":"#/components/parameters/resourceName"}],"responses":{"200":{"description":"The body contains all the non-security properties of the IoT Central application. Security-related properties are set to null.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"},"examples":{"Apps_Get":{"$ref":"#/components/examples/Apps_Get"}}}}},"default":{"description":"Default error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"},"examples":{"Apps_Get":{"$ref":"#/components/examples/Apps_Get"}}}}}},"tags":["Apps"]},"patch":{"deprecated":false,"description":"Update the metadata of an IoT Central application.","operationId":"Apps_Update","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/resourceGroupName"},{"$ref":"#/components/parameters/resourceName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppPatch"}}},"description":"The IoT Central application metadata and security metadata.","required":true},"responses":{"200":{"description":"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"},"examples":{"Apps_Update":{"$ref":"#/components/examples/Apps_Update"}}}}},"202":{"description":"Accepted - Put request accepted; the operation will complete asynchronously."},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"},"examples":{"Apps_Update":{"$ref":"#/components/examples/Apps_Update"}}}}}},"tags":["Apps"],"x-ms-long-running-operation":true},"put":{"deprecated":false,"description":"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.","operationId":"Apps_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/resourceGroupName"},{"$ref":"#/components/parameters/resourceName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}},"description":"The IoT Central application metadata and security metadata.","required":true},"responses":{"200":{"description":"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"},"examples":{"Apps_CreateOrUpdate":{"$ref":"#/components/examples/Apps_CreateOrUpdate"}}}}},"201":{"description":"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"},"examples":{"Apps_CreateOrUpdate":{"$ref":"#/components/examples/Apps_CreateOrUpdate"}}}}},"202":{"description":"Accepted - Put request accepted; the operation will complete asynchronously."},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"},"examples":{"Apps_CreateOrUpdate":{"$ref":"#/components/examples/Apps_CreateOrUpdate"}}}}}},"tags":["Apps"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Operations_List":{"value":{"error":{"code":"Error code","message":"Error message","target":"Error target"}}},"Apps_ListBySubscription":{"value":{"value":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp","location":"westus","name":"myIoTCentralApp","properties":{"applicationId":"6ebd8fd3-6e34-419e-908f-9be61ec6f6d6","displayName":"My IoT Central App","subdomain":"my-iot-central-app","template":"iotc-default@1.0.0"},"sku":{"name":"F1"},"tags":{"key":"value"},"type":"Microsoft.IoTCentral/IoTApps"}]}},"Apps_ListTemplates":{"value":{"value":[{"appTemplateName":"IoT Central Application template","description":"Description for IoT Central Application template","manifestId":"iotc-default","manifestVersion":"1.0.0","order":1,"title":"IoT Central Application template"}]}},"Apps_CheckNameAvailability":{"value":{"error":{"code":"Error code","message":"Error message","target":"Error target"}}},"Apps_SubdomainAvailability":{"value":{"error":{"code":"Error code","message":"Error message","target":"Error target"}}},"Apps_ListByResourceGroup":{"value":{"error":{"code":"Error code","message":"Error message","target":"Error target"}}},"Apps_Delete":{"value":{"error":{"code":"Error code","message":"Error message","target":"Error target"}}},"Apps_Get":{"value":{"error":{"code":"Error code","message":"Error message","target":"Error target"}}},"Apps_Update":{"value":{"error":{"code":"Error code","message":"Error message","target":"Error target"}}},"Apps_CreateOrUpdate":{"value":{"error":{"code":"Error code","message":"Error message","target":"Error target"}}}},"parameters":{"api-version":{"description":"The version of the API.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Operations_List":{"value":"2018-09-01"},"Apps_ListBySubscription":{"value":"2018-09-01"},"Apps_ListTemplates":{"value":"2018-09-01"},"Apps_CheckNameAvailability":{"value":"2018-09-01"},"Apps_SubdomainAvailability":{"value":"2018-09-01"},"Apps_ListByResourceGroup":{"value":"2018-09-01"},"Apps_Delete":{"value":"2018-09-01"},"Apps_Get":{"value":"2018-09-01"},"Apps_Update":{"value":"2018-09-01"},"Apps_CreateOrUpdate":{"value":"2018-09-01"}}},"resourceGroupName":{"description":"The name of the resource group that contains the IoT Central application.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Apps_ListByResourceGroup":{"value":"resRg"},"Apps_Delete":{"value":"resRg"},"Apps_Get":{"value":"resRg"},"Apps_Update":{"value":"resRg"},"Apps_CreateOrUpdate":{"value":"resRg"}}},"resourceName":{"description":"The ARM resource name of the IoT Central application.","in":"path","name":"resourceName","required":true,"x-comment":"validation must match #/definitions/Resource","x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Apps_Delete":{"value":"myIoTCentralApp"},"Apps_Get":{"value":"myIoTCentralApp"},"Apps_Update":{"value":"myIoTCentralApp"},"Apps_CreateOrUpdate":{"value":"myIoTCentralApp"}}},"subscriptionId":{"description":"The subscription identifier.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Apps_ListBySubscription":{"value":"00000000-0000-0000-0000-000000000000"},"Apps_ListTemplates":{"value":"00000000-0000-0000-0000-000000000000"},"Apps_CheckNameAvailability":{"value":"00000000-0000-0000-0000-000000000000"},"Apps_SubdomainAvailability":{"value":"00000000-0000-0000-0000-000000000000"},"Apps_ListByResourceGroup":{"value":"00000000-0000-0000-0000-000000000000"},"Apps_Delete":{"value":"00000000-0000-0000-0000-000000000000"},"Apps_Get":{"value":"00000000-0000-0000-0000-000000000000"},"Apps_Update":{"value":"00000000-0000-0000-0000-000000000000"},"Apps_CreateOrUpdate":{"value":"00000000-0000-0000-0000-000000000000"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"App":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"The IoT Central application.","properties":{"properties":{"$ref":"#/components/schemas/AppProperties"},"sku":{"$ref":"#/components/schemas/AppSkuInfo"}},"required":["sku"],"type":"object"},"AppAvailabilityInfo":{"description":"The properties indicating whether a given IoT Central application name or subdomain is available.","properties":{"message":{"description":"The detailed reason message.","readOnly":true,"type":"string"},"nameAvailable":{"description":"The value which indicates whether the provided name is available.","readOnly":true,"type":"boolean"},"reason":{"description":"The reason for unavailability.","readOnly":true,"type":"string"}},"type":"object"},"AppListResult":{"description":"A list of IoT Central Applications with a next link.","properties":{"nextLink":{"description":"The link used to get the next page of IoT Central Applications.","type":"string"},"value":{"description":"A list of IoT Central Applications.","items":{"$ref":"#/components/schemas/App"},"type":"array"}},"type":"object"},"AppPatch":{"description":"The description of the IoT Central application.","properties":{"properties":{"$ref":"#/components/schemas/AppProperties"},"tags":{"additionalProperties":{"type":"string"},"description":"Instance tags","type":"object"}},"type":"object"},"AppProperties":{"description":"The properties of an IoT Central application.","properties":{"applicationId":{"description":"The ID of the application.","readOnly":true,"type":"string"},"displayName":{"description":"The display name of the application.","pattern":"^.{1,200}$","type":"string"},"subdomain":{"description":"The subdomain of the application.","pattern":"^[a-z0-9-]{1,63}$","type":"string"},"template":{"description":"The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.","type":"string","x-ms-mutability":["create","read"]}},"type":"object"},"AppSkuInfo":{"description":"Information about the SKU of the IoT Central application.","properties":{"name":{"description":"The name of the SKU.","enum":["F1","S1","ST0","ST1","ST2"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"AppSku"}}},"required":["name"],"type":"object"},"AppTemplate":{"description":"IoT Central Application Template.","properties":{"appTemplateName":{"description":"The name of the template.","readOnly":true,"type":"string"},"description":{"description":"The description of the template.","readOnly":true,"type":"string"},"manifestId":{"description":"The ID of the template.","readOnly":true,"type":"string"},"manifestVersion":{"description":"The version of the template.","readOnly":true,"type":"string"},"order":{"description":"The order of the template in the templates list.","readOnly":true,"type":"number"},"title":{"description":"The title of the template.","readOnly":true,"type":"string"}},"type":"object"},"AppTemplatesResult":{"description":"A list of IoT Central Application Templates with a next link.","properties":{"nextLink":{"description":"The link used to get the next page of IoT Central application templates.","type":"string"},"value":{"description":"A list of IoT Central Application Templates.","items":{"$ref":"#/components/schemas/AppTemplate"},"readOnly":true,"type":"array"}},"type":"object"},"ErrorDetails":{"description":"Error details.","properties":{"error":{"$ref":"#/components/schemas/ErrorResponseBody"}}},"ErrorResponseBody":{"description":"Details of error response.","properties":{"code":{"description":"The error code.","readOnly":true,"type":"string"},"details":{"description":"A list of additional details about the error.","items":{"$ref":"#/components/schemas/ErrorResponseBody"},"type":"array"},"message":{"description":"The error message.","readOnly":true,"type":"string"},"target":{"description":"The target of the particular error.","readOnly":true,"type":"string"}},"type":"object"},"Operation":{"description":"IoT Central REST API operation","properties":{"display":{"$ref":"#/components/schemas/OperationDisplay"},"name":{"description":"Operation name: {provider}/{resource}/{read | write | action | delete}","readOnly":true,"type":"string"}},"type":"object"},"OperationDisplay":{"description":"The object that represents the operation.","properties":{"description":{"description":"Friendly description for the operation,","readOnly":true,"type":"string"},"operation":{"description":"Name of the operation","readOnly":true,"type":"string"},"provider":{"description":"Service provider: Microsoft IoT Central","readOnly":true,"type":"string"},"resource":{"description":"Resource Type: IoT Central","readOnly":true,"type":"string"}},"type":"object"},"OperationInputs":{"description":"Input values.","properties":{"name":{"description":"The name of the IoT Central application instance to check.","pattern":"^[a-z0-9-]{1,63}$","type":"string"},"type":{"default":"IoTApps","description":"The type of the IoT Central resource to query.","type":"string"}},"required":["name"],"type":"object"},"OperationListResult":{"description":"A list of IoT Central operations. It contains a list of operations and a URL link to get the next set of results.","properties":{"nextLink":{"description":"The link used to get the next page of IoT Central description objects.","type":"string"},"value":{"description":"A list of operations supported by the Microsoft.IoTCentral resource provider.","items":{"$ref":"#/components/schemas/Operation"},"readOnly":true,"type":"array"}},"type":"object"},"Resource":{"description":"The common properties of an ARM resource.","properties":{"id":{"description":"The ARM resource identifier.","readOnly":true,"type":"string"},"location":{"description":"The resource location.","type":"string","x-ms-mutability":["create","read"]},"name":{"description":"The ARM resource name.","pattern":"^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,99}[a-zA-Z0-9]$","readOnly":true,"type":"string","x-comment":"pattern must match #/parameters/resourceName"},"tags":{"additionalProperties":{"type":"string"},"description":"The resource tags.","type":"object"},"type":{"description":"The resource type.","readOnly":true,"type":"string"}},"required":["location"],"x-ms-azure-resource":true}}}}