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 参数

名称	在	必需	类型	说明
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 的版本。

请求正文

名称	必需	类型	说明
properties	True	DigitalTwinsEndpointResourceProperties: ServiceBus EventHub EventGrid	DigitalTwinsInstance 终结点资源属性。

响应

名称	类型	说明
200 OK	DigitalTwinsEndpointResource	这是作为对创建或更新操作的状态轮询请求的响应返回的。正文包含指示过渡预配状态的资源表示形式。
201 Created	DigitalTwinsEndpointResource	已创建 - 接受放置请求;操作将以异步方式完成。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
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"
    }
  }
}

定义

名称	说明
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 属性。

名称	类型	说明
IdentityBased	string
KeyBased	string

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DigitalTwinsEndpointResource

DigitalTwinsInstance 终结点资源。

名称	类型	说明
id	string	资源标识符。
name	string	扩展资源名称。
properties	DigitalTwinsEndpointResourceProperties: EventGrid EventHub ServiceBus	DigitalTwinsInstance 终结点资源属性。
systemData	SystemData	与资源的创建和上次修改相关的元数据。
type	string	资源类型。

EndpointProvisioningState

预配状态。

名称	类型	说明
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

错误定义。

名称	类型	说明
code	string	服务特定的错误代码，用作 HTTP 错误代码的子状态。
details	ErrorDefinition[]	内部错误详细信息。
message	string	错误的说明。

ErrorResponse

错误响应。

名称	类型	说明
error	ErrorDefinition	错误说明

EventGrid

与 EventGrid 相关的属性。

名称	类型	说明
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	数字孪生终结点的类型
identity	ManagedIdentityReference	终结点的托管标识属性。
provisioningState	EndpointProvisioningState	预配状态。

EventHub

与 EventHub 相关的属性。

名称	类型	说明
authenticationType	AuthenticationType	指定用于连接到终结点的身份验证类型。默认为“KeyBased”。如果选择“KeyBased”，则必须至少 (主连接字符串) 指定连接字符串。如果选择“IdentityBased”，则必须指定 endpointUri 和 entityPath 属性。
connectionStringPrimaryKey	string	用于基于密钥的身份验证的终结点的 PrimaryConnectionString。在读取期间将被模糊处理。
connectionStringSecondaryKey	string	用于基于密钥的身份验证的终结点的 SecondaryConnectionString。在读取期间将被模糊处理。
createdTime	string	将终结点添加到 DigitalTwinsInstance 的时间。
deadLetterSecret	string	用于基于密钥的身份验证的死信存储机密。在读取期间将被模糊处理。
deadLetterUri	string	用于基于标识的身份验证的死信存储 URL。
endpointType	string: EventHub	数字孪生终结点的类型
endpointUri	string	用于基于标识的身份验证的 EventHub 命名空间的 URL。它必须包含协议“sb://”。
entityPath	string	用于基于标识的身份验证的 EventHub 命名空间中的 EventHub 名称。
identity	ManagedIdentityReference	终结点的托管标识属性。
provisioningState	EndpointProvisioningState	预配状态。

IdentityType

使用的托管标识的类型。

名称	类型	说明
SystemAssigned	string
UserAssigned	string

ManagedIdentityReference

托管标识的属性。

名称	类型	说明
type	IdentityType	使用的托管标识的类型。
userAssignedIdentity	string	如果托管标识类型为“UserAssigned”，则为用户标识 ARM 资源 ID。

ServiceBus

与 ServiceBus 相关的属性。

名称	类型	说明
authenticationType	AuthenticationType	指定用于连接到终结点的身份验证类型。默认为“KeyBased”。如果选择“KeyBased”，则必须至少 (主连接字符串) 指定连接字符串。如果选择“IdentityBased”，则必须指定 endpointUri 和 entityPath 属性。
createdTime	string	将终结点添加到 DigitalTwinsInstance 的时间。
deadLetterSecret	string	用于基于密钥的身份验证的死信存储机密。在读取期间将被模糊处理。
deadLetterUri	string	用于基于标识的身份验证的死信存储 URL。
endpointType	string: ServiceBus	数字孪生终结点的类型
endpointUri	string	用于基于标识的身份验证的 ServiceBus 命名空间的 URL。它必须包含协议“sb://”。
entityPath	string	基于标识的身份验证的 ServiceBus 主题名称。
identity	ManagedIdentityReference	终结点的托管标识属性。
primaryConnectionString	string	用于基于密钥的身份验证的终结点的 PrimaryConnectionString。在读取期间将被模糊处理。
provisioningState	EndpointProvisioningState	预配状态。
secondaryConnectionString	string	用于基于密钥的身份验证的终结点的 SecondaryConnectionString。在读取期间将被模糊处理。

SystemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

Share via

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

反馈

反馈

其他资源