Iot Dps Resource - Create Or Update

Referencia

Szolgáltatás:: IoT Hub Device Provisioning Service

API-verzió:: 2022-12-12

Hozza létre 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étrehozni 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ő nem kötelező. Ha a válasz törzsében meg van adva, akkor fejlécként is meg kell adni a normál ETag-konvencióban.
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 egy 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 a művelet sikeres, a művelet a 201(OK) HTTP-állapotkódot 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	a felhasználói fiók megszemélyesítése

Példák

DPSCreate

Mintakérelem

HTTP

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

Állapotkód:: 200

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

Állapotkód:: 201

{
  "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	a 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 idScope-t
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	A privát végpontkapcsolat privát végponttulajdonsága
PrivateEndpointConnection	Egy kiépítési szolgáltatás privát végpontkapcsolata
PrivateEndpointConnectionProperties	A 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

Enumerálás

A kulcshoz fűződő jogok.

Érték	Description
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

AllocationPolicy

Enumerálás

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

Érték	Description
GeoLatency
Hashed
Static

createdByType

Enumerálás

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

Érték	Description
Application
Key
ManagedIdentity
User

ErrorDetails

Objektum

Hiba részletei.

Name	Típus	Description
code	integer (int32)	A hibakód.
details	string	A hiba részletei.
httpStatusCode	string	A HTTP-állapotkód.
message	string	A hibaüzenet.

IotDpsPropertiesDescription

Objektum

a 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 idScope-t

Name	Típus	Description
allocationPolicy	AllocationPolicy	A kiépítési szolgáltatás által használandó foglalási szabályzat.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	A kiépítési szolgáltatás engedélyezési kulcsainak listája.
deviceProvisioningHostName	string	Eszközvégpont ehhez a kiépítési szolgáltatáshoz.
enableDataResidency	boolean	Opcionális. Azt jelzi, hogy a DPS-példányon engedélyezve van-e az adattárolás, 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

Enumerálás

Termékváltozat neve.

Érték	Description
S1

IotDpsSkuInfo

Objektum

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

Name	Típus	Description
capacity	integer (int64)	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

Objektum

Az IoT Hub leírása.

Name	Típus	Description
allocationWeight	integer (int32)	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

Enumerálás

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

Érték	Description
Accept
Reject

IpFilterRule

Objektum

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

Enumerálás

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

Érték	Description
all
deviceApi
serviceApi

PrivateEndpoint

Objektum

A privát végpontkapcsolat privát végponttulajdonsága

Name	Típus	Description
id	string	Az erőforrás azonosítója.

PrivateEndpointConnection

Objektum

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 pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	Az erőforrás neve.
properties	PrivateEndpointConnectionProperties	A 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

Objektum

A privát végpontkapcsolat tulajdonságai

Name	Típus	Description
privateEndpoint	PrivateEndpoint	A privát végpontkapcsolat privát végponttulajdonsága
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Privát végpontkapcsolat aktuális állapota

PrivateLinkServiceConnectionState

Objektum

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

Enumerálás

Privát végpontkapcsolat állapota

Érték	Description
Approved
Disconnected
Pending
Rejected

ProvisioningServiceDescription

Objektum

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

Name	Típus	Description
etag	string	Az Etag mező nem kötelező. Ha a válasz törzsében meg van adva, akkor fejlécként is meg kell adni a normál ETag-konvencióban.
id	string	Az erőforrás azonosítója.
location	string	Az erőforrás helye.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$	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

Enumerálás

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

Érték	Description
Disabled
Enabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Objektum

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

Enumerálás

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

Érték	Description
Activating
ActivationFailed
Active
Deleted
Deleting
DeletionFailed
FailingOver
FailoverFailed
Resuming
Suspended
Suspending
Transitioning

systemData

Objektum

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

Name	Típus	Description
createdAt	string (date-time)	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 (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

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

Iot Dps Resource - Create Or Update

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

DPSCreate

Mintakérelem

Mintaválasz

Definíciók

AccessRightsDescription

AllocationPolicy

createdByType

ErrorDetails

IotDpsPropertiesDescription

IotDpsSku

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterActionType

IpFilterRule

IpFilterTargetType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningServiceDescription

PublicNetworkAccess

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

state

systemData

További források