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 매개 변수

Name	In(다음 안에)	필수	형식	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의 버전입니다.

요청 본문

Name	필수	형식	Description
properties	True	DigitalTwinsEndpointResourceProperties: ServiceBus EventHub EventGrid	DigitalTwinsInstance 엔드포인트 리소스 속성입니다.

응답

Name	형식	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

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

정의

Name	Description
AuthenticationType	엔드포인트에 연결하는 데 사용되는 인증 유형을 지정합니다. 기본값은 'KeyBased'입니다. 'KeyBased'를 선택하면 연결 문자열(적어도 기본 연결 문자열)을 지정해야 합니다. 'IdentityBased'를 선택하면 endpointUri 및 entityPath 속성을 지정해야 합니다.
createdByType	리소스를 만든 ID의 형식입니다.
DigitalTwinsEndpointResource	DigitalTwinsInstance 엔드포인트 리소스.
EndpointProvisioningState	프로비저닝 상태입니다.
ErrorDefinition	오류 정의.
ErrorResponse	오류 응답입니다.
EventGrid	EventGrid와 관련된 속성입니다.
EventHub	EventHub와 관련된 속성입니다.
IdentityType	사용되는 관리 ID의 유형입니다.
ManagedIdentityReference	관리 ID의 속성입니다.
ServiceBus	ServiceBus와 관련된 속성입니다.
SystemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

AuthenticationType

엔드포인트에 연결하는 데 사용되는 인증 유형을 지정합니다. 기본값은 'KeyBased'입니다. 'KeyBased'를 선택하면 연결 문자열(적어도 기본 연결 문자열)을 지정해야 합니다. 'IdentityBased'를 선택하면 endpointUri 및 entityPath 속성을 지정해야 합니다.

Name	형식	Description
IdentityBased	string
KeyBased	string

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigitalTwinsEndpointResource

DigitalTwinsInstance 엔드포인트 리소스.

Name	형식	Description
id	string	리소스 식별자입니다.
name	string	확장 리소스 이름입니다.
properties	DigitalTwinsEndpointResourceProperties: EventGrid EventHub ServiceBus	DigitalTwinsInstance 엔드포인트 리소스 속성입니다.
systemData	SystemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
type	string	리소스 종류입니다.

EndpointProvisioningState

프로비저닝 상태입니다.

Name	형식	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

오류 정의.

Name	형식	Description
code	string	HTTP 오류 코드의 하위 상태 역할을 하는 서비스별 오류 코드입니다.
details	ErrorDefinition[]	내부 오류 세부 정보입니다.
message	string	오류 설명입니다.

ErrorResponse

오류 응답입니다.

Name	형식	Description
error	ErrorDefinition	오류 설명

EventGrid

EventGrid와 관련된 속성입니다.

Name	형식	Description
TopicEndpoint	string	EventGrid 토픽 엔드포인트.
accessKey1	string	EventGrid 보조 액세스 키. 읽는 동안 난독 제거됩니다.
accessKey2	string	EventGrid 보조 액세스 키. 읽는 동안 난독 제거됩니다.
authenticationType	AuthenticationType	엔드포인트에 연결하는 데 사용되는 인증 유형을 지정합니다. 기본값은 'KeyBased'입니다. 'KeyBased'를 선택하면 연결 문자열(적어도 기본 연결 문자열)을 지정해야 합니다. 'IdentityBased'를 선택하면 endpointUri 및 entityPath 속성을 지정해야 합니다.
createdTime	string	엔드포인트가 DigitalTwinsInstance에 추가된 시간입니다.
deadLetterSecret	string	키 기반 인증을 위한 배달 못한 편지 스토리지 비밀입니다. 읽는 동안 난독 제거됩니다.
deadLetterUri	string	ID 기반 인증을 위한 배달 못한 편지 스토리지 URL입니다.
endpointType	string: EventGrid	Digital Twins 엔드포인트의 유형
identity	ManagedIdentityReference	엔드포인트에 대한 관리 ID 속성입니다.
provisioningState	EndpointProvisioningState	프로비저닝 상태입니다.

EventHub

EventHub와 관련된 속성입니다.

Name	형식	Description
authenticationType	AuthenticationType	엔드포인트에 연결하는 데 사용되는 인증 유형을 지정합니다. 기본값은 'KeyBased'입니다. 'KeyBased'를 선택하면 연결 문자열(적어도 기본 연결 문자열)을 지정해야 합니다. 'IdentityBased'를 선택하면 endpointUri 및 entityPath 속성을 지정해야 합니다.
connectionStringPrimaryKey	string	키 기반 인증을 위한 엔드포인트의 PrimaryConnectionString입니다. 읽는 동안 난독 제거됩니다.
connectionStringSecondaryKey	string	키 기반 인증을 위한 엔드포인트의 SecondaryConnectionString입니다. 읽는 동안 난독 제거됩니다.
createdTime	string	엔드포인트가 DigitalTwinsInstance에 추가된 시간입니다.
deadLetterSecret	string	키 기반 인증을 위한 배달 못한 편지 스토리지 비밀입니다. 읽는 동안 난독 제거됩니다.
deadLetterUri	string	ID 기반 인증을 위한 배달 못한 편지 스토리지 URL입니다.
endpointType	string: EventHub	Digital Twins 엔드포인트의 유형
endpointUri	string	ID 기반 인증을 위한 EventHub 네임스페이스의 URL입니다. 'sb://' 프로토콜을 포함해야 합니다.
entityPath	string	ID 기반 인증을 위한 EventHub 네임스페이스의 EventHub 이름입니다.
identity	ManagedIdentityReference	엔드포인트에 대한 관리 ID 속성입니다.
provisioningState	EndpointProvisioningState	프로비저닝 상태입니다.

IdentityType

사용되는 관리 ID의 유형입니다.

Name	형식	Description
SystemAssigned	string
UserAssigned	string

ManagedIdentityReference

관리 ID의 속성입니다.

Name	형식	Description
type	IdentityType	사용되는 관리 ID의 유형입니다.
userAssignedIdentity	string	관리 ID 유형이 'UserAssigned'인 경우 사용자 ID ARM 리소스 ID입니다.

ServiceBus

ServiceBus와 관련된 속성입니다.

Name	형식	Description
authenticationType	AuthenticationType	엔드포인트에 연결하는 데 사용되는 인증 유형을 지정합니다. 기본값은 'KeyBased'입니다. 'KeyBased'를 선택하면 연결 문자열(적어도 기본 연결 문자열)을 지정해야 합니다. 'IdentityBased'를 선택하면 endpointUri 및 entityPath 속성을 지정해야 합니다.
createdTime	string	엔드포인트가 DigitalTwinsInstance에 추가된 시간입니다.
deadLetterSecret	string	키 기반 인증을 위한 배달 못한 편지 스토리지 비밀입니다. 읽는 동안 난독 제거됩니다.
deadLetterUri	string	ID 기반 인증을 위한 배달 못한 편지 스토리지 URL입니다.
endpointType	string: ServiceBus	Digital Twins 엔드포인트의 유형
endpointUri	string	ID 기반 인증을 위한 ServiceBus 네임스페이스의 URL입니다. 'sb://' 프로토콜을 포함해야 합니다.
entityPath	string	ID 기반 인증에 대한 ServiceBus 토픽 이름입니다.
identity	ManagedIdentityReference	엔드포인트에 대한 관리 ID 속성입니다.
primaryConnectionString	string	키 기반 인증을 위한 엔드포인트의 PrimaryConnectionString입니다. 읽는 동안 난독 제거됩니다.
provisioningState	EndpointProvisioningState	프로비저닝 상태입니다.
secondaryConnectionString	string	키 기반 인증을 위한 엔드포인트의 SecondaryConnectionString입니다. 읽는 동안 난독 제거됩니다.

SystemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.

다음을 통해 공유

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

피드백

피드백

추가 리소스