Iot Dps Resource - Get
Haal de niet-beveiligingsgerelateerde metagegevens van de inrichtingsservice op.
Haal de metagegevens van de inrichtingsservice op zonder SAS-sleutels.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2018-01-22
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
provisioning
|
path | True |
string |
Naam van de inrichtingsservice die moet worden opgehaald. |
resource
|
path | True |
string |
Naam van de resourcegroep. |
subscription
|
path | True |
string |
De abonnements-id. |
api-version
|
query | True |
string |
De versie van de API. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De beschrijving van de inrichtingsservice zonder sleutels is opgenomen in het antwoord. |
|
Other Status Codes |
Standaardfoutreactie |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
DPSGet
Voorbeeldaanvraag
GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2018-01-22
Voorbeeldrespons
{
"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
}
}
Definities
Name | Description |
---|---|
Access |
Rechten die deze sleutel heeft. |
Allocation |
Toewijzingsbeleid dat moet worden gebruikt door deze inrichtingsservice. |
Error |
Foutdetails. |
Iot |
de servicespecifieke eigenschappen van een inrichtingsservice, waaronder sleutels, gekoppelde ioT-hubs, huidige status en door het systeem gegenereerde eigenschappen, zoals hostnaam en idScope |
Iot |
SKU-naam. |
Iot |
Lijst met mogelijke inrichtingsservice-SKU's. |
Iot |
Beschrijving van de IoT-hub. |
Provisioning |
De beschrijving van de inrichtingsservice. |
Shared |
Beschrijving van de gedeelde toegangssleutel. |
state |
Huidige status van de inrichtingsservice. |
AccessRightsDescription
Rechten die deze sleutel heeft.
Name | Type | Description |
---|---|---|
DeviceConnect |
string |
|
EnrollmentRead |
string |
|
EnrollmentWrite |
string |
|
RegistrationStatusRead |
string |
|
RegistrationStatusWrite |
string |
|
ServiceConfig |
string |
AllocationPolicy
Toewijzingsbeleid dat moet worden gebruikt door deze inrichtingsservice.
Name | Type | Description |
---|---|---|
GeoLatency |
string |
|
Hashed |
string |
|
Static |
string |
ErrorDetails
Foutdetails.
Name | Type | Description |
---|---|---|
code |
string |
De foutcode. |
details |
string |
De foutdetails. |
httpStatusCode |
string |
De HTTP-statuscode. |
message |
string |
Het foutbericht. |
IotDpsPropertiesDescription
de servicespecifieke eigenschappen van een inrichtingsservice, waaronder sleutels, gekoppelde ioT-hubs, huidige status en door het systeem gegenereerde eigenschappen, zoals hostnaam en idScope
Name | Type | Description |
---|---|---|
allocationPolicy |
Toewijzingsbeleid dat moet worden gebruikt door deze inrichtingsservice. |
|
authorizationPolicies |
Shared |
Lijst met autorisatiesleutels voor een inrichtingsservice. |
deviceProvisioningHostName |
string |
Apparaateindpunt voor deze inrichtingsservice. |
idScope |
string |
De unieke id van deze inrichtingsservice. |
iotHubs |
Lijst met IoT-hubs die zijn gekoppeld aan deze inrichtingsservice. |
|
provisioningState |
string |
De ARM-inrichtingsstatus van de inrichtingsservice. |
serviceOperationsHostName |
string |
Service-eindpunt voor inrichtingsservice. |
state |
Huidige status van de inrichtingsservice. |
IotDpsSku
SKU-naam.
Name | Type | Description |
---|---|---|
S1 |
string |
IotDpsSkuInfo
Lijst met mogelijke inrichtingsservice-SKU's.
Name | Type | Description |
---|---|---|
capacity |
integer |
Het aantal eenheden dat moet worden ingericht |
name |
SKU-naam. |
|
tier |
string |
De naam van de prijscategorie van de inrichtingsservice. |
IotHubDefinitionDescription
Beschrijving van de IoT-hub.
Name | Type | Description |
---|---|---|
allocationWeight |
integer |
gewicht toe te passen voor een bepaalde iot h. |
applyAllocationPolicy |
boolean |
vlag voor het toepassen van allocationPolicy of niet voor een bepaalde ioT-hub. |
connectionString |
string |
Verbindingsreeks voor de IoT-hub. |
location |
string |
ARM-regio van de IoT-hub. |
name |
string |
Hostnaam van de IoT-hub. |
ProvisioningServiceDescription
De beschrijving van de inrichtingsservice.
Name | Type | Description |
---|---|---|
etag |
string |
Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie. |
id |
string |
De resource-id. |
location |
string |
De resourcelocatie. |
name |
string |
De resourcenaam. |
properties |
Servicespecifieke eigenschappen voor een inrichtingsservice |
|
sku |
SKU-informatie voor een inrichtingsservice. |
|
tags |
object |
De resourcetags. |
type |
string |
Het resourcetype. |
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]
Beschrijving van de gedeelde toegangssleutel.
Name | Type | Description |
---|---|---|
keyName |
string |
Naam van de sleutel. |
primaryKey |
string |
Waarde van primaire SAS-sleutel. |
rights |
Rechten die deze sleutel heeft. |
|
secondaryKey |
string |
Waarde van secundaire SAS-sleutel. |
state
Huidige status van de inrichtingsservice.
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 |