Compartir a través de


Iot Dps Resource - List By Resource Group

Obtenga una lista de todos los servicios de aprovisionamiento del 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 identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
path True

string

Identificador del grupo de recursos.

subscriptionId
path True

string

Identificador de la suscripción.

api-version
query True

string

La versión de la API.

Respuestas

Nombre Tipo Description
200 OK

ProvisioningServiceDescriptionListResult

Lista de servicios de aprovisionamiento en el grupo de recursos.

Other Status Codes

ErrorDetails

Respuesta de error predeterminada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

DPSListByResourceGroup

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
AccessRightsDescription

Derechos que tiene esta clave.

AllocationPolicy

Directiva de asignación que usará este servicio de aprovisionamiento.

createdByType

Tipo de identidad que creó el recurso.

ErrorDetails

Detalles del error.

IotDpsPropertiesDescription

las propiedades específicas del servicio de un servicio de aprovisionamiento, incluidas las claves, los centros de iot vinculados, el estado actual y las propiedades generadas por el sistema, como el nombre de host y idScope.

IotDpsSku

Nombre de SKU.

IotDpsSkuInfo

Lista de las posibles SKU del servicio de aprovisionamiento.

IotHubDefinitionDescription

Descripción del centro de IoT.

IpFilterActionType

La acción deseada para las solicitudes capturadas por esta regla.

IpFilterRule

Reglas de filtro IP para un servicio de aprovisionamiento.

IpFilterTargetType

Destino de las solicitudes capturadas por esta regla.

PrivateEndpoint

La propiedad de punto de conexión privado de una conexión de punto de conexión privado

PrivateEndpointConnection

Conexión de punto de conexión privado de un servicio de aprovisionamiento

PrivateEndpointConnectionProperties

Propiedades de una conexión de punto de conexión privado

PrivateLinkServiceConnectionState

Estado actual de una conexión de punto de conexión privado

PrivateLinkServiceConnectionStatus

Estado de una conexión de punto de conexión privado

ProvisioningServiceDescription

Descripción del servicio de aprovisionamiento.

ProvisioningServiceDescriptionListResult

Lista de descripciones del servicio de aprovisionamiento.

PublicNetworkAccess

Indica si se permiten solicitudes de la red pública

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descripción de la clave de acceso compartido.

state

Estado actual del servicio de aprovisionamiento.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

AccessRightsDescription

Derechos que tiene esta clave.

Nombre Tipo Description
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

AllocationPolicy

Directiva de asignación que usará este servicio de aprovisionamiento.

Nombre Tipo Description
GeoLatency

string

Hashed

string

Static

string

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Detalles del error.

Nombre Tipo Description
code

integer

Código de error.

details

string

Los detalles del error.

httpStatusCode

string

El código de estado HTTP.

message

string

El mensaje de error.

IotDpsPropertiesDescription

las propiedades específicas del servicio de un servicio de aprovisionamiento, incluidas las claves, los centros de iot vinculados, el estado actual y las propiedades generadas por el sistema, como el nombre de host y idScope.

Nombre Tipo Description
allocationPolicy

AllocationPolicy

Directiva de asignación que usará este servicio de aprovisionamiento.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Lista de claves de autorización para un servicio de aprovisionamiento.

deviceProvisioningHostName

string

Punto de conexión de dispositivo para este servicio de aprovisionamiento.

enableDataResidency

boolean

Opcional. Indica si la instancia de DPS tiene Data Residency habilitada, quitando la recuperación ante desastres entre pares geográficos.

idScope

string

Identificador único de este servicio de aprovisionamiento.

iotHubs

IotHubDefinitionDescription[]

Lista de centros de IoT asociados a este servicio de aprovisionamiento.

ipFilterRules

IpFilterRule[]

Reglas de filtro IP.

portalOperationsHostName

string

Punto de conexión del portal para habilitar CORS para este servicio de aprovisionamiento.

privateEndpointConnections

PrivateEndpointConnection[]

Conexiones de punto de conexión privado creadas en este IotHub

provisioningState

string

Estado de aprovisionamiento de ARM del servicio de aprovisionamiento.

publicNetworkAccess

PublicNetworkAccess

Indica si se permiten solicitudes de la red pública

serviceOperationsHostName

string

Punto de conexión de servicio para el servicio de aprovisionamiento.

state

state

Estado actual del servicio de aprovisionamiento.

IotDpsSku

Nombre de SKU.

Nombre Tipo Description
S1

string

IotDpsSkuInfo

Lista de las posibles SKU del servicio de aprovisionamiento.

Nombre Tipo Description
capacity

integer

Número de unidades que se van a aprovisionar

name

IotDpsSku

Nombre de SKU.

tier

string

Nombre del plan de tarifa del servicio de aprovisionamiento.

IotHubDefinitionDescription

Descripción del centro de IoT.

Nombre Tipo Description
allocationWeight

integer

peso que se va a aplicar para un iot h determinado.

applyAllocationPolicy

boolean

marca para aplicar allocationPolicy o no para un centro de IoT determinado.

connectionString

string

Cadena de conexión del centro de IoT.

location

string

Región de ARM del centro de IoT.

name

string

Nombre de host del centro de IoT.

IpFilterActionType

La acción deseada para las solicitudes capturadas por esta regla.

Nombre Tipo Description
Accept

string

Reject

string

IpFilterRule

Reglas de filtro IP para un servicio de aprovisionamiento.

Nombre Tipo Description
action

IpFilterActionType

La acción deseada para las solicitudes capturadas por esta regla.

filterName

string

Nombre de la regla de filtro IP.

ipMask

string

Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla.

target

IpFilterTargetType

Destino de las solicitudes capturadas por esta regla.

IpFilterTargetType

Destino de las solicitudes capturadas por esta regla.

Nombre Tipo Description
all

string

deviceApi

string

serviceApi

string

PrivateEndpoint

La propiedad de punto de conexión privado de una conexión de punto de conexión privado

Nombre Tipo Description
id

string

Identificador del recurso.

PrivateEndpointConnection

Conexión de punto de conexión privado de un servicio de aprovisionamiento

Nombre Tipo Description
id

string

Identificador del recurso.

name

string

Nombre del recurso.

properties

PrivateEndpointConnectionProperties

Propiedades de una conexión de punto de conexión privado

systemData

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

type

string

El tipo de recurso.

PrivateEndpointConnectionProperties

Propiedades de una conexión de punto de conexión privado

Nombre Tipo Description
privateEndpoint

PrivateEndpoint

La propiedad de punto de conexión privado de una conexión de punto de conexión privado

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Estado actual de una conexión de punto de conexión privado

PrivateLinkServiceConnectionState

Estado actual de una conexión de punto de conexión privado

Nombre Tipo Description
actionsRequired

string

Acciones necesarias para una conexión de punto de conexión privado

description

string

Descripción del estado actual de una conexión de punto de conexión privado

status

PrivateLinkServiceConnectionStatus

Estado de una conexión de punto de conexión privado

PrivateLinkServiceConnectionStatus

Estado de una conexión de punto de conexión privado

Nombre Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

ProvisioningServiceDescription

Descripción del servicio de aprovisionamiento.

Nombre Tipo Description
etag

string

El campo Etag no es obligatorio. Si se proporciona en el cuerpo de la respuesta, también se debe proporcionar como un encabezado según la convención ETag normal.

id

string

Identificador del recurso.

location

string

Ubicación del recurso.

name

string

Nombre del recurso.

properties

IotDpsPropertiesDescription

Propiedades específicas del servicio para un servicio de aprovisionamiento

resourcegroup

string

El grupo de recursos del recurso.

sku

IotDpsSkuInfo

Información de SKU para un servicio de aprovisionamiento.

subscriptionid

string

Identificador de suscripción del recurso.

systemData

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

tags

object

Etiquetas del recurso.

type

string

El tipo de recurso.

ProvisioningServiceDescriptionListResult

Lista de descripciones del servicio de aprovisionamiento.

Nombre Tipo Description
nextLink

string

vínculo siguiente

value

ProvisioningServiceDescription[]

Lista de descripciones del servicio de aprovisionamiento.

PublicNetworkAccess

Indica si se permiten solicitudes de la red pública

Nombre Tipo Description
Disabled

string

Enabled

string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descripción de la clave de acceso compartido.

Nombre Tipo Description
keyName

string

Nombre de la clave.

primaryKey

string

Valor de clave SAS principal.

rights

AccessRightsDescription

Derechos que tiene esta clave.

secondaryKey

string

Valor de clave SAS secundario.

state

Estado actual del servicio de aprovisionamiento.

Nombre 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

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).

createdBy

string

Identidad que creó el recurso.

createdByType

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy

string

Identidad que modificó por última vez el recurso.

lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.