Megosztás a következőn keresztül:


Digital Twins Instance - DigitalTwins Update

Frissítse a DigitalTwinsInstance metaadatait.

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

URI-paraméterek

Name In Kötelező Típus Description
resourceGroupName
path True

string

A DigitalTwinsInstance erőforráscsoport neve.

resourceName
path True

string

A DigitalTwinsInstance neve.

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

subscriptionId
path True

string

Az előfizetés azonosítója.

api-version
query True

string

A DigitalTwinsInstance Management API verziója.

Kérelem törzse

Name Típus Description
identity

DigitalTwinsIdentity

A DigitalTwinsInstance felügyelt identitása.

properties

DigitalTwinsPatchProperties

A DigitalTwinsInstance tulajdonságai.

tags

object

Példányjavítás tulajdonságai

Válaszok

Name Típus Description
200 OK

DigitalTwinsDescription

Ez a létrehozási vagy frissítési művelet állapot lekérdezési kérésére adott válaszként jelenik meg. A törzs tartalmazza az átmeneti kiépítési állapotot jelző erőforrás-ábrázolást.

202 Accepted

DigitalTwinsDescription

Elfogadva – Javításkérés elfogadva; a művelet aszinkron módon fejeződik be.

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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 A felhasználói fiók megszemélyesítése

Példák

Patch a DigitalTwinsInstance resource
Patch a DigitalTwinsInstance resource with identity
Patch a DigitalTwinsInstance resource with publicNetworkAccess property

Patch a DigitalTwinsInstance resource

Sample Request

PATCH https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService?api-version=2023-01-31

{
  "tags": {
    "purpose": "dev"
  }
}

Sample Response

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
  "location": "westus2",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "name": "myDigitalTwinsService",
  "tags": {
    "purpose": "dev"
  },
  "systemData": {
    "createdBy": "user@example.com",
    "createdByType": "User",
    "createdAt": "2021-03-11T17:14:59.4037715Z",
    "lastModifiedBy": "user@example.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-11T17:15:02.5281409Z"
  },
  "properties": {
    "createdTime": "2019-11-19T12:55:05.229Z",
    "lastUpdatedTime": "2019-12-06T12:21:58.610Z",
    "provisioningState": "Succeeded",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
    "publicNetworkAccess": "Disabled"
  }
}
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",
  "location": "westus2",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "name": "myDigitalTwinsService",
  "tags": {
    "purpose": "dev"
  },
  "systemData": {
    "createdBy": "user@example.com",
    "createdByType": "User",
    "createdAt": "2021-03-11T17:14:59.4037715Z",
    "lastModifiedBy": "user@example.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-11T17:15:02.5281409Z"
  },
  "properties": {
    "createdTime": "2019-11-19T12:55:05.229Z",
    "lastUpdatedTime": "2019-12-06T12:21:58.610Z",
    "provisioningState": "Updating",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
    "publicNetworkAccess": "Disabled"
  }
}

Patch a DigitalTwinsInstance resource with identity

Sample Request

PATCH https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService?api-version=2023-01-31

{
  "identity": {
    "type": "None"
  }
}

Sample Response

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
  "location": "westus2",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "name": "myDigitalTwinsService",
  "tags": {
    "purpose": "dev"
  },
  "systemData": {
    "createdBy": "user@example.com",
    "createdByType": "User",
    "createdAt": "2021-03-11T17:14:59.4037715Z",
    "lastModifiedBy": "user@example.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-11T17:15:02.5281409Z"
  },
  "properties": {
    "createdTime": "2019-11-19T12:55:05.229Z",
    "lastUpdatedTime": "2019-12-06T12:21:58.610Z",
    "provisioningState": "Succeeded",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
    "publicNetworkAccess": "Enabled"
  }
}
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",
  "location": "westus2",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "name": "myDigitalTwinsService",
  "tags": {
    "purpose": "dev"
  },
  "systemData": {
    "createdBy": "user@example.com",
    "createdByType": "User",
    "createdAt": "2021-03-11T17:14:59.4037715Z",
    "lastModifiedBy": "user@example.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-11T17:15:02.5281409Z"
  },
  "properties": {
    "createdTime": "2019-11-19T12:55:05.229Z",
    "lastUpdatedTime": "2019-12-06T12:21:58.610Z",
    "provisioningState": "Updating",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
    "publicNetworkAccess": "Enabled"
  }
}

Patch a DigitalTwinsInstance resource with publicNetworkAccess property

Sample Request

PATCH https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService?api-version=2023-01-31

{
  "properties": {
    "publicNetworkAccess": "Disabled"
  }
}

Sample Response

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService",
  "location": "westus2",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "name": "myDigitalTwinsService",
  "tags": {
    "purpose": "dev"
  },
  "systemData": {
    "createdBy": "user@example.com",
    "createdByType": "User",
    "createdAt": "2021-03-11T17:14:59.4037715Z",
    "lastModifiedBy": "user@example.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-11T17:15:02.5281409Z"
  },
  "properties": {
    "createdTime": "2019-11-19T12:55:05.229Z",
    "lastUpdatedTime": "2019-12-06T12:21:58.610Z",
    "provisioningState": "Succeeded",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
    "publicNetworkAccess": "Disabled"
  }
}
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",
  "location": "westus2",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances",
  "name": "myDigitalTwinsService",
  "tags": {
    "purpose": "dev"
  },
  "systemData": {
    "createdBy": "user@example.com",
    "createdByType": "User",
    "createdAt": "2021-03-11T17:14:59.4037715Z",
    "lastModifiedBy": "user@example.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-11T17:15:02.5281409Z"
  },
  "properties": {
    "createdTime": "2019-11-19T12:55:05.229Z",
    "lastUpdatedTime": "2019-12-06T12:21:58.610Z",
    "provisioningState": "Updating",
    "hostName": "https://myDigitalTwinsService.api.wus2.ss.azuredigitaltwins-test.net",
    "publicNetworkAccess": "Disabled"
  }
}

Definíciók

Name Description
ConnectionProperties

A privát végponti kapcsolat tulajdonságai.

ConnectionPropertiesProvisioningState

A kiépítési állapot.

createdByType

Az erőforrást létrehozó identitás típusa.

DigitalTwinsDescription

A DigitalTwins szolgáltatás leírása.

DigitalTwinsIdentity

A DigitalTwinsInstance felügyelt identitása.

DigitalTwinsIdentityType

A DigitalTwinsInstance által használt felügyelt identitás típusa.

DigitalTwinsPatchDescription

A DigitalTwins szolgáltatás leírása.

DigitalTwinsPatchProperties

A DigitalTwinsInstance tulajdonságai.

ErrorDefinition

Hibadefiníció.

ErrorResponse

Hibaválasz.

PrivateEndpoint

A privát végponti kapcsolat privát végpont tulajdonsága.

PrivateEndpointConnection

A Digital Twin privát végponti kapcsolata.

PrivateLinkServiceConnectionState

A kapcsolat állapota.

PrivateLinkServiceConnectionStatus

A privát végponti kapcsolat állapota.

provisioningState

A kiépítési állapot.

publicNetworkAccess

A DigitalTwinsInstance nyilvános hálózati hozzáférése.

SystemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

UserAssignedIdentity

A felhasználó által hozzárendelt identitással kapcsolatos információk.

ConnectionProperties

A privát végponti kapcsolat tulajdonságai.

Name Típus Description
groupIds

string[]

A privát végponti kapcsolat csoportazonosítóinak listája.

privateEndpoint

PrivateEndpoint

A privát végpont.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

A kapcsolat állapota.

provisioningState

ConnectionPropertiesProvisioningState

A kiépítési állapot.

ConnectionPropertiesProvisioningState

A kiépítési állapot.

Name Típus Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

createdByType

Az erőforrást létrehozó identitás típusa.

Name Típus Description
Application

string

Key

string

ManagedIdentity

string

User

string

DigitalTwinsDescription

A DigitalTwins szolgáltatás leírása.

Name Típus Description
id

string

Az erőforrás azonosítója.

identity

DigitalTwinsIdentity

A DigitalTwinsInstance felügyelt identitása.

location

string

Az erőforrás helye.

name

string

Az erőforrás neve.

properties.createdTime

string

A DigitalTwinsInstance létrehozásának időpontja.

properties.hostName

string

API-végpont a DigitalTwinsInstance használatához.

properties.lastUpdatedTime

string

A DigitalTwinsInstance frissítésének időpontja.

properties.privateEndpointConnections

PrivateEndpointConnection[]

A privát végpont kapcsolatai.

properties.provisioningState

provisioningState

A kiépítési állapot.

properties.publicNetworkAccess

publicNetworkAccess

A DigitalTwinsInstance nyilvános hálózati hozzáférése.

systemData

SystemData

A DigitalTwinsInstance létrehozására és utolsó módosítására vonatkozó metaadatok.

tags

object

Az erőforráscímkék.

type

string

Az erőforrás típusa.

DigitalTwinsIdentity

A DigitalTwinsInstance felügyelt identitása.

Name Típus Description
principalId

string

A felügyelt identitás erőforrás objektumazonosítója. Ezt a rendszer a PUT-kérelem x-ms-identity-principal-id fejlécén keresztül küldi el az ARM-nek az RP-nek, ha az erőforrás systemAssigned(implicit) identitással rendelkezik

tenantId

string

A felügyelt identitás erőforrás bérlőazonosítója. Ezt a rendszer az ARM-ből az x-ms-client-tenant-id fejlécen keresztül küldi el az RP-nek a PUT-kérelemben, ha az erőforrás systemAssigned(implicit) identitással rendelkezik

type

DigitalTwinsIdentityType

A DigitalTwinsInstance által használt felügyelt identitás típusa.

userAssignedIdentities

<string,  UserAssignedIdentity>

Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai ARM-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". .

DigitalTwinsIdentityType

A DigitalTwinsInstance által használt felügyelt identitás típusa.

Name Típus Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

DigitalTwinsPatchDescription

A DigitalTwins szolgáltatás leírása.

Name Típus Description
identity

DigitalTwinsIdentity

A DigitalTwinsInstance felügyelt identitása.

properties

DigitalTwinsPatchProperties

A DigitalTwinsInstance tulajdonságai.

tags

object

Példányjavítás tulajdonságai

DigitalTwinsPatchProperties

A DigitalTwinsInstance tulajdonságai.

Name Típus Description
publicNetworkAccess

publicNetworkAccess

A DigitalTwinsInstance nyilvános hálózati hozzáférése.

ErrorDefinition

Hibadefiníció.

Name Típus Description
code

string

Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.

details

ErrorDefinition[]

Belső hiba részletei.

message

string

A hiba leírása.

ErrorResponse

Hibaválasz.

Name Típus Description
error

ErrorDefinition

Hibaleírás

PrivateEndpoint

A privát végponti kapcsolat privát végpont tulajdonsága.

Name Típus Description
id

string

Az erőforrás azonosítója.

PrivateEndpointConnection

A Digital Twin privát végponti kapcsolata.

Name Típus Description
id

string

Az erőforrás azonosítója.

name

string

Az erőforrás neve.

properties

ConnectionProperties

A kapcsolat tulajdonságai.

systemData

SystemData

A privát végponti kapcsolat létrehozásával és utolsó módosításával kapcsolatos metaadatok.

type

string

Az erőforrás típusa.

PrivateLinkServiceConnectionState

A kapcsolat állapota.

Name Típus Description
actionsRequired

string

Privát végponti kapcsolathoz szükséges műveletek.

description

string

A privát végponti kapcsolat aktuális állapotának leírása.

status

PrivateLinkServiceConnectionStatus

A privát végponti kapcsolat állapota.

PrivateLinkServiceConnectionStatus

A privát végponti kapcsolat állapota.

Name Típus Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

provisioningState

A kiépítési állapot.

Name Típus Description
Canceled

string

Deleted

string

Deleting

string

Failed

string

Moving

string

Provisioning

string

Restoring

string

Succeeded

string

Suspending

string

Updating

string

Warning

string

publicNetworkAccess

A DigitalTwinsInstance nyilvános hálózati hozzáférése.

Name Típus Description
Disabled

string

Enabled

string

SystemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string

Az erőforrás-létrehozás időbélyege (UTC).

createdBy

string

Az erőforrást létrehozó identitás.

createdByType

createdByType

Az erőforrást létrehozó identitás típusa.

lastModifiedAt

string

Az erőforrás utolsó módosításának időbélyege (UTC)

lastModifiedBy

string

Az erőforrást utoljára módosító identitás.

lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.

UserAssignedIdentity

A felhasználó által hozzárendelt identitással kapcsolatos információk.

Name Típus Description
clientId

string

A felhasználó által hozzárendelt identitás erőforrás ügyfél-azonosítója.

principalId

string

A felhasználó által hozzárendelt identitás erőforrás objektumazonosítója.