Dela via


Endpoints - DigitalTwinsEndpoint CreateOrUpdate

Skapa eller uppdatera DigitalTwinsInstance-slutpunkten.

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

URI-parametrar

Name I Obligatorisk Typ Description
endpointName
path True

string

Namnet på slutpunktsresursen.

Regex pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

resourceGroupName
path True

string

Namnet på resursgruppen som innehåller DigitalTwinsInstance.

resourceName
path True

string

Namnet på DigitalTwinsInstance.

Regex pattern: ^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$

subscriptionId
path True

string

Prenumerationsidentifieraren.

api-version
query True

string

Version av DigitalTwinsInstance Management-API:et.

Begärandetext

Name Obligatorisk Typ Description
properties True DigitalTwinsEndpointResourceProperties:

Egenskaper för digitalTwinsInstance-slutpunktsresurs.

Svar

Name Typ Description
200 OK

DigitalTwinsEndpointResource

Detta returneras som ett svar på begäran om statussökning för skapande- eller uppdateringsåtgärden. Brödtexten innehåller resursrepresentationen som anger ett övergångsetableringstillstånd.

201 Created

DigitalTwinsEndpointResource

Skapad – Skicka begäran accepterad; åtgärden slutförs asynkront.

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation Personifiera ditt användarkonto

Exempel

Put a DigitalTwinsEndpoint resource
Put a DigitalTwinsEndpoint resource with identity
Put a DigitalTwinsEndpoint resource with user assigned identity

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

Definitioner

Name Description
AuthenticationType

Anger vilken autentiseringstyp som används för att ansluta till slutpunkten. Standardvärdet är "KeyBased". Om "KeyBased" har valts måste en anslutningssträng anges (åtminstone den primära anslutningssträngen). Om "IdentityBased" väljs måste egenskaperna endpointUri och entityPath anges.

createdByType

Den typ av identitet som skapade resursen.

DigitalTwinsEndpointResource

DigitalTwinsInstance-slutpunktsresurs.

EndpointProvisioningState

Etableringstillståndet.

ErrorDefinition

Feldefinition.

ErrorResponse

Felsvar.

EventGrid

Egenskaper relaterade till EventGrid.

EventHub

Egenskaper relaterade till EventHub.

IdentityType

Den typ av hanterad identitet som används.

ManagedIdentityReference

Egenskaperna för den hanterade identiteten.

ServiceBus

Egenskaper relaterade till ServiceBus.

SystemData

Metadata som rör skapande och senaste ändring av resursen.

AuthenticationType

Anger vilken autentiseringstyp som används för att ansluta till slutpunkten. Standardvärdet är "KeyBased". Om "KeyBased" har valts måste en anslutningssträng anges (åtminstone den primära anslutningssträngen). Om "IdentityBased" väljs måste egenskaperna endpointUri och entityPath anges.

Name Typ Description
IdentityBased

string

KeyBased

string

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

DigitalTwinsEndpointResource

DigitalTwinsInstance-slutpunktsresurs.

Name Typ Description
id

string

Resursidentifieraren.

name

string

Namn på tilläggsresurs.

properties DigitalTwinsEndpointResourceProperties:

Egenskaper för digitalTwinsInstance-slutpunktsresurs.

systemData

SystemData

Metadata som rör skapande och senaste ändring av resursen.

type

string

Resurstypen.

EndpointProvisioningState

Etableringstillståndet.

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

Feldefinition.

Name Typ Description
code

string

Tjänstspecifik felkod som fungerar som understatus för HTTP-felkoden.

details

ErrorDefinition[]

Intern felinformation.

message

string

Beskrivning av felet.

ErrorResponse

Felsvar.

Name Typ Description
error

ErrorDefinition

Felbeskrivning

EventGrid

Egenskaper relaterade till EventGrid.

Name Typ Description
TopicEndpoint

string

EventGrid-ämnesslutpunkt.

accessKey1

string

EventGrid sekundär åtkomstnyckel. Kommer att döljas under läsningen.

accessKey2

string

EventGrid sekundär åtkomstnyckel. Kommer att döljas under läsningen.

authenticationType

AuthenticationType

Anger vilken autentiseringstyp som används för att ansluta till slutpunkten. Standardvärdet är "KeyBased". Om "KeyBased" har valts måste en anslutningssträng anges (åtminstone den primära anslutningssträngen). Om "IdentityBased" väljs måste egenskaperna endpointUri och entityPath anges.

createdTime

string

Tid då slutpunkten lades till i DigitalTwinsInstance.

deadLetterSecret

string

Obeställbara lagringshemligheter för nyckelbaserad autentisering. Kommer att döljas under läsningen.

deadLetterUri

string

Lagrings-URL för obeställbara meddelanden för identitetsbaserad autentisering.

endpointType string:

EventGrid

Typ av Digital Twins-slutpunkt

identity

ManagedIdentityReference

Egenskaper för hanterad identitet för slutpunkten.

provisioningState

EndpointProvisioningState

Etableringstillståndet.

EventHub

Egenskaper relaterade till EventHub.

Name Typ Description
authenticationType

AuthenticationType

Anger vilken autentiseringstyp som används för att ansluta till slutpunkten. Standardvärdet är "KeyBased". Om "KeyBased" har valts måste en anslutningssträng anges (åtminstone den primära anslutningssträngen). Om "IdentityBased" väljs måste egenskaperna endpointUri och entityPath anges.

connectionStringPrimaryKey

string

PrimaryConnectionString för slutpunkten för nyckelbaserad autentisering. Kommer att döljas under läsningen.

connectionStringSecondaryKey

string

SecondaryConnectionString för slutpunkten för nyckelbaserad autentisering. Kommer att döljas under läsningen.

createdTime

string

Tid då slutpunkten lades till i DigitalTwinsInstance.

deadLetterSecret

string

Obeställbara lagringshemligheter för nyckelbaserad autentisering. Kommer att döljas under läsningen.

deadLetterUri

string

Lagrings-URL för obeställbara meddelanden för identitetsbaserad autentisering.

endpointType string:

EventHub

Typ av Digital Twins-slutpunkt

endpointUri

string

URL:en för EventHub-namnområdet för identitetsbaserad autentisering. Det måste innehålla protokollet "sb://".

entityPath

string

EventHub-namnet i EventHub-namnområdet för identitetsbaserad autentisering.

identity

ManagedIdentityReference

Egenskaper för hanterad identitet för slutpunkten.

provisioningState

EndpointProvisioningState

Etableringstillståndet.

IdentityType

Den typ av hanterad identitet som används.

Name Typ Description
SystemAssigned

string

UserAssigned

string

ManagedIdentityReference

Egenskaperna för den hanterade identiteten.

Name Typ Description
type

IdentityType

Den typ av hanterad identitet som används.

userAssignedIdentity

string

Användaridentitetens ARM-resurs-ID om den hanterade identitetstypen är "UserAssigned".

ServiceBus

Egenskaper relaterade till ServiceBus.

Name Typ Description
authenticationType

AuthenticationType

Anger vilken autentiseringstyp som används för att ansluta till slutpunkten. Standardvärdet är "KeyBased". Om "KeyBased" har valts måste en anslutningssträng anges (åtminstone den primära anslutningssträngen). Om "IdentityBased" väljs måste egenskaperna endpointUri och entityPath anges.

createdTime

string

Tid då slutpunkten lades till i DigitalTwinsInstance.

deadLetterSecret

string

Obeställbara lagringshemligheter för nyckelbaserad autentisering. Kommer att döljas under läsningen.

deadLetterUri

string

Lagrings-URL för obeställbara meddelanden för identitetsbaserad autentisering.

endpointType string:

ServiceBus

Typ av Digital Twins-slutpunkt

endpointUri

string

URL:en för ServiceBus-namnområdet för identitetsbaserad autentisering. Det måste innehålla protokollet "sb://".

entityPath

string

ServiceBus-ämnesnamnet för identitetsbaserad autentisering.

identity

ManagedIdentityReference

Egenskaper för hanterad identitet för slutpunkten.

primaryConnectionString

string

PrimaryConnectionString för slutpunkten för nyckelbaserad autentisering. Kommer att döljas under läsningen.

provisioningState

EndpointProvisioningState

Etableringstillståndet.

secondaryConnectionString

string

SecondaryConnectionString för slutpunkten för nyckelbaserad autentisering. Kommer att döljas under läsningen.

SystemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.