Endpoints - DigitalTwinsEndpoint CreateOrUpdate

  • Referenz
Service:
Azure Digital Twins
API Version:
2023-01-31

Erstellen oder Aktualisieren des DigitalTwinsInstance-Endpunkts

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpointName
 path True

string

Name der Endpunktressource.

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

string

Der Name der Ressourcengruppe, die digitalTwinsInstance enthält.
resourceName
 path True

string

Der Name der DigitalTwinsInstance.

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

string

Die Abonnement-ID.
api-version
 query True

string

Version der DigitalTwinsInstance Management-API.

Anforderungstext

Name Erforderlich Typ Beschreibung
properties True DigitalTwinsEndpointResourceProperties:

Ressourceneigenschaften des DigitalTwinsInstance-Endpunkts.

Antworten

Name Typ Beschreibung
200 OK

DigitalTwinsEndpointResource

Dies wird als Antwort auf die status Abrufanforderung für den Erstellungs- oder Aktualisierungsvorgang zurückgegeben. Der Text enthält die Ressourcendarstellung, die einen Übergangsbereitstellungsstatus angibt.
201 Created

DigitalTwinsEndpointResource

Erstellt: Put-Anforderung akzeptiert; Der Vorgang wird asynchron abgeschlossen.
Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Put a DigitalTwinsEndpoint resource
Put a DigitalTwinsEndpoint resource with identity
Put a DigitalTwinsEndpoint resource with user assigned identity

Put a DigitalTwinsEndpoint resource

Sample Request

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

{
  "properties": {
    "endpointType": "ServiceBus",
    "authenticationType": "KeyBased",
    "primaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc",
    "secondaryConnectionString": "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xyzxyzoX4=;EntityPath=abcabc"
  }
}

Sample Response

Status code:
200 
{
  "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": "KeyBased",
    "provisioningState": "Succeeded",
    "primaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
    "secondaryConnectionString": "Endpoint=sb://***/;SharedAccessKeyName=***;SharedAccessKey=***;EntityPath=***",
    "createdTime": "2019-11-19T01:10:34.350Z"
  }
}
Status code:
201 
azure-asyncoperation: https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/locations/westus2/operationStatuses/12345678-1234-1234-123456789012
location: https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/locations/westus2/operationResults/12345678-1234-1234-123456789012
retry-after: 10
Response Body
{
  "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": "KeyBased",
    "provisioningState": "Provisioning",
    "primaryConnectionString": "",
    "secondaryConnectionString": "",
    "createdTime": "2019-11-19T01:10:34.350Z"
  }
}

Put a DigitalTwinsEndpoint resource with identity

Sample Request

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

{
  "properties": {
    "endpointType": "ServiceBus",
    "authenticationType": "IdentityBased",
    "endpointUri": "sb://mysb.servicebus.windows.net/",
    "entityPath": "mysbtopic"
  }
}

Sample Response

Status code:
200 
{
  "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",
    "provisioningState": "Provisioning",
    "authenticationType": "IdentityBased",
    "endpointUri": "sb://mysb.servicebus.windows.net/",
    "entityPath": "mysbtopic",
    "createdTime": "2019-11-19T01:10:34.350Z"
  }
}
Status code:
201 
azure-asyncoperation: https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/locations/westus2/operationStatuses/12345678-1234-1234-123456789012
location: https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/locations/westus2/operationResults/12345678-1234-1234-123456789012
retry-after: 10
Response Body
{
  "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",
    "provisioningState": "Provisioning",
    "authenticationType": "IdentityBased",
    "endpointUri": "sb://mysb.servicebus.windows.net/",
    "entityPath": "mysbtopic",
    "createdTime": "2019-11-19T01:10:34.350Z"
  }
}

Put a DigitalTwinsEndpoint resource with user assigned identity

Sample Request

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

{
  "properties": {
    "endpointType": "ServiceBus",
    "authenticationType": "IdentityBased",
    "endpointUri": "sb://mysb.servicebus.windows.net/",
    "entityPath": "mysbtopic",
    "identity": {
      "type": "UserAssigned",
      "userAssignedIdentity": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity"
    }
  }
}

Sample Response

Status code:
200 
{
  "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",
    "provisioningState": "Provisioning",
    "authenticationType": "IdentityBased",
    "endpointUri": "sb://mysb.servicebus.windows.net/",
    "entityPath": "mysbtopic",
    "createdTime": "2019-11-19T01:10:34.350Z",
    "identity": {
      "type": "UserAssigned",
      "userAssignedIdentity": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity"
    }
  }
}
Status code:
201 
azure-asyncoperation: https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/locations/westus2/operationStatuses/12345678-1234-1234-123456789012
location: https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/providers/Microsoft.DigitalTwins/locations/westus2/operationResults/12345678-1234-1234-123456789012
retry-after: 10
Response Body
{
  "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",
    "provisioningState": "Provisioning",
    "authenticationType": "IdentityBased",
    "endpointUri": "sb://mysb.servicebus.windows.net/",
    "entityPath": "mysbtopic",
    "createdTime": "2019-11-19T01:10:34.350Z",
    "identity": {
      "type": "UserAssigned",
      "userAssignedIdentity": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity"
    }
  }
}

Definitionen

Name Beschreibung
AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Endpunkt verwendet wird. Der Standardwert ist "KeyBased". Wenn "KeyBased" ausgewählt ist, muss eine Verbindungszeichenfolge angegeben werden (mindestens die primäre Verbindungszeichenfolge). Wenn "IdentityBased" ausgewählt ist, müssen die Eigenschaften endpointUri und entityPath angegeben werden.
createdByType

Der Identitätstyp, der die Ressource erstellt hat.
DigitalTwinsEndpointResource

DigitalTwinsInstance-Endpunktressource.
EndpointProvisioningState

Der Bereitstellungsstatus.
ErrorDefinition

Fehlerdefinition.
ErrorResponse

Fehlerantwort.
EventGrid

Eigenschaften im Zusammenhang mit EventGrid.
EventHub

Eigenschaften im Zusammenhang mit EventHub.
IdentityType

Der Typ der verwendeten verwalteten Identität.
ManagedIdentityReference

Die Eigenschaften der verwalteten Identität.
ServiceBus

Eigenschaften im Zusammenhang mit ServiceBus.
SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Endpunkt verwendet wird. Der Standardwert ist "KeyBased". Wenn "KeyBased" ausgewählt ist, muss eine Verbindungszeichenfolge angegeben werden (mindestens die primäre Verbindungszeichenfolge). Wenn "IdentityBased" ausgewählt ist, müssen die Eigenschaften endpointUri und entityPath angegeben werden.

Name Typ Beschreibung
IdentityBased

string

KeyBased

string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

DigitalTwinsEndpointResource

DigitalTwinsInstance-Endpunktressource.

Name Typ Beschreibung
id

string

Der Ressourcenbezeichner.
name

string

Name der Erweiterungsressource.
properties DigitalTwinsEndpointResourceProperties:

Ressourceneigenschaften des DigitalTwinsInstance-Endpunkts.
systemData

SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
type

string

Der Ressourcentyp.

EndpointProvisioningState

Der Bereitstellungsstatus.

Name Typ Beschreibung
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

Fehlerdefinition.

Name Typ Beschreibung
code

string

Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
details

ErrorDefinition[]

Interne Fehlerdetails.
message

string

Beschreibung des Fehlers

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
error

ErrorDefinition

Fehlerbeschreibung

EventGrid

Eigenschaften im Zusammenhang mit EventGrid.

Name Typ Beschreibung
TopicEndpoint

string

EventGrid-Themenendpunkt.
accessKey1

string

Sekundärer EventGrid-Zugriffsschlüssel. Wird während des Lesevorgangs verschleiert.
accessKey2

string

Sekundärer EventGrid-Zugriffsschlüssel. Wird während des Lesevorgangs verschleiert.
authenticationType

AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Endpunkt verwendet wird. Der Standardwert ist "KeyBased". Wenn "KeyBased" ausgewählt ist, muss eine Verbindungszeichenfolge angegeben werden (mindestens die primäre Verbindungszeichenfolge). Wenn "IdentityBased" ausgewählt ist, müssen die Eigenschaften endpointUri und entityPath angegeben werden.
createdTime

string

Zeitpunkt, zu dem der Endpunkt zu DigitalTwinsInstance hinzugefügt wurde.
deadLetterSecret

string

Geheimer Speichergeheimnis für unzustellbare Nachrichten für die schlüsselbasierte Authentifizierung. Wird während des Lesevorgangs verschleiert.
deadLetterUri

string

Speicher-URL für unzustellbare Nachrichten für die identitätsbasierte Authentifizierung.
endpointType string:

EventGrid

Typ des Digital Twins-Endpunkts
identity

ManagedIdentityReference

Eigenschaften der verwalteten Identität für den Endpunkt.
provisioningState

EndpointProvisioningState

Der Bereitstellungsstatus.

EventHub

Eigenschaften im Zusammenhang mit EventHub.

Name Typ Beschreibung
authenticationType

AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Endpunkt verwendet wird. Der Standardwert ist "KeyBased". Wenn "KeyBased" ausgewählt ist, muss eine Verbindungszeichenfolge angegeben werden (mindestens die primäre Verbindungszeichenfolge). Wenn "IdentityBased" ausgewählt ist, müssen die Eigenschaften endpointUri und entityPath angegeben werden.
connectionStringPrimaryKey

string

PrimaryConnectionString des Endpunkts für die schlüsselbasierte Authentifizierung. Wird während des Lesevorgangs verschleiert.
connectionStringSecondaryKey

string

SecondaryConnectionString des Endpunkts für die schlüsselbasierte Authentifizierung. Wird während des Lesevorgangs verschleiert.
createdTime

string

Zeitpunkt, zu dem der Endpunkt zu DigitalTwinsInstance hinzugefügt wurde.
deadLetterSecret

string

Geheimer Speichergeheimnis für unzustellbare Nachrichten für die schlüsselbasierte Authentifizierung. Wird während des Lesevorgangs verschleiert.
deadLetterUri

string

Speicher-URL für unzustellbare Nachrichten für die identitätsbasierte Authentifizierung.
endpointType string:

EventHub

Typ des Digital Twins-Endpunkts
endpointUri

string

Die URL des EventHub-Namespace für die identitätsbasierte Authentifizierung. Sie muss das Protokoll "sb://" enthalten.
entityPath

string

Der EventHub-Name im EventHub-Namespace für die identitätsbasierte Authentifizierung.
identity

ManagedIdentityReference

Eigenschaften der verwalteten Identität für den Endpunkt.
provisioningState

EndpointProvisioningState

Der Bereitstellungsstatus.

IdentityType

Der Typ der verwendeten verwalteten Identität.

Name Typ Beschreibung
SystemAssigned

string

UserAssigned

string

ManagedIdentityReference

Die Eigenschaften der verwalteten Identität.

Name Typ Beschreibung
type

IdentityType

Der Typ der verwendeten verwalteten Identität.
userAssignedIdentity

string

Die ARM-Ressourcen-ID der Benutzeridentität, wenn der verwaltete Identitätstyp "UserAssigned" lautet.

ServiceBus

Eigenschaften im Zusammenhang mit ServiceBus.

Name Typ Beschreibung
authenticationType

AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Endpunkt verwendet wird. Der Standardwert ist "KeyBased". Wenn "KeyBased" ausgewählt ist, muss eine Verbindungszeichenfolge angegeben werden (mindestens die primäre Verbindungszeichenfolge). Wenn "IdentityBased" ausgewählt ist, müssen die Eigenschaften endpointUri und entityPath angegeben werden.
createdTime

string

Zeitpunkt, zu dem der Endpunkt zu DigitalTwinsInstance hinzugefügt wurde.
deadLetterSecret

string

Geheimer Speichergeheimnis für unzustellbare Nachrichten für die schlüsselbasierte Authentifizierung. Wird während des Lesevorgangs verschleiert.
deadLetterUri

string

Speicher-URL für unzustellbare Nachrichten für die identitätsbasierte Authentifizierung.
endpointType string:

ServiceBus

Typ des Digital Twins-Endpunkts
endpointUri

string

Die URL des ServiceBus-Namespace für die identitätsbasierte Authentifizierung. Sie muss das Protokoll "sb://" enthalten.
entityPath

string

Der Name des ServiceBus-Themas für die identitätsbasierte Authentifizierung.
identity

ManagedIdentityReference

Eigenschaften der verwalteten Identität für den Endpunkt.
primaryConnectionString

string

PrimaryConnectionString des Endpunkts für die schlüsselbasierte Authentifizierung. Wird während des Lesevorgangs verschleiert.
provisioningState

EndpointProvisioningState

Der Bereitstellungsstatus.
secondaryConnectionString

string

SecondaryConnectionString des Endpunkts für die schlüsselbasierte Authentifizierung. Wird während des Lesevorgangs verschleiert.

SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy

string

Die Identität, die die Ressource erstellt hat.
createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.