openapi-directory/api/azure.com/iotspaces.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 the IoTSpaces service instances in your Azure subscription.","title":"IoTSpacesClient","version":"2017-10-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-ms-code-generation-settings":{"header":"MICROSOFT_MIT_NO_VERSION"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/iotspaces.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"iotspaces","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.IoTSpaces/operations":{"get":{"deprecated":false,"description":"Lists all of the available IoTSpaces service 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":{"Get available operations":{"$ref":"#/components/examples/Get_available_operations"}}}}},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"}}}}},"tags":["Proxy"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.IoTSpaces/Graph":{"get":{"deprecated":false,"description":"Get all the IoTSpaces instances in a subscription.","operationId":"IoTSpaces_List","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 IoTSpaces instances in the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IoTSpacesDescriptionListResult"},"examples":{"Get IoT spaces services by subscription":{"$ref":"#/components/examples/Get_IoT_spaces_services_by_subscription"}}}}},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"}}}}},"tags":["Collection"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.IoTSpaces/checkNameAvailability":{"post":{"deprecated":false,"description":"Check if an IoTSpaces instance name is available.","operationId":"IoTSpaces_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 IoTSpaces instance to check.","required":true},"responses":{"200":{"description":"This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoTSpaces service name is available. If the name is not available, the body contains the reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IoTSpacesNameAvailabilityInfo"},"examples":{"Check name Availability":{"$ref":"#/components/examples/Check_name_Availability"}}}}},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"}}}}},"tags":["Proxy"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTSpaces/Graph":{"get":{"deprecated":false,"description":"Get all the IoTSpaces instances in a resource group.","operationId":"IoTSpaces_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 IoTSpaces instances in the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IoTSpacesDescriptionListResult"},"examples":{"Get IoT spaces services by resource group":{"$ref":"#/components/examples/Get_IoT_spaces_services_by_resource_group"}}}}},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"}}}}},"tags":["Collection"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTSpaces/Graph/{resourceName}":{"delete":{"description":"Delete an IoTSpaces instance.","operationId":"IoTSpaces_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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IoTSpacesDescription"},"examples":{"Delete an IoT spaces service":{"$ref":"#/components/examples/Delete_an_IoT_spaces_service"}}}}},"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 IoTSpaces service 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"}}}}},"tags":["Resource"],"x-ms-long-running-operation":true},"get":{"deprecated":false,"description":"Get the metadata of a IoTSpaces instance.","operationId":"IoTSpaces_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 IoTSpaces instance. Security-related properties are set to null.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IoTSpacesDescription"},"examples":{"Get a IoT spaces service":{"$ref":"#/components/examples/Get_a_IoT_spaces_service"}}}}},"default":{"description":"Default error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"}}}}},"tags":["Resource"]},"patch":{"deprecated":false,"description":"Update the metadata of a IoTSpaces instance.","operationId":"IoTSpaces_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/IoTSpacesPatchDescription"}}},"description":"The IoTSpaces instance 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/IoTSpacesDescription"},"examples":{"Patch an IoT spaces service":{"$ref":"#/components/examples/Patch_an_IoT_spaces_service"}}}}},"202":{"description":"Accepted - Put request accepted; the operation will complete asynchronously."},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"}}}}},"tags":["Resource"],"x-ms-long-running-operation":true},"put":{"deprecated":false,"description":"Create or update the metadata of an IoTSpaces instance. The usual pattern to modify a property is to retrieve the IoTSpaces instance metadata and security metadata, and then combine them with the modified values in a new body to update the IoTSpaces instance.","operationId":"IoTSpaces_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/IoTSpacesDescription"}}},"description":"The IoTSpaces instance 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/IoTSpacesDescription"},"examples":{"Put an IoT spaces service":{"$ref":"#/components/examples/Put_an_IoT_spaces_service"}}}}},"202":{"description":"Accepted - Put request accepted; the operation will complete asynchronously."},"default":{"description":"DefaultErrorResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetails"}}}}},"tags":["Resource"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_available_operations":{"value":{"value":[{"display":{"description":"Check IoT Spaces Service name availability.","operation":"Check IoT Spaces Service name availability.","provider":"Microsoft IoT Spaces Service","resource":"Microsoft IoT Spaces Service instance"},"name":"Microsoft.IoTSpaces/checkNameAvailability/action"},{"display":{"description":"Create or update a IoT Spaces Service instance.","operation":"Create or update a IoT Spaces Service instance.","provider":"Microsoft IoT Spaces Service","resource":"Microsoft IoT Spaces Service instance"},"name":"Microsoft.IoTSpaces/Graph/write"},{"display":{"description":"Get a IoT Spaces Service instance.","operation":"Get a IoT Spaces Service instance.","provider":"Microsoft IoT Spaces Service","resource":"Microsoft IoT Spaces Service instance"},"name":"Microsoft.IoTSpaces/Graph/read"},{"display":{"description":"Delete a IoT Spaces Service instance.","operation":"Delete a IoT Spaces Service instance.","provider":"Microsoft IoT Spaces Service","resource":"Microsoft IoT Spaces Service instance"},"name":"Microsoft.IoTSpaces/Graph/delete"}]}},"Get_IoT_spaces_services_by_subscription":{"value":{"value":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService","location":"westus","name":"myIoTSpacesService","properties":{"managementApiUrl":"myIoTSpacesService-management.AzureIoTSpaces.net","provisioningState":"Provisioning","storageContainer":{"containerName":"myStorageContainer","resourceGroup":"resReg","subscriptionId":"00000000-0000-0000-0000-000000000000"},"webPortalUrl":"myIoTSpacesService-webportal.AzureIoTSpaces.net"},"sku":{"name":"F1"},"type":"Microsoft.IoTSpaces/IoTSpacesService"}]}},"Check_name_Availability":{"value":{"nameAvailable":true}},"Get_IoT_spaces_services_by_resource_group":{"value":{"value":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService","location":"westus","name":"myIoTSpacesService","properties":{"managementApiUrl":"myIoTSpacesService-management.AzureIoTSpaces.net","provisioningState":"Provisioning","storageContainer":{"containerName":"myStorageContainer","resourceGroup":"resReg","subscriptionId":"00000000-0000-0000-0000-000000000000"},"webPortalUrl":"myIoTSpacesService-webportal.AzureIoTSpaces.net"},"sku":{"name":"F1"},"type":"Microsoft.IoTSpaces/IoTSpacesService"}]}},"Delete_an_IoT_spaces_service":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService","location":"westus","name":"myIoTSpacesService","properties":{"managementApiUrl":"myIoTSpacesService-management.AzureIoTSpaces.net","provisioningState":"Deleting","storageContainer":{"containerName":"myStorageContainer","resourceGroup":"resReg","subscriptionId":"00000000-0000-0000-0000-000000000000"},"webPortalUrl":"myIoTSpacesService-webportal.AzureIoTSpaces.net"},"sku":{"name":"F1"},"type":"Microsoft.IoTSpaces/IoTSpacesService"}},"Get_a_IoT_spaces_service":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService","location":"westus","name":"myIoTSpacesService","properties":{"managementApiUrl":"myIoTSpacesService-management.AzureIoTSpaces.net","provisioningState":"Provisioning","storageContainer":{"containerName":"myStorageContainer","resourceGroup":"resReg","subscriptionId":"00000000-0000-0000-0000-000000000000"},"webPortalUrl":"myIoTSpacesService-webportal.AzureIoTSpaces.net"},"sku":{"name":"F1"},"type":"Microsoft.IoTSpaces/IoTSpacesService"}},"Patch_an_IoT_spaces_service":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService","location":"westus","name":"myIoTSpacesService","properties":{"managementApiUrl":"myIoTSpacesService-management.AzureIoTSpaces.net","provisioningState":"Succeeded","storageContainer":{"containerName":"myStorageContainer","resourceGroup":"resReg","subscriptionId":"00000000-0000-0000-0000-000000000000"},"webPortalUrl":"myIoTSpacesService-webportal.AzureIoTSpaces.net"},"sku":{"name":"F1"},"type":"Microsoft.IoTSpaces/IoTSpacesService"}},"Put_an_IoT_spaces_service":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService","location":"westus","name":"myIoTSpacesService","properties":{"managementApiUrl":"myIoTSpacesService-management.AzureIoTSpaces.net","provisioningState":"Provisioning","storageContainer":{"containerName":"myStorageContainer","resourceGroup":"resReg","subscriptionId":"00000000-0000-0000-0000-000000000000"},"webPortalUrl":"myIoTSpacesService-webportal.AzureIoTSpaces.net"},"sku":{"name":"F1"},"type":"Microsoft.IoTSpaces/IoTSpacesService"}}},"parameters":{"api-version":{"description":"The version of the API.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":10,"enum":["2017-10-01-preview"]},"examples":{"Get available operations":{"value":"2017-10-01-preview"},"Get IoT spaces services by subscription":{"value":"2017-10-01-preview"},"Check name Availability":{"value":"2017-10-01-preview"},"Get IoT spaces services by resource group":{"value":"2017-10-01-preview"},"Delete an IoT spaces service":{"value":"2017-10-01-preview"},"Get a IoT spaces service":{"value":"2017-10-01-preview"},"Patch an IoT spaces service":{"value":"2017-10-01-preview"},"Put an IoT spaces service":{"value":"2017-10-01-preview"}}},"resourceGroupName":{"description":"The name of the resource group that contains the IoTSpaces instance.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":64},"examples":{"Get IoT spaces services by resource group":{"value":"resRg"},"Delete an IoT spaces service":{"value":"resRg"},"Get a IoT spaces service":{"value":"resRg"},"Patch an IoT spaces service":{"value":"resRg"},"Put an IoT spaces service":{"value":"resRg"}}},"resourceName":{"description":"The name of the IoTSpaces instance.","in":"path","name":"resourceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":64},"examples":{"Delete an IoT spaces service":{"value":"myIoTSpacesService"},"Get a IoT spaces service":{"value":"myIoTSpacesService"},"Patch an IoT spaces service":{"value":"myIoTSpacesService"},"Put an IoT spaces service":{"value":"myIoTSpacesService"}}},"subscriptionId":{"description":"The subscription identifier.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Get IoT spaces services by subscription":{"value":"00000000-0000-0000-0000-000000000000"},"Check name Availability":{"value":"00000000-0000-0000-0000-000000000000"},"Get IoT spaces services by resource group":{"value":"00000000-0000-0000-0000-000000000000"},"Delete an IoT spaces service":{"value":"00000000-0000-0000-0000-000000000000"},"Get a IoT spaces service":{"value":"00000000-0000-0000-0000-000000000000"},"Patch an IoT spaces service":{"value":"00000000-0000-0000-0000-000000000000"},"Put an IoT spaces service":{"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":{"ErrorDetails":{"description":"Error details.","properties":{"code":{"description":"The error code.","readOnly":true,"type":"string"},"message":{"description":"The error message.","readOnly":true,"type":"string"},"target":{"description":"The target of the particular error.","readOnly":true,"type":"string"}},"type":"object"},"IoTSpacesDescription":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"The description of the IoTSpaces service.","properties":{"properties":{"$ref":"#/components/schemas/IoTSpacesProperties"},"sku":{"$ref":"#/components/schemas/IoTSpacesSkuInfo"}},"required":["sku"],"type":"object"},"IoTSpacesDescriptionListResult":{"description":"A list of IoTSpaces description objects with a next link.","properties":{"nextLink":{"description":"The link used to get the next page of IoTSpaces description objects.","type":"string"},"value":{"description":"A list of IoTSpaces description objects.","items":{"$ref":"#/components/schemas/IoTSpacesDescription"},"type":"array"}},"type":"object"},"IoTSpacesNameAvailabilityInfo":{"description":"The properties indicating whether a given IoTSpaces service name is available.","properties":{"message":{"description":"The detailed reason message.","type":"string"},"nameAvailable":{"description":"The value which indicates whether the provided name is available.","readOnly":true,"type":"boolean"},"reason":{"description":"The reason for unavailability.","enum":["Invalid","AlreadyExists"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":false,"name":"IoTSpacesNameUnavailabilityReason"}}},"type":"object"},"IoTSpacesPatchDescription":{"description":"The description of the IoTSpaces service.","properties":{"properties":{"$ref":"#/components/schemas/IoTSpacesProperties"},"tags":{"additionalProperties":{"type":"string"},"description":"Instance tags","type":"object"}},"type":"object"},"IoTSpacesProperties":{"description":"The properties of an IoTSpaces instance.","properties":{"managementApiUrl":{"description":"The management Api endpoint.","readOnly":true,"type":"string"},"provisioningState":{"description":"The provisioning state.","enum":["Provisioning","Deleting","Succeeded","Failed","Canceled"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"provisioningState"}},"storageContainer":{"$ref":"#/components/schemas/StorageContainerProperties"},"webPortalUrl":{"description":"The management UI endpoint.","readOnly":true,"type":"string"}},"type":"object"},"IoTSpacesSkuInfo":{"description":"Information about the SKU of the IoTSpaces instance.","properties":{"name":{"description":"The name of the SKU.","enum":["F1","S1","S2","S3"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"IoTSpacesSku"}}},"required":["name"],"type":"object"},"Operation":{"description":"IoTSpaces service 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 IoTSpaces","readOnly":true,"type":"string"},"resource":{"description":"Resource Type: IoTSpaces","readOnly":true,"type":"string"}},"type":"object"},"OperationInputs":{"description":"Input values.","properties":{"name":{"description":"The name of the IoTSpaces service instance to check.","type":"string"}},"required":["name"],"type":"object"},"OperationListResult":{"description":"A list of IoTSpaces service 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 IoTSpaces description objects.","type":"string"},"value":{"description":"A list of IoT spaces operations supported by the Microsoft.IoTSpaces resource provider.","items":{"$ref":"#/components/schemas/Operation"},"readOnly":true,"type":"array"}},"type":"object"},"Resource":{"description":"The common properties of an IoTSpaces service.","properties":{"id":{"description":"The resource identifier.","readOnly":true,"type":"string"},"location":{"description":"The resource location.","type":"string","x-ms-mutability":["create","read"]},"name":{"description":"The resource name.","pattern":"^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$","readOnly":true,"type":"string"},"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},"StorageContainerProperties":{"description":"The properties of the Azure Storage Container for file archive.","properties":{"connectionString":{"description":"The connection string of the storage account.","type":"string"},"containerName":{"description":"The name of storage container in the storage account.","type":"string"},"resourceGroup":{"description":"The name of the resource group of the storage account.","type":"string"},"subscriptionId":{"description":"The subscription identifier of the storage account.","type":"string"}},"type":"object"}}}}