Iot Dps Resource - Get

Referenz

Service:: IoT Hub Device Provisioning Service

API Version:: 2018-01-22

Rufen Sie die nicht sicherheitsbezogenen Metadaten des Bereitstellungsdiensts ab.
Rufen Sie die Metadaten des Bereitstellungsdiensts ohne SAS-Schlüssel ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
provisioningServiceName	path	True	string	Name des abzurufenden Bereitstellungsdiensts.
resourceGroupName	path	True	string	Ressourcengruppenname
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.

Antworten

Name	Typ	Beschreibung
200 OK	ProvisioningServiceDescription	Die Beschreibung des Bereitstellungsdiensts ohne Schlüssel ist in der Antwort enthalten.
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

DPSGet

Sample Request

HTTP

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

Sample Response

Status code:: 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",
    "authorizationPolicies": []
  },
  "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
  }
}

Definitionen

Name	Beschreibung
AccessRightsDescription	Rechte, über die dieser Schlüssel verfügt.
AllocationPolicy	Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.
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.
ProvisioningServiceDescription	Die Beschreibung des Bereitstellungsdiensts.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beschreibung des gemeinsam genutzten Zugriffsschlüssels.
state	Aktueller Status des Bereitstellungsdiensts.

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

ErrorDetails

Fehlerdetails.

Name	Typ	Beschreibung
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ü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.
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 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 für den IoT-Hub.
location	string	ARM-Region des IoT-Hubs.
name	string	Hostname des IoT-Hubs.

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
sku	IotDpsSkuInfo	SKU-Informationen für einen Bereitstellungsdienst.
tags	object	Die Ressourcentags.
type	string	Der Ressourcentyp.

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