Iot Dps Resource - Update

Referencia

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

API-verzió:: 2022-12-12

Meglévő kiépítési szolgáltatás címkéinek frissítése. más mezők frissítéséhez használja a CreateOrUpdate metódust

PATCH 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ítendő 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	Típus	Description
tags	object	Erőforráscímkék

Válaszok

Name	Típus	Description
200 OK	ProvisioningServiceDescription	A kiépítési szolgáltatás frissítése sikerült

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

DPSPatch

Mintakérelem

HTTP

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

{
  "tags": {
    "foo": "bar"
  }
}

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",
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {
    "foo": "bar"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Definíciók

Name	Description
AccessRightsDescription	Jogosultságok, amelyekkel ez a kulcs rendelkezik.
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.
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 kiépítési szolgáltatás lehetséges termékváltozatainak 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élja.
PrivateEndpoint	A privát végponti kapcsolat privát végpont tulajdonsága
PrivateEndpointConnection	Egy kiépítési szolgáltatás privát végponti kapcsolata
PrivateEndpointConnectionProperties	A privát végponti kapcsolat tulajdonságai
PrivateLinkServiceConnectionState	A privát végponti kapcsolat aktuális állapota
PrivateLinkServiceConnectionStatus	Privát végponti kapcsolat állapota
ProvisioningServiceDescription	A kiépítési szolgáltatás leírása.
PublicNetworkAccess	Engedélyezve vannak-e a nyilvános hálózatról érkező kérések
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.
TagsResource	Egy olyan tároló, amely csak egy erőforrás címkéivel rendelkezik, így a felhasználó frissítheti a címkéket egy kiépítési szolgáltatáspéldányon.

AccessRightsDescription

Enumerálás

Jogosultságok, amelyekkel ez a kulcs rendelkezik.

É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

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][]	Engedélyezési kulcsok listája egy kiépítési szolgáltatáshoz.
deviceProvisioningHostName	string	Eszközvégpont ehhez a kiépítési szolgáltatáshoz.
enableDataResidency	boolean	Választható. Azt jelzi, hogy a DPS-példány Data Residency engedélyezve van-e, 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 ezen kiépítési szolgáltatáshoz való engedélyezéséhez.
privateEndpointConnections	PrivateEndpointConnection[]	Ezen az IotHubon létrehozott privát végponti kapcsolatok
provisioningState	string	A kiépítési szolgáltatás ARM-kiépítési állapota.
publicNetworkAccess	PublicNetworkAccess	Engedélyezve vannak-e a nyilvános hálózatról érkező kérések
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 kiépítési szolgáltatás lehetséges termékváltozatainak 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 hubhoz.
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	Egy sztring, amely a szabály CIDR-jelölésében szereplő IP-címtartományt tartalmazza.
target	IpFilterTargetType	A szabály által rögzített kérések célja.

IpFilterTargetType

Enumerálás

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

Érték	Description
all
deviceApi
serviceApi

PrivateEndpoint

Objektum

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

Objektum

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

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égponti kapcsolat 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égponti kapcsolat tulajdonságai

Name	Típus	Description
privateEndpoint	PrivateEndpoint	A privát végponti kapcsolat privát végpont tulajdonsága
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A privát végponti kapcsolat aktuális állapota

PrivateLinkServiceConnectionState

Objektum

A privát végponti kapcsolat aktuális á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	Privát végponti kapcsolat állapota

PrivateLinkServiceConnectionStatus

Enumerálás

Privát végponti kapcsolat á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ő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ónak megfelelően.
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	Egy kiépítési szolgáltatás termékváltozat-információi.
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

Engedélyezve vannak-e a nyilvános hálózatról érkező kérések

É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	Jogosultságok, amelyekkel ez a kulcs rendelkezik.
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 utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

TagsResource

Objektum

Egy olyan tároló, amely csak egy erőforrás címkéivel rendelkezik, így a felhasználó frissítheti a címkéket egy kiépítési szolgáltatáspéldányon.

Name	Típus	Description
tags	object	Erőforráscímkék

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

Iot Dps Resource - Update

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

DPSPatch

Mintakérelem

Mintaválasz

Definíciók

AccessRightsDescription

AllocationPolicy

createdByType

IotDpsPropertiesDescription

IotDpsSku

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterActionType

IpFilterRule

IpFilterTargetType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningServiceDescription

PublicNetworkAccess

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

state

systemData

TagsResource

További források