Endpoints - DigitalTwinsEndpoint CreateOrUpdate

Reference

Service:: Azure Digital Twins

API Version:: 2023-01-31

Vytvoření nebo aktualizace koncového bodu DigitalTwinsInstance

PUT 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

Text požadavku

Name	Vyžadováno	Typ	Description
properties	True	DigitalTwinsEndpointResourceProperties: ServiceBus EventHub EventGrid	Vlastnosti prostředku koncového bodu DigitalTwinsInstance.

Odpovědi

Name	Typ	Description
200 OK	DigitalTwinsEndpointResource	Vrátí se jako odpověď na požadavek dotazování stavu pro operaci vytvoření nebo aktualizace. Tělo obsahuje reprezentaci prostředku, která označuje přechodný stav zřizování.
201 Created	DigitalTwinsEndpointResource	Vytvořeno – Žádost o vložení byla přijata. operace se dokončí asynchronně.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

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

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

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í se zadat připojovací řetězec (alespoň primární připojovací řetězec). Pokud je možnost IdentityBased vybraná, musí být zadány vlastnosti endpointUri a entityPath.
createdByType	Typ identity, která prostředek vytvořila.
DigitalTwinsEndpointResource	Prostředek koncového bodu DigitalTwinsInstance.
EndpointProvisioningState	Stav zřizování.
ErrorDefinition	Definice chyby.
ErrorResponse	Chybová odpověď.
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í se službou 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í se zadat připojovací řetězec (alespoň primární připojovací řetězec). Pokud je možnost IdentityBased vybraná, musí být zadány vlastnosti endpointUri a entityPath.

Name	Typ	Description
IdentityBased	string
KeyBased	string

createdByType

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

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

Chybová odpověď.

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 zamlženo.
accessKey2	string	Sekundární přístupový klíč EventGrid. Během čtení bude zamlženo.
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í se zadat připojovací řetězec (alespoň primární připojovací řetězec). Pokud je možnost IdentityBased vybraná, 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 zamlženo.
deadLetterUri	string	Nedoručených adres URL úložiště 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í se zadat připojovací řetězec (alespoň primární připojovací řetězec). Pokud je možnost IdentityBased vybraná, 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 zamlženo.
connectionStringSecondaryKey	string	SecondaryConnectionString koncového bodu pro ověřování na základě klíčů. Během čtení bude zamlženo.
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 zamlženo.
deadLetterUri	string	Nedoručených adres URL úložiště 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ě identity. Musí obsahovat protokol "sb://".
entityPath	string	Název EventHubu v oboru názvů EventHub 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í se službou 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í se zadat připojovací řetězec (alespoň primární připojovací řetězec). Pokud je možnost IdentityBased vybraná, 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 zamlženo.
deadLetterUri	string	Nedoručených adres URL úložiště 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ě identity. Musí obsahovat protokol "sb://".
entityPath	string	Název tématu Služby 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 zamlženo.
provisioningState	EndpointProvisioningState	Stav zřizování.
secondaryConnectionString	string	SecondaryConnectionString koncového bodu pro ověřování na základě klíčů. Během čtení bude zamlženo.

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á vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
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.

Endpoints - DigitalTwinsEndpoint CreateOrUpdate

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

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

Definice

AuthenticationType

createdByType

DigitalTwinsEndpointResource

EndpointProvisioningState

ErrorDefinition

ErrorResponse

EventGrid

EventHub

IdentityType

ManagedIdentityReference

ServiceBus

SystemData

Váš názor

Váš názor

Další materiály