Iot Dps Resource - List By Resource Group

Referencia

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Az adott erőforráscsoportban található összes kiépítési szolgáltatás listájának lekérése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
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.

Válaszok

Name	Típus	Description
200 OK	ProvisioningServiceDescriptionListResult	Az erőforráscsoportban található kiépítési szolgáltatások listája.
Other Status Codes	ErrorDetails	Alapértelmezett hibaválasz.

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

Példák

DPSListByResourceGroup

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "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": {},
      "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
      }
    },
    {
      "etag": "AAAAAAAADGk=",
      "name": "mySecondProvisioningService",
      "location": "eastus",
      "properties": {
        "state": "Active",
        "allocationPolicy": "Hashed",
        "serviceOperationsHostName": "mySecondProvisioningService.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/mySecondProvisioningService",
      "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
      "tags": {},
      "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.
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 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.
ProvisioningServiceDescriptionListResult	A kiépítési szolgáltatás leírásainak listája.
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.

AccessRightsDescription

Jogosultságok, amelyekkel ez a kulcs rendelkezik.

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

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

Termékváltozat neve.

Name	Típus	Description
S1	string

IotDpsSkuInfo

A kiépítési szolgáltatás lehetséges termékváltozatainak 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 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

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

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

Name	Típus	Description
all	string
deviceApi	string
serviceApi	string

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

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

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

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

Privát végponti kapcsolat á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ónak megfelelően.
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	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.

ProvisioningServiceDescriptionListResult

A kiépítési szolgáltatás leírásainak listája.

Name	Típus	Description
nextLink	string	a következő hivatkozás
value	ProvisioningServiceDescription[]	A kiépítési szolgáltatás leírásainak listája.

PublicNetworkAccess

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

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	Jogosultságok, amelyekkel ez a kulcs rendelkezik.
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 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.