Megosztás a következőn keresztül:


Time Series Database Connections - Get

Lekérheti egy meglévő idősorozat-adatbáziskapcsolat leírását.

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

URI-paraméterek

Name In Kötelező Típus Description
resourceGroupName
path True

string

A DigitalTwinsInstance erőforráscsoport neve.

resourceName
path True

string

A DigitalTwinsInstance neve.

Regex pattern: ^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$

subscriptionId
path True

string

Az előfizetés azonosítója.

timeSeriesDatabaseConnectionName
path True

string

Idősor-adatbáziskapcsolat neve.

Regex pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

api-version
query True

string

A DigitalTwinsInstance Management API verziója.

Válaszok

Name Típus Description
200 OK

TimeSeriesDatabaseConnection

Az idősorozat-kapcsolat leírása.

Other Status Codes

ErrorResponse

Alapértelmezett hibaválasz

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation A felhasználói fiók megszemélyesítése

Példák

Get time series database connection for a DigitalTwins instance.

Sample Request

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

Sample Response

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/timeSeriesDatabaseConnections/myConnection",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances/timeSeriesDatabaseConnections",
  "name": "myConnection",
  "properties": {
    "connectionType": "AzureDataExplorer",
    "provisioningState": "Succeeded",
    "adxEndpointUri": "https://mycluster.kusto.windows.net",
    "adxResourceId": "/subscriptions/c493073e-2460-45ba-a403-f3e0df1e9feg/resourceGroups/testrg/providers/Microsoft.Kusto/clusters/mycluster",
    "adxDatabaseName": "myDatabase",
    "adxTableName": "myTable",
    "eventHubEndpointUri": "sb://myeh.servicebus.windows.net/",
    "eventHubEntityPath": "myeh",
    "eventHubConsumerGroup": "$Default",
    "eventHubNamespaceResourceId": "/subscriptions/c493073e-2460-45ba-a403-f3e0df1e9feg/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/myeh"
  }
}

Definíciók

Name Description
AzureDataExplorerConnectionProperties

Az Azure Data Explorer idősorozat-adatbázis-kapcsolatának tulajdonságai az EventHubon keresztül küldött adatokkal.

createdByType

Az erőforrást létrehozó identitás típusa.

ErrorDefinition

Hibadefiníció.

ErrorResponse

Hibaválasz.

IdentityType

A használt felügyelt identitás típusa.

ManagedIdentityReference

A felügyelt identitás tulajdonságai.

recordPropertyAndItemRemovals

Meghatározza, hogy az iker-/kapcsolattulajdonságokat és az elemek eltávolítását rögzítse-e, beleértve az indexelt vagy kulcsolt értékek (például térképbejegyzések, tömbelemek stb.) eltávolítását is. Ez a funkció csak akkor aktiválódik, ha kifejezetten "true" (igaz) értékre van állítva. Ha ezt a tulajdonságot "true" értékre állítja, egy további oszlop jön létre az ADX tulajdonságesemény-táblájában.

SystemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

TimeSeriesDatabaseConnection

Egy idősorozat-adatbázis kapcsolati erőforrását ismerteti.

TimeSeriesDatabaseConnectionState

A kiépítési állapot.

AzureDataExplorerConnectionProperties

Az Azure Data Explorer idősorozat-adatbázis-kapcsolatának tulajdonságai az EventHubon keresztül küldött adatokkal.

Name Típus Alapértelmezett érték Description
adxDatabaseName

string

Az Azure Data Explorer-adatbázis neve.

adxEndpointUri

string

Az Azure Data Explorer végpont URI-ja.

adxRelationshipLifecycleEventsTableName

string

A kapcsolat életciklus-eseményeinek rögzítéséhez használt Azure Data Explorer tábla neve. A tábla nem jön létre, ha a tulajdonság nincs meghatározva.

adxResourceId

string

Az Azure Data Explorer-fürt erőforrás-azonosítója.

adxTableName

string

AdtPropertyEvents

Az ikerpéldányok és kapcsolatok tulajdonságainak frissítéseinek tárolására használt Azure Data Explorer tábla neve. Alapértelmezés szerint az AdtPropertyEvents.

adxTwinLifecycleEventsTableName

string

Az iker életciklus-események rögzítéséhez használt Azure Data Explorer tábla neve. A tábla nem jön létre, ha a tulajdonság nincs meghatározva.

connectionType string:

AzureDataExplorer

Az idősor kapcsolati erőforrásának típusa.

eventHubConsumerGroup

string

$Default

Az EventHub fogyasztói csoportja, amelyet akkor kell használni, amikor az ADX beolvassa az EventHubról. Alapértelmezés szerint $Default.

eventHubEndpointUri

string

Az EventHub-névtér URL-címe identitásalapú hitelesítéshez. Tartalmaznia kell a protokoll sb://

eventHubEntityPath

string

Az EventHub-névtérben található EventHub-név az identitásalapú hitelesítéshez.

eventHubNamespaceResourceId

string

Az EventHub-névtér erőforrás-azonosítója.

identity

ManagedIdentityReference

Az idősor adatbázis-kapcsolati erőforrásának felügyelt identitástulajdonságai.

provisioningState

TimeSeriesDatabaseConnectionState

A kiépítési állapot.

recordPropertyAndItemRemovals

recordPropertyAndItemRemovals

false

Meghatározza, hogy az iker-/kapcsolattulajdonságokat és az elemek eltávolítását rögzítse-e, beleértve az indexelt vagy kulcsolt értékek (például térképbejegyzések, tömbelemek stb.) eltávolítását is. Ez a funkció csak akkor aktiválódik, ha kifejezetten "true" (igaz) értékre van állítva. Ha ezt a tulajdonságot "true" értékre állítja, egy további oszlop jön létre az ADX tulajdonságesemény-táblájában.

createdByType

Az erőforrást létrehozó identitás típusa.

Name Típus Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDefinition

Hibadefiníció.

Name Típus Description
code

string

Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.

details

ErrorDefinition[]

Belső hiba részletei.

message

string

A hiba leírása.

ErrorResponse

Hibaválasz.

Name Típus Description
error

ErrorDefinition

Hibaleírás

IdentityType

A használt felügyelt identitás típusa.

Name Típus Description
SystemAssigned

string

UserAssigned

string

ManagedIdentityReference

A felügyelt identitás tulajdonságai.

Name Típus Description
type

IdentityType

A használt felügyelt identitás típusa.

userAssignedIdentity

string

A felhasználói identitás ARM-erőforrás-azonosítója, ha a felügyelt identitás típusa "UserAssigned".

recordPropertyAndItemRemovals

Meghatározza, hogy az iker-/kapcsolattulajdonságokat és az elemek eltávolítását rögzítse-e, beleértve az indexelt vagy kulcsolt értékek (például térképbejegyzések, tömbelemek stb.) eltávolítását is. Ez a funkció csak akkor aktiválódik, ha kifejezetten "true" (igaz) értékre van állítva. Ha ezt a tulajdonságot "true" értékre állítja, egy további oszlop jön létre az ADX tulajdonságesemény-táblájában.

Name Típus Description
false

string

true

string

SystemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string

Az erőforrás-létrehozás időbélyege (UTC).

createdBy

string

Az erőforrást létrehozó identitás.

createdByType

createdByType

Az erőforrást létrehozó identitás típusa.

lastModifiedAt

string

Az erőforrás utolsó módosításának időbélyege (UTC)

lastModifiedBy

string

Az erőforrást utoljára módosító identitás.

lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.

TimeSeriesDatabaseConnection

Egy idősorozat-adatbázis kapcsolati erőforrását ismerteti.

Name Típus Description
id

string

Az erőforrás azonosítója.

name

string

Bővítmény erőforrásának neve.

properties TimeSeriesDatabaseConnectionProperties:

AzureDataExplorerConnectionProperties

Egy adott idősorozat-adatbáziskapcsolat tulajdonságai.

systemData

SystemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

type

string

Az erőforrás típusa.

TimeSeriesDatabaseConnectionState

A kiépítési állapot.

Name Típus Description
Canceled

string

Deleted

string

Deleting

string

Disabled

string

Failed

string

Moving

string

Provisioning

string

Restoring

string

Succeeded

string

Suspending

string

Updating

string

Warning

string