Endpoints - DigitalTwinsEndpoint CreateOrUpdate
Cree o actualice el punto de conexión de 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 identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Nombre del recurso de punto de conexión. Regex pattern: |
resource
|
path | True |
string |
Nombre del grupo de recursos que contiene DigitalTwinsInstance. |
resource
|
path | True |
string |
Nombre de DigitalTwinsInstance. Regex pattern: |
subscription
|
path | True |
string |
Identificador de la suscripción. |
api-version
|
query | True |
string |
Versión de digitalTwinsInstance Management API. |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
properties | True | DigitalTwinsEndpointResourceProperties: |
Propiedades del recurso de punto de conexión DigitalTwinsInstance. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Se devuelve como respuesta a la solicitud de sondeo de estado para la operación de creación o actualización. El cuerpo contiene la representación del recurso que indica un estado de aprovisionamiento transitorio. |
|
201 Created |
Creado - Put request accepted; la operación se completará de forma asincrónica. |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | Suplantación de su cuenta de usuario |
Ejemplos
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"
}
}
}
Definiciones
Nombre | Description |
---|---|
Authentication |
Especifica el tipo de autenticación que se usa para conectarse al punto de conexión. El valor predeterminado es "KeyBased". Si se selecciona "KeyBased", se debe especificar una cadena de conexión (al menos la cadena de conexión principal). Si se selecciona "IdentityBased", se deben especificar las propiedades endpointUri y entityPath. |
created |
Tipo de identidad que creó el recurso. |
Digital |
Recurso de punto de conexión DigitalTwinsInstance. |
Endpoint |
Estado de aprovisionamiento. |
Error |
Definición de error. |
Error |
Respuesta de error. |
Event |
Propiedades relacionadas con EventGrid. |
Event |
Propiedades relacionadas con EventHub. |
Identity |
Tipo de identidad administrada usada. |
Managed |
Propiedades de la identidad administrada. |
Service |
Propiedades relacionadas con ServiceBus. |
System |
Metadatos relacionados con la creación y la última modificación del recurso. |
AuthenticationType
Especifica el tipo de autenticación que se usa para conectarse al punto de conexión. El valor predeterminado es "KeyBased". Si se selecciona "KeyBased", se debe especificar una cadena de conexión (al menos la cadena de conexión principal). Si se selecciona "IdentityBased", se deben especificar las propiedades endpointUri y entityPath.
Nombre | Tipo | Description |
---|---|---|
IdentityBased |
string |
|
KeyBased |
string |
createdByType
Tipo de identidad que creó el recurso.
Nombre | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DigitalTwinsEndpointResource
Recurso de punto de conexión DigitalTwinsInstance.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador del recurso. |
name |
string |
Nombre del recurso de extensión. |
properties | DigitalTwinsEndpointResourceProperties: |
Propiedades del recurso de punto de conexión DigitalTwinsInstance. |
systemData |
Metadatos relacionados con la creación y la última modificación del recurso. |
|
type |
string |
El tipo de recurso. |
EndpointProvisioningState
Estado de aprovisionamiento.
Nombre | 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
Definición de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error específico del servicio que actúa como subestado para el código de error HTTP. |
details |
Detalles internos del error. |
|
message |
string |
Descripción del error. |
ErrorResponse
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error |
Descripción del error |
EventGrid
Propiedades relacionadas con EventGrid.
Nombre | Tipo | Description |
---|---|---|
TopicEndpoint |
string |
Punto de conexión de tema de EventGrid. |
accessKey1 |
string |
Clave de acceso secundaria de EventGrid. Se ofuscará durante la lectura. |
accessKey2 |
string |
Clave de acceso secundaria de EventGrid. Se ofuscará durante la lectura. |
authenticationType |
Especifica el tipo de autenticación que se usa para conectarse al punto de conexión. El valor predeterminado es "KeyBased". Si se selecciona "KeyBased", se debe especificar una cadena de conexión (al menos la cadena de conexión principal). Si se selecciona "IdentityBased", se deben especificar las propiedades endpointUri y entityPath. |
|
createdTime |
string |
Hora en la que se agregó el punto de conexión a DigitalTwinsInstance. |
deadLetterSecret |
string |
Secreto de almacenamiento de mensajes fallidos para la autenticación basada en claves. Se ofuscará durante la lectura. |
deadLetterUri |
string |
Dirección URL de almacenamiento de mensajes fallidos para la autenticación basada en identidades. |
endpointType | string: |
El tipo de punto de conexión de Digital Twins |
identity |
Propiedades de identidad administrada para el punto de conexión. |
|
provisioningState |
Estado de aprovisionamiento. |
EventHub
Propiedades relacionadas con EventHub.
Nombre | Tipo | Description |
---|---|---|
authenticationType |
Especifica el tipo de autenticación que se usa para conectarse al punto de conexión. El valor predeterminado es "KeyBased". Si se selecciona "KeyBased", se debe especificar una cadena de conexión (al menos la cadena de conexión principal). Si se selecciona "IdentityBased", se deben especificar las propiedades endpointUri y entityPath. |
|
connectionStringPrimaryKey |
string |
PrimaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. |
connectionStringSecondaryKey |
string |
SecondaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. |
createdTime |
string |
Hora en la que se agregó el punto de conexión a DigitalTwinsInstance. |
deadLetterSecret |
string |
Secreto de almacenamiento de mensajes fallidos para la autenticación basada en claves. Se ofuscará durante la lectura. |
deadLetterUri |
string |
Dirección URL de almacenamiento de mensajes fallidos para la autenticación basada en identidades. |
endpointType | string: |
El tipo de punto de conexión de Digital Twins |
endpointUri |
string |
Dirección URL del espacio de nombres de EventHub para la autenticación basada en identidades. Debe incluir el protocolo "sb://". |
entityPath |
string |
Nombre de EventHub en el espacio de nombres de EventHub para la autenticación basada en identidades. |
identity |
Propiedades de identidad administrada para el punto de conexión. |
|
provisioningState |
Estado de aprovisionamiento. |
IdentityType
Tipo de identidad administrada usada.
Nombre | Tipo | Description |
---|---|---|
SystemAssigned |
string |
|
UserAssigned |
string |
ManagedIdentityReference
Propiedades de la identidad administrada.
Nombre | Tipo | Description |
---|---|---|
type |
Tipo de identidad administrada usada. |
|
userAssignedIdentity |
string |
Identificador de recurso de ARM de identidad de usuario si el tipo de identidad administrada es "UserAssigned". |
ServiceBus
Propiedades relacionadas con ServiceBus.
Nombre | Tipo | Description |
---|---|---|
authenticationType |
Especifica el tipo de autenticación que se usa para conectarse al punto de conexión. El valor predeterminado es "KeyBased". Si se selecciona "KeyBased", se debe especificar una cadena de conexión (al menos la cadena de conexión principal). Si se selecciona "IdentityBased", se deben especificar las propiedades endpointUri y entityPath. |
|
createdTime |
string |
Hora en la que se agregó el punto de conexión a DigitalTwinsInstance. |
deadLetterSecret |
string |
Secreto de almacenamiento de mensajes fallidos para la autenticación basada en claves. Se ofuscará durante la lectura. |
deadLetterUri |
string |
Dirección URL de almacenamiento de mensajes fallidos para la autenticación basada en identidades. |
endpointType | string: |
El tipo de punto de conexión de Digital Twins |
endpointUri |
string |
Dirección URL del espacio de nombres de ServiceBus para la autenticación basada en identidades. Debe incluir el protocolo "sb://". |
entityPath |
string |
Nombre del tema de ServiceBus para la autenticación basada en identidades. |
identity |
Propiedades de identidad administrada para el punto de conexión. |
|
primaryConnectionString |
string |
PrimaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. |
provisioningState |
Estado de aprovisionamiento. |
|
secondaryConnectionString |
string |
SecondaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. |
SystemData
Metadatos relacionados con la creación y la última modificación del recurso.
Nombre | Tipo | Description |
---|---|---|
createdAt |
string |
Marca de tiempo de creación de recursos (UTC). |
createdBy |
string |
Identidad que creó el recurso. |
createdByType |
Tipo de identidad que creó el recurso. |
|
lastModifiedAt |
string |
Marca de tiempo de la última modificación del recurso (UTC) |
lastModifiedBy |
string |
Identidad que modificó por última vez el recurso. |
lastModifiedByType |
Tipo de identidad que modificó por última vez el recurso. |
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de