Partilhar via


Iot Dps Resource - List By Subscription

Obtenha todos os serviços de aprovisionamento numa subscrição.
Liste todos os serviços de aprovisionamento para um determinado ID de subscrição.

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

Parâmetros do URI

Name Em Necessário Tipo Description
subscriptionId
path True

string

O identificador da subscrição.

api-version
query True

string

A versão da API.

Respostas

Name Tipo Description
200 OK

ProvisioningServiceDescriptionListResult

Esta é uma operação síncrona. O corpo contém uma matriz serializada JSON dos metadados de todos os serviços de aprovisionamento na subscrição.

Other Status Codes

ErrorDetails

Resposta de erro predefinida.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

DPSListBySubscription

Pedido de amostra

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

Resposta da amostra

{
  "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

Name Description
AccessRightsDescription

Direitos que esta chave tem.

AllocationPolicy

Política de alocação a utilizar por este serviço de aprovisionamento.

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 aprovisionamento, incluindo chaves, hubs iot ligados, estado atual e propriedades geradas pelo sistema, como o nome do anfitrião e o idScope

IotDpsSku

Nome do SKU.

IotDpsSkuInfo

Lista de SKUs do serviço de aprovisionamento possíveis.

IotHubDefinitionDescription

Descrição do hub IoT.

IpFilterActionType

A ação pretendida para pedidos capturados por esta regra.

IpFilterRule

As regras de filtro de IP para um Serviço de aprovisionamento.

IpFilterTargetType

Destino para pedidos capturados por esta regra.

PrivateEndpoint

A propriedade de ponto final privado de uma ligação de ponto final privado

PrivateEndpointConnection

A ligação de ponto final privado de um serviço de aprovisionamento

PrivateEndpointConnectionProperties

As propriedades de uma ligação de ponto final privado

PrivateLinkServiceConnectionState

O estado atual de uma ligação de ponto final privado

PrivateLinkServiceConnectionStatus

O estado de uma ligação de ponto final privado

ProvisioningServiceDescription

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

ProvisioningServiceDescriptionListResult

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

PublicNetworkAccess

Se os pedidos da Rede Pública são permitidos

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descrição da chave de acesso partilhado.

state

Estado atual do serviço de aprovisionamento.

systemData

Metadados relativos à criação e última modificação do recurso.

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

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Detalhes do erro.

Name Tipo Description
code

integer

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

AllocationPolicy

Política de alocação a utilizar por este serviço de aprovisionamento.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Lista de chaves de autorização para um serviço de aprovisionamento.

deviceProvisioningHostName

string

Ponto final do dispositivo para este serviço de aprovisionamento.

enableDataResidency

boolean

Opcional. Indica se a instância do DPS Data Residency ativada, removendo a recuperação após desastre entre pares geográficos.

idScope

string

Identificador exclusivo deste serviço de aprovisionamento.

iotHubs

IotHubDefinitionDescription[]

Lista de hubs IoT associados a este serviço de aprovisionamento.

ipFilterRules

IpFilterRule[]

As regras de filtro de IP.

portalOperationsHostName

string

Ponto final do portal para ativar o CORS para este serviço de aprovisionamento.

privateEndpointConnections

PrivateEndpointConnection[]

Ligações de ponto final privados criadas neste IotHub

provisioningState

string

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

publicNetworkAccess

PublicNetworkAccess

Se os pedidos da Rede Pública são permitidos

serviceOperationsHostName

string

Ponto final de serviço para o serviço de aprovisionamento.

state

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

IotDpsSku

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 do hub IoT.

location

string

Região arm do hub IoT.

name

string

Nome do anfitrião do hub IoT.

IpFilterActionType

A ação pretendida para pedidos capturados por esta regra.

Name Tipo Description
Accept

string

Reject

string

IpFilterRule

As regras de filtro de IP para um Serviço de aprovisionamento.

Name Tipo Description
action

IpFilterActionType

A ação pretendida para pedidos capturados por esta regra.

filterName

string

O nome da regra de filtro IP.

ipMask

string

Uma cadeia que contém o intervalo de endereços IP na notação CIDR da regra.

target

IpFilterTargetType

Destino para pedidos capturados por esta regra.

IpFilterTargetType

Destino para pedidos capturados por esta regra.

Name Tipo Description
all

string

deviceApi

string

serviceApi

string

PrivateEndpoint

A propriedade de ponto final privado de uma ligação de ponto final privado

Name Tipo Description
id

string

O identificador de recursos.

PrivateEndpointConnection

A ligação de ponto final privado de um serviço de aprovisionamento

Name Tipo Description
id

string

O identificador de recursos.

name

string

O nome do recurso.

properties

PrivateEndpointConnectionProperties

As propriedades de uma ligação de ponto final privado

systemData

systemData

Metadados relativos à criação e última modificação do recurso.

type

string

O tipo de recurso.

PrivateEndpointConnectionProperties

As propriedades de uma ligação de ponto final privado

Name Tipo Description
privateEndpoint

PrivateEndpoint

A propriedade de ponto final privado de uma ligação de ponto final privado

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

O estado atual de uma ligação de ponto final privado

PrivateLinkServiceConnectionState

O estado atual de uma ligação de ponto final privado

Name Tipo Description
actionsRequired

string

Ações necessárias para uma ligação de ponto final privado

description

string

A descrição do estado atual de uma ligação de ponto final privado

status

PrivateLinkServiceConnectionStatus

O estado de uma ligação de ponto final privado

PrivateLinkServiceConnectionStatus

O estado de uma ligação de ponto final privado

Name Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

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 de recursos.

location

string

A localização do recurso.

name

string

O nome do recurso.

properties

IotDpsPropertiesDescription

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

resourcegroup

string

O grupo de recursos do recurso.

sku

IotDpsSkuInfo

Informações de SKU para um Serviço de aprovisionamento.

subscriptionid

string

O ID da subscrição do recurso.

systemData

systemData

Metadados relativos à criação e última modificação do recurso.

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

ProvisioningServiceDescription[]

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

PublicNetworkAccess

Se os pedidos da Rede Pública são permitidos

Name Tipo Description
Disabled

string

Enabled

string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descrição da chave de acesso partilhado.

Name Tipo Description
keyName

string

Nome da chave.

primaryKey

string

Valor da chave SAS principal.

rights

AccessRightsDescription

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

systemData

Metadados relativos à criação e última modificação do recurso.

Name 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.