Compartilhar via


Iot Dps Resource - List By Subscription

Obtenha todos os serviços de provisionamento em uma assinatura.
Liste todos os serviços de provisionamento para uma determinada ID de assinatura.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices?api-version=2022-12-12

Parâmetros de URI

Nome Em Obrigatório Tipo Description
subscriptionId
path True

string

O identificador da assinatura.

api-version
query True

string

A versão da API.

Respostas

Nome Tipo Description
200 OK

ProvisioningServiceDescriptionListResult

Essa é uma operação síncrona. O corpo contém uma matriz serializada em JSON dos metadados de todos os serviços de provisionamento na assinatura.

Other Status Codes

ErrorDetails

Resposta de erro padrão.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

DPSListBySubscription

Sample Request

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/provisioningServices?api-version=2022-12-12

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",
        "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": "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/mySecondProvisioningService",
      "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
      "tags": {},
      "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
      }
    }
  ]
}

Definições

Nome Description
AccessRightsDescription

Direitos que essa chave tem.

AllocationPolicy

Política de alocação a ser usada por esse serviço de provisionamento.

createdByType

O tipo de identidade que criou o recurso.

ErrorDetails

Detalhes do 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

IotDpsSku

Nome da SKU.

IotDpsSkuInfo

Lista de SKUs de serviço de provisionamento possíveis.

IotHubDefinitionDescription

Descrição do Hub IoT.

IpFilterActionType

A ação desejada para solicitações capturadas por essa regra.

IpFilterRule

As regras de filtro IP para um serviço de provisionamento.

IpFilterTargetType

Destino para solicitações capturadas por essa regra.

PrivateEndpoint

A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado

PrivateEndpointConnection

A conexão de ponto de extremidade privado de um serviço de provisionamento

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privado

PrivateLinkServiceConnectionState

O estado atual de uma conexão de ponto de extremidade privado

PrivateLinkServiceConnectionStatus

O status de uma conexão de ponto de extremidade privado

ProvisioningServiceDescription

A descrição do serviço de provisionamento.

ProvisioningServiceDescriptionListResult

Lista de descrições do serviço de provisionamento.

PublicNetworkAccess

Se as solicitações da Rede Pública são permitidas

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descrição da chave de acesso compartilhado.

state

Estado atual do serviço de provisionamento.

systemData

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

AllocationPolicy

Política de alocação a ser usada por esse serviço de provisionamento.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

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

IotHubDefinitionDescription[]

Lista de hubs IoT associados a esse serviço de provisionamento.

ipFilterRules

IpFilterRule[]

As regras de filtro ip.

portalOperationsHostName

string

Ponto de extremidade do portal para habilitar o CORS para esse serviço de provisionamento.

privateEndpointConnections

PrivateEndpointConnection[]

Conexões de ponto de extremidade privado criadas neste IotHub

provisioningState

string

O estado de provisionamento do ARM do serviço de provisionamento.

publicNetworkAccess

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

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

IotDpsSku

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

IpFilterActionType

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

IpFilterTargetType

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

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privado

systemData

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

PrivateEndpoint

A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado

privateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

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

IotDpsPropertiesDescription

Propriedades específicas do serviço para um serviço de provisionamento

resourcegroup

string

O grupo de recursos do recurso.

sku

IotDpsSkuInfo

Informações de SKU para um serviço de provisionamento.

subscriptionid

string

A ID da assinatura do recurso.

systemData

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

ProvisioningServiceDescription[]

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

AccessRightsDescription

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

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

createdByType

O tipo de identidade que modificou o recurso pela última vez.