Endpoints - DigitalTwinsEndpoint Get

Service:

Azure Digital Twins

API Version:

2023-01-31

DigitalTwinsInstances エンドポイントを取得します。

GET 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 Management API のバージョン。

応答

名前	型	説明
200 OK	DigitalTwinsEndpointResource	本文には、DigitalTwinsInstance のすべてのセキュリティ以外のプロパティが含まれています。 セキュリティ関連のプロパティは null に設定されます。
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	ユーザー アカウントの借用

例

Get a DigitalTwinsInstance endpoint

Get a DigitalTwinsInstance endpoint with identity

Get a DigitalTwinsInstance endpoint

Sample Request

HTTP

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

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

Get a DigitalTwinsInstance endpoint with identity

Sample Request

HTTP

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

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": "IdentityBased",
    "provisioningState": "Succeeded",
    "endpointUri": "sb://mysb.servicebus.windows.net/",
    "entityPath": "mysbtopic",
    "createdTime": "2019-11-19T01:10:34.350Z"
  }
}

定義

名前	説明
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 プロパティを指定する必要があります。

名前	型	説明
IdentityBased	string
KeyBased	string

createdByType

リソースを作成した ID の種類。

名前	型	説明
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	ID ベースの認証用の配信不能ストレージ URL。
endpointType	string: EventGrid	Digital Twins エンドポイントの種類
identity	ManagedIdentityReference	エンドポイントのマネージド ID プロパティ。
provisioningState	EndpointProvisioningState	プロビジョニングの状態。

EventHub

EventHub に関連するプロパティ。

名前	型	説明
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 の種類。

名前	型	説明
SystemAssigned	string
UserAssigned	string

ManagedIdentityReference

マネージド ID のプロパティ。

名前	型	説明
type	IdentityType	使用されるマネージド ID の種類。
userAssignedIdentity	string	マネージド ID の種類が 'UserAssigned' の場合のユーザー ID ARM リソース ID。

ServiceBus

ServiceBus に関連するプロパティ。

名前	型	説明
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

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。