Iot Dps Resource - List By Subscription

Referenz

Service:: IoT Hub Device Provisioning Service

API Version:: 2018-01-22

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

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

URI-Parameter

Name	In	Required	Type	Description
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.

Antworten

Name	Type	Description
200 OK	ProvisioningServiceDescriptionListResult	Dies ist ein synchroner Vorgang. Der Text enthält ein JSON-serialisiertes Array der Metadaten aus allen Bereitstellungsdiensten im Abonnement.
Other Status Codes	ErrorDetails	Standardfehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Scopes

Name	Description
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=2018-01-22

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"
      },
      "type": "Microsoft.Devices/ProvisioningServices",
      "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
      "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"
      },
      "type": "Microsoft.Devices/ProvisioningServices",
      "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService",
      "tags": {},
      "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
      }
    }
  ]
}

Definitionen

AccessRightsDescription	Rechte, die dieser Schlüssel hat.
AllocationPolicy	Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.
ErrorDetails	Fehlerdetails.
IotDpsPropertiesDescription	die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüssel, verknüpfter iot Hubs, aktueller Zustand und vom System generierte Eigenschaften wie Hostname und idScope
IotDpsSku	Sku-Name.
IotDpsSkuInfo	Liste der möglichen Bereitstellungsdienst-SKUs.
IotHubDefinitionDescription	Beschreibung des IoT-Hubs.
ProvisioningServiceDescription	Die Beschreibung des Bereitstellungsdiensts.
ProvisioningServiceDescriptionListResult	Liste der Bereitstellungsdienstbeschreibungen.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beschreibung des freigegebenen Zugriffsschlüssels.
state	Aktueller Status des Bereitstellungsdiensts.

AccessRightsDescription

Rechte, die dieser Schlüssel hat.

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

AllocationPolicy

Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.

Name	Type	Description
GeoLatency	string
Hashed	string
Static	string

ErrorDetails

Fehlerdetails.

Name	Type	Description
code	string	Der Fehlercode.
details	string	Die Fehlerdetails.
httpStatusCode	string	Der HTTP-Statuscode.
message	string	Die Fehlermeldung.

IotDpsPropertiesDescription

die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüssel, verknüpfter iot Hubs, aktueller Zustand und vom System generierte Eigenschaften wie Hostname und idScope

Name	Type	Description
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.
idScope	string	Eindeutiger Bezeichner dieses Bereitstellungsdiensts.
iotHubs	IotHubDefinitionDescription[]	Liste der IoT-Hubs, die diesem Bereitstellungsdienst zugeordnet sind.
provisioningState	string	Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts.
serviceOperationsHostName	string	Dienstendpunkt für bereitstellungsdienst.
state	state	Aktueller Status des Bereitstellungsdiensts.

IotDpsSku

Sku-Name.

Name	Type	Description
S1	string

IotDpsSkuInfo

Liste der möglichen Bereitstellungsdienst-SKUs.

Name	Type	Description
capacity	integer	Die Anzahl der einheiten, die bereitgestellt werden sollen
name	IotDpsSku	Sku-Name.
tier	string	Preisstufenname des Bereitstellungsdiensts.

IotHubDefinitionDescription

Beschreibung des IoT-Hubs.

Name	Type	Description
allocationWeight	integer	Gewichtung, die für ein bestimmtes Iot h angewendet werden soll.
applyAllocationPolicy	boolean	flag for applying allocationPolicy or not for a given iot hub.
connectionString	string	Verbindungszeichenfolge og ioT hub.
location	string	ARM-Region des IoT-Hubs.
name	string	Hostname des IoT-Hubs.

ProvisioningServiceDescription

Die Beschreibung des Bereitstellungsdiensts.

Name	Type	Description
etag	string	Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden.
id	string	Der Ressourcenbezeichner.
location	string	Der Ressourcenspeicherort.
name	string	Der Name der Ressource.
properties	IotDpsPropertiesDescription	Dienstspezifische Eigenschaften für einen Bereitstellungsdienst
sku	IotDpsSkuInfo	Sku-Informationen für einen Bereitstellungsdienst.
tags	object	Die Ressourcentags.
type	string	Der Ressourcentyp.

ProvisioningServiceDescriptionListResult

Liste der Bereitstellungsdienstbeschreibungen.

Name	Type	Description
nextLink	string	der nächste Link
value	ProvisioningServiceDescription[]	Liste der Bereitstellungsdienstbeschreibungen.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschreibung des freigegebenen Zugriffsschlüssels.

Name	Type	Description
keyName	string	Name des Schlüssels.
primaryKey	string	Primärer SAS-Schlüsselwert.
rights	AccessRightsDescription	Rechte, die dieser Schlüssel hat.
secondaryKey	string	Sekundärer SAS-Schlüsselwert.

state

Aktueller Status des Bereitstellungsdiensts.

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