Endpoints - DigitalTwinsEndpoint CreateOrUpdate

參考

Service:: Azure Digital Twins

API Version:: 2023-01-31

建立或更新 DigitalTwinsInstance 端點。

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

URI 參數

名稱	位於	必要	類型	Description
endpointName	path	True	string	端點資源的名稱。 Regex pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	包含 DigitalTwinsInstance 的資源群組名稱。
resourceName	path	True	string	DigitalTwinsInstance 的名稱。 Regex pattern: `^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$`
subscriptionId	path	True	string	訂用帳戶識別碼。
api-version	query	True	string	DigitalTwinsInstance 管理 API 的版本。

要求本文

名稱	必要	類型	Description
properties	True	DigitalTwinsEndpointResourceProperties: ServiceBus EventHub EventGrid	DigitalTwinsInstance 端點資源屬性。

回應

名稱	類型	Description
200 OK	DigitalTwinsEndpointResource	這會以回應建立或更新作業的狀態輪詢要求傳回。本文包含資源標記法，表示過渡布建狀態。
201 Created	DigitalTwinsEndpointResource	已建立 - 接受放置要求;作業將會以非同步方式完成。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的使用者帳戶

範例

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

定義

名稱	Description
AuthenticationType	指定用於連線至端點的驗證類型。預設為 'KeyBased'。如果已選取 'KeyBased'，則必須 (至少) 主要連接字串來指定連接字串。如果選取 'IdentityBased'，則必須指定 endpointUri 和 entityPath 屬性。
createdByType	建立資源的身分識別類型。
DigitalTwinsEndpointResource	DigitalTwinsInstance 端點資源。
EndpointProvisioningState	布建狀態。
ErrorDefinition	錯誤定義。
ErrorResponse	錯誤回應。
EventGrid	與 EventGrid 相關的屬性。
EventHub	與 EventHub 相關的屬性。
IdentityType	使用的受控識別類型。
ManagedIdentityReference	受控識別的屬性。
ServiceBus	與 ServiceBus 相關的屬性。
SystemData	與建立和上次修改資源相關的中繼資料。

AuthenticationType

指定用於連線至端點的驗證類型。預設為 'KeyBased'。如果已選取 'KeyBased'，則必須 (至少) 主要連接字串來指定連接字串。如果選取 'IdentityBased'，則必須指定 endpointUri 和 entityPath 屬性。

名稱	類型	Description
IdentityBased	string
KeyBased	string

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigitalTwinsEndpointResource

DigitalTwinsInstance 端點資源。

名稱	類型	Description
id	string	資源識別碼。
name	string	延伸模組資源名稱。
properties	DigitalTwinsEndpointResourceProperties: EventGrid EventHub ServiceBus	DigitalTwinsInstance 端點資源屬性。
systemData	SystemData	與建立和上次修改資源相關的中繼資料。
type	string	資源類型。

EndpointProvisioningState

布建狀態。

名稱	類型	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

錯誤定義。

名稱	類型	Description
code	string	服務特定的錯誤碼，可作為 HTTP 錯誤碼的子狀態。
details	ErrorDefinition[]	內部錯誤詳細資料。
message	string	錯誤的描述。

ErrorResponse

錯誤回應。

名稱	類型	Description
error	ErrorDefinition	錯誤描述

EventGrid

與 EventGrid 相關的屬性。

名稱	類型	Description
TopicEndpoint	string	EventGrid 主題端點。
accessKey1	string	EventGrid 次要存取金鑰。在讀取期間會模糊化。
accessKey2	string	EventGrid 次要存取金鑰。在讀取期間會模糊化。
authenticationType	AuthenticationType	指定用於連線至端點的驗證類型。預設為 'KeyBased'。如果已選取 'KeyBased'，則必須 (至少) 主要連接字串來指定連接字串。如果選取 'IdentityBased'，則必須指定 endpointUri 和 entityPath 屬性。
createdTime	string	將端點新增至 DigitalTwinsInstance 的時間。
deadLetterSecret	string	金鑰型驗證的無效信件儲存體秘密。在讀取期間會模糊化。
deadLetterUri	string	身分識別型驗證的無效信件儲存體 URL。
endpointType	string: EventGrid	Digital Twins 端點的類型
identity	ManagedIdentityReference	端點的受控識別屬性。
provisioningState	EndpointProvisioningState	布建狀態。

EventHub

與 EventHub 相關的屬性。

名稱	類型	Description
authenticationType	AuthenticationType	指定用於連線至端點的驗證類型。預設為 'KeyBased'。如果已選取 'KeyBased'，則必須 (至少) 主要連接字串來指定連接字串。如果選取 'IdentityBased'，則必須指定 endpointUri 和 entityPath 屬性。
connectionStringPrimaryKey	string	金鑰型驗證端點的 PrimaryConnectionString。在讀取期間會模糊化。
connectionStringSecondaryKey	string	金鑰型驗證端點的 SecondaryConnectionString。在讀取期間會模糊化。
createdTime	string	將端點新增至 DigitalTwinsInstance 的時間。
deadLetterSecret	string	金鑰型驗證的無效信件儲存體秘密。在讀取期間會模糊化。
deadLetterUri	string	身分識別型驗證的無效信件儲存體 URL。
endpointType	string: EventHub	Digital Twins 端點的類型
endpointUri	string	EventHub 命名空間的 URL，用於身分識別型驗證。它必須包含通訊協定 'sb://'。
entityPath	string	EventHub 命名空間中的 EventHub 名稱，用於身分識別型驗證。
identity	ManagedIdentityReference	端點的受控識別屬性。
provisioningState	EndpointProvisioningState	布建狀態。

IdentityType

使用的受控識別類型。

名稱	類型	Description
SystemAssigned	string
UserAssigned	string

ManagedIdentityReference

受控識別的屬性。

名稱	類型	Description
type	IdentityType	使用的受控識別類型。
userAssignedIdentity	string	如果受控識別類型為 'UserAssigned'，則為使用者身分識別 ARM 資源識別碼。

ServiceBus

與 ServiceBus 相關的屬性。

名稱	類型	Description
authenticationType	AuthenticationType	指定用於連線至端點的驗證類型。預設為 'KeyBased'。如果已選取 'KeyBased'，則必須 (至少) 主要連接字串來指定連接字串。如果選取 'IdentityBased'，則必須指定 endpointUri 和 entityPath 屬性。
createdTime	string	將端點新增至 DigitalTwinsInstance 的時間。
deadLetterSecret	string	金鑰型驗證的無效信件儲存體秘密。在讀取期間會模糊化。
deadLetterUri	string	身分識別型驗證的無效信件儲存體 URL。
endpointType	string: ServiceBus	Digital Twins 端點的類型
endpointUri	string	ServiceBus 命名空間的 URL，用於身分識別型驗證。它必須包含通訊協定 'sb://'。
entityPath	string	身分識別型驗證的 ServiceBus 主題名稱。
identity	ManagedIdentityReference	端點的受控識別屬性。
primaryConnectionString	string	金鑰型驗證端點的 PrimaryConnectionString。在讀取期間會模糊化。
provisioningState	EndpointProvisioningState	布建狀態。
secondaryConnectionString	string	金鑰型驗證端點的 SecondaryConnectionString。在讀取期間會模糊化。

SystemData

與建立和上次修改資源相關的中繼資料。

名稱	類型	Description
createdAt	string	資源建立的時間戳記 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳記 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

共用方式為

Endpoints - DigitalTwinsEndpoint CreateOrUpdate

URI 參數

要求本文

回應

安全性

azure_auth

Scopes

範例

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

定義

AuthenticationType

createdByType

DigitalTwinsEndpointResource

EndpointProvisioningState

ErrorDefinition

ErrorResponse

EventGrid

EventHub

IdentityType

ManagedIdentityReference

ServiceBus

SystemData

意見反應

意見反應

其他資源