Iot Dps Resource - List By Subscription

Service:

IoT Hub Device Provisioning Service

API Version:

2022-12-12

Získejte všechny služby zřizování v předplatném.
Vypíše všechny služby zřizování pro dané ID předplatného.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API.

Odpovědi

Name	Typ	Description
200 OK	ProvisioningServiceDescriptionListResult	Jedná se o synchronní operaci. Tělo obsahuje json serializované pole metadat ze všech služeb zřizování v předplatném.
Other Status Codes	ErrorDetails	Výchozí chybová odpověď.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

DPSListBySubscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/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": "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/mySecondProvisioningService",
      "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
      "tags": {},
      "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
      }
    }
  ]
}

Definice

Name	Description
AccessRightsDescription	Práva, která tento klíč má.
AllocationPolicy	Zásady přidělování, které tato služba zřizování použije.
createdByType	Typ identity, která prostředek vytvořila.
ErrorDetails	Podrobnosti o chybě.
IotDpsPropertiesDescription	vlastnosti služby zřizování specifické pro službu, včetně klíčů, propojených center IoT, aktuálního stavu a systémem generovaných vlastností, jako je název hostitele a idScope
IotDpsSku	Název skladové položky.
IotDpsSkuInfo	Seznam možných skladových položek služby zřizování
IotHubDefinitionDescription	Popis centra IoT.
IpFilterActionType	Požadovaná akce pro požadavky zachycené tímto pravidlem
IpFilterRule	Pravidla filtru IP adres pro službu zřizování.
IpFilterTargetType	Cíl pro požadavky zachycené tímto pravidlem.
PrivateEndpoint	Vlastnost privátního koncového bodu připojení privátního koncového bodu
PrivateEndpointConnection	Připojení privátního koncového bodu služby zřizování
PrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu
PrivateLinkServiceConnectionState	Aktuální stav připojení privátního koncového bodu
PrivateLinkServiceConnectionStatus	Stav připojení privátního koncového bodu
ProvisioningServiceDescription	Popis služby zřizování.
ProvisioningServiceDescriptionListResult	Seznam popisů služby zřizování
PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Popis sdíleného přístupového klíče
state	Aktuální stav služby zřizování
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AccessRightsDescription

Práva, která tento klíč má.

Name	Typ	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

AllocationPolicy

Zásady přidělování, které tato služba zřizování použije.

Name	Typ	Description
GeoLatency	string
Hashed	string
Static	string

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	integer	Kód chyby
details	string	Podrobnosti o chybě.
httpStatusCode	string	Stavový kód HTTP
message	string	Chybová zpráva

IotDpsPropertiesDescription

vlastnosti služby zřizování specifické pro službu, včetně klíčů, propojených center IoT, aktuálního stavu a systémem generovaných vlastností, jako je název hostitele a idScope

Name	Typ	Description
allocationPolicy	AllocationPolicy	Zásady přidělování, které tato služba zřizování použije.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Seznam autorizačních klíčů pro službu zřizování
deviceProvisioningHostName	string	Koncový bod zařízení pro tuto službu zřizování
enableDataResidency	boolean	Nepovinný parametr. Označuje, jestli má instance služby DPS Data Residency povolená, čímž se odebere zotavení po havárii napříč geografickým párem.
idScope	string	Jedinečný identifikátor této služby zřizování.
iotHubs	IotHubDefinitionDescription[]	Seznam center IoT přidružených k této službě zřizování
ipFilterRules	IpFilterRule[]	Pravidla filtru IP adres.
portalOperationsHostName	string	Koncový bod portálu pro povolení CORS pro tuto službu zřizování
privateEndpointConnections	PrivateEndpointConnection[]	Připojení privátních koncových bodů vytvořená na tomto IotHubu
provisioningState	string	Stav zřizování ARM služby zřizování.
publicNetworkAccess	PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
serviceOperationsHostName	string	Koncový bod služby pro službu zřizování.
state	state	Aktuální stav služby zřizování

IotDpsSku

Název skladové položky.

Name	Typ	Description
S1	string

IotDpsSkuInfo

Seznam možných skladových položek služby zřizování

Name	Typ	Description
capacity	integer	Počet jednotek, které se mají zřídit
name	IotDpsSku	Název skladové položky.
tier	string	Název cenové úrovně služby zřizování.

IotHubDefinitionDescription

Popis centra IoT.

Name	Typ	Description
allocationWeight	integer	hmotnosti, která se použije pro danou iot h.
applyAllocationPolicy	boolean	příznak pro použití zásad allocationPolicy pro dané centrum ioT.
connectionString	string	Připojovací řetězec centra IoT.
location	string	Oblast ARM centra IoT.
name	string	Název hostitele centra IoT.

IpFilterActionType

Požadovaná akce pro požadavky zachycené tímto pravidlem

Name	Typ	Description
Accept	string
Reject	string

IpFilterRule

Pravidla filtru IP adres pro službu zřizování.

Name	Typ	Description
action	IpFilterActionType	Požadovaná akce pro požadavky zachycené tímto pravidlem
filterName	string	Název pravidla filtru IP adres.
ipMask	string	Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pro pravidlo.
target	IpFilterTargetType	Cíl pro požadavky zachycené tímto pravidlem.

IpFilterTargetType

Cíl pro požadavky zachycené tímto pravidlem.

Name	Typ	Description
all	string
deviceApi	string
serviceApi	string

PrivateEndpoint

Vlastnost privátního koncového bodu připojení privátního koncového bodu

Name	Typ	Description
id	string	Identifikátor prostředku.

PrivateEndpointConnection

Připojení privátního koncového bodu služby zřizování

Name	Typ	Description
id	string	Identifikátor prostředku.
name	string	Název prostředku.
properties	PrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku.
type	string	Typ prostředku.

PrivateEndpointConnectionProperties

Vlastnosti připojení privátního koncového bodu

Name	Typ	Description
privateEndpoint	PrivateEndpoint	Vlastnost privátního koncového bodu připojení privátního koncového bodu
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Aktuální stav připojení privátního koncového bodu

PrivateLinkServiceConnectionState

Aktuální stav připojení privátního koncového bodu

Name	Typ	Description
actionsRequired	string	Akce vyžadované pro připojení privátního koncového bodu
description	string	Popis aktuálního stavu připojení privátního koncového bodu
status	PrivateLinkServiceConnectionStatus	Stav připojení privátního koncového bodu

PrivateLinkServiceConnectionStatus

Stav připojení privátního koncového bodu

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningServiceDescription

Popis služby zřizování.

Name	Typ	Description
etag	string	Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí být také uvedený jako hlavička podle normální konvence ETag.
id	string	Identifikátor prostředku.
location	string	Umístění prostředku.
name	string	Název prostředku.
properties	IotDpsPropertiesDescription	Vlastnosti specifické pro službu zřizování
resourcegroup	string	Skupina prostředků prostředku.
sku	IotDpsSkuInfo	Informace o SKU pro službu zřizování
subscriptionid	string	ID předplatného prostředku.
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku.
tags	object	Značky prostředků.
type	string	Typ prostředku.

ProvisioningServiceDescriptionListResult

Seznam popisů služby zřizování

Name	Typ	Description
nextLink	string	the next link
value	ProvisioningServiceDescription[]	Seznam popisů služby zřizování

PublicNetworkAccess

Jestli jsou povolené požadavky z veřejné sítě

Name	Typ	Description
Disabled	string
Enabled	string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Popis sdíleného přístupového klíče

Name	Typ	Description
keyName	string	Název klíče.
primaryKey	string	Hodnota primárního klíče SAS
rights	AccessRightsDescription	Práva, která tento klíč má.
secondaryKey	string	Hodnota sekundárního klíče SAS

state

Aktuální stav služby zřizování

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

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.