Endpoints - DigitalTwinsEndpoint Get

Reference

Service:: Azure Digital Twins

API Version:: 2023-01-31

Získejte koncový bod DigitalTwinsInstances.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpointName	path	True	string	Název prostředku koncového bodu. Regex pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje DigitalTwinsInstance.
resourceName	path	True	string	Název instance DigitalTwinsInstance. Regex pattern: `^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$`
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API služby DigitalTwinsInstance Management

Odpovědi

Name	Typ	Description
200 OK	DigitalTwinsEndpointResource	Tělo obsahuje všechny vlastnosti netýkající se zabezpečení digitalTwinsInstance. Vlastnosti související se zabezpečením jsou nastaveny na hodnotu null.
Other Status Codes	ErrorResponse	Výchozí chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
AuthenticationType	Určuje typ ověřování, který se používá pro připojení ke koncovému bodu. Výchozí hodnota je KeyBased. Pokud je vybraná možnost KeyBased, musí být zadán připojovací řetězec (alespoň primární připojovací řetězec). Pokud je vybraná možnost IdentityBased, musí být zadány vlastnosti endpointUri a entityPath.
createdByType	Typ identity, která vytvořila prostředek.
DigitalTwinsEndpointResource	Prostředek koncového bodu DigitalTwinsInstance.
EndpointProvisioningState	Stav zřizování.
ErrorDefinition	Definice chyby
ErrorResponse	Odpověď na chybu.
EventGrid	Vlastnosti související s EventGrid.
EventHub	Vlastnosti související s EventHubem.
IdentityType	Typ použité spravované identity
ManagedIdentityReference	Vlastnosti spravované identity.
ServiceBus	Vlastnosti související s ServiceBus.
SystemData	Metadata týkající se vytvoření a poslední změny prostředku

AuthenticationType

Určuje typ ověřování, který se používá pro připojení ke koncovému bodu. Výchozí hodnota je KeyBased. Pokud je vybraná možnost KeyBased, musí být zadán připojovací řetězec (alespoň primární připojovací řetězec). Pokud je vybraná možnost IdentityBased, musí být zadány vlastnosti endpointUri a entityPath.

Name	Typ	Description
IdentityBased	string
KeyBased	string

createdByType

Typ identity, která vytvořila prostředek.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigitalTwinsEndpointResource

Prostředek koncového bodu DigitalTwinsInstance.

Name	Typ	Description
id	string	Identifikátor prostředku.
name	string	Název prostředku rozšíření.
properties	DigitalTwinsEndpointResourceProperties: EventGrid EventHub ServiceBus	Vlastnosti prostředku koncového bodu DigitalTwinsInstance
systemData	SystemData	Metadata týkající se vytvoření a poslední změny prostředku
type	string	Typ prostředku.

EndpointProvisioningState

Stav zřizování.

Name	Typ	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

Definice chyby

Name	Typ	Description
code	string	Kód chyby specifický pro službu, který slouží jako dílčí stav pro kód chyby HTTP.
details	ErrorDefinition[]	Podrobnosti o vnitřní chybě.
message	string	Popis chyby

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error	ErrorDefinition	Popis chyby

EventGrid

Vlastnosti související s EventGrid.

Name	Typ	Description
TopicEndpoint	string	Koncový bod tématu EventGrid.
accessKey1	string	Sekundární přístupový klíč EventGrid. Během čtení bude obfuskován.
accessKey2	string	Sekundární přístupový klíč EventGrid. Během čtení bude obfuskován.
authenticationType	AuthenticationType	Určuje typ ověřování, který se používá pro připojení ke koncovému bodu. Výchozí hodnota je KeyBased. Pokud je vybraná možnost KeyBased, musí být zadán připojovací řetězec (alespoň primární připojovací řetězec). Pokud je vybraná možnost IdentityBased, musí být zadány vlastnosti endpointUri a entityPath.
createdTime	string	Čas přidání koncového bodu do instance DigitalTwinsInstance
deadLetterSecret	string	Nedoručený tajný kód úložiště pro ověřování na základě klíčů. Během čtení bude obfuskován.
deadLetterUri	string	Adresa URL úložiště nedoručených dopisů pro ověřování na základě identity
endpointType	string: EventGrid	Typ koncového bodu služby Digital Twins
identity	ManagedIdentityReference	Vlastnosti spravované identity pro koncový bod
provisioningState	EndpointProvisioningState	Stav zřizování.

EventHub

Vlastnosti související s EventHubem.

Name	Typ	Description
authenticationType	AuthenticationType	Určuje typ ověřování, který se používá pro připojení ke koncovému bodu. Výchozí hodnota je KeyBased. Pokud je vybraná možnost KeyBased, musí být zadán připojovací řetězec (alespoň primární připojovací řetězec). Pokud je vybraná možnost IdentityBased, musí být zadány vlastnosti endpointUri a entityPath.
connectionStringPrimaryKey	string	PrimaryConnectionString koncového bodu pro ověřování na základě klíčů. Během čtení bude obfuskován.
connectionStringSecondaryKey	string	SecondaryConnectionString koncového bodu pro ověřování na základě klíčů. Během čtení bude obfuskován.
createdTime	string	Čas přidání koncového bodu do instance DigitalTwinsInstance
deadLetterSecret	string	Nedoručený tajný kód úložiště pro ověřování na základě klíčů. Během čtení bude obfuskován.
deadLetterUri	string	Adresa URL úložiště nedoručených dopisů pro ověřování na základě identity
endpointType	string: EventHub	Typ koncového bodu služby Digital Twins
endpointUri	string	Adresa URL oboru názvů EventHubu pro ověřování na základě identit. Musí obsahovat protokol "sb://".
entityPath	string	Název EventHubu v oboru názvů EventHubu pro ověřování na základě identity.
identity	ManagedIdentityReference	Vlastnosti spravované identity pro koncový bod
provisioningState	EndpointProvisioningState	Stav zřizování.

IdentityType

Typ použité spravované identity

Name	Typ	Description
SystemAssigned	string
UserAssigned	string

ManagedIdentityReference

Vlastnosti spravované identity.

Name	Typ	Description
type	IdentityType	Typ použité spravované identity
userAssignedIdentity	string	ID prostředku ARM identity uživatele, pokud je typ spravované identity UserAssigned.

ServiceBus

Vlastnosti související s ServiceBus.

Name	Typ	Description
authenticationType	AuthenticationType	Určuje typ ověřování, který se používá pro připojení ke koncovému bodu. Výchozí hodnota je KeyBased. Pokud je vybraná možnost KeyBased, musí být zadán připojovací řetězec (alespoň primární připojovací řetězec). Pokud je vybraná možnost IdentityBased, musí být zadány vlastnosti endpointUri a entityPath.
createdTime	string	Čas přidání koncového bodu do instance DigitalTwinsInstance
deadLetterSecret	string	Nedoručený tajný kód úložiště pro ověřování na základě klíčů. Během čtení bude obfuskován.
deadLetterUri	string	Adresa URL úložiště nedoručených dopisů pro ověřování na základě identity
endpointType	string: ServiceBus	Typ koncového bodu služby Digital Twins
endpointUri	string	Adresa URL oboru názvů ServiceBus pro ověřování na základě identit. Musí obsahovat protokol "sb://".
entityPath	string	Název tématu ServiceBus pro ověřování na základě identity.
identity	ManagedIdentityReference	Vlastnosti spravované identity pro koncový bod
primaryConnectionString	string	PrimaryConnectionString koncového bodu pro ověřování na základě klíčů. Během čtení bude obfuskován.
provisioningState	EndpointProvisioningState	Stav zřizování.
secondaryConnectionString	string	SecondaryConnectionString koncového bodu pro ověřování na základě klíčů. Během čtení bude obfuskován.

SystemData

Metadata týkající se vytvoření a poslední změny prostředku

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která vytvořila prostředek.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Endpoints - DigitalTwinsEndpoint Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

Get a DigitalTwinsInstance endpoint

Sample Request

Sample Response

Get a DigitalTwinsInstance endpoint with identity

Sample Request

Sample Response

Definice

AuthenticationType

createdByType

DigitalTwinsEndpointResource

EndpointProvisioningState

ErrorDefinition

ErrorResponse

EventGrid

EventHub

IdentityType

ManagedIdentityReference

ServiceBus

SystemData

Váš názor

Váš názor

Další materiály