Endpoints - DigitalTwinsEndpoint CreateOrUpdate

Referência

Service:: Azure Digital Twins

API Version:: 2023-01-31

Criar ou atualizar o ponto de extremidade DigitalTwinsInstance.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpointName	path	True	string	Nome do Recurso de Ponto de Extremidade. Regex pattern: `^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o DigitalTwinsInstance.
resourceName	path	True	string	O nome do DigitalTwinsInstance. Regex pattern: `^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$`
subscriptionId	path	True	string	O identificador da assinatura.
api-version	query	True	string	Versão da API de Gerenciamento do DigitalTwinsInstance.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties	True	DigitalTwinsEndpointResourceProperties: ServiceBus EventHub EventGrid	Propriedades do recurso de ponto de extremidade DigitalTwinsInstance.

Respostas

Nome	Tipo	Description
200 OK	DigitalTwinsEndpointResource	Isso é retornado como uma resposta ao status solicitação de sondagem para a operação de criação ou atualização. O corpo contém a representação de recurso que indica um estado de provisionamento transitório.
201 Created	DigitalTwinsEndpointResource	Criado – Solicitação put aceita; a operação será concluída de forma assíncrona.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	Representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
AuthenticationType	Especifica o tipo de autenticação que está sendo usado para se conectar ao ponto de extremidade. O padrão é 'KeyBased'. Se 'KeyBased' estiver selecionado, uma cadeia de conexão deverá ser especificada (pelo menos a cadeia de conexão primária). Se 'IdentityBased' for selecionado, as propriedades endpointUri e entityPath deverão ser especificadas.
createdByType	O tipo de identidade que criou o recurso.
DigitalTwinsEndpointResource	Recurso de ponto de extremidade DigitalTwinsInstance.
EndpointProvisioningState	O estado de provisionamento.
ErrorDefinition	Definição de erro.
ErrorResponse	Resposta de erro.
EventGrid	Propriedades relacionadas ao EventGrid.
EventHub	Propriedades relacionadas ao EventHub.
IdentityType	O tipo de identidade gerenciada usada.
ManagedIdentityReference	As propriedades da Identidade Gerenciada.
ServiceBus	Propriedades relacionadas ao ServiceBus.
SystemData	Metadados relativos à criação e à última modificação do recurso.

AuthenticationType

Especifica o tipo de autenticação que está sendo usado para se conectar ao ponto de extremidade. O padrão é 'KeyBased'. Se 'KeyBased' estiver selecionado, uma cadeia de conexão deverá ser especificada (pelo menos a cadeia de conexão primária). Se 'IdentityBased' for selecionado, as propriedades endpointUri e entityPath deverão ser especificadas.

Nome	Tipo	Description
IdentityBased	string
KeyBased	string

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigitalTwinsEndpointResource

Recurso de ponto de extremidade DigitalTwinsInstance.

Nome	Tipo	Description
id	string	O identificador do recurso.
name	string	Nome do recurso de extensão.
properties	DigitalTwinsEndpointResourceProperties: EventGrid EventHub ServiceBus	Propriedades do recurso de ponto de extremidade DigitalTwinsInstance.
systemData	SystemData	Metadados relativos à criação e à última modificação do recurso.
type	string	O tipo de recurso.

EndpointProvisioningState

O estado de provisionamento.

Nome	Tipo	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

Definição de erro.

Nome	Tipo	Description
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
details	ErrorDefinition[]	Detalhes do erro interno.
message	string	Descrição do erro.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	ErrorDefinition	Descrição do erro

EventGrid

Propriedades relacionadas ao EventGrid.

Nome	Tipo	Description
TopicEndpoint	string	Ponto de extremidade do tópico EventGrid.
accessKey1	string	Chave de acesso secundária do EventGrid. Será ofuscado durante a leitura.
accessKey2	string	Chave de acesso secundária do EventGrid. Será ofuscado durante a leitura.
authenticationType	AuthenticationType	Especifica o tipo de autenticação que está sendo usado para se conectar ao ponto de extremidade. O padrão é 'KeyBased'. Se 'KeyBased' estiver selecionado, uma cadeia de conexão deverá ser especificada (pelo menos a cadeia de conexão primária). Se 'IdentityBased' for selecionado, as propriedades endpointUri e entityPath deverão ser especificadas.
createdTime	string	Hora em que o ponto de extremidade foi adicionado a DigitalTwinsInstance.
deadLetterSecret	string	Segredo de armazenamento de mensagens mortas para autenticação baseada em chave. Será ofuscado durante a leitura.
deadLetterUri	string	URL de armazenamento de mensagens mortas para autenticação baseada em identidade.
endpointType	string: EventGrid	O tipo de ponto de extremidade dos Gêmeos Digitais
identity	ManagedIdentityReference	Propriedades de identidade gerenciada para o ponto de extremidade.
provisioningState	EndpointProvisioningState	O estado de provisionamento.

EventHub

Propriedades relacionadas ao EventHub.

Nome	Tipo	Description
authenticationType	AuthenticationType	Especifica o tipo de autenticação que está sendo usado para se conectar ao ponto de extremidade. O padrão é 'KeyBased'. Se 'KeyBased' estiver selecionado, uma cadeia de conexão deverá ser especificada (pelo menos a cadeia de conexão primária). Se 'IdentityBased' for selecionado, as propriedades endpointUri e entityPath deverão ser especificadas.
connectionStringPrimaryKey	string	PrimaryConnectionString do ponto de extremidade para autenticação baseada em chave. Será ofuscado durante a leitura.
connectionStringSecondaryKey	string	SecondaryConnectionString do ponto de extremidade para autenticação baseada em chave. Será ofuscado durante a leitura.
createdTime	string	Hora em que o ponto de extremidade foi adicionado a DigitalTwinsInstance.
deadLetterSecret	string	Segredo de armazenamento de mensagens mortas para autenticação baseada em chave. Será ofuscado durante a leitura.
deadLetterUri	string	URL de armazenamento de mensagens mortas para autenticação baseada em identidade.
endpointType	string: EventHub	O tipo de ponto de extremidade dos Gêmeos Digitais
endpointUri	string	A URL do namespace do EventHub para autenticação baseada em identidade. Ele deve incluir o protocolo 'sb://'.
entityPath	string	O nome do EventHub no namespace do EventHub para autenticação baseada em identidade.
identity	ManagedIdentityReference	Propriedades de identidade gerenciada para o ponto de extremidade.
provisioningState	EndpointProvisioningState	O estado de provisionamento.

IdentityType

O tipo de identidade gerenciada usada.

Nome	Tipo	Description
SystemAssigned	string
UserAssigned	string

ManagedIdentityReference

As propriedades da Identidade Gerenciada.

Nome	Tipo	Description
type	IdentityType	O tipo de identidade gerenciada usada.
userAssignedIdentity	string	A ID do recurso ARM de identidade do usuário se o tipo de identidade gerenciada for 'UserAssigned'.

ServiceBus

Propriedades relacionadas ao ServiceBus.

Nome	Tipo	Description
authenticationType	AuthenticationType	Especifica o tipo de autenticação que está sendo usado para se conectar ao ponto de extremidade. O padrão é 'KeyBased'. Se 'KeyBased' estiver selecionado, uma cadeia de conexão deverá ser especificada (pelo menos a cadeia de conexão primária). Se 'IdentityBased' for selecionado, as propriedades endpointUri e entityPath deverão ser especificadas.
createdTime	string	Hora em que o ponto de extremidade foi adicionado a DigitalTwinsInstance.
deadLetterSecret	string	Segredo de armazenamento de mensagens mortas para autenticação baseada em chave. Será ofuscado durante a leitura.
deadLetterUri	string	URL de armazenamento de mensagens mortas para autenticação baseada em identidade.
endpointType	string: ServiceBus	O tipo de ponto de extremidade dos Gêmeos Digitais
endpointUri	string	A URL do namespace ServiceBus para autenticação baseada em identidade. Ele deve incluir o protocolo 'sb://'.
entityPath	string	O nome do Tópico do ServiceBus para autenticação baseada em identidade.
identity	ManagedIdentityReference	Propriedades de identidade gerenciada para o ponto de extremidade.
primaryConnectionString	string	PrimaryConnectionString do ponto de extremidade para autenticação baseada em chave. Será ofuscado durante a leitura.
provisioningState	EndpointProvisioningState	O estado de provisionamento.
secondaryConnectionString	string	SecondaryConnectionString do ponto de extremidade para autenticação baseada em chave. Será ofuscado durante a leitura.

SystemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Endpoints - DigitalTwinsEndpoint CreateOrUpdate

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

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

Definições

AuthenticationType

createdByType

DigitalTwinsEndpointResource

EndpointProvisioningState

ErrorDefinition

ErrorResponse

EventGrid

EventHub

IdentityType

ManagedIdentityReference

ServiceBus

SystemData

Comentários

Comentários

Recursos adicionais