Iot Dps Resource - List By Resource Group
Obtenha uma lista de todos os serviços de provisionamento no grupo de recursos especificado.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices?api-version=2022-12-12
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Identificador do grupo de recursos. |
subscription
|
path | True |
string |
O identificador da assinatura. |
api-version
|
query | True |
string |
A versão da API. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Lista de serviços de provisionamento no grupo de recursos. |
|
Other Status Codes |
Resposta de erro padrão. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
DPSListByResourceGroup
Solicitação de exemplo
GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices?api-version=2022-12-12
Resposta de exemplo
{
"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",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
},
"resourcegroup": "myResourceGroup",
"type": "Microsoft.Devices/ProvisioningServices",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"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",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
},
"resourcegroup": "myResourceGroup",
"type": "Microsoft.Devices/ProvisioningServices",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService",
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
}
]
}
Definições
Nome | Description |
---|---|
Access |
Direitos que essa chave tem. |
Allocation |
Política de alocação a ser usada por esse serviço de provisionamento. |
created |
O tipo de identidade que criou o recurso. |
Error |
Detalhes do erro. |
Iot |
as propriedades específicas do serviço de um serviço de provisionamento, incluindo chaves, hubs iot vinculados, estado atual e propriedades geradas pelo sistema, como hostname e idScope |
Iot |
Nome da SKU. |
Iot |
Lista de SKUs de serviço de provisionamento possíveis. |
Iot |
Descrição do Hub IoT. |
Ip |
A ação desejada para solicitações capturadas por essa regra. |
Ip |
As regras de filtro IP para um serviço de provisionamento. |
Ip |
Destino para solicitações capturadas por essa regra. |
Private |
A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado |
Private |
A conexão de ponto de extremidade privado de um serviço de provisionamento |
Private |
As propriedades de uma conexão de ponto de extremidade privado |
Private |
O estado atual de uma conexão de ponto de extremidade privado |
Private |
O status de uma conexão de ponto de extremidade privado |
Provisioning |
A descrição do serviço de provisionamento. |
Provisioning |
Lista de descrições do serviço de provisionamento. |
Public |
Se as solicitações da Rede Pública são permitidas |
Shared |
Descrição da chave de acesso compartilhado. |
state |
Estado atual do serviço de provisionamento. |
system |
Metadados relativos à criação e à última modificação do recurso. |
AccessRightsDescription
Direitos que essa chave tem.
Nome | Tipo | Description |
---|---|---|
DeviceConnect |
string |
|
EnrollmentRead |
string |
|
EnrollmentWrite |
string |
|
RegistrationStatusRead |
string |
|
RegistrationStatusWrite |
string |
|
ServiceConfig |
string |
AllocationPolicy
Política de alocação a ser usada por esse serviço de provisionamento.
Nome | Tipo | Description |
---|---|---|
GeoLatency |
string |
|
Hashed |
string |
|
Static |
string |
createdByType
O tipo de identidade que criou o recurso.
Nome | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDetails
Detalhes do erro.
Nome | Tipo | Description |
---|---|---|
code |
integer |
O código de erro. |
details |
string |
Os detalhes do erro. |
httpStatusCode |
string |
O código de status do HTTP. |
message |
string |
A mensagem de erro. |
IotDpsPropertiesDescription
as propriedades específicas do serviço de um serviço de provisionamento, incluindo chaves, hubs iot vinculados, estado atual e propriedades geradas pelo sistema, como hostname e idScope
Nome | Tipo | Description |
---|---|---|
allocationPolicy |
Política de alocação a ser usada por esse serviço de provisionamento. |
|
authorizationPolicies |
Shared |
Lista de chaves de autorização para um serviço de provisionamento. |
deviceProvisioningHostName |
string |
Ponto de extremidade do dispositivo para este serviço de provisionamento. |
enableDataResidency |
boolean |
Opcional. Indica se a instância do DPS Data Residency habilitada, removendo a recuperação de desastre entre pares geográficos. |
idScope |
string |
Identificador exclusivo desse serviço de provisionamento. |
iotHubs |
Lista de hubs IoT associados a esse serviço de provisionamento. |
|
ipFilterRules |
As regras de filtro ip. |
|
portalOperationsHostName |
string |
Ponto de extremidade do portal para habilitar o CORS para esse serviço de provisionamento. |
privateEndpointConnections |
Conexões de ponto de extremidade privado criadas neste IotHub |
|
provisioningState |
string |
O estado de provisionamento do ARM do serviço de provisionamento. |
publicNetworkAccess |
Se as solicitações da Rede Pública são permitidas |
|
serviceOperationsHostName |
string |
Ponto de extremidade de serviço para o serviço de provisionamento. |
state |
Estado atual do serviço de provisionamento. |
IotDpsSku
Nome da SKU.
Nome | Tipo | Description |
---|---|---|
S1 |
string |
IotDpsSkuInfo
Lista de SKUs de serviço de provisionamento possíveis.
Nome | Tipo | Description |
---|---|---|
capacity |
integer |
O número de unidades a serem provisionados |
name |
Nome da SKU. |
|
tier |
string |
Nome do tipo de preço do serviço de provisionamento. |
IotHubDefinitionDescription
Descrição do Hub IoT.
Nome | Tipo | Description |
---|---|---|
allocationWeight |
integer |
peso a ser aplicado a um determinado iot h. |
applyAllocationPolicy |
boolean |
sinalizador para aplicar allocationPolicy ou não para um determinado hub iot. |
connectionString |
string |
Cadeia de conexão do Hub IoT. |
location |
string |
Região do ARM do Hub IoT. |
name |
string |
Nome do host do Hub IoT. |
IpFilterActionType
A ação desejada para solicitações capturadas por essa regra.
Nome | Tipo | Description |
---|---|---|
Accept |
string |
|
Reject |
string |
IpFilterRule
As regras de filtro IP para um serviço de provisionamento.
Nome | Tipo | Description |
---|---|---|
action |
A ação desejada para solicitações capturadas por essa regra. |
|
filterName |
string |
O nome da regra de filtro IP. |
ipMask |
string |
Uma cadeia de caracteres que contém o intervalo de endereços IP na notação CIDR para a regra. |
target |
Destino para solicitações capturadas por essa regra. |
IpFilterTargetType
Destino para solicitações capturadas por essa regra.
Nome | Tipo | Description |
---|---|---|
all |
string |
|
deviceApi |
string |
|
serviceApi |
string |
PrivateEndpoint
A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado
Nome | Tipo | Description |
---|---|---|
id |
string |
O identificador do recurso. |
PrivateEndpointConnection
A conexão de ponto de extremidade privado de um serviço de provisionamento
Nome | Tipo | Description |
---|---|---|
id |
string |
O identificador do recurso. |
name |
string |
O nome do recurso. |
properties |
As propriedades de uma conexão de ponto de extremidade privado |
|
systemData |
Metadados relativos à criação e à última modificação do recurso. |
|
type |
string |
O tipo de recurso. |
PrivateEndpointConnectionProperties
As propriedades de uma conexão de ponto de extremidade privado
Nome | Tipo | Description |
---|---|---|
privateEndpoint |
A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado |
|
privateLinkServiceConnectionState |
O estado atual de uma conexão de ponto de extremidade privado |
PrivateLinkServiceConnectionState
O estado atual de uma conexão de ponto de extremidade privado
Nome | Tipo | Description |
---|---|---|
actionsRequired |
string |
Ações necessárias para uma conexão de ponto de extremidade privado |
description |
string |
A descrição do estado atual de uma conexão de ponto de extremidade privado |
status |
O status de uma conexão de ponto de extremidade privado |
PrivateLinkServiceConnectionStatus
O status de uma conexão de ponto de extremidade privado
Nome | Tipo | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
ProvisioningServiceDescription
A descrição do serviço de provisionamento.
Nome | Tipo | Description |
---|---|---|
etag |
string |
O campo Etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um cabeçalho de acordo com a convenção de ETag normal. |
id |
string |
O identificador do recurso. |
location |
string |
O local do recurso. |
name |
string |
O nome do recurso. |
properties |
Propriedades específicas do serviço para um serviço de provisionamento |
|
resourcegroup |
string |
O grupo de recursos do recurso. |
sku |
Informações de SKU para um serviço de provisionamento. |
|
subscriptionid |
string |
A ID da assinatura do recurso. |
systemData |
Metadados relativos à criação e à última modificação do recurso. |
|
tags |
object |
As marcas do recurso. |
type |
string |
O tipo de recurso. |
ProvisioningServiceDescriptionListResult
Lista de descrições do serviço de provisionamento.
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
o próximo link |
value |
Lista de descrições do serviço de provisionamento. |
PublicNetworkAccess
Se as solicitações da Rede Pública são permitidas
Nome | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]
Descrição da chave de acesso compartilhado.
Nome | Tipo | Description |
---|---|---|
keyName |
string |
Nome da chave. |
primaryKey |
string |
Valor da chave SAS primária. |
rights |
Direitos que essa chave tem. |
|
secondaryKey |
string |
Valor da chave SAS secundária. |
state
Estado atual do serviço de provisionamento.
Nome | 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 |
systemData
Metadados relativos à criação e à última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |