{ "swagger": "2.0", "info": { "version": "2023-01-31", "title": "AzureDigitalTwinsManagementClient", "description": "Azure Digital Twins Client for managing DigitalTwinsInstance" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "Impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}": { "get": { "tags": [ "DigitalTwinsInstance" ], "description": "Get DigitalTwinsInstances resource.", "operationId": "DigitalTwins_Get", "x-ms-examples": { "Get a DigitalTwinsInstance resource": { "$ref": "./examples/DigitalTwinsGet_example.json" }, "Get a DigitalTwinsInstance resource with identity": { "$ref": "./examples/DigitalTwinsGet_WithIdentity_example.json" }, "Get a DigitalTwinsInstance resource with a private endpoint connection": { "$ref": "./examples/DigitalTwinsGet_WithPrivateEndpointConnection_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" } ], "responses": { "200": { "description": "The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.", "schema": { "$ref": "#/definitions/DigitalTwinsDescription" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "DigitalTwinsInstance" ], "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", "x-ms-long-running-operation": true, "x-ms-examples": { "Put a DigitalTwinsInstance resource": { "$ref": "./examples/DigitalTwinsPut_example.json" }, "Put a DigitalTwinsInstance resource with identity": { "$ref": "./examples/DigitalTwinsPut_WithIdentity_example.json" }, "Put a DigitalTwinsInstance resource with publicNetworkAccess property": { "$ref": "./examples/DigitalTwinsPut_WithPublicNetworkAccess.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "name": "digitalTwinsCreate", "in": "body", "description": "The DigitalTwinsInstance and security metadata.", "required": true, "schema": { "$ref": "#/definitions/DigitalTwinsDescription" } } ], "responses": { "200": { "description": "This is returned as a response when the resource already exists and was updated successfully.", "schema": { "$ref": "#/definitions/DigitalTwinsDescription" } }, "201": { "description": "Created - Put request accepted; the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/DigitalTwinsDescription" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "DigitalTwinsInstance" ], "description": "Update metadata of DigitalTwinsInstance.", "operationId": "DigitalTwins_Update", "x-ms-long-running-operation": true, "x-ms-examples": { "Patch a DigitalTwinsInstance resource": { "$ref": "./examples/DigitalTwinsPatch_example.json" }, "Patch a DigitalTwinsInstance resource with identity": { "$ref": "./examples/DigitalTwinsPatch_WithIdentity_example.json" }, "Patch a DigitalTwinsInstance resource with publicNetworkAccess property": { "$ref": "./examples/DigitalTwinsPatch_WithPublicNetworkAccess.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "name": "digitalTwinsPatchDescription", "in": "body", "description": "The DigitalTwinsInstance and security metadata.", "required": true, "schema": { "$ref": "#/definitions/DigitalTwinsPatchDescription" } } ], "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.", "schema": { "$ref": "#/definitions/DigitalTwinsDescription" } }, "202": { "description": "Accepted - Patch request accepted; the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/DigitalTwinsDescription" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "DigitalTwinsInstance" ], "description": "Delete a DigitalTwinsInstance.", "operationId": "DigitalTwins_Delete", "x-ms-long-running-operation": true, "x-ms-examples": { "Delete a DigitalTwinsInstance resource": { "$ref": "./examples/DigitalTwinsDelete_example.json" }, "Delete a DigitalTwinsInstance resource with identity": { "$ref": "./examples/DigitalTwinsDelete_WithIdentity_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" } ], "responses": { "200": { "description": "Returned if the operation was canceled or failed.", "schema": { "$ref": "#/definitions/DigitalTwinsDescription" } }, "202": { "description": "Accepted - Delete request accepted; the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/DigitalTwinsDescription" } }, "204": { "description": "Returned when the long running delete operation has finished, or the Digital Twins instance does not exist." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints": { "get": { "tags": [ "Endpoints" ], "description": "Get DigitalTwinsInstance Endpoints.", "operationId": "DigitalTwinsEndpoint_List", "x-ms-examples": { "Get a DigitalTwinsInstance endpoints": { "$ref": "./examples/DigitalTwinsEndpointsGet_example.json" }, "Get a DigitalTwinsInstance endpoints with identity": { "$ref": "./examples/DigitalTwinsEndpointsGet_WithIdentity_example.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" } ], "responses": { "200": { "description": "The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.", "schema": { "$ref": "#/definitions/DigitalTwinsEndpointResourceListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}": { "get": { "tags": [ "Endpoints" ], "description": "Get DigitalTwinsInstances Endpoint.", "operationId": "DigitalTwinsEndpoint_Get", "x-ms-examples": { "Get a DigitalTwinsInstance endpoint": { "$ref": "./examples/DigitalTwinsEndpointGet_example.json" }, "Get a DigitalTwinsInstance endpoint with identity": { "$ref": "./examples/DigitalTwinsEndpointGet_WithIdentity_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "$ref": "#/parameters/endpointName" } ], "responses": { "200": { "description": "The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.", "schema": { "$ref": "#/definitions/DigitalTwinsEndpointResource" } }, "default": { "description": "Default error response", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "Endpoints" ], "description": "Create or update DigitalTwinsInstance endpoint.", "operationId": "DigitalTwinsEndpoint_CreateOrUpdate", "x-ms-long-running-operation": true, "x-ms-examples": { "Put a DigitalTwinsEndpoint resource": { "$ref": "./examples/DigitalTwinsEndpointPut_example.json" }, "Put a DigitalTwinsEndpoint resource with identity": { "$ref": "./examples/DigitalTwinsEndpointPut_WithIdentity_example.json" }, "Put a DigitalTwinsEndpoint resource with user assigned identity": { "$ref": "./examples/DigitalTwinsEndpointPut_WithUserIdentity_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "$ref": "#/parameters/endpointName" }, { "name": "endpointDescription", "in": "body", "description": "The DigitalTwinsInstance endpoint metadata and security metadata.", "required": true, "schema": { "$ref": "#/definitions/DigitalTwinsEndpointResource" } } ], "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.", "schema": { "$ref": "#/definitions/DigitalTwinsEndpointResource" } }, "201": { "description": "Created - Put request accepted; the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/DigitalTwinsEndpointResource" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "Endpoints" ], "description": "Delete a DigitalTwinsInstance endpoint.", "operationId": "DigitalTwinsEndpoint_Delete", "x-ms-long-running-operation": true, "x-ms-examples": { "Delete a DigitalTwinsInstance endpoint": { "$ref": "./examples/DigitalTwinsEndpointDelete_example.json" }, "Delete a DigitalTwinsInstance endpoint with identity": { "$ref": "./examples/DigitalTwinsEndpointDelete_WithIdentity_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "$ref": "#/parameters/endpointName" } ], "responses": { "200": { "description": "Returned if the operation was canceled or failed.", "schema": { "$ref": "#/definitions/DigitalTwinsEndpointResource" } }, "202": { "description": "Accepted - Delete request accepted; the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/DigitalTwinsEndpointResource" } }, "204": { "description": "Returned when the long running delete operation has finished, or the egress endpoint does not exist." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/digitalTwinsInstances": { "get": { "tags": [ "DigitalTwinsInstance" ], "description": "Get all the DigitalTwinsInstances in a subscription.", "operationId": "DigitalTwins_List", "x-ms-examples": { "Get DigitalTwinsInstance resources by subscription": { "$ref": "./examples/DigitalTwinsList_example.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/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.", "schema": { "$ref": "#/definitions/DigitalTwinsDescriptionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances": { "get": { "tags": [ "DigitalTwinsInstance" ], "description": "Get all the DigitalTwinsInstances in a resource group.", "operationId": "DigitalTwins_ListByResourceGroup", "x-ms-examples": { "Get DigitalTwinsInstance resources by resource group": { "$ref": "./examples/DigitalTwinsListByResourceGroup_example.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/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. If more data is available, the body will contain a link to the next page of items (nextLink).", "schema": { "$ref": "#/definitions/DigitalTwinsDescriptionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/providers/Microsoft.DigitalTwins/operations": { "get": { "tags": [ "Operations" ], "description": "Lists all of the available DigitalTwins service REST API operations.", "operationId": "Operations_List", "x-ms-examples": { "Get available operations": { "$ref": "./examples/DigitalTwinsOperationsList_example.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" ], "description": "Check if a DigitalTwinsInstance name is available.", "operationId": "DigitalTwins_CheckNameAvailability", "x-ms-examples": { "Check name Availability": { "$ref": "./examples/DigitalTwinsCheckNameAvailability_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/location" }, { "name": "digitalTwinsInstanceCheckName", "in": "body", "description": "Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check.", "required": true, "schema": { "$ref": "#/definitions/CheckNameRequest" } } ], "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.", "schema": { "$ref": "#/definitions/CheckNameResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateLinkResources": { "get": { "tags": [ "PrivateEndpoints" ], "description": "List private link resources for given Digital Twin.", "operationId": "PrivateLinkResources_List", "x-ms-examples": { "List private link resources for given Digital Twin": { "$ref": "./examples/PrivateLinkResourcesList_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" } ], "responses": { "200": { "description": "The body contains the list of private link resources.", "schema": { "$ref": "#/definitions/GroupIdInformationResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateLinkResources/{resourceId}": { "get": { "tags": [ "PrivateEndpoints" ], "description": "Get the specified private link resource for the given Digital Twin.", "operationId": "PrivateLinkResources_Get", "x-ms-examples": { "Get the specified private link resource for the given Digital Twin": { "$ref": "./examples/PrivateLinkResourcesByGroupId_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "$ref": "#/parameters/resourceId" } ], "responses": { "200": { "description": "The body contains the specified of private link resource.", "schema": { "$ref": "#/definitions/GroupIdInformation" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections": { "get": { "tags": [ "PrivateEndpoints" ], "description": "List private endpoint connection properties.", "operationId": "PrivateEndpointConnections_List", "x-ms-examples": { "List private endpoint connection properties": { "$ref": "./examples/PrivateEndpointConnectionsList_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" } ], "responses": { "200": { "description": "The body contains the list of private endpoint connection properties.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionsResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "tags": [ "PrivateEndpoints" ], "description": "Get private endpoint connection properties for the given private endpoint.", "operationId": "PrivateEndpointConnections_Get", "x-ms-examples": { "Get private endpoint connection properties for the given private endpoint": { "$ref": "./examples/PrivateEndpointConnectionByConnectionName_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "$ref": "#/parameters/privateEndpointConnectionName" } ], "responses": { "200": { "description": "The body contains the private endpoint connection properties.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "PrivateEndpoints" ], "description": "Delete private endpoint connection with the specified name.", "operationId": "PrivateEndpointConnections_Delete", "x-ms-long-running-operation": true, "x-ms-examples": { "Delete private endpoint connection with the specified name": { "$ref": "./examples/PrivateEndpointConnectionDelete_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "$ref": "#/parameters/privateEndpointConnectionName" } ], "responses": { "200": { "description": "Returned when the long running delete operation has failed, and has reached a terminal state." }, "202": { "description": "This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. The status URL returns 204 No Content when the deletion is complete." }, "204": { "description": "Returned when the long running delete operation has finished, or the private endpoint does not exist." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "PrivateEndpoints" ], "description": "Update the status of a private endpoint connection with the given name.", "operationId": "PrivateEndpointConnections_CreateOrUpdate", "x-ms-long-running-operation": true, "x-ms-examples": { "Update the status of a private endpoint connection with the given name": { "$ref": "./examples/PrivateEndpointConnectionPut_example.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "$ref": "#/parameters/privateEndpointConnectionName" }, { "name": "privateEndpointConnection", "in": "body", "description": "The private endpoint connection with updated properties.", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } } ], "responses": { "202": { "description": "This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 200 (OK).", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "200": { "description": "This is returned as a response when the resource already exists and was updated successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections": { "get": { "tags": [ "TimeSeriesDatabaseConnections" ], "description": "Get all existing time series database connections for this DigitalTwins instance.", "operationId": "TimeSeriesDatabaseConnections_List", "x-ms-pageable": { "nextLinkName": "nextLink" }, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" } ], "responses": { "200": { "description": "List of time series database connections for this DigitalTwins instance.", "schema": { "$ref": "#/definitions/TimeSeriesDatabaseConnectionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List time series database connections for a DigitalTwins instance.": { "$ref": "./examples/TimeSeriesDatabaseConnectionsList_example.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}": { "get": { "tags": [ "TimeSeriesDatabaseConnections" ], "description": "Get the description of an existing time series database connection.", "operationId": "TimeSeriesDatabaseConnections_Get", "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "$ref": "#/parameters/timeSeriesDatabaseConnectionName" } ], "responses": { "200": { "description": "Description of the time series connection.", "schema": { "$ref": "#/definitions/TimeSeriesDatabaseConnection" } }, "default": { "description": "Default error response", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get time series database connection for a DigitalTwins instance.": { "$ref": "./examples/TimeSeriesDatabaseConnectionsGet_example.json" } } }, "put": { "tags": [ "TimeSeriesDatabaseConnections" ], "description": "Create or update a time series database connection.", "operationId": "TimeSeriesDatabaseConnections_CreateOrUpdate", "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "$ref": "#/parameters/timeSeriesDatabaseConnectionName" }, { "name": "timeSeriesDatabaseConnectionDescription", "in": "body", "description": "The time series database connection description.", "required": true, "schema": { "$ref": "#/definitions/TimeSeriesDatabaseConnection" } } ], "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.", "schema": { "$ref": "#/definitions/TimeSeriesDatabaseConnection" } }, "201": { "description": "Created - Put request accepted; the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/TimeSeriesDatabaseConnection" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or replace a time series database connection for a DigitalTwins instance.": { "$ref": "./examples/TimeSeriesDatabaseConnectionsPut_example.json" }, "Create or replace a time series database connection for a DigitalTwins instance with user assigned identity.": { "$ref": "./examples/TimeSeriesDatabaseConnectionsPut_WithUserIdentity_example.json" } } }, "delete": { "tags": [ "TimeSeriesDatabaseConnections" ], "description": "Delete a time series database connection.", "operationId": "TimeSeriesDatabaseConnections_Delete", "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/api-version" }, { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/resourceGroupName" }, { "$ref": "#/parameters/resourceName" }, { "$ref": "#/parameters/timeSeriesDatabaseConnectionName" }, { "$ref": "#/parameters/cleanupConnectionArtifacts" } ], "responses": { "200": { "description": "Returned if the operation was canceled or failed.", "schema": { "$ref": "#/definitions/TimeSeriesDatabaseConnection" } }, "202": { "description": "Accepted - Delete request accepted; the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/TimeSeriesDatabaseConnection" } }, "204": { "description": "Returned when the long running delete operation has finished, or the time series database connection does not exist." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a time series database connection for a DigitalTwins instance.": { "$ref": "./examples/TimeSeriesDatabaseConnectionsDelete_example.json" } } } } }, "definitions": { "DigitalTwinsPatchProperties": { "description": "The properties of a DigitalTwinsInstance.", "type": "object", "properties": { "publicNetworkAccess": { "description": "Public network access for the DigitalTwinsInstance.", "enum": [ "Enabled", "Disabled" ], "type": "string", "x-nullable": true, "x-ms-enum": { "name": "publicNetworkAccess", "modelAsString": true } } } }, "DigitalTwinsProperties": { "description": "The properties of a DigitalTwinsInstance.", "type": "object", "properties": { "createdTime": { "description": "Time when DigitalTwinsInstance was created.", "readOnly": true, "type": "string", "format": "date-time" }, "lastUpdatedTime": { "description": "Time when DigitalTwinsInstance was updated.", "readOnly": true, "type": "string", "format": "date-time" }, "provisioningState": { "description": "The provisioning state.", "enum": [ "Provisioning", "Deleting", "Updating", "Succeeded", "Failed", "Canceled", "Deleted", "Warning", "Suspending", "Restoring", "Moving" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "provisioningState", "modelAsString": true } }, "hostName": { "description": "Api endpoint to work with DigitalTwinsInstance.", "type": "string", "x-nullable": true, "readOnly": true }, "privateEndpointConnections": { "description": "The private endpoint connections.", "type": "array", "x-nullable": true, "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "publicNetworkAccess": { "description": "Public network access for the DigitalTwinsInstance.", "enum": [ "Enabled", "Disabled" ], "type": "string", "x-nullable": true, "x-ms-enum": { "name": "publicNetworkAccess", "modelAsString": true } } } }, "DigitalTwinsDescription": { "description": "The description of the DigitalTwins service.", "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "description": "DigitalTwins instance properties.", "$ref": "#/definitions/DigitalTwinsProperties" } }, "allOf": [ { "$ref": "#/definitions/DigitalTwinsResource" } ] }, "DigitalTwinsPatchDescription": { "description": "The description of the DigitalTwins service.", "type": "object", "properties": { "tags": { "description": "Instance patch properties", "type": "object", "x-nullable": true, "additionalProperties": { "type": "string" } }, "identity": { "description": "The managed identity for the DigitalTwinsInstance.", "x-nullable": true, "$ref": "#/definitions/DigitalTwinsIdentity" }, "properties": { "description": "Properties for the DigitalTwinsInstance.", "x-nullable": true, "$ref": "#/definitions/DigitalTwinsPatchProperties" } } }, "DigitalTwinsResource": { "description": "The common properties of a DigitalTwinsInstance.", "properties": { "id": { "readOnly": true, "type": "string", "description": "The resource identifier." }, "name": { "readOnly": true, "type": "string", "description": "The resource name.", "pattern": "^(?!-)[A-Za-z0-9-]{3,63}(?