Endpoints - DigitalTwinsEndpoint CreateOrUpdate
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 |
---|---|---|---|---|
endpoint
|
path | True |
string |
Nome do Recurso de Ponto Final. Regex pattern: |
resource
|
path | True |
string |
O nome do grupo de recursos que contém o DigitalTwinsInstance. |
resource
|
path | True |
string |
O nome do DigitalTwinsInstance. Regex pattern: |
subscription
|
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: |
Propriedades de recursos de ponto final DigitalTwinsInstance. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
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 |
Criado - Colocar pedido aceite; a operação será concluída de forma assíncrona. |
|
Other Status Codes |
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 Digital |
Put a Digital |
Put a Digital |
Put a DigitalTwinsEndpoint resource
Sample Request
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
{
"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"
}
}
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
{
"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
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
{
"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"
}
}
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
{
"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
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
{
"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"
}
}
}
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
{
"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 |
---|---|
Authentication |
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. |
created |
O tipo de identidade que criou o recurso. |
Digital |
Recurso de ponto final DigitalTwinsInstance. |
Endpoint |
O estado de aprovisionamento. |
Error |
Definição de erro. |
Error |
Resposta de erro. |
Event |
Propriedades relacionadas com o EventGrid. |
Event |
Propriedades relacionadas com o EventHub. |
Identity |
O tipo de identidade gerida utilizada. |
Managed |
As propriedades da Identidade Gerida. |
Service |
Propriedades relacionadas com o ServiceBus. |
System |
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: |
Propriedades de recursos de ponto final DigitalTwinsInstance. |
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 |
Detalhes de erro internos. |
|
message |
string |
Descrição do erro. |
ErrorResponse
Resposta de erro.
Name | Tipo | Description |
---|---|---|
error |
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 |
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: |
O tipo de ponto final do Digital Twins |
identity |
Propriedades de identidade geridas para o ponto final. |
|
provisioningState |
O estado de aprovisionamento. |
EventHub
Propriedades relacionadas com o EventHub.
Name | Tipo | 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. |
|
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: |
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 |
Propriedades de identidade geridas para o ponto final. |
|
provisioningState |
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 |
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 |
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: |
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 |
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 |
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 |
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 |
O tipo de identidade que modificou o recurso pela última vez. |
Comentários
https://aka.ms/ContentUserFeedback.
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja:Submeter e ver comentários