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


Iot Dps Resource - Create Or Update

Létrehozás vagy frissítse a kiépítési szolgáltatás metaadatait. A tulajdonság módosításának szokásos módja a kiépítési szolgáltatás metaadatainak és biztonsági metaadatainak lekérése, majd az új törzs módosított értékeinek kombinálása a kiépítési szolgáltatás frissítéséhez.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2022-12-12

URI-paraméterek

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

string

A létrehozandó vagy frissíteni kívánt kiépítési szolgáltatás neve.

resourceGroupName
path True

string

Erőforráscsoport azonosítója.

subscriptionId
path True

string

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

api-version
query True

string

Az API verziója.

Kérelem törzse

Name Kötelező Típus Description
location True

string

Az erőforrás helye.

properties True

IotDpsPropertiesDescription

Szolgáltatásspecifikus tulajdonságok egy kiépítési szolgáltatáshoz

sku True

IotDpsSkuInfo

Termékváltozat adatai egy kiépítési szolgáltatáshoz.

etag

string

Az Etag mezőre nincs szükség. Ha a válasz törzsében szerepel, akkor fejlécként is meg kell adni a normál ETag-konvenciók szerint.

resourcegroup

string

Az erőforrás erőforráscsoportja.

subscriptionid

string

Az erőforrás előfizetés-azonosítója.

tags

object

Az erőforráscímkék.

Válaszok

Name Típus Description
200 OK

ProvisioningServiceDescription

A törzs tartalmazza a kiépítési szolgáltatás összes nem biztonsági tulajdonságát. A biztonsággal kapcsolatos tulajdonságok értéke null.

201 Created

ProvisioningServiceDescription

Ez egy hosszú ideig futó művelet. A művelet 201-et ad vissza, ha az ellenőrzés befejeződött. A válasz tartalmaz egy Azure-AsyncOperation fejlécet, amely egy állapot URL-címet tartalmaz. Az ügyfelek várhatóan lekérdezik a művelet állapotának URL-címét. Ha sikeres, a művelet a 201-ben megadott HTTP-állapotkódot (OK) adja vissza.

Other Status Codes

ErrorDetails

Alapértelmezett hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

DPSCreate

Mintakérelem

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2022-12-12

{
  "location": "East US",
  "properties": {
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  },
  "tags": {}
}

Mintaválasz

{
  "etag": "AAAAAAAADGk=",
  "name": "myFirstProvisioningService",
  "location": "eastus",
  "properties": {
    "state": "Active",
    "allocationPolicy": "Hashed",
    "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
    "deviceProvisioningHostName": "global.azure-devices-provisioning.net",
    "idScope": "0ne00000012",
    "authorizationPolicies": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}
{
  "etag": "AAAAAAAADGk=",
  "name": "myFirstProvisioningService",
  "location": "eastus",
  "properties": {
    "state": "Active",
    "allocationPolicy": "Hashed",
    "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
    "deviceProvisioningHostName": "global.azure-devices-provisioning.net",
    "idScope": "0ne00000012",
    "authorizationPolicies": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Definíciók

Name Description
AccessRightsDescription

A kulcshoz fűződő jogok.

AllocationPolicy

A kiépítési szolgáltatás által használandó foglalási szabályzat.

createdByType

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

ErrorDetails

Hiba részletei.

IotDpsPropertiesDescription

egy kiépítési szolgáltatás szolgáltatásspecifikus tulajdonságai, beleértve a kulcsokat, a csatolt iot hubokat, az aktuális állapotot és a rendszer által létrehozott tulajdonságokat, például a gazdagépnevet és az idScopeot

IotDpsSku

Termékváltozat neve.

IotDpsSkuInfo

A lehetséges kiépítési szolgáltatási termékváltozatok listája.

IotHubDefinitionDescription

Az IoT Hub leírása.

IpFilterActionType

A szabály által rögzített kérések kívánt művelete.

IpFilterRule

A kiépítési szolgáltatás IP-szűrési szabályai.

IpFilterTargetType

A szabály által rögzített kérések célhelye.

PrivateEndpoint

Magánvégpont-kapcsolat privát végponttulajdonsága

PrivateEndpointConnection

Egy kiépítési szolgáltatás privát végpontkapcsolata

PrivateEndpointConnectionProperties

Privát végpontkapcsolat tulajdonságai

PrivateLinkServiceConnectionState

Privát végpontkapcsolat aktuális állapota

PrivateLinkServiceConnectionStatus

Privát végpontkapcsolat állapota

ProvisioningServiceDescription

A kiépítési szolgáltatás leírása.

PublicNetworkAccess

A nyilvános hálózatról érkező kérések engedélyezése

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

A megosztott hozzáférési kulcs leírása.

state

A kiépítési szolgáltatás aktuális állapota.

systemData

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

AccessRightsDescription

A kulcshoz fűződő jogok.

Name Típus Description
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

AllocationPolicy

A kiépítési szolgáltatás által használandó foglalási szabályzat.

Name Típus Description
GeoLatency

string

Hashed

string

Static

string

createdByType

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

Name Típus Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Hiba részletei.

Name Típus Description
code

integer

A hibakód.

details

string

A hiba részletei.

httpStatusCode

string

A HTTP-állapotkód.

message

string

A hibaüzenet.

IotDpsPropertiesDescription

egy kiépítési szolgáltatás szolgáltatásspecifikus tulajdonságai, beleértve a kulcsokat, a csatolt iot hubokat, az aktuális állapotot és a rendszer által létrehozott tulajdonságokat, például a gazdagépnevet és az idScopeot

Name Típus Description
allocationPolicy

AllocationPolicy

A kiépítési szolgáltatás által használandó foglalási szabályzat.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Egy kiépítési szolgáltatás engedélyezési kulcsainak listája.

deviceProvisioningHostName

string

A kiépítési szolgáltatás eszközvégpontja.

enableDataResidency

boolean

Választható. Azt jelzi, hogy a DPS-példány engedélyezve van-e Data Residency, eltávolítva a geopárok közötti vészhelyreállítást.

idScope

string

A kiépítési szolgáltatás egyedi azonosítója.

iotHubs

IotHubDefinitionDescription[]

A kiépítési szolgáltatáshoz társított IoT Hubok listája.

ipFilterRules

IpFilterRule[]

Az IP-szűrési szabályok.

portalOperationsHostName

string

Portálvégpont a CORS engedélyezéséhez ehhez a kiépítési szolgáltatáshoz.

privateEndpointConnections

PrivateEndpointConnection[]

Ezen az IotHubon létrehozott privát végpontkapcsolatok

provisioningState

string

A kiépítési szolgáltatás ARM-kiépítési állapota.

publicNetworkAccess

PublicNetworkAccess

A nyilvános hálózatról érkező kérések engedélyezése

serviceOperationsHostName

string

Szolgáltatásvégpont a szolgáltatás kiépítéséhez.

state

state

A kiépítési szolgáltatás aktuális állapota.

IotDpsSku

Termékváltozat neve.

Name Típus Description
S1

string

IotDpsSkuInfo

A lehetséges kiépítési szolgáltatási termékváltozatok listája.

Name Típus Description
capacity

integer

A kiosztandó egységek száma

name

IotDpsSku

Termékváltozat neve.

tier

string

A kiépítési szolgáltatás tarifacsomagjának neve.

IotHubDefinitionDescription

Az IoT Hub leírása.

Name Típus Description
allocationWeight

integer

súlyt kell alkalmazni egy adott iot h.

applyAllocationPolicy

boolean

jelölő a allocationPolicy alkalmazásához, vagy nem egy adott iot hubra.

connectionString

string

Az IoT Hub kapcsolati sztringje.

location

string

Az IoT Hub ARM-régiója.

name

string

Az IoT Hub állomásneve.

IpFilterActionType

A szabály által rögzített kérések kívánt művelete.

Name Típus Description
Accept

string

Reject

string

IpFilterRule

A kiépítési szolgáltatás IP-szűrési szabályai.

Name Típus Description
action

IpFilterActionType

A szabály által rögzített kérések kívánt művelete.

filterName

string

Az IP-szűrőszabály neve.

ipMask

string

A szabály CIDR-jelölésében szereplő IP-címtartományt tartalmazó sztring.

target

IpFilterTargetType

A szabály által rögzített kérések célhelye.

IpFilterTargetType

A szabály által rögzített kérések célhelye.

Name Típus Description
all

string

deviceApi

string

serviceApi

string

PrivateEndpoint

Magánvégpont-kapcsolat privát végponttulajdonsága

Name Típus Description
id

string

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

PrivateEndpointConnection

Egy kiépítési szolgáltatás privát végpontkapcsolata

Name Típus Description
id

string

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

name

string

Az erőforrás neve.

properties

PrivateEndpointConnectionProperties

Privát végpontkapcsolat tulajdonságai

systemData

systemData

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

type

string

Az erőforrás típusa.

PrivateEndpointConnectionProperties

Privát végpontkapcsolat tulajdonságai

Name Típus Description
privateEndpoint

PrivateEndpoint

Magánvégpont-kapcsolat privát végponttulajdonsága

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Privát végpontkapcsolat aktuális állapota

PrivateLinkServiceConnectionState

Privát végpontkapcsolat aktuális állapota

Name Típus Description
actionsRequired

string

Privát végpontkapcsolathoz szükséges műveletek

description

string

A privát végpontkapcsolat aktuális állapotának leírása

status

PrivateLinkServiceConnectionStatus

Privát végpontkapcsolat állapota

PrivateLinkServiceConnectionStatus

Privát végpontkapcsolat állapota

Name Típus Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

ProvisioningServiceDescription

A kiépítési szolgáltatás leírása.

Name Típus Description
etag

string

Az Etag mezőre nincs szükség. Ha a válasz törzsében szerepel, akkor fejlécként is meg kell adni a normál ETag-konvenciók szerint.

id

string

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

location

string

Az erőforrás helye.

name

string

Az erőforrás neve.

properties

IotDpsPropertiesDescription

Szolgáltatásspecifikus tulajdonságok egy kiépítési szolgáltatáshoz

resourcegroup

string

Az erőforrás erőforráscsoportja.

sku

IotDpsSkuInfo

Termékváltozat adatai egy kiépítési szolgáltatáshoz.

subscriptionid

string

Az erőforrás előfizetés-azonosítója.

systemData

systemData

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

tags

object

Az erőforráscímkék.

type

string

Az erőforrás típusa.

PublicNetworkAccess

A nyilvános hálózatról érkező kérések engedélyezése

Name Típus Description
Disabled

string

Enabled

string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

A megosztott hozzáférési kulcs leírása.

Name Típus Description
keyName

string

A kulcs neve.

primaryKey

string

Elsődleges SAS-kulcs értéke.

rights

AccessRightsDescription

A kulcshoz fűződő jogok.

secondaryKey

string

Másodlagos SAS-kulcs értéke.

state

A kiépítési szolgáltatás aktuális állapota.

Name Típus Description
Activating

string

ActivationFailed

string

Active

string

Deleted

string

Deleting

string

DeletionFailed

string

FailingOver

string

FailoverFailed

string

Resuming

string

Suspended

string

Suspending

string

Transitioning

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 az identitás, amely legutóbb módosította az erőforrást.

lastModifiedByType

createdByType

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