Endpoints - DigitalTwinsEndpoint CreateOrUpdate

Odwołanie

Service:: Azure Digital Twins

API Version:: 2023-01-31

Utwórz lub zaktualizuj punkt końcowy usługi DigitalTwinsInstance.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpointName	path	True	string	Nazwa zasobu punktu końcowego. Regex pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nazwa grupy zasobów, która zawiera element DigitalTwinsInstance.
resourceName	path	True	string	Nazwa klasy DigitalTwinsInstance. Regex pattern: `^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$`
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API usługi DigitalTwinsInstance Management.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties	True	DigitalTwinsEndpointResourceProperties: ServiceBus EventHub EventGrid	Właściwości zasobu punktu końcowego usługi DigitalTwinsInstance.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DigitalTwinsEndpointResource	Jest to zwracane jako odpowiedź na żądanie sondowania stanu dla operacji tworzenia lub aktualizacji. Treść zawiera reprezentację zasobu, która wskazuje stan przejściowej aprowizacji.
201 Created	DigitalTwinsEndpointResource	Utworzono — umieść zaakceptowane żądanie; operacja zostanie ukończona asynchronicznie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Przykłady

Put a DigitalTwinsEndpoint resource

Put a DigitalTwinsEndpoint resource with identity

Put a DigitalTwinsEndpoint resource with user assigned identity

Put a DigitalTwinsEndpoint resource

Sample Request

HTTP

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

HTTP

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

HTTP

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"
    }
  }
}

Definicje

Nazwa	Opis
AuthenticationType	Określa typ uwierzytelniania używany do nawiązywania połączenia z punktem końcowym. Wartość domyślna to "KeyBased". Jeśli wybrano opcję "KeyBased", należy określić parametry połączenia (co najmniej podstawowe parametry połączenia). Jeśli wybrano wartość "IdentityBased", należy określić właściwości endpointUri i entityPath.
createdByType	Typ tożsamości, która utworzyła zasób.
DigitalTwinsEndpointResource	Zasób punktu końcowego Usługi DigitalTwinsInstance.
EndpointProvisioningState	Stan aprowizacji.
ErrorDefinition	Definicja błędu.
ErrorResponse	Odpowiedź na błąd.
EventGrid	Właściwości związane z usługą EventGrid.
EventHub	Właściwości związane z usługą EventHub.
IdentityType	Używany typ tożsamości zarządzanej.
ManagedIdentityReference	Właściwości tożsamości zarządzanej.
ServiceBus	Właściwości związane z usługą ServiceBus.
SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AuthenticationType

Określa typ uwierzytelniania używany do nawiązywania połączenia z punktem końcowym. Wartość domyślna to "KeyBased". Jeśli wybrano opcję "KeyBased", należy określić parametry połączenia (co najmniej podstawowe parametry połączenia). Jeśli wybrano wartość "IdentityBased", należy określić właściwości endpointUri i entityPath.

Nazwa	Typ	Opis
IdentityBased	string
KeyBased	string

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DigitalTwinsEndpointResource

Zasób punktu końcowego Usługi DigitalTwinsInstance.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu rozszerzenia.
properties	DigitalTwinsEndpointResourceProperties: EventGrid EventHub ServiceBus	Właściwości zasobu punktu końcowego usługi DigitalTwinsInstance.
systemData	SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	string	Typ zasobu.

EndpointProvisioningState

Stan aprowizacji.

Nazwa	Typ	Opis
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

Definicja błędu.

Nazwa	Typ	Opis
code	string	Kod błędu specyficzny dla usługi, który służy jako stan podrzędny kodu błędu HTTP.
details	ErrorDefinition[]	Szczegóły błędu wewnętrznego.
message	string	Opis błędu.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	ErrorDefinition	Opis błędu

EventGrid

Właściwości związane z usługą EventGrid.

Nazwa	Typ	Opis
TopicEndpoint	string	EventGrid Topic Endpoint( Punkt końcowy tematu usługi EventGrid).
accessKey1	string	EventGrid pomocniczy klucz dostępu. Podczas odczytu będą zaciemnione.
accessKey2	string	EventGrid pomocniczy klucz dostępu. Podczas odczytu będą zaciemnione.
authenticationType	AuthenticationType	Określa typ uwierzytelniania używany do nawiązywania połączenia z punktem końcowym. Wartość domyślna to "KeyBased". Jeśli wybrano opcję "KeyBased", należy określić parametry połączenia (co najmniej podstawowe parametry połączenia). Jeśli wybrano wartość "IdentityBased", należy określić właściwości endpointUri i entityPath.
createdTime	string	Czas dodania punktu końcowego do klasy DigitalTwinsInstance.
deadLetterSecret	string	Wpis tajny magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione.
deadLetterUri	string	Adres URL magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na tożsamościach.
endpointType	string: EventGrid	Typ punktu końcowego usługi Digital Twins
identity	ManagedIdentityReference	Właściwości tożsamości zarządzanej dla punktu końcowego.
provisioningState	EndpointProvisioningState	Stan aprowizacji.

EventHub

Właściwości związane z usługą EventHub.

Nazwa	Typ	Opis
authenticationType	AuthenticationType	Określa typ uwierzytelniania używany do nawiązywania połączenia z punktem końcowym. Wartość domyślna to "KeyBased". Jeśli wybrano opcję "KeyBased", należy określić parametry połączenia (co najmniej podstawowe parametry połączenia). Jeśli wybrano wartość "IdentityBased", należy określić właściwości endpointUri i entityPath.
connectionStringPrimaryKey	string	PrimaryConnectionString punktu końcowego na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione.
connectionStringSecondaryKey	string	SecondaryConnectionString punktu końcowego na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione.
createdTime	string	Czas dodania punktu końcowego do klasy DigitalTwinsInstance.
deadLetterSecret	string	Wpis tajny magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione.
deadLetterUri	string	Adres URL magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na tożsamościach.
endpointType	string: EventHub	Typ punktu końcowego usługi Digital Twins
endpointUri	string	Adres URL przestrzeni nazw usługi EventHub na potrzeby uwierzytelniania opartego na tożsamościach. Musi zawierać protokół "sb://".
entityPath	string	Nazwa usługi EventHub w przestrzeni nazw usługi EventHub na potrzeby uwierzytelniania opartego na tożsamościach.
identity	ManagedIdentityReference	Właściwości tożsamości zarządzanej dla punktu końcowego.
provisioningState	EndpointProvisioningState	Stan aprowizacji.

IdentityType

Używany typ tożsamości zarządzanej.

Nazwa	Typ	Opis
SystemAssigned	string
UserAssigned	string

ManagedIdentityReference

Właściwości tożsamości zarządzanej.

Nazwa	Typ	Opis
type	IdentityType	Używany typ tożsamości zarządzanej.
userAssignedIdentity	string	Identyfikator zasobu usługi ARM tożsamości użytkownika, jeśli typ tożsamości zarządzanej to "UserAssigned".

ServiceBus

Właściwości związane z usługą ServiceBus.

Nazwa	Typ	Opis
authenticationType	AuthenticationType	Określa typ uwierzytelniania używany do nawiązywania połączenia z punktem końcowym. Wartość domyślna to "KeyBased". Jeśli wybrano opcję "KeyBased", należy określić parametry połączenia (co najmniej podstawowe parametry połączenia). Jeśli wybrano wartość "IdentityBased", należy określić właściwości endpointUri i entityPath.
createdTime	string	Czas dodania punktu końcowego do klasy DigitalTwinsInstance.
deadLetterSecret	string	Wpis tajny magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione.
deadLetterUri	string	Adres URL magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na tożsamościach.
endpointType	string: ServiceBus	Typ punktu końcowego usługi Digital Twins
endpointUri	string	Adres URL przestrzeni nazw ServiceBus na potrzeby uwierzytelniania opartego na tożsamościach. Musi zawierać protokół "sb://".
entityPath	string	Nazwa tematu usługi ServiceBus na potrzeby uwierzytelniania opartego na tożsamościach.
identity	ManagedIdentityReference	Właściwości tożsamości zarządzanej dla punktu końcowego.
primaryConnectionString	string	PrimaryConnectionString punktu końcowego na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione.
provisioningState	EndpointProvisioningState	Stan aprowizacji.
secondaryConnectionString	string	SecondaryConnectionString punktu końcowego na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione.

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Share via

Endpoints - DigitalTwinsEndpoint CreateOrUpdate

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

Put a DigitalTwinsEndpoint resource

Sample Request

Sample Response

Put a DigitalTwinsEndpoint resource with identity

Sample Request

Sample Response

Put a DigitalTwinsEndpoint resource with user assigned identity

Sample Request

Sample Response

Definicje

AuthenticationType

createdByType

DigitalTwinsEndpointResource

EndpointProvisioningState

ErrorDefinition

ErrorResponse

EventGrid

EventHub

IdentityType

ManagedIdentityReference

ServiceBus

SystemData

Opinia

Opinia

Dodatkowe zasoby