Partilhar via


Digital Twins Instance - DigitalTwins Get

Obtenha o recurso DigitalTwinsInstances.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}?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

DigitalTwinsDescription

O corpo contém todas as propriedades não relacionadas com segurança do DigitalTwinsInstance. As propriedades relacionadas com a segurança estão definidas como nulas.

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

Get a DigitalTwinsInstance resource
Get a DigitalTwinsInstance resource with a private endpoint connection
Get a DigitalTwinsInstance resource with identity

Get a DigitalTwinsInstance resource

Sample Request

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

Sample Response

{
  "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-12-06T12:21:58.610Z",
    "provisioningState": "Succeeded",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
    "publicNetworkAccess": "Enabled"
  }
}

Get a DigitalTwinsInstance resource with a private endpoint connection

Sample Request

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

Sample Response

{
  "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-12-06T12:21:58.610Z",
    "provisioningState": "Succeeded",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/privateEndpointConnections/myPrivateConnection",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
          },
          "groupIds": [
            "digitalTwinsInstance"
          ],
          "privateLinkServiceConnectionState": {
            "status": "Pending",
            "description": "Please approve my request, thanks.",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "publicNetworkAccess": "Enabled"
  }
}

Get a DigitalTwinsInstance resource with identity

Sample Request

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

Sample Response

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
  "location": "westus2",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "name": "myDigitalTwinsService",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "544215a9-21d8-4fb5-8094-8efbcc311dd0",
    "tenantId": "544215a9-21d8-4fb5-8094-8efbcc311dd0",
    "userAssignedIdentities": {
      "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {
        "clientId": "544215a9-21d8-4fb5-8094-8efbcc311dd0",
        "principalId": "50016170-c839-41ba-a724-51e9df440b9e"
      }
    }
  },
  "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-12-06T12:21:58.610Z",
    "provisioningState": "Succeeded",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
    "publicNetworkAccess": "Enabled"
  }
}

Definições

Name Description
ConnectionProperties

As propriedades de uma ligação de ponto final privado.

ConnectionPropertiesProvisioningState

O estado de aprovisionamento.

createdByType

O tipo de identidade que criou o recurso.

DigitalTwinsDescription

A descrição do serviço DigitalTwins.

DigitalTwinsIdentity

A identidade gerida do DigitalTwinsInstance.

DigitalTwinsIdentityType

O tipo de Identidade Gerida utilizada pela DigitalTwinsInstance.

ErrorDefinition

Definição de erro.

ErrorResponse

Resposta de erro.

PrivateEndpoint

A propriedade de ponto final privado de uma ligação de ponto final privado.

PrivateEndpointConnection

A ligação de ponto final privado de um Duplo Digital.

PrivateLinkServiceConnectionState

O estado da ligação.

PrivateLinkServiceConnectionStatus

O estado de uma ligação de ponto final privado.

provisioningState

O estado de aprovisionamento.

publicNetworkAccess

Acesso à rede pública para DigitalTwinsInstance.

SystemData

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

UserAssignedIdentity

As informações sobre a identidade atribuída pelo utilizador.

ConnectionProperties

As propriedades de uma ligação de ponto final privado.

Name Tipo Description
groupIds

string[]

A lista de IDs de grupo para a ligação de ponto final privado.

privateEndpoint

PrivateEndpoint

O ponto final privado.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

O estado da ligação.

provisioningState

ConnectionPropertiesProvisioningState

O estado de aprovisionamento.

ConnectionPropertiesProvisioningState

O estado de aprovisionamento.

Name Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DigitalTwinsDescription

A descrição do serviço DigitalTwins.

Name Tipo Description
id

string

O identificador do recurso.

identity

DigitalTwinsIdentity

A identidade gerida do DigitalTwinsInstance.

location

string

A localização do recurso.

name

string

O nome do recurso.

properties.createdTime

string

Hora em que DigitalTwinsInstance foi criado.

properties.hostName

string

Ponto final da API para trabalhar com DigitalTwinsInstance.

properties.lastUpdatedTime

string

Hora em que DigitalTwinsInstance foi atualizado.

properties.privateEndpointConnections

PrivateEndpointConnection[]

As ligações de ponto final privado.

properties.provisioningState

provisioningState

O estado de aprovisionamento.

properties.publicNetworkAccess

publicNetworkAccess

Acesso à rede pública para DigitalTwinsInstance.

systemData

SystemData

Metadados relativos à criação e última modificação da DigitalTwinsInstance.

tags

object

As etiquetas de recursos.

type

string

O tipo de recurso.

DigitalTwinsIdentity

A identidade gerida do DigitalTwinsInstance.

Name Tipo Description
principalId

string

O ID de objeto do Recurso de Identidade Gerida. Será enviado para o RP a partir do ARM através do cabeçalho x-ms-identity-principal-id no pedido PUT se o recurso tiver uma identidade systemAssigned(implicit)

tenantId

string

O ID de inquilino do Recurso de Identidade Gerida. Será enviado para o RP a partir do ARM através do cabeçalho x-ms-client-tenant-id no pedido PUT se o recurso tiver uma identidade systemAssigned(implicit)

type

DigitalTwinsIdentityType

O tipo de Identidade Gerida utilizada pela DigitalTwinsInstance.

userAssignedIdentities

<string,  UserAssignedIdentity>

A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". .

DigitalTwinsIdentityType

O tipo de Identidade Gerida utilizada pela DigitalTwinsInstance.

Name Tipo Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

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

PrivateEndpoint

A propriedade de ponto final privado de uma ligação de ponto final privado.

Name Tipo Description
id

string

O identificador do recurso.

PrivateEndpointConnection

A ligação de ponto final privado de um Duplo Digital.

Name Tipo Description
id

string

O identificador do recurso.

name

string

O nome do recurso.

properties

ConnectionProperties

As propriedades da ligação.

systemData

SystemData

Metadados relativos à criação e última modificação da ligação de ponto final privado.

type

string

O tipo de recurso.

PrivateLinkServiceConnectionState

O estado da ligação.

Name Tipo Description
actionsRequired

string

Ações necessárias para uma ligação de ponto final privado.

description

string

A descrição do estado atual de uma ligação de ponto final privado.

status

PrivateLinkServiceConnectionStatus

O estado de uma ligação de ponto final privado.

PrivateLinkServiceConnectionStatus

O estado de uma ligação de ponto final privado.

Name Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

provisioningState

O estado de aprovisionamento.

Name Tipo Description
Canceled

string

Deleted

string

Deleting

string

Failed

string

Moving

string

Provisioning

string

Restoring

string

Succeeded

string

Suspending

string

Updating

string

Warning

string

publicNetworkAccess

Acesso à rede pública para DigitalTwinsInstance.

Name Tipo Description
Disabled

string

Enabled

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.

UserAssignedIdentity

As informações sobre a identidade atribuída pelo utilizador.

Name Tipo Description
clientId

string

O ID de cliente do Recurso de Identidade Atribuída pelo Utilizador.

principalId

string

O ID de objeto do Recurso de Identidade Atribuída pelo Utilizador.