Iot Dps Resource - List By Subscription

Referenz

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Rufen Sie alle Bereitstellungsdienste in einem Abonnement ab.
Listet alle Bereitstellungsdienste für eine angegebene Abonnement-ID auf.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.

Antworten

Name	Typ	Beschreibung
200 OK	ProvisioningServiceDescriptionListResult	Dies ist ein synchroner Vorgang. Der Text enthält ein JSON-serialisiertes Array der Metadaten aller Bereitstellungsdienste im Abonnement.
Other Status Codes	ErrorDetails	Standardfehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
AccessRightsDescription	Rechte, über die dieser Schlüssel verfügt.
AllocationPolicy	Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorDetails	Fehlerdetails.
IotDpsPropertiesDescription	die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot Hubs, aktueller Zustand und systemgenerierte Eigenschaften wie Hostname und idScope
IotDpsSku	SKU-Name.
IotDpsSkuInfo	Liste der möglichen Bereitstellungsdienst-SKUs.
IotHubDefinitionDescription	Beschreibung des IoT-Hubs.
IpFilterActionType	Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.
IpFilterRule	Die IP-Filterregeln für einen Bereitstellungsdienst.
IpFilterTargetType	Ziel für Anforderungen, die von dieser Regel erfasst werden.
PrivateEndpoint	Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt
PrivateEndpointConnection	Die private Endpunktverbindung eines Bereitstellungsdiensts
PrivateEndpointConnectionProperties	Die Eigenschaften einer Verbindung mit einem privaten Endpunkt
PrivateLinkServiceConnectionState	Der aktuelle Status einer Verbindung mit einem privaten Endpunkt
PrivateLinkServiceConnectionStatus	Die status einer Verbindung mit einem privaten Endpunkt
ProvisioningServiceDescription	Die Beschreibung des Bereitstellungsdiensts.
ProvisioningServiceDescriptionListResult	Liste der Beschreibungen des Bereitstellungsdiensts.
PublicNetworkAccess	Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beschreibung des gemeinsam genutzten Zugriffsschlüssels.
state	Aktueller Status des Bereitstellungsdiensts.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

AccessRightsDescription

Rechte, über die dieser Schlüssel verfügt.

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

AllocationPolicy

Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.

Name	Typ	Beschreibung
GeoLatency	string
Hashed	string
Static	string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Fehlerdetails.

Name	Typ	Beschreibung
code	integer	Der Fehlercode.
details	string	Die Fehlerdetails.
httpStatusCode	string	Der HTTP-Statuscode.
message	string	Die Fehlermeldung.

IotDpsPropertiesDescription

die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot Hubs, aktueller Zustand und systemgenerierte Eigenschaften wie Hostname und idScope

Name	Typ	Beschreibung
allocationPolicy	AllocationPolicy	Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Liste der Autorisierungsschlüssel für einen Bereitstellungsdienst.
deviceProvisioningHostName	string	Geräteendpunkt für diesen Bereitstellungsdienst.
enableDataResidency	boolean	Optional. Gibt an, ob für die DPS-instance Data Residency aktiviert ist, wobei die übergreifende geopaarübergreifende Notfallwiederherstellung entfernt wird.
idScope	string	Eindeutiger Bezeichner dieses Bereitstellungsdiensts.
iotHubs	IotHubDefinitionDescription[]	Liste der IoT Hubs, die diesem Bereitstellungsdienst zugeordnet sind.
ipFilterRules	IpFilterRule[]	Die IP-Filterregeln.
portalOperationsHostName	string	Portalendpunkt zum Aktivieren von CORS für diesen Bereitstellungsdienst.
privateEndpointConnections	PrivateEndpointConnection[]	Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden
provisioningState	string	Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts.
publicNetworkAccess	PublicNetworkAccess	Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind
serviceOperationsHostName	string	Dienstendpunkt für den Bereitstellungsdienst.
state	state	Aktueller Status des Bereitstellungsdiensts.

IotDpsSku

SKU-Name.

Name	Typ	Beschreibung
S1	string

IotDpsSkuInfo

Liste der möglichen Bereitstellungsdienst-SKUs.

Name	Typ	Beschreibung
capacity	integer	Die Anzahl der bereitzustellenden Einheiten
name	IotDpsSku	SKU-Name.
tier	string	Tarifname des Bereitstellungsdiensts.

IotHubDefinitionDescription

Beschreibung des IoT-Hubs.

Name	Typ	Beschreibung
allocationWeight	integer	Gewichtung, die für einen bestimmten iot h-Wert angewendet werden soll.
applyAllocationPolicy	boolean	flag for applying allocationPolicy or not for a given iot hub.
connectionString	string	Verbindungszeichenfolge des IoT-Hubs.
location	string	ARM-Region des IoT-Hubs.
name	string	Hostname des IoT-Hubs.

IpFilterActionType

Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.

Name	Typ	Beschreibung
Accept	string
Reject	string

IpFilterRule

Die IP-Filterregeln für einen Bereitstellungsdienst.

Name	Typ	Beschreibung
action	IpFilterActionType	Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.
filterName	string	Der Name der IP-Filterregel.
ipMask	string	Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält.
target	IpFilterTargetType	Ziel für Anforderungen, die von dieser Regel erfasst werden.

IpFilterTargetType

Ziel für Anforderungen, die von dieser Regel erfasst werden.

Name	Typ	Beschreibung
all	string
deviceApi	string
serviceApi	string

PrivateEndpoint

Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.

PrivateEndpointConnection

Die private Endpunktverbindung eines Bereitstellungsdiensts

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.
name	string	Der Name der Ressource.
properties	PrivateEndpointConnectionProperties	Die Eigenschaften einer Verbindung mit einem privaten Endpunkt
systemData	systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
type	string	Der Ressourcentyp.

PrivateEndpointConnectionProperties

Die Eigenschaften einer Verbindung mit einem privaten Endpunkt

Name	Typ	Beschreibung
privateEndpoint	PrivateEndpoint	Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Der aktuelle Status einer Verbindung mit einem privaten Endpunkt

PrivateLinkServiceConnectionState

Der aktuelle Status einer Verbindung mit einem privaten Endpunkt

Name	Typ	Beschreibung
actionsRequired	string	Für eine Verbindung mit einem privaten Endpunkt erforderliche Aktionen
description	string	Die Beschreibung für den aktuellen Status einer Verbindung mit einem privaten Endpunkt
status	PrivateLinkServiceConnectionStatus	Die status einer Verbindung mit einem privaten Endpunkt

PrivateLinkServiceConnectionStatus

Die status einer Verbindung mit einem privaten Endpunkt

Name	Typ	Beschreibung
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningServiceDescription

Die Beschreibung des Bereitstellungsdiensts.

Name	Typ	Beschreibung
etag	string	Das Etag-Feld ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss er gemäß der normalen ETag-Konvention auch als Header bereitgestellt werden.
id	string	Der Ressourcenbezeichner.
location	string	Der Ressourcenspeicherort.
name	string	Der Name der Ressource.
properties	IotDpsPropertiesDescription	Dienstspezifische Eigenschaften für einen Bereitstellungsdienst
resourcegroup	string	Die Ressourcengruppe der Ressource.
sku	IotDpsSkuInfo	SKU-Informationen für einen Bereitstellungsdienst.
subscriptionid	string	Die Abonnement-ID der Ressource.
systemData	systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
tags	object	Die Ressourcentags.
type	string	Der Ressourcentyp.

ProvisioningServiceDescriptionListResult

Liste der Beschreibungen des Bereitstellungsdiensts.

Name	Typ	Beschreibung
nextLink	string	der nächste Link
value	ProvisioningServiceDescription[]	Liste der Beschreibungen des Bereitstellungsdiensts.

PublicNetworkAccess

Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind

Name	Typ	Beschreibung
Disabled	string
Enabled	string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschreibung des gemeinsam genutzten Zugriffsschlüssels.

Name	Typ	Beschreibung
keyName	string	Name des Schlüssels.
primaryKey	string	Primärer SAS-Schlüsselwert.
rights	AccessRightsDescription	Rechte, über die dieser Schlüssel verfügt.
secondaryKey	string	Wert des sekundären SAS-Schlüssels.

state

Aktueller Status des Bereitstellungsdiensts.

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

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.