Partilhar via


Time Series Database Connections - List

Obtenha todas as ligações de base de dados de série temporal existentes para esta instância do DigitalTwins.

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

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos que contém o DigitalTwinsInstance.

resourceName
path True

string

O nome da DigitalTwinsInstance.

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

subscriptionId
path True

string

O identificador da subscrição.

api-version
query True

string

Versão da API de Gestão DigitalTwinsInstance.

Respostas

Name Tipo Description
200 OK

TimeSeriesDatabaseConnectionListResult

Lista de ligações de bases de dados de série temporal para esta instância do DigitalTwins.

Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation Representar a sua conta de utilizador

Exemplos

List time series database connections 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?api-version=2023-01-31

Sample Response

{
  "value": [
    {
      "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",
        "eventHubNamespaceResourceId": "/subscriptions/c493073e-2460-45ba-a403-f3e0df1e9feg/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/myeh"
      }
    }
  ]
}

Definições

Name Description
AzureDataExplorerConnectionProperties

As propriedades de uma ligação de base de dados de série temporal ao Azure Data Explorer com dados enviados através de um EventHub.

createdByType

O tipo de identidade que criou o recurso.

ErrorDefinition

Definição de erro.

ErrorResponse

Resposta de erro.

IdentityType

O tipo de identidade gerida utilizada.

ManagedIdentityReference

As propriedades da Identidade Gerida.

recordPropertyAndItemRemovals

Especifica se pretende ou não registar a propriedade de duplo/relação e as remoção de itens, incluindo remoção de valores indexados ou com chave (como entradas de mapa, elementos de matriz, etc.). Esta funcionalidade é desativada, a menos que esteja explicitamente definida como "true". Definir esta propriedade como "true" irá gerar uma coluna adicional na tabela de eventos de propriedades no ADX.

SystemData

Metadados relativos à criação e última modificação do recurso.

TimeSeriesDatabaseConnection

Descreve um recurso de ligação de base de dados de série temporal.

TimeSeriesDatabaseConnectionListResult

Uma lista paginável de recursos de ligação da base de dados de série temporal.

TimeSeriesDatabaseConnectionState

O estado de aprovisionamento.

AzureDataExplorerConnectionProperties

As propriedades de uma ligação de base de dados de série temporal ao Azure Data Explorer com dados enviados através de um EventHub.

Name Tipo Valor Predefinido Description
adxDatabaseName

string

O nome da base de dados do Azure Data Explorer.

adxEndpointUri

string

O URI do ponto final do Azure Data Explorer.

adxRelationshipLifecycleEventsTableName

string

O nome da tabela Data Explorer do Azure utilizada para registar eventos de ciclo de vida de relações. A tabela não será criada se esta propriedade não for especificada.

adxResourceId

string

O ID de recurso do cluster do Azure Data Explorer.

adxTableName

string

AdtPropertyEvents

O nome da tabela de Data Explorer do Azure utilizada para armazenar atualizações em propriedades de duplos e relações. A predefinição é AdtPropertyEvents.

adxTwinLifecycleEventsTableName

string

O nome da tabela de Data Explorer do Azure utilizada para gravar eventos de ciclo de vida de duplos. A tabela não será criada se esta propriedade não for especificada.

connectionType string:

AzureDataExplorer

O tipo de recurso de ligação de série temporal.

eventHubConsumerGroup

string

$Default

O grupo de consumidores do EventHub a utilizar quando o ADX lê a partir do EventHub. A predefinição é $Default.

eventHubEndpointUri

string

O URL do espaço de nomes do EventHub para autenticação baseada em identidade. Tem de incluir o protocolo sb://

eventHubEntityPath

string

O nome do EventHub no espaço de nomes do EventHub para autenticação baseada em identidade.

eventHubNamespaceResourceId

string

O ID de recurso do espaço de nomes do EventHub.

identity

ManagedIdentityReference

Propriedades de identidade gerida para o recurso de ligação da base de dados de série temporal.

provisioningState

TimeSeriesDatabaseConnectionState

O estado de aprovisionamento.

recordPropertyAndItemRemovals

recordPropertyAndItemRemovals

false

Especifica se pretende ou não registar a propriedade de duplo/relação e as remoção de itens, incluindo remoção de valores indexados ou com chave (como entradas de mapa, elementos de matriz, etc.). Esta funcionalidade é desativada, a menos que esteja explicitamente definida como "true". Definir esta propriedade como "true" irá gerar uma coluna adicional na tabela de eventos de propriedades no ADX.

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDefinition

Definição de erro.

Name Tipo Description
code

string

Código de erro específico do serviço que serve como subestado para o código de erro HTTP.

details

ErrorDefinition[]

Detalhes internos do erro.

message

string

Descrição do erro.

ErrorResponse

Resposta de erro.

Name Tipo Description
error

ErrorDefinition

Descrição do erro

IdentityType

O tipo de identidade gerida utilizada.

Name Tipo Description
SystemAssigned

string

UserAssigned

string

ManagedIdentityReference

As propriedades da Identidade Gerida.

Name Tipo Description
type

IdentityType

O tipo de identidade gerida utilizada.

userAssignedIdentity

string

O ID de recurso do ARM da identidade do utilizador se o tipo de identidade gerida for "UserAssigned".

recordPropertyAndItemRemovals

Especifica se pretende ou não registar a propriedade de duplo/relação e as remoção de itens, incluindo remoção de valores indexados ou com chave (como entradas de mapa, elementos de matriz, etc.). Esta funcionalidade é desativada, a menos que esteja explicitamente definida como "true". Definir esta propriedade como "true" irá gerar uma coluna adicional na tabela de eventos de propriedades no ADX.

Name Tipo Description
false

string

true

string

SystemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

TimeSeriesDatabaseConnection

Descreve um recurso de ligação de base de dados de série temporal.

Name Tipo Description
id

string

O identificador do recurso.

name

string

Nome do recurso da extensão.

properties TimeSeriesDatabaseConnectionProperties:

AzureDataExplorerConnectionProperties

Propriedades de uma ligação de base de dados de série temporal específica.

systemData

SystemData

Metadados relativos à criação e última modificação do recurso.

type

string

O tipo de recurso.

TimeSeriesDatabaseConnectionListResult

Uma lista paginável de recursos de ligação da base de dados de série temporal.

Name Tipo Description
nextLink

string

A ligação utilizada para obter a página seguinte de resultados.

value

TimeSeriesDatabaseConnection[]

Uma lista de recursos de ligação da base de dados de série temporal.

TimeSeriesDatabaseConnectionState

O estado de aprovisionamento.

Name Tipo 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