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

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

{"openapi":"3.0.0","info":{"description":"Azure Digital Twins Client for managing DigitalTwinsInstance","title":"AzureDigitalTwinsManagementClient","version":"2020-03-01-preview","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/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview/digitaltwins.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"digitaltwins","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.DigitalTwins/operations":{"get":{"description":"Lists all of the available DigitalTwins 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":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Operations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/digitalTwinsInstances":{"get":{"description":"Get all the DigitalTwinsInstances in a subscription.","operationId":"DigitalTwins_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 DigitalTwinsInstances in the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalTwinsDescriptionListResult"},"examples":{"Get DigitalTwinsInstance resources by subscription":{"$ref":"#/components/examples/Get_DigitalTwinsInstance_resources_by_subscription"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["DigitalTwinsInstance"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability":{"post":{"description":"Check if a DigitalTwinsInstance name is available.","operationId":"DigitalTwins_CheckNameAvailability","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/location"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameRequest"}}},"description":"Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check.","required":true},"responses":{"200":{"description":"This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the DigitalTwins service name is available. If the name is not available, the body contains the reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameResult"},"examples":{"Check name Availability":{"$ref":"#/components/examples/Check_name_Availability"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["CheckNameAvailability"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances":{"get":{"description":"Get all the DigitalTwinsInstances in a resource group.","operationId":"DigitalTwins_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 DigitalTwinsInstances in the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalTwinsDescriptionListResult"},"examples":{"Get DigitalTwinsInstance resources by resource group":{"$ref":"#/components/examples/Get_DigitalTwinsInstance_resources_by_resource_group"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["DigitalTwinsInstance"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}":{"delete":{"description":"Delete a DigitalTwinsInstance.","operationId":"DigitalTwins_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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalTwinsDescription"},"examples":{"Delete a DigitalTwinsInstance resource":{"$ref":"#/components/examples/Delete_a_DigitalTwinsInstance_resource"}}}}},"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 DigitalTwins service metadata in the service and the status of the delete operation is set to a completed state."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["DigitalTwinsInstance"],"x-ms-long-running-operation":true},"get":{"description":"Get DigitalTwinsInstances resource.","operationId":"DigitalTwins_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 DigitalTwinsInstance. Security-related properties are set to null.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalTwinsDescription"},"examples":{"Get a DigitalTwinsInstance resource":{"$ref":"#/components/examples/Get_a_DigitalTwinsInstance_resource"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["DigitalTwinsInstance"]},"patch":{"description":"Update metadata of DigitalTwinsInstance.","operationId":"DigitalTwins_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/DigitalTwinsPatchDescription"}}},"description":"The DigitalTwinsInstance 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/DigitalTwinsDescription"},"examples":{"Patch a DigitalTwinsInstance resource":{"$ref":"#/components/examples/Patch_a_DigitalTwinsInstance_resource"}}}}},"201":{"description":"Accepted - Put request accepted; the operation will complete asynchronously."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["DigitalTwinsInstance"],"x-ms-long-running-operation":true},"put":{"description":"Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance.","operationId":"DigitalTwins_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/DigitalTwinsDescription"}}},"description":"The DigitalTwinsInstance 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/DigitalTwinsDescription"},"examples":{"Put a DigitalTwinsInstance resource":{"$ref":"#/components/examples/Put_a_DigitalTwinsInstance_resource"}}}}},"201":{"description":"Created - Put request accepted; the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalTwinsDescription"},"examples":{"Put a DigitalTwinsInstance resource":{"$ref":"#/components/examples/Put_a_DigitalTwinsInstance_resource"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["DigitalTwinsInstance"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints":{"get":{"description":"Get DigitalTwinsInstance Endpoints.","operationId":"DigitalTwinsEndpoint_List","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 DigitalTwinsInstance. Security-related properties are set to null.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalTwinsEndpointResourceListResult"},"examples":{"Get a DigitalTwinsInstance endpoints":{"$ref":"#/components/examples/Get_a_DigitalTwinsInstance_endpoints"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Endpoints"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}":{"delete":{"description":"Delete a DigitalTwinsInstance endpoint.","operationId":"DigitalTwinsEndpoint_Delete","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/resourceGroupName"},{"$ref":"#/components/parameters/resourceName"},{"$ref":"#/components/parameters/endpointName"}],"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalTwinsEndpointResource"},"examples":{"Delete a DigitalTwinsInstance endpoint":{"$ref":"#/components/examples/Delete_a_DigitalTwinsInstance_endpoint"}}}}},"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 DigitalTwins service metadata in the service and the status of the delete operation is set to a completed state."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Endpoints"],"x-ms-long-running-operation":true},"get":{"description":"Get DigitalTwinsInstances Endpoint.","operationId":"DigitalTwinsEndpoint_Get","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/resourceGroupName"},{"$ref":"#/components/parameters/resourceName"},{"$ref":"#/components/parameters/endpointName"}],"responses":{"200":{"description":"The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalTwinsEndpointResource"},"examples":{"Get a DigitalTwinsInstance endpoint":{"$ref":"#/components/examples/Get_a_DigitalTwinsInstance_endpoint"}}}}},"default":{"description":"Default error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Endpoints"]},"put":{"description":"Create or update DigitalTwinsInstance endpoint.","operationId":"DigitalTwinsEndpoint_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/resourceGroupName"},{"$ref":"#/components/parameters/resourceName"},{"$ref":"#/components/parameters/endpointName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalTwinsEndpointResource"}}},"description":"The DigitalTwinsInstance endpoint 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/DigitalTwinsEndpointResource"},"examples":{"Put a DigitalTwinsInstance resource":{"$ref":"#/components/examples/Put_a_DigitalTwinsInstance_resource"}}}}},"201":{"description":"Created - Put request accepted; the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalTwinsEndpointResource"},"examples":{"Put a DigitalTwinsInstance resource":{"$ref":"#/components/examples/Put_a_DigitalTwinsInstance_resource"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Endpoints"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/integrationResources":{"get":{"description":"Get DigitalTwinsInstance IoTHubs.","operationId":"DigitalTwinsIoTHubs_List","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 DigitalTwinsInstance. Security-related properties are set to null.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalTwinsIntegrationResourceListResult"},"examples":{"Get a DigitalTwinsInstance IoTHubs":{"$ref":"#/components/examples/Get_a_DigitalTwinsInstance_IoTHubs"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["IoTHub Integration"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/{scope}/providers/Microsoft.DigitalTwins/integrationResources/{integrationResourceName}":{"delete":{"description":"Deletes a DigitalTwinsInstance link with IoTHub.","operationId":"IoTHub_Delete","parameters":[{"$ref":"#/components/parameters/scope"},{"$ref":"#/components/parameters/integrationResourceName"}],"responses":{"200":{"description":"OK. DigitalTwinsInstance IoTHub link has been Deleted."},"202":{"description":"Accepted. Response includes a Location header which points to the DigitalTwins and IoTHub Integration resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResource"},"examples":{"Connect IoTHub with DigitalTwinsInstance":{"$ref":"#/components/examples/Connect_IoTHub_with_DigitalTwinsInstance"}}}}},"204":{"description":"NoContent. DigitalTwinsInstance IoTHub link does not exist."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["IoTHub Integration"],"x-ms-long-running-operation":true},"get":{"description":"Gets properties of an IoTHub Integration.","operationId":"IoTHub_Get","parameters":[{"$ref":"#/components/parameters/scope"},{"$ref":"#/components/parameters/integrationResourceName"}],"responses":{"200":{"description":"This is a synchronous operation. The body contains metadata about IoTHub and DigitalTwinsInstance Integration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResource"},"examples":{"Get IoTHub by DigitalTwinsInstance":{"$ref":"#/components/examples/Get_IoTHub_by_DigitalTwinsInstance"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["IoTHub Integration"]},"put":{"description":"Creates or Updates an IoTHub Integration with DigitalTwinsInstances.","operationId":"IoTHub_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/scope"},{"$ref":"#/components/parameters/integrationResourceName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResource"}}},"description":"The IoTHub metadata.","required":true},"responses":{"201":{"description":"This is an asynchronous operation. The body contains metadata about IoTHub and DigitalTwinsInstance Integration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResource"},"examples":{"Connect IoTHub with DigitalTwinsInstance":{"$ref":"#/components/examples/Connect_IoTHub_with_DigitalTwinsInstance"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["IoTHub Integration"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_available_operations":{"value":{"value":[{"display":{"description":"Check Digital Twins Service name availability.","operation":"Check Digital Twins Service name availability.","provider":"Microsoft Digital Twins Service","resource":"Microsoft Digital Twins Service instance"},"name":"Microsoft.DigitalTwins/checkNameAvailability/action"},{"display":{"description":"Create or update a Digital Twins Service instance.","operation":"Create or update a Digital Twins Service instance.","provider":"Microsoft Digital Twins Service","resource":"Microsoft Digital Twins Service instance"},"name":"Microsoft.DigitalTwins/DigitalTwinsInstance/write"},{"display":{"description":"Get a Digital Twins Service instance.","operation":"Get a Digital Twins Service instance.","provider":"Microsoft Digital Twins Service","resource":"Microsoft Digital Twins Service instance"},"name":"Microsoft.DigitalTwins/DigitalTwinsInstance/read"},{"display":{"description":"Delete a Digital Twins Service instance.","operation":"Delete a Digital Twins Service instance.","provider":"Microsoft Digital Twins Service","resource":"Microsoft Digital Twins Service instance"},"name":"Microsoft.DigitalTwins/DigitalTwinsInstance/delete"}]}},"Get_DigitalTwinsInstance_resources_by_subscription":{"value":{"value":[{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService","location":"westus","name":"myDigitalTwinsService","properties":{"createdTime":"2019-11-19T12:55:05.229Z","hostName":"https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net","provisioningState":"Provisioning"},"sku":{"name":"F1"},"type":"Microsoft.DigitalTwins/DigitalTwinsInstance"},{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg2/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService2","location":"westus","name":"myDigitalTwinsService2","properties":{"createdTime":"2019-11-19T12:55:05.229Z","hostName":"https://myDigitalTwinsService2.api.wus2.ss.azuredigitaltwins-test.net","provisioningState":"Provisioning"},"sku":{"name":"F1"},"type":"Microsoft.DigitalTwins/DigitalTwinsInstance"}]}},"Check_name_Availability":{"value":{"message":"Name 'myadtinstance' is already taken. Please specify a different name","name":"myadtinstance","nameAvailable":false,"reason":"AlreadyExists"}},"Get_DigitalTwinsInstance_resources_by_resource_group":{"value":{"value":[{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService","location":"westus","name":"myDigitalTwinsService","properties":{"createdTime":"2019-11-19T12:55:05.229Z","hostName":"https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net","provisioningState":"Provisioning"},"sku":{"name":"F1"},"type":"Microsoft.DigitalTwins/DigitalTwinsInstance"},{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService2","location":"westus","name":"myDigitalTwinsService2","properties":{"createdTime":"2019-11-19T12:55:05.229Z","hostName":"https://myDigitalTwinsService2.api.wus2.ss.azuredigitaltwins-test.net","provisioningState":"Provisioning"},"sku":{"name":"F1"},"type":"Microsoft.DigitalTwins/DigitalTwinsInstance"}]}},"Delete_a_DigitalTwinsInstance_resource":{"value":{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService","location":"westus","name":"myDigitalTwinsService","properties":{"createdTime":"2019-11-19T12:55:05.229Z","hostName":"https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net","lastUpdatedTime":"2019-12-06T12:21:58.610Z","provisioningState":"Deleting"},"sku":{"name":"F1"},"type":"Microsoft.DigitalTwins/DigitalTwinsInstance"}},"Get_a_DigitalTwinsInstance_resource":{"value":{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService","location":"westus","name":"myDigitalTwinsService","properties":{"createdTime":"2019-11-19T12:55:05.229Z","hostName":"https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net","lastUpdatedTime":"2019-12-06T12:21:58.610Z","provisioningState":"Provisioning"},"sku":{"name":"F1"},"type":"Microsoft.DigitalTwins/DigitalTwinsInstance"}},"Patch_a_DigitalTwinsInstance_resource":{"value":{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService","location":"westus","name":"myDigitalTwinsService","properties":{"createdTime":"2019-11-19T12:55:05.229Z","hostName":"https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net","lastUpdatedTime":"2019-12-06T12:21:58.610Z","provisioningState":"Provisioning"},"sku":{"name":"F1"},"tags":{"purpose":"dev"},"type":"Microsoft.DigitalTwins/DigitalTwinsInstance"}},"Put_a_DigitalTwinsInstance_resource":{"value":{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus","name":"myendpoint","properties":{"createdTime":"2019-11-19T01:10:34.350Z","endpointType":"ServiceBus","primaryConnectionString":"************","provisioningState":"Provisioning","secondaryConnectionString":"************"},"type":"Microsoft.DigitalTwins/digitalTwinsInstance/endpoints"}},"Get_a_DigitalTwinsInstance_endpoints":{"value":{"value":[{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus","name":"myendpoint1","properties":{"createdTime":"2019-11-19T01:10:34.350Z","endpointType":"ServiceBus","primaryConnectionString":"************","provisioningState":"Provisioned","secondaryConnectionString":"************"},"type":"Microsoft.DigitalTwins/digitalTwinsInstance/endpoints"},{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus","name":"myendpoint2","properties":{"connectionString-PrimaryKey":"************","connectionString-SecondaryKey":"************","createdTime":"2019-11-19T01:10:34.350Z","endpointType":"EventHub","provisioningState":"Provisioned"},"type":"Microsoft.DigitalTwins/digitalTwinsInstance/endpoints"}]}},"Delete_a_DigitalTwinsInstance_endpoint":{"value":{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus","name":"myendpoint","properties":{"createdTime":"2019-11-19T01:10:34.350Z","endpointType":"ServiceBus","primaryConnectionString":"************","provisioningState":"Deleting","secondaryConnectionString":"************"},"type":"Microsoft.DigitalTwins/digitalTwinsInstance/endpoints"}},"Get_a_DigitalTwinsInstance_endpoint":{"value":{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/DigitalTwinsInstance/myDigitalTwinsService/endpoints/myServiceBus","name":"myendpoint","properties":{"createdTime":"2019-11-19T01:10:34.350Z","endpointType":"ServiceBus","primaryConnectionString":"************","provisioningState":"Provisioned","secondaryConnectionString":"************"},"type":"Microsoft.DigitalTwins/digitalTwinsInstance/endpoints"}},"Get_a_DigitalTwinsInstance_IoTHubs":{"value":{"value":[{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.Devices/IoTHubs/firstIh/Microsoft.DigitalTwins/integrationResources/myIoTHubLink1","name":"myIoTHubLink1","properties":{"createdTime":"2019-11-19T12:57:15.452Z","provisioningState":"Provisioned","resourceId":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwins/myAdt"},"type":"Microsoft.DigitalTwins/integrationResources"},{"id":"/subscriptions/f2bc87c8-fa5d-4c74-822e-7fd480f8df00/resourcegroups/anotherrg/providers/Microsoft.Devices/IoTHubs/secondIh/Microsoft.DigitalTwins/integrationResources/myIoTHubLink2","name":"myIoTHubLink2","properties":{"createdTime":"2019-12-29T12:57:15.452Z","provisioningState":"Provisioned","resourceId":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwins/myAdt"},"type":"Microsoft.DigitalTwins/integrationResources"}]}},"Connect_IoTHub_with_DigitalTwinsInstance":{"value":{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.Devices/IoTHubs/myIoTHub/provider/Microsoft.DigitalTwins/integrationResources/myIoTHubLink","name":"myIoTHubLink","properties":{"createdTime":"2019-11-19T12:57:15.452Z","provisioningState":"Provisioning","resourceId":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwins/myAdt"},"type":"Microsoft.DigitalTwins/integrationResources"}},"Get_IoTHub_by_DigitalTwinsInstance":{"value":{"id":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.Devices/IoTHubs/myIoTHub/provider/Microsoft.DigitalTwins/integrationResources/myIoTHubLink","name":"myIoTHubLink","properties":{"createdTime":"2019-11-19T12:57:15.452Z","provisioningState":"Provisioned","resourceId":"/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwins/myAdt"},"type":"Microsoft.DigitalTwins/integrationResources"}}},"parameters":{"api-version":{"description":"Version of the DigitalTwinsInstance Management API.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":10,"enum":["2020-03-01-preview"]},"examples":{"Get available operations":{"value":"2020-03-01-preview"},"Get DigitalTwinsInstance resources by subscription":{"value":"2020-03-01-preview"},"Check name Availability":{"value":"2020-03-01-preview"},"Get DigitalTwinsInstance resources by resource group":{"value":"2020-03-01-preview"},"Delete a DigitalTwinsInstance resource":{"value":"2020-03-01-preview"},"Get a DigitalTwinsInstance resource":{"value":"2020-03-01-preview"},"Patch a DigitalTwinsInstance resource":{"value":"2020-03-01-preview"},"Put a DigitalTwinsInstance resource":{"value":"2020-03-01-preview"},"Get a DigitalTwinsInstance endpoints":{"value":"2020-03-01-preview"},"Delete a DigitalTwinsInstance endpoint":{"value":"2020-03-01-preview"},"Get a DigitalTwinsInstance endpoint":{"value":"2020-03-01-preview"},"Get a DigitalTwinsInstance IoTHubs":{"value":"2020-03-01-preview"}}},"endpointName":{"description":"Name of Endpoint Resource.","in":"path","name":"endpointName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9-._]{1,64}$"},"examples":{"Delete a DigitalTwinsInstance endpoint":{"value":"myendpoint"},"Get a DigitalTwinsInstance endpoint":{"value":"myServiceBus"},"Put a DigitalTwinsInstance resource":{"value":"myServiceBus"}}},"integrationResourceName":{"description":"Name of IoTHub and DigitalTwinsInstance integration instance.","in":"path","name":"integrationResourceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":64},"examples":{"Connect IoTHub with DigitalTwinsInstance":{"value":"myIoTHubLink"},"Get IoTHub by DigitalTwinsInstance":{"value":"myIoTHubLink"}}},"location":{"description":"Location of DigitalTwinsInstance.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":3},"examples":{"Check name Availability":{"value":"WestUS"}}},"resourceGroupName":{"description":"The name of the resource group that contains the DigitalTwinsInstance.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":64},"examples":{"Get DigitalTwinsInstance resources by resource group":{"value":"resRg"},"Delete a DigitalTwinsInstance resource":{"value":"resRg"},"Get a DigitalTwinsInstance resource":{"value":"resRg"},"Patch a DigitalTwinsInstance resource":{"value":"resRg"},"Put a DigitalTwinsInstance resource":{"value":"resRg"},"Get a DigitalTwinsInstance endpoints":{"value":"resRg"},"Delete a DigitalTwinsInstance endpoint":{"value":"resRg"},"Get a DigitalTwinsInstance endpoint":{"value":"resRg"},"Get a DigitalTwinsInstance IoTHubs":{"value":"resRg"}}},"resourceName":{"description":"The name of the DigitalTwinsInstance.","in":"path","name":"resourceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":64},"examples":{"Delete a DigitalTwinsInstance resource":{"value":"myDigitalTwinsService"},"Get a DigitalTwinsInstance resource":{"value":"myDigitalTwinsService"},"Patch a DigitalTwinsInstance resource":{"value":"myDigitalTwinsService"},"Put a DigitalTwinsInstance resource":{"value":"myDigitalTwinsService"},"Get a DigitalTwinsInstance endpoints":{"value":"myDigitalTwinsService"},"Delete a DigitalTwinsInstance endpoint":{"value":"myDigitalTwinsService"},"Get a DigitalTwinsInstance endpoint":{"value":"myDigitalTwinsService"},"Get a DigitalTwinsInstance IoTHubs":{"value":"myAdt"}}},"scope":{"description":"The scope of the Digital Twins Integration. The scope has to be an IoTHub resource. For example, /{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IoTHubs/{resourceName}.","in":"path","name":"scope","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Connect IoTHub with DigitalTwinsInstance":{"value":"subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.Devices/IoTHubs/myIoTHub"},"Get IoTHub by DigitalTwinsInstance":{"value":"subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.Devices/IoTHubs/myIoTHub"}}},"subscriptionId":{"description":"The subscription identifier.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Get DigitalTwinsInstance resources by subscription":{"value":"50016170-c839-41ba-a724-51e9df440b9e"},"Check name Availability":{"value":"50016170-c839-41ba-a724-51e9df440b9e"},"Get DigitalTwinsInstance resources by resource group":{"value":"50016170-c839-41ba-a724-51e9df440b9e"},"Delete a DigitalTwinsInstance resource":{"value":"50016170-c839-41ba-a724-51e9df440b9e"},"Get a DigitalTwinsInstance resource":{"value":"50016170-c839-41ba-a724-51e9df440b9e"},"Patch a DigitalTwinsInstance resource":{"value":"50016170-c839-41ba-a724-51e9df440b9e"},"Put a DigitalTwinsInstance resource":{"value":"50016170-c839-41ba-a724-51e9df440b9e"},"Get a DigitalTwinsInstance endpoints":{"value":"50016170-c839-41ba-a724-51e9df440b9e"},"Delete a DigitalTwinsInstance endpoint":{"value":"50016170-c839-41ba-a724-51e9df440b9e"},"Get a DigitalTwinsInstance endpoint":{"value":"50016170-c839-41ba-a724-51e9df440b9e"},"Get a DigitalTwinsInstance IoTHubs":{"value":"50016170-c839-41ba-a724-51e9df440b9e"}}}},"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":{"CheckNameRequest":{"description":"The result returned from a database check name availability request.","properties":{"name":{"description":"Resource name.","type":"string"},"type":{"description":"The type of resource, for instance Microsoft.DigitalTwins/digitalTwinsInstances.","enum":["Microsoft.DigitalTwins/digitalTwinsInstances"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"Type"}}},"required":["name","type"],"type":"object"},"CheckNameResult":{"description":"The result returned from a check name availability request.","properties":{"message":{"description":"Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.","type":"string"},"name":{"description":"The name that was checked.","type":"string"},"nameAvailable":{"description":"Specifies a Boolean value that indicates if the name is available.","type":"boolean"},"reason":{"description":"Message providing the reason why the given name is invalid.","enum":["Invalid","AlreadyExists"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"reason"}}},"type":"object"},"DigitalTwinsDescription":{"allOf":[{"$ref":"#/components/schemas/DigitalTwinsResource"}],"description":"The description of the DigitalTwins service.","properties":{"properties":{"$ref":"#/components/schemas/DigitalTwinsProperties"}},"required":["sku"],"type":"object"},"DigitalTwinsDescriptionListResult":{"description":"A list of DigitalTwins description objects with a next link.","properties":{"nextLink":{"description":"The link used to get the next page of DigitalTwins description objects.","type":"string"},"value":{"description":"A list of DigitalTwins description objects.","items":{"$ref":"#/components/schemas/DigitalTwinsDescription"},"type":"array"}},"type":"object"},"DigitalTwinsEndpointResource":{"allOf":[{"$ref":"#/components/schemas/ExternalResource"}],"description":"DigitalTwinsInstance endpoint resource.","properties":{"properties":{"$ref":"#/components/schemas/DigitalTwinsEndpointResourceProperties"}},"x-ms-azure-resource":true},"DigitalTwinsEndpointResourceListResult":{"description":"A list of DigitalTwinsInstance Endpoints with a next link.","properties":{"nextLink":{"description":"The link used to get the next page of DigitalTwinsInstance Endpoints.","type":"string"},"value":{"description":"A list of DigitalTwinsInstance Endpoints.","items":{"$ref":"#/components/schemas/DigitalTwinsEndpointResource"},"type":"array"}},"type":"object"},"DigitalTwinsEndpointResourceProperties":{"description":"Properties related to Digital Twins Endpoint","discriminator":{"propertyName":"endpointType"},"properties":{"createdTime":{"description":"Time when the Endpoint was added to DigitalTwinsInstance.","format":"date-time","readOnly":true,"type":"string"},"endpointType":{"description":"The type of Digital Twins endpoint","enum":["EventHub","EventGrid","ServiceBus"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"endpointType"}},"provisioningState":{"description":"The provisioning state.","enum":["Provisioning","Deleting","Succeeded","Failed","Canceled"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"EndpointProvisioningState"}},"tags":{"additionalProperties":{"type":"string"},"description":"The resource tags.","type":"object"}},"required":["endpointType"]},"DigitalTwinsIntegrationResourceListResult":{"description":"A list of DigitalTwinsInstance IoTHubs with a next link.","properties":{"nextLink":{"description":"The link used to get the next page of DigitalTwinsInstance IoTHubs.","type":"string"},"value":{"description":"A list of DigitalTwinsInstance IoTHubs.","items":{"$ref":"#/components/schemas/IntegrationResource"},"type":"array"}},"type":"object"},"DigitalTwinsPatchDescription":{"description":"The description of the DigitalTwins service.","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"Instance tags","type":"object"}},"type":"object"},"DigitalTwinsProperties":{"description":"The properties of a DigitalTwinsInstance.","properties":{"createdTime":{"description":"Time when DigitalTwinsInstance was created.","format":"date-time","readOnly":true,"type":"string"},"hostName":{"description":"Api endpoint to work with DigitalTwinsInstance.","readOnly":true,"type":"string"},"lastUpdatedTime":{"description":"Time when DigitalTwinsInstance was created.","format":"date-time","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"}}},"type":"object"},"DigitalTwinsResource":{"description":"The common properties of a DigitalTwinsInstance.","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"},"sku":{"$ref":"#/components/schemas/DigitalTwinsSkuInfo"},"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},"DigitalTwinsSkuInfo":{"description":"Information about the SKU of the DigitalTwinsInstance.","properties":{"name":{"description":"The name of the SKU.","enum":["F1"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"DigitalTwinsSku"}}},"required":["name"],"type":"object"},"ErrorDefinition":{"description":"Error definition.","properties":{"code":{"description":"Service specific error code which serves as the substatus for the HTTP error code.","readOnly":true,"type":"string"},"details":{"description":"Internal error details.","items":{"$ref":"#/components/schemas/ErrorDefinition"},"readOnly":true,"type":"array"},"message":{"description":"Description of the error.","readOnly":true,"type":"string"}}},"ErrorResponse":{"description":"Error response.","properties":{"error":{"$ref":"#/components/schemas/ErrorDefinition"}}},"EventGrid":{"allOf":[{"$ref":"#/components/schemas/DigitalTwinsEndpointResourceProperties"},{"properties":{"TopicEndpoint":{"description":"EventGrid Topic Endpoint","type":"string"},"accessKey1":{"description":"EventGrid secondary accesskey. Will be obfuscated during read","type":"string"},"accessKey2":{"description":"EventGrid secondary accesskey. Will be obfuscated during read","type":"string"}},"type":"object"}],"description":"properties related to eventgrid.","required":["accessKey1","accessKey2"],"x-ms-discriminator-value":"EventGrid"},"EventHub":{"allOf":[{"properties":{"connectionString-PrimaryKey":{"description":"PrimaryConnectionString of the endpoint. Will be obfuscated during read","type":"string"},"connectionString-SecondaryKey":{"description":"SecondaryConnectionString of the endpoint. Will be obfuscated during read","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/DigitalTwinsEndpointResourceProperties"}],"description":"properties related to eventhub.","required":["connectionString-PrimaryKey","connectionString-SecondaryKey"],"x-ms-discriminator-value":"EventHub"},"ExternalResource":{"description":"Definition of a Resource.","properties":{"id":{"description":"The resource identifier.","readOnly":true,"type":"string"},"name":{"description":"Extension resource name.","pattern":"^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$","readOnly":true,"type":"string"},"type":{"description":"The resource type.","readOnly":true,"type":"string"}},"type":"object"},"IntegrationResource":{"allOf":[{"$ref":"#/components/schemas/ExternalResource"}],"description":"IoTHub integration resource.","properties":{"properties":{"$ref":"#/components/schemas/IntegrationResourceProperties"}},"type":"object"},"IntegrationResourceProperties":{"allOf":[{"$ref":"#/components/schemas/IntegrationResourceState"}],"description":"Properties related to the IoTHub DigitalTwinsInstance Integration Resource.","properties":{"createdTime":{"description":"Time when the IoTHub was added to DigitalTwinsInstance.","format":"date-time","readOnly":true,"type":"string"},"resourceId":{"description":"Fully qualified resource identifier of the DigitalTwins Azure resource.","type":"string"}},"type":"object"},"IntegrationResourceState":{"description":"Properties related to the IoTHub DigitalTwinsInstance Integration Resource.","properties":{"provisioningState":{"description":"DigitalTwinsInstance - IoTHub link state.","enum":["Provisioning","Deleting","Succeeded","Failed","Canceled"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"IntegrationResourceState"}}},"type":"object"},"IntegrationResourceUpdateInfo":{"allOf":[{"$ref":"#/components/schemas/ExternalResource"}],"description":"IoTHub integration resource.","properties":{"properties":{"$ref":"#/components/schemas/IntegrationResourceUpdateProperties"}},"type":"object"},"IntegrationResourceUpdateProperties":{"allOf":[{"$ref":"#/components/schemas/IntegrationResourceState"}],"description":"Updatable properties related to the IoTHub DigitalTwinsInstance Integration Resource.","type":"object"},"Operation":{"description":"DigitalTwins 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 DigitalTwins","readOnly":true,"type":"string"},"resource":{"description":"Resource Type: DigitalTwinsInstances","readOnly":true,"type":"string"}},"type":"object"},"OperationListResult":{"description":"A list of DigitalTwins 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 DigitalTwins description objects.","type":"string"},"value":{"description":"A list of DigitalTwins operations supported by the Microsoft.DigitalTwins resource provider.","items":{"$ref":"#/components/schemas/Operation"},"readOnly":true,"type":"array"}},"type":"object"},"ServiceBus":{"allOf":[{"$ref":"#/components/schemas/DigitalTwinsEndpointResourceProperties"},{"properties":{"primaryConnectionString":{"description":"PrimaryConnectionString of the endpoint. Will be obfuscated during read","type":"string"},"secondaryConnectionString":{"description":"SecondaryConnectionString of the endpoint. Will be obfuscated during read","type":"string"}},"type":"object"}],"description":"properties related to servicebus.","required":["primaryConnectionString","secondaryConnectionString"],"x-ms-discriminator-value":"ServiceBus"}}}}