Delen via


Endpoints - DigitalTwinsEndpoint List

Haal DigitalTwinsInstance-eindpunten op.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
path True

string

De naam van de resourcegroep die de DigitalTwinsInstance bevat.

resourceName
path True

string

De naam van de DigitalTwinsInstance.

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

subscriptionId
path True

string

De abonnements-id.

api-version
query True

string

Versie van de DigitalTwinsInstance Management-API.

Antwoorden

Name Type Description
200 OK

DigitalTwinsEndpointResourceListResult

De hoofdtekst bevat alle niet-beveiligingseigenschappen van de DigitalTwinsInstance. Beveiligingsgerelateerde eigenschappen worden ingesteld op null.

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 a DigitalTwinsInstance endpoints
Get a DigitalTwinsInstance endpoints with identity

Get a DigitalTwinsInstance endpoints

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myServiceBus",
      "type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
      "name": "myendpoint1",
      "systemData": {
        "createdBy": "user@example.com",
        "createdByType": "User",
        "createdAt": "2021-03-11T17:13:59.4037715Z",
        "lastModifiedBy": "user@example.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-03-11T17:14:02.5281409Z"
      },
      "properties": {
        "endpointType": "ServiceBus",
        "authenticationType": "KeyBased",
        "primaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
        "secondaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
        "provisioningState": "Succeeded",
        "createdTime": "2019-11-19T01:10:34.350Z"
      }
    },
    {
      "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myServiceBus",
      "type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
      "name": "myendpoint2",
      "systemData": {
        "createdBy": "user@example.com",
        "createdByType": "User",
        "createdAt": "2021-03-11T17:13:59.4037715Z",
        "lastModifiedBy": "user@example.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-03-11T17:14:02.5281409Z"
      },
      "properties": {
        "endpointType": "EventHub",
        "authenticationType": "KeyBased",
        "connectionStringPrimaryKey": "************",
        "connectionStringSecondaryKey": "************",
        "provisioningState": "Succeeded",
        "createdTime": "2019-11-19T01:10:34.350Z"
      }
    }
  ]
}

Get a DigitalTwinsInstance endpoints with identity

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myServiceBus",
      "type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
      "name": "myServiceBus",
      "systemData": {
        "createdBy": "user@example.com",
        "createdByType": "User",
        "createdAt": "2021-03-11T17:13:59.4037715Z",
        "lastModifiedBy": "user@example.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-03-11T17:14:02.5281409Z"
      },
      "properties": {
        "endpointType": "ServiceBus",
        "authenticationType": "IdentityBased",
        "provisioningState": "Succeeded",
        "endpointUri": "sb://mysb.servicebus.windows.net/",
        "entityPath": "mysbtopic",
        "createdTime": "2019-11-19T01:10:34.350Z"
      }
    },
    {
      "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/endpoints/myServiceBus",
      "type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
      "name": "myServiceBus",
      "systemData": {
        "createdBy": "user@example.com",
        "createdByType": "User",
        "createdAt": "2021-03-11T17:13:59.4037715Z",
        "lastModifiedBy": "user@example.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-03-11T17:14:02.5281409Z"
      },
      "properties": {
        "endpointType": "EventHub",
        "authenticationType": "KeyBased",
        "connectionStringPrimaryKey": "************",
        "connectionStringSecondaryKey": "************",
        "provisioningState": "Succeeded",
        "createdTime": "2019-11-19T01:10:34.350Z"
      }
    }
  ]
}

Definities

Name Description
AuthenticationType

Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het eindpunt. De standaardinstelling is 'KeyBased'. Als 'KeyBased' is geselecteerd, moet er een connection string worden opgegeven (ten minste de primaire connection string). Als 'IdentityBased' is geselecteerd, moeten de eigenschappen endpointUri en entityPath worden opgegeven.

createdByType

Het type identiteit waarmee de resource is gemaakt.

DigitalTwinsEndpointResource

DigitalTwinsInstance-eindpuntresource.

DigitalTwinsEndpointResourceListResult

Een lijst met DigitalTwinsInstance-eindpunten met een volgende koppeling.

EndpointProvisioningState

De inrichtingsstatus.

ErrorDefinition

Foutdefinitie.

ErrorResponse

Foutreactie.

EventGrid

Eigenschappen met betrekking tot EventGrid.

EventHub

Eigenschappen met betrekking tot EventHub.

IdentityType

Het type beheerde identiteit dat wordt gebruikt.

ManagedIdentityReference

De eigenschappen van de beheerde identiteit.

ServiceBus

Eigenschappen met betrekking tot ServiceBus.

SystemData

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

AuthenticationType

Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het eindpunt. De standaardinstelling is 'KeyBased'. Als 'KeyBased' is geselecteerd, moet er een connection string worden opgegeven (ten minste de primaire connection string). Als 'IdentityBased' is geselecteerd, moeten de eigenschappen endpointUri en entityPath worden opgegeven.

Name Type Description
IdentityBased

string

KeyBased

string

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DigitalTwinsEndpointResource

DigitalTwinsInstance-eindpuntresource.

Name Type Description
id

string

De resource-id.

name

string

Naam van extensieresource.

properties DigitalTwinsEndpointResourceProperties:

Resource-eigenschappen van digitalTwinsInstance-eindpunt.

systemData

SystemData

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

type

string

Het resourcetype.

DigitalTwinsEndpointResourceListResult

Een lijst met DigitalTwinsInstance-eindpunten met een volgende koppeling.

Name Type Description
nextLink

string

De koppeling die wordt gebruikt om de volgende pagina van DigitalTwinsInstance Endpoints op te halen.

value

DigitalTwinsEndpointResource[]

Een lijst met DigitalTwinsInstance-eindpunten.

EndpointProvisioningState

De inrichtingsstatus.

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

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

EventGrid

Eigenschappen met betrekking tot EventGrid.

Name Type Description
TopicEndpoint

string

EventGrid-onderwerpeindpunt.

accessKey1

string

Secundaire toegangssleutel voor EventGrid. Wordt verborgen tijdens het lezen.

accessKey2

string

Secundaire toegangssleutel voor EventGrid. Wordt verborgen tijdens het lezen.

authenticationType

AuthenticationType

Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het eindpunt. De standaardinstelling is 'KeyBased'. Als 'KeyBased' is geselecteerd, moet er een connection string worden opgegeven (ten minste de primaire connection string). Als 'IdentityBased' is geselecteerd, moeten de eigenschappen endpointUri en entityPath worden opgegeven.

createdTime

string

Tijdstip waarop het eindpunt is toegevoegd aan DigitalTwinsInstance.

deadLetterSecret

string

Opslaggeheim voor onbestelbare berichten voor verificatie op basis van sleutels. Wordt verborgen tijdens het lezen.

deadLetterUri

string

Opslag-URL voor onbestelbare berichten voor verificatie op basis van identiteit.

endpointType string:

EventGrid

Het type Digital Twins-eindpunt

identity

ManagedIdentityReference

Eigenschappen van beheerde identiteit voor het eindpunt.

provisioningState

EndpointProvisioningState

De inrichtingsstatus.

EventHub

Eigenschappen met betrekking tot EventHub.

Name Type Description
authenticationType

AuthenticationType

Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het eindpunt. De standaardinstelling is 'KeyBased'. Als 'KeyBased' is geselecteerd, moet er een connection string worden opgegeven (ten minste de primaire connection string). Als 'IdentityBased' is geselecteerd, moeten de eigenschappen endpointUri en entityPath worden opgegeven.

connectionStringPrimaryKey

string

PrimaryConnectionString van het eindpunt voor verificatie op basis van sleutels. Wordt verborgen tijdens het lezen.

connectionStringSecondaryKey

string

SecondaryConnectionString van het eindpunt voor verificatie op basis van sleutels. Wordt verborgen tijdens het lezen.

createdTime

string

Tijdstip waarop het eindpunt is toegevoegd aan DigitalTwinsInstance.

deadLetterSecret

string

Opslaggeheim voor onbestelbare berichten voor verificatie op basis van sleutels. Wordt verborgen tijdens het lezen.

deadLetterUri

string

Opslag-URL voor onbestelbare berichten voor verificatie op basis van identiteit.

endpointType string:

EventHub

Het type Digital Twins-eindpunt

endpointUri

string

De URL van de EventHub-naamruimte voor verificatie op basis van identiteit. Het moet het protocol 'sb://' bevatten.

entityPath

string

De EventHub-naam in de EventHub-naamruimte voor verificatie op basis van identiteit.

identity

ManagedIdentityReference

Eigenschappen van beheerde identiteit voor het eindpunt.

provisioningState

EndpointProvisioningState

De inrichtingsstatus.

IdentityType

Het type beheerde identiteit dat wordt gebruikt.

Name Type Description
SystemAssigned

string

UserAssigned

string

ManagedIdentityReference

De eigenschappen van de beheerde identiteit.

Name Type Description
type

IdentityType

Het type beheerde identiteit dat wordt gebruikt.

userAssignedIdentity

string

De ARM-resource-id van de gebruikersidentiteit als het type beheerde identiteit 'UserAssigned' is.

ServiceBus

Eigenschappen met betrekking tot ServiceBus.

Name Type Description
authenticationType

AuthenticationType

Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het eindpunt. De standaardinstelling is 'KeyBased'. Als 'KeyBased' is geselecteerd, moet er een connection string worden opgegeven (ten minste de primaire connection string). Als 'IdentityBased' is geselecteerd, moeten de eigenschappen endpointUri en entityPath worden opgegeven.

createdTime

string

Tijdstip waarop het eindpunt is toegevoegd aan DigitalTwinsInstance.

deadLetterSecret

string

Opslaggeheim voor onbestelbare berichten voor verificatie op basis van sleutels. Wordt verborgen tijdens het lezen.

deadLetterUri

string

Opslag-URL voor onbestelbare berichten voor verificatie op basis van identiteit.

endpointType string:

ServiceBus

Het type Digital Twins-eindpunt

endpointUri

string

De URL van de ServiceBus-naamruimte voor verificatie op basis van identiteit. Het moet het protocol 'sb://' bevatten.

entityPath

string

De ServiceBus-onderwerpnaam voor verificatie op basis van identiteit.

identity

ManagedIdentityReference

Eigenschappen van beheerde identiteit voor het eindpunt.

primaryConnectionString

string

PrimaryConnectionString van het eindpunt voor verificatie op basis van sleutels. Wordt verborgen tijdens het lezen.

provisioningState

EndpointProvisioningState

De inrichtingsstatus.

secondaryConnectionString

string

SecondaryConnectionString van het eindpunt voor verificatie op basis van sleutels. Wordt verborgen tijdens het lezen.

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.