Endpoints - DigitalTwinsEndpoint CreateOrUpdate

Referência

Service:: Azure Digital Twins

API Version:: 2023-01-31

Criar ou atualizar o ponto final DigitalTwinsInstance.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpointName	path	True	string	Nome do Recurso de Ponto Final. 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 subscrição.
api-version	query	True	string	Versão da API de Gestão digitalTwinsInstance.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties	True	DigitalTwinsEndpointResourceProperties: ServiceBus EventHub EventGrid	Propriedades de recursos de ponto final DigitalTwinsInstance.

Respostas

Name	Tipo	Description
200 OK	DigitalTwinsEndpointResource	Isto é devolvido como resposta ao pedido de consulta de estado para a operação de criação ou atualização. O corpo contém a representação de recursos que indica um estado de aprovisionamento transitório.
201 Created	DigitalTwinsEndpointResource	Criado - Colocar pedido aceite; a operação será concluída de forma assíncrona.
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual 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

Name	Description
user_impersonation	Representar a sua conta de utilizador

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

Name	Description
AuthenticationType	Especifica o tipo de autenticação que está a ser utilizado para ligar ao ponto final. A predefinição é "KeyBased". Se "KeyBased" estiver selecionado, tem de ser especificada uma cadeia de ligação (pelo menos a cadeia de ligação primária). Se "IdentityBased" estiver selecionado, as propriedades endpointUri e entityPath têm de ser especificadas.
createdByType	O tipo de identidade que criou o recurso.
DigitalTwinsEndpointResource	Recurso de ponto final DigitalTwinsInstance.
EndpointProvisioningState	O estado de aprovisionamento.
ErrorDefinition	Definição de erro.
ErrorResponse	Resposta de erro.
EventGrid	Propriedades relacionadas com o EventGrid.
EventHub	Propriedades relacionadas com o EventHub.
IdentityType	O tipo de identidade gerida utilizada.
ManagedIdentityReference	As propriedades da Identidade Gerida.
ServiceBus	Propriedades relacionadas com o ServiceBus.
SystemData	Metadados relativos à criação e última modificação do recurso.

AuthenticationType

Especifica o tipo de autenticação que está a ser utilizado para ligar ao ponto final. A predefinição é "KeyBased". Se "KeyBased" estiver selecionado, tem de ser especificada uma cadeia de ligação (pelo menos a cadeia de ligação primária). Se "IdentityBased" estiver selecionado, as propriedades endpointUri e entityPath têm de ser especificadas.

Name	Tipo	Description
IdentityBased	string
KeyBased	string

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigitalTwinsEndpointResource

Recurso de ponto final DigitalTwinsInstance.

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

EndpointProvisioningState

O estado de aprovisionamento.

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

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

ErrorResponse

Resposta de erro.

Name	Tipo	Description
error	ErrorDefinition	Descrição do erro

EventGrid

Propriedades relacionadas com o EventGrid.

Name	Tipo	Description
TopicEndpoint	string	Ponto Final do Tópico EventGrid.
accessKey1	string	EventGrid secondary accesskey. Será obfuscado durante a leitura.
accessKey2	string	EventGrid secondary accesskey. Será obfuscado durante a leitura.
authenticationType	AuthenticationType	Especifica o tipo de autenticação que está a ser utilizado para ligar ao ponto final. A predefinição é "KeyBased". Se "KeyBased" estiver selecionado, tem de ser especificada uma cadeia de ligação (pelo menos a cadeia de ligação primária). Se "IdentityBased" estiver selecionado, as propriedades endpointUri e entityPath têm de ser especificadas.
createdTime	string	Hora em que o Ponto Final foi adicionado ao DigitalTwinsInstance.
deadLetterSecret	string	Segredo de armazenamento de letras não entregues para autenticação baseada em chaves. Será obfuscado durante a leitura.
deadLetterUri	string	URL de armazenamento de letras não entregues para autenticação baseada em identidades.
endpointType	string: EventGrid	O tipo de ponto final do Digital Twins
identity	ManagedIdentityReference	Propriedades de identidade geridas para o ponto final.
provisioningState	EndpointProvisioningState	O estado de aprovisionamento.

EventHub

Propriedades relacionadas com o EventHub.

Name	Tipo	Description
authenticationType	AuthenticationType	Especifica o tipo de autenticação que está a ser utilizado para ligar ao ponto final. A predefinição é "KeyBased". Se "KeyBased" estiver selecionado, tem de ser especificada uma cadeia de ligação (pelo menos a cadeia de ligação primária). Se "IdentityBased" estiver selecionado, as propriedades endpointUri e entityPath têm de ser especificadas.
connectionStringPrimaryKey	string	PrimaryConnectionString do ponto final para autenticação baseada em chaves. Será obfuscado durante a leitura.
connectionStringSecondaryKey	string	SecondaryConnectionString do ponto final para autenticação baseada em chaves. Será obfuscado durante a leitura.
createdTime	string	Hora em que o Ponto Final foi adicionado ao DigitalTwinsInstance.
deadLetterSecret	string	Segredo de armazenamento de letras não entregues para autenticação baseada em chaves. Será obfuscado durante a leitura.
deadLetterUri	string	URL de armazenamento de letras não entregues para autenticação baseada em identidades.
endpointType	string: EventHub	O tipo de ponto final do Digital Twins
endpointUri	string	O URL do espaço de nomes do EventHub para autenticação baseada em identidades. Tem de incluir o protocolo "sb://".
entityPath	string	O nome do EventHub no espaço de nomes do EventHub para autenticação baseada em identidades.
identity	ManagedIdentityReference	Propriedades de identidade geridas para o ponto final.
provisioningState	EndpointProvisioningState	O estado de aprovisionamento.

IdentityType

O tipo de identidade gerida utilizada.

Name	Tipo	Description
SystemAssigned	string
UserAssigned	string

ManagedIdentityReference

As propriedades da Identidade Gerida.

Name	Tipo	Description
type	IdentityType	O tipo de identidade gerida utilizada.
userAssignedIdentity	string	O ID de recurso arm da identidade do utilizador se o tipo de identidade gerida for "UserAssigned".

ServiceBus

Propriedades relacionadas com o ServiceBus.

Name	Tipo	Description
authenticationType	AuthenticationType	Especifica o tipo de autenticação que está a ser utilizado para ligar ao ponto final. A predefinição é "KeyBased". Se "KeyBased" estiver selecionado, tem de ser especificada uma cadeia de ligação (pelo menos a cadeia de ligação primária). Se "IdentityBased" estiver selecionado, as propriedades endpointUri e entityPath têm de ser especificadas.
createdTime	string	Hora em que o Ponto Final foi adicionado ao DigitalTwinsInstance.
deadLetterSecret	string	Segredo de armazenamento de letras não entregues para autenticação baseada em chaves. Será obfuscado durante a leitura.
deadLetterUri	string	URL de armazenamento de letras não entregues para autenticação baseada em identidades.
endpointType	string: ServiceBus	O tipo de ponto final do Digital Twins
endpointUri	string	O URL do espaço de nomes do ServiceBus para autenticação baseada em identidades. Tem de incluir o protocolo "sb://".
entityPath	string	O Nome do Tópico do ServiceBus para autenticação baseada em identidade.
identity	ManagedIdentityReference	Propriedades de identidade geridas para o ponto final.
primaryConnectionString	string	PrimaryConnectionString do ponto final para autenticação baseada em chaves. Será obfuscado durante a leitura.
provisioningState	EndpointProvisioningState	O estado de aprovisionamento.
secondaryConnectionString	string	SecondaryConnectionString do ponto final para autenticação baseada em chaves. Será obfuscado durante a leitura.

SystemData

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

Name	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 do URI

Corpo do Pedido

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