Iot Dps Resource - List By Resource Group
Obtenha uma lista de todos os serviços de aprovisionamento no grupo de recursos especificado.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices?api-version=2018-01-22
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Identificador do grupo de recursos. |
subscription
|
path | True |
string |
O identificador da subscrição. |
api-version
|
query | True |
string |
A versão da API. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Lista de serviços de aprovisionamento no grupo de recursos. |
|
Other Status Codes |
Resposta de erro predefinida. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
DPSListByResourceGroup
Sample Request
GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices?api-version=2018-01-22
Sample Response
{
"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": "mySecondProvisioningService.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
}
}
]
}
Definições
Name | Description |
---|---|
Access |
Direitos que esta chave tem. |
Allocation |
Política de alocação a utilizar por este serviço de aprovisionamento. |
Error |
Detalhes do erro. |
Iot |
as propriedades específicas do serviço de um serviço de aprovisionamento, incluindo chaves, hubs iot ligados, estado atual e propriedades geradas pelo sistema, como o nome do anfitrião e o idScope |
Iot |
Nome do SKU. |
Iot |
Lista de SKUs do serviço de aprovisionamento possíveis. |
Iot |
Descrição do hub IoT. |
Provisioning |
A descrição do serviço de aprovisionamento. |
Provisioning |
Lista de descrições do serviço de aprovisionamento. |
Shared |
Descrição da chave de acesso partilhado. |
state |
Estado atual do serviço de aprovisionamento. |
AccessRightsDescription
Direitos que esta chave tem.
Name | Tipo | Description |
---|---|---|
DeviceConnect |
string |
|
EnrollmentRead |
string |
|
EnrollmentWrite |
string |
|
RegistrationStatusRead |
string |
|
RegistrationStatusWrite |
string |
|
ServiceConfig |
string |
AllocationPolicy
Política de alocação a utilizar por este serviço de aprovisionamento.
Name | Tipo | Description |
---|---|---|
GeoLatency |
string |
|
Hashed |
string |
|
Static |
string |
ErrorDetails
Detalhes do erro.
Name | Tipo | Description |
---|---|---|
code |
string |
O código de erro. |
details |
string |
Os detalhes do erro. |
httpStatusCode |
string |
O código de estado HTTP. |
message |
string |
A mensagem de erro. |
IotDpsPropertiesDescription
as propriedades específicas do serviço de um serviço de aprovisionamento, incluindo chaves, hubs iot ligados, estado atual e propriedades geradas pelo sistema, como o nome do anfitrião e o idScope
Name | Tipo | Description |
---|---|---|
allocationPolicy |
Política de alocação a utilizar por este serviço de aprovisionamento. |
|
authorizationPolicies |
Shared |
Lista de chaves de autorização para um serviço de aprovisionamento. |
deviceProvisioningHostName |
string |
Ponto final do dispositivo para este serviço de aprovisionamento. |
idScope |
string |
Identificador exclusivo deste serviço de aprovisionamento. |
iotHubs |
Lista de hubs IoT associados a este serviço de aprovisionamento. |
|
provisioningState |
string |
O estado de aprovisionamento do ARM do serviço de aprovisionamento. |
serviceOperationsHostName |
string |
Ponto final de serviço para o serviço de aprovisionamento. |
state |
Estado atual do serviço de aprovisionamento. |
IotDpsSku
Nome do SKU.
Name | Tipo | Description |
---|---|---|
S1 |
string |
IotDpsSkuInfo
Lista de SKUs do serviço de aprovisionamento possíveis.
Name | Tipo | Description |
---|---|---|
capacity |
integer |
O número de unidades a aprovisionar |
name |
Nome do SKU. |
|
tier |
string |
Nome do escalão de preço do serviço de aprovisionamento. |
IotHubDefinitionDescription
Descrição do hub IoT.
Name | Tipo | Description |
---|---|---|
allocationWeight |
integer |
peso a aplicar para um determinado iot h. |
applyAllocationPolicy |
boolean |
sinalizador para aplicar allocationPolicy ou não para um determinado hub iot. |
connectionString |
string |
Cadeia de ligação og o hub IoT. |
location |
string |
Região arm do hub IoT. |
name |
string |
Nome do anfitrião do hub IoT. |
ProvisioningServiceDescription
A descrição do serviço de aprovisionamento.
Name | Tipo | Description |
---|---|---|
etag |
string |
O campo Etag não é obrigatório. Se for fornecido no corpo da resposta, também tem de ser fornecido como um cabeçalho de acordo com a convenção ETag normal. |
id |
string |
O identificador do recurso. |
location |
string |
A localização do recurso. |
name |
string |
O nome do recurso. |
properties |
Propriedades específicas do serviço para um serviço de aprovisionamento |
|
sku |
Informações de SKU para um Serviço de aprovisionamento. |
|
tags |
object |
As etiquetas de recursos. |
type |
string |
O tipo de recurso. |
ProvisioningServiceDescriptionListResult
Lista de descrições do serviço de aprovisionamento.
Name | Tipo | Description |
---|---|---|
nextLink |
string |
a ligação seguinte |
value |
Lista de descrições do serviço de aprovisionamento. |
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]
Descrição da chave de acesso partilhado.
Name | Tipo | Description |
---|---|---|
keyName |
string |
Nome da chave. |
primaryKey |
string |
Valor da chave SAS primária. |
rights |
Direitos que esta chave tem. |
|
secondaryKey |
string |
Valor da chave SAS secundária. |
state
Estado atual do serviço de aprovisionamento.
Name | Tipo | 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 |