Microsoft Azure

Azure Digitaltwins (2023-01-31)

Azure Digital Twins Client for managing DigitalTwinsInstance

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure Digital Twins Client for managing DigitalTwinsInstance

Endpoints 22

DigitalTwinsInstance

  • GETDigitalTwins_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName?api-version=stringGet DigitalTwinsInstances resource.
  • PUTDigitalTwins_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName?api-version=stringCreate or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata,…
  • DELETEDigitalTwins_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName?api-version=stringDelete a DigitalTwinsInstance.
  • PATCHDigitalTwins_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName?api-version=stringUpdate metadata of DigitalTwinsInstance.
  • GETDigitalTwins_List/subscriptions/:subscriptionId/providers/Microsoft.DigitalTwins/digitalTwinsInstances?api-version=stringGet all the DigitalTwinsInstances in a subscription.
  • GETDigitalTwins_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances?api-version=stringGet all the DigitalTwinsInstances in a resource group.

Endpoints

  • GETDigitalTwinsEndpoint_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/endpoints?api-version=stringGet DigitalTwinsInstance Endpoints.
  • GETDigitalTwinsEndpoint_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/endpoints/:endpointName?api-version=stringGet DigitalTwinsInstances Endpoint.
  • PUTDigitalTwinsEndpoint_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/endpoints/:endpointName?api-version=stringCreate or update DigitalTwinsInstance endpoint.
  • DELETEDigitalTwinsEndpoint_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/endpoints/:endpointName?api-version=stringDelete a DigitalTwinsInstance endpoint.

Operations

  • GETOperations_List/providers/Microsoft.DigitalTwins/operations?api-version=stringLists all of the available DigitalTwins service REST API operations.

CheckNameAvailability

  • POSTDigitalTwins_CheckNameAvailability/subscriptions/:subscriptionId/providers/Microsoft.DigitalTwins/locations/:location/checkNameAvailability?api-version=stringCheck if a DigitalTwinsInstance name is available.

PrivateEndpoints

  • GETPrivateLinkResources_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/privateLinkResources?api-version=stringList private link resources for given Digital Twin.
  • GETPrivateLinkResources_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/privateLinkResources/:resourceId?api-version=stringGet the specified private link resource for the given Digital Twin.
  • GETPrivateEndpointConnections_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/privateEndpointConnections?api-version=stringList private endpoint connection properties.
  • GETPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringGet private endpoint connection properties for the given private endpoint.
  • PUTPrivateEndpointConnections_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringUpdate the status of a private endpoint connection with the given name.
  • DELETEPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringDelete private endpoint connection with the specified name.

TimeSeriesDatabaseConnections

  • GETTimeSeriesDatabaseConnections_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/timeSeriesDatabaseConnections?api-version=stringGet all existing time series database connections for this DigitalTwins instance.
  • GETTimeSeriesDatabaseConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/timeSeriesDatabaseConnections/:timeSeriesDatabaseConnectionName?api-version=stringGet the description of an existing time series database connection.
  • PUTTimeSeriesDatabaseConnections_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/timeSeriesDatabaseConnections/:timeSeriesDatabaseConnectionName?api-version=stringCreate or update a time series database connection.
  • DELETETimeSeriesDatabaseConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName/timeSeriesDatabaseConnections/:timeSeriesDatabaseConnectionName?api-version=string&cleanupConnectionArtifacts=trueDelete a time series database connection.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
22 operations on 13 pathsGET 12PUT 4DELETE 4POST 1PATCH 1
Main resources
DigitalTwinsInstance 6PrivateEndpoints 6Endpoints 4TimeSeriesDatabaseConnections 4CheckNameAvailability 1Operations 1
Response formats
application/json
Description format
Swagger 2.0, API version 2023-01-31

How to test the Azure Digitaltwins (2023-01-31) in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Digitaltwins (2023-01-31) collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “DigitalTwins_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DigitalTwins/digitalTwinsInstances/:resourceName?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Digitaltwins (2023-01-31)?

Azure Digital Twins Client for managing DigitalTwinsInstance It is listed under Developer tools and has 22 endpoints.

Who publishes the Azure Digitaltwins (2023-01-31)?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Digitaltwins (2023-01-31)?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Digitaltwins (2023-01-31)?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Digitaltwins (2023-01-31) have?

22 operations on 13 paths (12 GET, 4 PUT, 4 DELETE, 1 POST, 1 PATCH). The largest groups are DigitalTwinsInstance, PrivateEndpoints, Endpoints, TimeSeriesDatabaseConnections.

Is forking the Azure Digitaltwins (2023-01-31) free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.