Endpoints - DigitalTwinsEndpoint CreateOrUpdate
Utwórz lub zaktualizuj punkt końcowy usługi DigitalTwinsInstance.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}?api-version=2023-01-31
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
endpoint
|
path | True |
string |
Nazwa zasobu punktu końcowego. Regex pattern: |
resource
|
path | True |
string |
Nazwa grupy zasobów, która zawiera element DigitalTwinsInstance. |
resource
|
path | True |
string |
Nazwa klasy DigitalTwinsInstance. Regex pattern: |
subscription
|
path | True |
string |
Identyfikator subskrypcji. |
api-version
|
query | True |
string |
Wersja interfejsu API usługi DigitalTwinsInstance Management. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
properties | True | DigitalTwinsEndpointResourceProperties: |
Właściwości zasobu punktu końcowego usługi DigitalTwinsInstance. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Jest to zwracane jako odpowiedź na żądanie sondowania stanu dla operacji tworzenia lub aktualizacji. Treść zawiera reprezentację zasobu, która wskazuje stan przejściowej aprowizacji. |
|
201 Created |
Utworzono — umieść zaakceptowane żądanie; operacja zostanie ukończona asynchronicznie. |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | Personifikuj konto użytkownika |
Przykłady
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"
}
}
}
Definicje
Nazwa | Opis |
---|---|
Authentication |
Określa typ uwierzytelniania używany do nawiązywania połączenia z punktem końcowym. Wartość domyślna to "KeyBased". Jeśli wybrano opcję "KeyBased", należy określić parametry połączenia (co najmniej podstawowe parametry połączenia). Jeśli wybrano wartość "IdentityBased", należy określić właściwości endpointUri i entityPath. |
created |
Typ tożsamości, która utworzyła zasób. |
Digital |
Zasób punktu końcowego Usługi DigitalTwinsInstance. |
Endpoint |
Stan aprowizacji. |
Error |
Definicja błędu. |
Error |
Odpowiedź na błąd. |
Event |
Właściwości związane z usługą EventGrid. |
Event |
Właściwości związane z usługą EventHub. |
Identity |
Używany typ tożsamości zarządzanej. |
Managed |
Właściwości tożsamości zarządzanej. |
Service |
Właściwości związane z usługą ServiceBus. |
System |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
AuthenticationType
Określa typ uwierzytelniania używany do nawiązywania połączenia z punktem końcowym. Wartość domyślna to "KeyBased". Jeśli wybrano opcję "KeyBased", należy określić parametry połączenia (co najmniej podstawowe parametry połączenia). Jeśli wybrano wartość "IdentityBased", należy określić właściwości endpointUri i entityPath.
Nazwa | Typ | Opis |
---|---|---|
IdentityBased |
string |
|
KeyBased |
string |
createdByType
Typ tożsamości, która utworzyła zasób.
Nazwa | Typ | Opis |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DigitalTwinsEndpointResource
Zasób punktu końcowego Usługi DigitalTwinsInstance.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
name |
string |
Nazwa zasobu rozszerzenia. |
properties | DigitalTwinsEndpointResourceProperties: |
Właściwości zasobu punktu końcowego usługi DigitalTwinsInstance. |
systemData |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
|
type |
string |
Typ zasobu. |
EndpointProvisioningState
Stan aprowizacji.
Nazwa | Typ | Opis |
---|---|---|
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
Definicja błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu specyficzny dla usługi, który służy jako stan podrzędny kodu błędu HTTP. |
details |
Szczegóły błędu wewnętrznego. |
|
message |
string |
Opis błędu. |
ErrorResponse
Odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
error |
Opis błędu |
EventGrid
Właściwości związane z usługą EventGrid.
Nazwa | Typ | Opis |
---|---|---|
TopicEndpoint |
string |
EventGrid Topic Endpoint( Punkt końcowy tematu usługi EventGrid). |
accessKey1 |
string |
EventGrid pomocniczy klucz dostępu. Podczas odczytu będą zaciemnione. |
accessKey2 |
string |
EventGrid pomocniczy klucz dostępu. Podczas odczytu będą zaciemnione. |
authenticationType |
Określa typ uwierzytelniania używany do nawiązywania połączenia z punktem końcowym. Wartość domyślna to "KeyBased". Jeśli wybrano opcję "KeyBased", należy określić parametry połączenia (co najmniej podstawowe parametry połączenia). Jeśli wybrano wartość "IdentityBased", należy określić właściwości endpointUri i entityPath. |
|
createdTime |
string |
Czas dodania punktu końcowego do klasy DigitalTwinsInstance. |
deadLetterSecret |
string |
Wpis tajny magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione. |
deadLetterUri |
string |
Adres URL magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na tożsamościach. |
endpointType | string: |
Typ punktu końcowego usługi Digital Twins |
identity |
Właściwości tożsamości zarządzanej dla punktu końcowego. |
|
provisioningState |
Stan aprowizacji. |
EventHub
Właściwości związane z usługą EventHub.
Nazwa | Typ | Opis |
---|---|---|
authenticationType |
Określa typ uwierzytelniania używany do nawiązywania połączenia z punktem końcowym. Wartość domyślna to "KeyBased". Jeśli wybrano opcję "KeyBased", należy określić parametry połączenia (co najmniej podstawowe parametry połączenia). Jeśli wybrano wartość "IdentityBased", należy określić właściwości endpointUri i entityPath. |
|
connectionStringPrimaryKey |
string |
PrimaryConnectionString punktu końcowego na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione. |
connectionStringSecondaryKey |
string |
SecondaryConnectionString punktu końcowego na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione. |
createdTime |
string |
Czas dodania punktu końcowego do klasy DigitalTwinsInstance. |
deadLetterSecret |
string |
Wpis tajny magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione. |
deadLetterUri |
string |
Adres URL magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na tożsamościach. |
endpointType | string: |
Typ punktu końcowego usługi Digital Twins |
endpointUri |
string |
Adres URL przestrzeni nazw usługi EventHub na potrzeby uwierzytelniania opartego na tożsamościach. Musi zawierać protokół "sb://". |
entityPath |
string |
Nazwa usługi EventHub w przestrzeni nazw usługi EventHub na potrzeby uwierzytelniania opartego na tożsamościach. |
identity |
Właściwości tożsamości zarządzanej dla punktu końcowego. |
|
provisioningState |
Stan aprowizacji. |
IdentityType
Używany typ tożsamości zarządzanej.
Nazwa | Typ | Opis |
---|---|---|
SystemAssigned |
string |
|
UserAssigned |
string |
ManagedIdentityReference
Właściwości tożsamości zarządzanej.
Nazwa | Typ | Opis |
---|---|---|
type |
Używany typ tożsamości zarządzanej. |
|
userAssignedIdentity |
string |
Identyfikator zasobu usługi ARM tożsamości użytkownika, jeśli typ tożsamości zarządzanej to "UserAssigned". |
ServiceBus
Właściwości związane z usługą ServiceBus.
Nazwa | Typ | Opis |
---|---|---|
authenticationType |
Określa typ uwierzytelniania używany do nawiązywania połączenia z punktem końcowym. Wartość domyślna to "KeyBased". Jeśli wybrano opcję "KeyBased", należy określić parametry połączenia (co najmniej podstawowe parametry połączenia). Jeśli wybrano wartość "IdentityBased", należy określić właściwości endpointUri i entityPath. |
|
createdTime |
string |
Czas dodania punktu końcowego do klasy DigitalTwinsInstance. |
deadLetterSecret |
string |
Wpis tajny magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione. |
deadLetterUri |
string |
Adres URL magazynu utraconych wiadomości na potrzeby uwierzytelniania opartego na tożsamościach. |
endpointType | string: |
Typ punktu końcowego usługi Digital Twins |
endpointUri |
string |
Adres URL przestrzeni nazw ServiceBus na potrzeby uwierzytelniania opartego na tożsamościach. Musi zawierać protokół "sb://". |
entityPath |
string |
Nazwa tematu usługi ServiceBus na potrzeby uwierzytelniania opartego na tożsamościach. |
identity |
Właściwości tożsamości zarządzanej dla punktu końcowego. |
|
primaryConnectionString |
string |
PrimaryConnectionString punktu końcowego na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione. |
provisioningState |
Stan aprowizacji. |
|
secondaryConnectionString |
string |
SecondaryConnectionString punktu końcowego na potrzeby uwierzytelniania opartego na kluczach. Podczas odczytu będą zaciemnione. |
SystemData
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
Nazwa | Typ | Opis |
---|---|---|
createdAt |
string |
Sygnatura czasowa tworzenia zasobów (UTC). |
createdBy |
string |
Tożsamość, która utworzyła zasób. |
createdByType |
Typ tożsamości, która utworzyła zasób. |
|
lastModifiedAt |
string |
Sygnatura czasowa ostatniej modyfikacji zasobu (UTC) |
lastModifiedBy |
string |
Tożsamość, która ostatnio zmodyfikowała zasób. |
lastModifiedByType |
Typ tożsamości, która ostatnio zmodyfikowała zasób. |
Opinia
https://aka.ms/ContentUserFeedback.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla