Iot Dps Resource - Get

Referens

Service:: IoT Hub Device Provisioning Service

API Version:: 2018-01-22

Hämta icke-säkerhetsrelaterade metadata för etableringstjänsten.
Hämta metadata för etableringstjänsten utan SAS-nycklar.

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

URI-parametrar

Name	In	Required	Type	Description
provisioningServiceName	path	True	string	Namnet på etableringstjänsten som ska hämtas.
resourceGroupName	path	True	string	Namn på resursgrupp.
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	Versionen av API:et.

Svar

Name	Type	Description
200 OK	ProvisioningServiceDescription	Beskrivningen av etableringstjänsten utan nycklar ingår i svaret.
Other Status Codes	ErrorDetails	Standardfelsvar

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

AccessRightsDescription	Rättigheter som nyckeln har.
AllocationPolicy	Allokeringsprincip som ska användas av den här etableringstjänsten.
ErrorDetails	Felinformation.
IotDpsPropertiesDescription	tjänstspecifika egenskaper för en etableringstjänst, inklusive nycklar, länkade iot-hubbar, aktuellt tillstånd och systemgenererade egenskaper som värdnamn och idScope
IotDpsSku	Sku-namn.
IotDpsSkuInfo	Lista över möjliga SKU:er för etableringstjänsten.
IotHubDefinitionDescription	Beskrivning av IoT-hubben.
ProvisioningServiceDescription	Beskrivningen av etableringstjänsten.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beskrivning av den delade åtkomstnyckeln.
state	Etableringstjänstens aktuella tillstånd.

AccessRightsDescription

Rättigheter som nyckeln har.

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

AllocationPolicy

Allokeringsprincip som ska användas av den här etableringstjänsten.

Name	Type	Description
GeoLatency	string
Hashed	string
Static	string

ErrorDetails

Felinformation.

Name	Type	Description
code	string	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.

IotDpsPropertiesDescription

tjänstspecifika egenskaper för en etableringstjänst, inklusive nycklar, länkade iot-hubbar, aktuellt tillstånd och systemgenererade egenskaper som värdnamn och idScope

Name	Type	Description
allocationPolicy	AllocationPolicy	Allokeringsprincip som ska användas av den här etableringstjänsten.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	Lista över auktoriseringsnycklar för en etableringstjänst.
deviceProvisioningHostName	string	Enhetsslutpunkt för den här etableringstjänsten.
idScope	string	Unik identifierare för den här etableringstjänsten.
iotHubs	IotHubDefinitionDescription[]	Lista över IoT-hubbar som är associerade med den här etableringstjänsten.
provisioningState	string	ARM-etableringstillståndet för etableringstjänsten.
serviceOperationsHostName	string	Tjänstslutpunkt för etableringstjänst.
state	state	Etableringstjänstens aktuella tillstånd.

IotDpsSku

Sku-namn.

Name	Type	Description
S1	string

IotDpsSkuInfo

Lista över möjliga SKU:er för etableringstjänsten.

Name	Type	Description
capacity	integer	Antalet enheter som ska etableras
name	IotDpsSku	Sku-namn.
tier	string	Namn på prisnivå för etableringstjänsten.

IotHubDefinitionDescription

Beskrivning av IoT-hubben.

Name	Type	Description
allocationWeight	integer	vikt att ansöka om en viss iot h.
applyAllocationPolicy	boolean	flagga för att tillämpa allocationPolicy eller inte för en viss iot-hubb.
connectionString	string	Anslutningssträng från IoT-hubben.
location	string	ARM-regionen i IoT-hubben.
name	string	Värdnamnet för IoT-hubben.

ProvisioningServiceDescription

Beskrivningen av etableringstjänsten.

Name	Type	Description
etag	string	Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen.
id	string	Resursidentifieraren.
location	string	Resursplatsen.
name	string	Resursnamnet.
properties	IotDpsPropertiesDescription	Tjänstspecifika egenskaper för en etableringstjänst
sku	IotDpsSkuInfo	SKU-information för en etableringstjänst.
tags	object	Resurstaggar.
type	string	Resurstypen.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beskrivning av den delade åtkomstnyckeln.

Name	Type	Description
keyName	string	Namnet på nyckeln.
primaryKey	string	Primärt SAS-nyckelvärde.
rights	AccessRightsDescription	Rättigheter som nyckeln har.
secondaryKey	string	Sekundärt SAS-nyckelvärde.

state

Etableringstjänstens aktuella tillstånd.

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