Delen via


Digital Twins Instance - DigitalTwins List

Download alle DigitalTwinsInstances in een abonnement.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/digitalTwinsInstances?api-version=2023-01-31

URI-parameters

Name In Vereist Type Description
subscriptionId
path True

string

De abonnements-id.

api-version
query True

string

Versie van de DigitalTwinsInstance Management-API.

Antwoorden

Name Type Description
200 OK

DigitalTwinsDescriptionListResult

Dit is een synchrone bewerking. De hoofdtekst bevat een JSON-geserialiseerde matrix van de metagegevens van alle DigitalTwinsInstances in het abonnement.

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Get DigitalTwinsInstance resources by subscription

Sample Request

GET https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/digitalTwinsInstances?api-version=2023-01-31

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
      "location": "westus2",
      "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
      "name": "myDigitalTwinsService",
      "systemData": {
        "createdBy": "user@example.com",
        "createdByType": "User",
        "createdAt": "2021-03-11T17:13:59.4037715Z",
        "lastModifiedBy": "d2baee3d-44c0-41b6-9961-92563de66a97",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2021-03-11T17:14:02.5281409Z"
      },
      "properties": {
        "createdTime": "2019-11-19T12:55:05.229Z",
        "lastUpdatedTime": "2019-11-19T12:55:07.229Z",
        "provisioningState": "Succeeded",
        "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
        "publicNetworkAccess": "Enabled"
      }
    },
    {
      "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg2/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService2",
      "location": "westus2",
      "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
      "name": "myDigitalTwinsService2",
      "systemData": {
        "createdBy": "user@example.com",
        "createdByType": "User",
        "createdAt": "2021-03-11T17:14:59.4037715Z",
        "lastModifiedBy": "429f7e65-6d99-455e-a469-7a885be68642",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2021-03-11T17:15:02.5281409Z"
      },
      "properties": {
        "createdTime": "2019-11-19T12:55:05.229Z",
        "lastUpdatedTime": "2019-11-19T12:55:07.229Z",
        "provisioningState": "Provisioning",
        "hostName": null,
        "publicNetworkAccess": "Enabled"
      }
    }
  ]
}

Definities

Name Description
ConnectionProperties

De eigenschappen van een privé-eindpuntverbinding.

ConnectionPropertiesProvisioningState

De inrichtingsstatus.

createdByType

Het type identiteit waarmee de resource is gemaakt.

DigitalTwinsDescription

De beschrijving van de DigitalTwins-service.

DigitalTwinsDescriptionListResult

Een lijst met DigitalTwins-beschrijvingsobjecten met een volgende koppeling.

DigitalTwinsIdentity

De beheerde identiteit voor de DigitalTwinsInstance.

DigitalTwinsIdentityType

Het type beheerde identiteit dat wordt gebruikt door de DigitalTwinsInstance.

ErrorDefinition

Foutdefinitie.

ErrorResponse

Foutreactie.

PrivateEndpoint

De privé-eindpunteigenschap van een privé-eindpuntverbinding.

PrivateEndpointConnection

De privé-eindpuntverbinding van een digital twin.

PrivateLinkServiceConnectionState

De verbindingsstatus.

PrivateLinkServiceConnectionStatus

De status van een privé-eindpuntverbinding.

provisioningState

De inrichtingsstatus.

publicNetworkAccess

Openbare netwerktoegang voor de DigitalTwinsInstance.

SystemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

UserAssignedIdentity

De informatie over de door de gebruiker toegewezen identiteit.

ConnectionProperties

De eigenschappen van een privé-eindpuntverbinding.

Name Type Description
groupIds

string[]

De lijst met groeps-id's voor de privé-eindpuntverbinding.

privateEndpoint

PrivateEndpoint

Het privé-eindpunt.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

De verbindingsstatus.

provisioningState

ConnectionPropertiesProvisioningState

De inrichtingsstatus.

ConnectionPropertiesProvisioningState

De inrichtingsstatus.

Name Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DigitalTwinsDescription

De beschrijving van de DigitalTwins-service.

Name Type Description
id

string

De resource-id.

identity

DigitalTwinsIdentity

De beheerde identiteit voor de DigitalTwinsInstance.

location

string

De resourcelocatie.

name

string

De resourcenaam.

properties.createdTime

string

Tijdstip waarop DigitalTwinsInstance is gemaakt.

properties.hostName

string

API-eindpunt voor gebruik met DigitalTwinsInstance.

properties.lastUpdatedTime

string

Tijdstip waarop DigitalTwinsInstance is bijgewerkt.

properties.privateEndpointConnections

PrivateEndpointConnection[]

De privé-eindpuntverbindingen.

properties.provisioningState

provisioningState

De inrichtingsstatus.

properties.publicNetworkAccess

publicNetworkAccess

Openbare netwerktoegang voor de DigitalTwinsInstance.

systemData

SystemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de DigitalTwinsInstance.

tags

object

De resourcetags.

type

string

Het resourcetype.

DigitalTwinsDescriptionListResult

Een lijst met DigitalTwins-beschrijvingsobjecten met een volgende koppeling.

Name Type Description
nextLink

string

De koppeling die wordt gebruikt om de volgende pagina van DigitalTwins-beschrijvingsobjecten op te halen.

value

DigitalTwinsDescription[]

Een lijst met DigitalTwins-beschrijvingsobjecten.

DigitalTwinsIdentity

De beheerde identiteit voor de DigitalTwinsInstance.

Name Type Description
principalId

string

De object-id van de beheerde identiteitsresource. Dit wordt vanuit ARM naar de RP verzonden via de header x-ms-identity-principal-id in de PUT-aanvraag als de resource een systemAssigned(impliciete) identiteit heeft

tenantId

string

De tenant-id van de beheerde identiteitsresource. Dit wordt vanuit ARM verzonden naar de RP via de header x-ms-client-tenant-id in de PUT-aanvraag als de resource een systemAssigned(impliciete) identiteit heeft

type

DigitalTwinsIdentityType

Het type beheerde identiteit dat wordt gebruikt door de DigitalTwinsInstance.

userAssignedIdentities

<string,  UserAssignedIdentity>

De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. .

DigitalTwinsIdentityType

Het type beheerde identiteit dat wordt gebruikt door de DigitalTwinsInstance.

Name Type Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ErrorDefinition

Foutdefinitie.

Name Type Description
code

string

Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.

details

ErrorDefinition[]

Details van interne fouten.

message

string

Beschrijving van de fout.

ErrorResponse

Foutreactie.

Name Type Description
error

ErrorDefinition

Foutbeschrijving

PrivateEndpoint

De privé-eindpunteigenschap van een privé-eindpuntverbinding.

Name Type Description
id

string

De resource-id.

PrivateEndpointConnection

De privé-eindpuntverbinding van een digital twin.

Name Type Description
id

string

De resource-id.

name

string

De resourcenaam.

properties

ConnectionProperties

De verbindingseigenschappen.

systemData

SystemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de privé-eindpuntverbinding.

type

string

Het resourcetype.

PrivateLinkServiceConnectionState

De verbindingsstatus.

Name Type Description
actionsRequired

string

Acties die vereist zijn voor een privé-eindpuntverbinding.

description

string

De beschrijving voor de huidige status van een privé-eindpuntverbinding.

status

PrivateLinkServiceConnectionStatus

De status van een privé-eindpuntverbinding.

PrivateLinkServiceConnectionStatus

De status van een privé-eindpuntverbinding.

Name Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

provisioningState

De inrichtingsstatus.

Name Type Description
Canceled

string

Deleted

string

Deleting

string

Failed

string

Moving

string

Provisioning

string

Restoring

string

Succeeded

string

Suspending

string

Updating

string

Warning

string

publicNetworkAccess

Openbare netwerktoegang voor de DigitalTwinsInstance.

Name Type Description
Disabled

string

Enabled

string

SystemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name Type Description
createdAt

string

Het tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit waarmee de resource is gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string

De tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.

UserAssignedIdentity

De informatie over de door de gebruiker toegewezen identiteit.

Name Type Description
clientId

string

De client-id van de door de gebruiker toegewezen identiteitsresource.

principalId

string

De object-id van de door de gebruiker toegewezen identiteitsresource.