Microsoft Azure

Microsoft Azure IndividualEnrollment API

The IndividualEnrollment API from Microsoft Azure — 4 operation(s) for individualenrollment.

Documentation GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PUT /enrollments/{id} Create or update a device enrollment record · Microsoft Azure Create Or Update A Device Enrollment Record #

Ask an LLM

“How do I enroll a single IoT device in the Device Provisioning Service?”

“Can I set the initial device twin and target IoT hubs when enrolling a device?”

Tell an agent

Create individual enrollment {id} with registration ID {registrationId} and attestation {attestation}.

Update enrollment {id} to allocate to IoT hubs {iotHubs}, only if ETag {ifMatch} matches.

POST /enrollments/query Query individual device enrollment records · Microsoft Azure Query The Device Enrollment Records #

Ask an LLM

“Which individual device enrollments match a query in my provisioning service?”

“Can I page through enrollment query results with a continuation token?”

Tell an agent

Query individual enrollments with {query}.

Run enrollment query {query} returning {pageSize} records per page.

POST /enrollments/{id}/attestationmechanism Get the attestation mechanism of a device enrollment · Microsoft Azure Get The Attestation Mechanism In The Device Enrollment Record #

Ask an LLM

“What attestation mechanism, TPM or X.509, does a device enrollment use?”

“How do I read the attestation keys or certificates on an individual enrollment?”

Tell an agent

Get the attestation mechanism for enrollment {id}.

Show how device enrollment {id} attests its identity.

POST /enrollments Run a bulk operation on up to 10 device enrollments · Microsoft Azure Bulk Device Enrollment Operation With Maximum Of 10 Enrollments #

Ask an LLM

“Can I create or delete several individual enrollments in one request?”

“What is the maximum number of enrollments per bulk operation?”

Tell an agent

Apply bulk operation mode {mode} to enrollments {enrollments}.

Submit up to ten device enrollments {enrollments} in one bulk {mode} request.

Documentation

https://learn.microsoft.com/en-us/rest/api/azure/

https://learn.microsoft.com/en-us/azure/role-based-access-control/

https://learn.microsoft.com/en-us/rest/api/monitor/action-groups?view=rest-monitor-2021-09-01

https://learn.microsoft.com/en-us/entra/identity/

https://learn.microsoft.com/en-us/rest/api/monitor/activity-log-alerts?view=rest-monitor-2020-10-01

https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/whatis-azure-ad-connect

https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types

https://azuremarketplace.microsoft.com/en-us/marketplace/apps/robomq.adptoad?tab=overview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.advisor-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.agfoodplatform-readme?view=azure-dotnet-preview

https://azure.microsoft.com/en-us/products/data-manager-for-agriculture

https://learn.microsoft.com/en-us/azure/ai-services/translator/

https://learn.microsoft.com/en-us/azure/azure-health-insights/

https://learn.microsoft.com/en-us/azure/azure-monitor/alerts/alerts-overview

https://learn.microsoft.com/en-us/azure/analysis-services/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/analytics.purview.datamap-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/azure/ai-services/anomaly-detector/

https://learn.microsoft.com/en-us/azure/api-center/

https://learn.microsoft.com/en-us/azure/azure-monitor/scom-manage-instance/overview

https://learn.microsoft.com/en-us/azure/api-management/

https://learn.microsoft.com/en-us/rest/api/apimanagement/

https://learn.microsoft.com/en-us/microsoft-365-app-certification/docs/acat-overview

https://learn.microsoft.com/en-us/azure/azure-app-configuration/

https://learn.microsoft.com/en-us/azure/app-service/

https://learn.microsoft.com/en-us/rest/api/appservice/app-service-certificate-orders/get?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/app-service/environment/

https://learn.microsoft.com/en-us/rest/api/appservice/app-service-plans?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/

https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app

https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview

https://learn.microsoft.com/en-us/cli/azure/monitor/app-insights/component/linked-storage?view=azure-cli-latest

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.applicationinsights-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/azure-arc/

https://learn.microsoft.com/en-us/azure/governance/resource-graph/

https://learn.microsoft.com/en-us/azure/devops/artifacts/?view=azure-devops

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/security.attestation-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/attestation/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.authorization-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/python/api/azure-cognitiveservices-search-autosuggest/azure.cognitiveservices.search.autosuggest.autosuggestclient?view=azure-python-preview

https://learn.microsoft.com/en-us/azure/automanage/

https://learn.microsoft.com/en-us/azure/automation/

https://learn.microsoft.com/en-us/azure/backup/

https://learn.microsoft.com/en-us/azure/baremetal-infrastructure/

https://learn.microsoft.com/en-us/azure/batch/

https://learn.microsoft.com/en-us/azure/ai-services/translator/document-translation/quickstarts/client-library-sdks

https://learn.microsoft.com/en-us/azure/ai-services/speech-service/batch-synthesis

https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.billingbenefits-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/azure/cost-management-billing/

https://learn.microsoft.com/en-us/azure/storage/blobs/

https://learn.microsoft.com/en-us/archive/msdn-magazine/2018/june/blockchain-introducing-azure-blockchain-workbench

https://learn.microsoft.com/en-us/azure/governance/blueprints/

https://learn.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0

https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles

https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/scenarios/cloud-scale-analytics/govern-metadata-standards

https://learn.microsoft.com/en-us/azure/carbon-optimization/view-emissions

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.cdn-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/web-application-firewall/

https://learn.microsoft.com/en-us/rest/api/appservice/certificate-orders-diagnostics?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates-for-clients

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.changeanalysis-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-changes-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/azure/chaos-studio/

https://learn.microsoft.com/en-us/rest/api/policy/policy-restrictions?view=rest-policy-2023-03-01

https://learn.microsoft.com/en-us/azure/cloud-shell/overview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.trustedsigning-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.cognitiveservices-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/cognitiveservices/

https://learn.microsoft.com/en-us/python/api/overview/azure/commerce?view=azure-python

https://learn.microsoft.com/en-us/azure/azure-monitor/alerts/alerts-types

https://learn.microsoft.com/en-us/azure/search/search-blob-metadata-properties

https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/considerations/fundamental-concepts

https://learn.microsoft.com/en-us/azure/sentinel/entities-reference

https://learn.microsoft.com/en-us/dynamics365/field-service/configure-incident-types

https://learn.microsoft.com/en-us/azure/azure-monitor/

https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/parameter-files

https://learn.microsoft.com/en-us/azure/storage/tables/table-storage-design-modeling

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.operationalinsights-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/virtual-machines/share-gallery-community

https://learn.microsoft.com/en-us/rest/api/policy/component-policy-states?view=rest-policy-2022-04-01

https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles/compute

https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/

https://learn.microsoft.com/en-us/azure/virtual-network-manager/concept-connectivity-configuration

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.appcontainers-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/containerapps/

https://learn.microsoft.com/en-us/azure/container-apps/revisions-manage

https://learn.microsoft.com/en-us/azure/containers/

https://learn.microsoft.com/en-us/azure/templates/microsoft.containerservice/fleets

https://learn.microsoft.com/en-us/azure/ai-services/content-moderator/

https://learn.microsoft.com/en-us/azure/ai-services/content-safety/

https://learn.microsoft.com/en-us/azure/cosmos-db/postgresql/

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cognitiveservices.search.customimagesearch.customimagesearchclient?view=azure-dotnet

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/search.documents-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/ai-services/custom-vision-service/

https://learn.microsoft.com/en-us/rest/api/speech/

https://learn.microsoft.com/en-us/rest/api/storageservices/data-lake-storage-gen2

https://learn.microsoft.com/en-us/rest/api/data-manager-for-agri/

https://learn.microsoft.com/en-us/azure/dms/

https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/control-plane-and-data-plane

https://learn.microsoft.com/en-us/azure/defender-for-cloud/data-sensitivity-settings

https://learn.microsoft.com/en-us/azure/databox/

https://learn.microsoft.com/en-us/rest/api/sql/database-threat-detection-policies/get?view=rest-sql-2014-04-01

https://learn.microsoft.com/en-us/azure/external-attack-surface-management/

https://learn.microsoft.com/en-us/azure/storage/files/

https://learn.microsoft.com/en-us/rest/api/appservice/web-apps/delete?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/deployment-script-template

https://learn.microsoft.com/en-us/azure/deployment-environments/

https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/deployment-stacks

https://learn.microsoft.com/en-us/azure/iot-dps/

https://learn.microsoft.com/en-us/azure/api-management/diagnostic-logs-reference

https://learn.microsoft.com/en-us/azure/ai-services/document-intelligence/?view=doc-intel-4.0.0

https://learn.microsoft.com/en-us/azure/iot-edge/?view=iotedge-1.5

https://learn.microsoft.com/en-us/shows/azure-cosmos-db-conf-2022/creating-enterprise-knowledge-graphs-from-unstructured-data

https://learn.microsoft.com/en-us/python/api/azureml-core/azureml.core.experiment.experiment?view=azure-ml-py

https://learn.microsoft.com/en-us/azure/expressroute/cross-connections-api-development

https://learn.microsoft.com/en-us/fabric/admin/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/ai.vision.face-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.management.resourcemanager.fluent.featureclient?view=azure-dotnet-legacy

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/ai.formrecognizer-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/virtual-machines/azure-compute-gallery

https://learn.microsoft.com/en-us/rest/api/monitor/diagnostic-settings?view=rest-monitor-2021-05-01-preview

https://learn.microsoft.com/en-us/azure/templates/microsoft.insights/guestdiagnosticsettingsassociation

https://learn.microsoft.com/en-us/azure/hdinsight-aks/

https://docs.citusdata.com/en/v9.2/portals/citus_cloud.html

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cognitiveservices.search.imagesearch.imagesearchclient?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/data-collection-rule-overview

https://learn.microsoft.com/en-us/azure/integration-environments/create-integration-environment

https://learn.microsoft.com/en-us/azure/hdinsight/kafka/rest-proxy

https://learn.microsoft.com/en-us/rest/api/appservice/kube-environments/create-or-update?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.kusto-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/azure-large-instances/what-is-azure-large-instances

https://learn.microsoft.com/en-us/azure/azure-monitor/app/live-stream

https://learn.microsoft.com/en-us/dotnet/api/azure.search.documents.searchclient?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-overview

https://learn.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-tutorial

https://learn.microsoft.com/en-us/azure/azure-monitor/logs/query-packs

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.logic-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/ai-services/luis/client-libraries-rest-api

https://learn.microsoft.com/en-us/azure/azure-resource-manager/managed-applications/

https://learn.microsoft.com/en-us/azure/azure-managed-lustre/

https://learn.microsoft.com/en-us/azure/synapse-analytics/security/synapse-workspace-managed-private-endpoints

https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-links-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.management.resourcemanager.managementlockclient?view=azure-dotnet-legacy

https://learn.microsoft.com/en-us/azure/azure-maps/how-to-create-data-registries

https://learn.microsoft.com/en-us/azure/azure-maps/how-to-use-feedback-tool

https://learn.microsoft.com/en-us/azure/azure-maps/

https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tileset?view=rest-maps-2024-04-01

https://learn.microsoft.com/en-us/rest/api/maps/timezone?view=rest-maps-2024-04-01

https://learn.microsoft.com/en-us/azure/azure-maps/how-to-creator-wayfinding

https://learn.microsoft.com/en-us/azure/azure-maps/how-to-request-weather-data

https://learn.microsoft.com/en-us/partner-center/marketplace-offers/create-new-saas-offer

https://learn.microsoft.com/sr-cyrl-rs/azure/media-services/latest/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.media-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/ai-services/metrics-advisor/

https://learn.microsoft.com/en-us/azure/ai-services/language-service/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/ai.language.conversations-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/language/text-analysis-authoring/import?view=rest-language-2023-04-01

https://azure.microsoft.com/en-us/products/ai-services/question-answering

https://learn.microsoft.com/en-us/azure/defender-for-cloud/

https://learn.microsoft.com/en-us/rest/api/application-insights/

https://learn.microsoft.com/en-us/rest/api/marketplacecatalog/dataplane/reviews/get?view=rest-marketplacecatalog-dataplane-2023-01-01-preview&tabs=HTTP

https://learn.microsoft.com/en-us/azure/azure-netapp-files/

https://learn.microsoft.com/en-us/azure/playwright-testing/how-to-manage-authentication

https://azure.microsoft.com/en-us/products/ai-services/ai-document-intelligence

https://learn.microsoft.com/en-us/azure/defender-for-cloud/azure-devops-extension

https://learn.microsoft.com/en-us/azure/sentinel/upload-indicators-api

https://learn.microsoft.com/en-us/troubleshoot/azure/virtual-machines/windows/serial-console-windows

https://learn.microsoft.com/en-us/azure/templates/microsoft.servicelinker/linkers

https://learn.microsoft.com/en-us/azure/container-instances/container-instances-standby-pool-overview

https://learn.microsoft.com/en-us/azure/storage/file-sync/

https://learn.microsoft.com/en-us/rest/api/mobilepacketcore/

https://azure.microsoft.com/en-us/products/azure-network-function-manager

https://learn.microsoft.com/en-us/azure/network-watcher/traffic-analytics

https://learn.microsoft.com/en-us/azure/service-health/resource-health-overview

https://learn.microsoft.com/en-us/azure/security/

https://learn.microsoft.com/en-us/azure/migrate/

https://learn.microsoft.com/en-us/rest/api/migrate/

https://learn.microsoft.com/en-us/java/api/com.azure.mixedreality.remoterendering?view=azure-java-stable

https://learn.microsoft.com/en-us/java/api/com.azure.mixedreality.authentication.mixedrealitystsclient?view=azure-java-stable

https://learn.microsoft.com/en-us/rest/api/monitor/

https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/data-collection-endpoint-overview

https://learn.microsoft.com/en-us/rest/api/monitor/data-collection-rule-associations?view=rest-monitor-2023-03-11

https://learn.microsoft.com/en-us/rest/api/monitor/data-collection-rules?view=rest-monitor-2023-03-11

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.monitormanagementclient?view=azure-python

https://learn.microsoft.com/en-us/azure/batch/monitor-batch

https://learn.microsoft.com/en-us/rest/api/monitor/metrics?view=rest-monitor-2023-10-01

https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions?view=rest-monitor-2023-10-01

https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/monitor-resource-manager

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.sql-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/virtual-network-manager/

https://learn.microsoft.com/en-us/azure/networking/

https://learn.microsoft.com/en-us/azure/virtual-network/network-security-groups-overview

https://learn.microsoft.com/en-us/azure/virtual-network-manager/concept-network-groups

https://learn.microsoft.com/en-us/azure/private-link/network-security-perimeter-concepts

https://docs.newrelic.com/docs/infrastructure/microsoft-azure-integrations/get-started/introduction-azure-monitoring-integrations/

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cognitiveservices.search.newssearch.newssearchclient?view=azure-dotnet

https://docs.nginx.com/nginx/deployment-guides/microsoft-azure/

https://learn.microsoft.com/en-us/azure/notification-hubs/

https://azure.microsoft.com/en-us/products/spring-apps

https://learn.microsoft.com/en-us/azure/ai-services/openai/

https://learn.microsoft.com/en-us/azure/ai-services/openai/reference

https://learn.microsoft.com/en-us/azure/ai-services/openai/overview

https://learn.microsoft.com/en-us/azure/ai-services/openai/reference-preview

https://learn.microsoft.com/en-us/azure/ai-services/openai/api-version-deprecation

https://learn.microsoft.com/en-us/azure/ai-services/openai/reference

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-oep-readme?view=azure-node-preview

https://learn.microsoft.com/en-us/azure/orbital/

https://docs.paloaltonetworks.com/cloud-ngfw/azure

https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.peering-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/ai-services/personalizer/

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-playwrighttesting-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/azure/governance/policy/

https://learn.microsoft.com/en-us/azure/governance/policy/concepts/event-overview

https://learn.microsoft.com/en-us/rest/api/policy/

https://learn.microsoft.com/en-us/azure/governance/policy/concepts/definition-structure-basics

https://learn.microsoft.com/en-us/azure/governance/policy/overview

https://learn.microsoft.com/en-us/azure/azure-portal/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.postgresql-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-powerbiembedded-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-powerbidedicated-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/power-platform/

https://learn.microsoft.com/en-us/azure/ai-services/custom-vision-service/use-prediction-api

https://learn.microsoft.com/en-us/azure/private-link/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.privatedns-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/private-link/private-endpoint-overview

https://learn.microsoft.com/en-us/power-bi/enterprise/service-security-private-links-on-premises

https://azure.microsoft.com/en-us/products/programmable-connectivity

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.providerhub-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/purview/

https://learn.microsoft.com/en-us/purview/legacy/concept-policies-devops

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.purview-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis

https://learn.microsoft.com/en-us/purview/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/analytics.purview.sharing-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/purview/legacy/concept-workflow

https://learn.microsoft.com/en-us/azure/ai-services/qnamaker/

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cognitiveservices.knowledge.qnamaker.runtime?view=azure-dotnet-legacy

https://learn.microsoft.com/en-us/azure/quantum/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.quantum-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/azure/storage/queues/

https://learn.microsoft.com/en-us/rest/api/quota/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/recovery-services?view=azure-dotnet

https://docs.openshift.com/aro/4/welcome/index.html

https://learn.microsoft.com/en-us/azure/openshift/

https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.redisenterprise-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/relay/

https://learn.microsoft.com/en-us/mem/intune/fundamentals/remediations

https://learn.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-apis

https://learn.microsoft.com/en-us/rest/api/appservice/resource-health-metadata/list?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/azure-resource-manager/

https://learn.microsoft.com/en-us/rest/api/resources/

https://learn.microsoft.com/en-us/azure/resource-mover/

https://learn.microsoft.com/en-us/azure/virtual-network/virtual-networks-udr-overview

https://learn.microsoft.com/en-us/azure/virtual-machines/windows/run-command

https://learn.microsoft.com/en-us/rest/api/monitor/scheduled-query-rules?view=rest-monitor-2021-08-01

https://learn.microsoft.com/en-us/azure/scheduler/

https://learn.microsoft.com/en-us/azure/event-hubs/schema-registry-overview

https://learn.microsoft.com/en-us/rest/api/networkmanager/scope-connections/create-or-update?view=rest-networkmanager-2023-11-01

https://github.com/Azure/service-fabric-issues/issues/1021

https://learn.microsoft.com/en-us/python/api/azure-search-documents/azure.search.documents.indexes.searchindexclient?view=azure-python

https://learn.microsoft.com/en-us/python/api/azure-mgmt-search/azure.mgmt.search.searchmanagementclient?view=azure-python

https://learn.microsoft.com/en-us/azure/search/

https://learn.microsoft.com/en-us/azure/compliance/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.securityinsights-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/service-bus-messaging/

https://learn.microsoft.com/en-us/rest/api/servicebus/

https://learn.microsoft.com/en-us/rest/api/servicefabric/sfclient-index

https://learn.microsoft.com/en-us/azure/service-fabric/

https://learn.microsoft.com/en-us/azure/virtual-machines/share-gallery-direct

https://learn.microsoft.com/en-us/azure/virtual-machines/shared-image-galleries

https://learn.microsoft.com/en-us/azure/azure-signalr/

https://learn.microsoft.com/en-us/azure/site-recovery/

https://learn.microsoft.com/en-us/rest/api/site-recovery/

https://learn.microsoft.com/en-us/azure/virtual-machines/snapshot-copy-managed-disk

https://learn.microsoft.com/en-us/python/api/azure-synapse-spark/azure.synapse.spark.sparkclient?view=azure-python-preview

https://learn.microsoft.com/en-us/rest/api/speakerrecognition/

https://learn.microsoft.com/en-us/azure/ai-services/speech-service/

https://learn.microsoft.com/en-us/azure/ai-services/speech-service/rest-speech-to-text

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cognitiveservices.language.spellcheck.spellcheckclient?view=azure-dotnet

https://learn.microsoft.com/en-us/azure-sphere/?view=azure-sphere-integrated

https://learn.microsoft.com/en-us/azure/azure-sql/?view=azuresql

https://learn.microsoft.com/en-us/rest/api/sql/

https://learn.microsoft.com/en-us/azure/azure-sql/database/automated-backups-overview?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/dynamic-data-masking-overview?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/disaster-recovery-guidance?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/database-import-export-private-link?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/replication-to-sql-database?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/firewall-configure?view=azuresql

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.sqlvirtualmachine-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure-stack/

https://docs.azure.cn/en-us/azure-stack/hci/

https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/get-static-site?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/storsimple/

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-storsimple8000series-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/azure/storage/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.storageactions-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.storagecache-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/import-export/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.storage-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/storage-mover/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.storagepool-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/stream-analytics/

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-subscriptions-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/landing-zone/design-area/resource-org-subscriptions

https://learn.microsoft.com/en-us/python/api/azure-mgmt-synapse/azure.mgmt.synapse.synapsemanagementclient?view=azure-python

https://learn.microsoft.com/en-us/azure/synapse-analytics/sql/connect-overview

https://learn.microsoft.com/en-us/microsoft-365/syntex/

https://learn.microsoft.com/en-us/system-center/vmm/?view=sc-vmm-2025

https://learn.microsoft.com/en-us/azure/data-factory/control-flow-get-metadata-activity

https://learn.microsoft.com/en-us/rest/api/chaosstudio/target-types/list?view=rest-chaosstudio-2024-01-01

https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/template-specs

https://learn.microsoft.com/en-us/azure/azure-monitor/alerts/action-groups

https://learn.microsoft.com/en-us/azure/azure-monitor/alerts/alerts-create-activity-log-alert-rule

https://learn.microsoft.com/en-us/microsoft-365/test-base/overview?view=o365-worldwide

https://learn.microsoft.com/en-us/python/api/overview/azure/ai-textanalytics-readme?view=azure-python

https://learn.microsoft.com/en-us/azure/time-series-insights/

https://learn.microsoft.com/en-us/rest/api/appservice/top-level-domains/list?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/expressroute/traffic-collector

https://learn.microsoft.com/en-us/azure/traffic-manager/

https://learn.microsoft.com/en-us/azure/update-manager/overview

https://learn.microsoft.com/en-us/azure/update-manager/manage-vms-programmatically

https://learn.microsoft.com/en-us/rest/api/consumption/

https://learn.microsoft.com/en-us/azure/azure-video-indexer/

https://learn.microsoft.com/en-us/javascript/api/@azure/video-analyzer-edge/?view=azure-node-legacy

https://learn.microsoft.com/en-us/azure/virtual-wan/

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-visualstudio-readme?view=azure-node-preview

https://learn.microsoft.com/en-us/azure/azure-monitor/vm/vminsights-overview

https://learn.microsoft.com/en-us/azure/azure-vmware/

https://learn.microsoft.com/en-us/rest/api/avs/

https://learn.microsoft.com/en-us/azure/virtual-network/

https://learn.microsoft.com/en-us/azure/communications-gateway/provisioning-platform

https://learn.microsoft.com/en-us/rest/api/voiceservices/

https://learn.microsoft.com/en-us/azure/azure-web-pubsub/

https://learn.microsoft.com/en-us/rest/api/webpubsub/

https://learn.microsoft.com/en-us/python/api/azure-mgmt-web/azure.mgmt.web.websitemanagementclient?view=azure-python

https://learn.microsoft.com/en-us/lifecycle/faq/extended-security-updates

https://learn.microsoft.com/en-us/azure/azure-monitor/visualize/workbooks-overview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.workloads-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/containerregistry/

https://azure.microsoft.com/en-us/products/container-registry

https://learn.microsoft.com/en-us/rest/api/aks/

https://azure.microsoft.com/en-us/products/kubernetes-service

https://learn.microsoft.com/en-us/rest/api/cosmos-db/

https://learn.microsoft.com/en-us/rest/api/cosmos-db-resource-provider/

https://azure.microsoft.com/en-us/products/cosmos-db

https://learn.microsoft.com/en-us/rest/api/resources/

https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resources-rest

https://learn.microsoft.com/en-us/rest/api/cognitiveservices/

https://learn.microsoft.com/en-us/rest/api/keyvault/

https://azure.microsoft.com/en-us/products/key-vault

Specifications

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-individualenrollment-api-openapi.yml

Other Resources

https://azure.microsoft.com/en-us/pricing/details/api-management/

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-blob-storage-context.jsonld

https://azure.microsoft.com/en-us/pricing/details/azure-openai/

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-openai-service-context.jsonld

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-container-registry-context.jsonld

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-kubernetes-service-context.jsonld

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-cosmos-db-context.jsonld

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-resource-manager-context.jsonld

https://azure.microsoft.com/en-us/pricing/details/cognitive-services/

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-cognitive-services-context.jsonld

https://azure.microsoft.com/en-us/pricing/details/key-vault/

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-key-vault-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure:microsoft-azure-individualenrollment-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '2021-10-01'
  title: Microsoft Azure ProvisioningServiceClient Individual…
  description: API for service operations with the Azure IoT Hub Device Provisioning Service
servers:
- url: https://your-dps.azure-devices-provisioning.net
tags:
- name: IndividualEnrollment
paths:
  /enrollments/{id}:
    put:
      tags:
      - IndividualEnrollment
      summary: Microsoft Azure Create Or Update A Device Enrollment Record
      operationId: microsoftAzureIndividualenrollmentCreateorupdate
      parameters:
      - name: id
        in: path
        description: 'This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end.'
        required: true
        schema:
          type: string
      - name: If-Match
        in: header
        description: The ETag of the enrollment record.
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndividualEnrollment'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndividualEnrollment'
        description: The device enrollment record.
        required: true
  /enrollments/query:
    post:
      tags:
      - IndividualEnrollment
      summary: Microsoft Azure Query The Device Enrollment Records
      operationId: microsoftAzureIndividualenrollmentQuery
      parameters:
      - name: x-ms-max-item-count
        in: header
        description: Page size
        required: false
        schema:
          type: integer
          format: int32
      - name: x-ms-continuation
        in: header
        description: Continuation token
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          headers:
            x-ms-continuation:
              description: The continuation token for getting the next page of results.
              schema:
                type: string
            x-ms-max-item-count:
              description: The maximum number of items returned in a page.
              schema:
                type: integer
            x-ms-item-type:
              description: The list of values returned from the query.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndividualEnrollment'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuerySpecification'
        description: The query specification.
        required: true
  /enrollments/{id}/attestationmechanism:
    post:
      tags:
      - IndividualEnrollment
      summary: Microsoft Azure Get The Attestation Mechanism In The Device Enrollment Record
      operationId: microsoftAzureIndividualenrollmentGetattestationmechanism
      parameters:
      - name: id
        in: path
        description: 'This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end.'
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttestationMechanism'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
  /enrollments:
    post:
      tags:
      - IndividualEnrollment
      summary: Microsoft Azure Bulk Device Enrollment Operation With Maximum Of 10 Enrollments
      operationId: microsoftAzureIndividualenrollmentRunbulkoperation
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkEnrollmentOperationResult'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkEnrollmentOperation'
        description: Bulk operation.
        required: true
components:
  schemas:
    BulkEnrollmentOperationResult:
      description: Results of a bulk enrollment operation
      required:
      - isSuccessful
      type: object
      properties:
        errors:
          description: Registration errors
          type: array
          items:
            $ref: '#/components/schemas/BulkEnrollmentOperationError'
        isSuccessful:
          description: Indicates if the operation was successful in its entirety.
          type: boolean
    ProvisioningServiceErrorDetails:
      description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service.
      type: object
      properties:
        errorCode:
          format: int32
          type: integer
        trackingId:
          type: string
        message:
          type: string
        info:
          type: object
          additionalProperties:
            type: string
        timestampUtc:
          format: date-time
          type: string
    X509Attestation:
      description: Attestation via X509.
      type: object
      properties:
        clientCertificates:
          $ref: '#/components/schemas/X509Certificates'
        signingCertificates:
          $ref: '#/components/schemas/X509Certificates'
        caReferences:
          $ref: '#/components/schemas/X509CAReferences'
    TpmAttestation:
      description: Attestation via TPM.
      required:
      - endorsementKey
      type: object
      properties:
        endorsementKey:
          type: string
        storageRootKey:
          type: string
    CustomAllocationDefinition:
      description: This tells DPS which webhook to call when using custom allocation.
      required:
      - webhookUrl
      - apiVersion
      type: object
      properties:
        webhookUrl:
          description: The webhook URL used for allocation requests.
          type: string
        apiVersion:
          description: 'The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview".'
          type: string
    SymmetricKeyAttestation:
      description: Attestation via SymmetricKey.
      type: object
      properties:
        primaryKey:
          description: Primary symmetric key.
          type: string
        secondaryKey:
          description: Secondary symmetric key.
          type: string
    X509CertificateWithInfo:
      description: Certificate and Certificate info
      type: object
      properties:
        certificate:
          type: string
        info:
          $ref: '#/components/schemas/X509CertificateInfo'
    ReprovisionPolicy:
      description: The behavior of the service when a device is re-provisioned to an IoT hub.
      required:
      - updateHubAssignment
      - migrateDeviceData
      type: object
      properties:
        updateHubAssignment:
          description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub.
          default: true
          type: boolean
        migrateDeviceData:
          description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list.
          default: true
          type: boolean
    X509Certificates:
      description: Primary and secondary certificates
      type: object
      properties:
        primary:
          $ref: '#/components/schemas/X509CertificateWithInfo'
        secondary:
          $ref: '#/components/schemas/X509CertificateWithInfo'
    BulkEnrollmentOperation:
      description: Bulk enrollment operation.
      required:
      - enrollments
      - mode
      type: object
      properties:
        enrollments:
          description: Enrollment items
          type: array
          items:
            $ref: '#/components/schemas/IndividualEnrollment'
        mode:
          description: Operation mode.
          enum:
          - create
          - update
          - updateIfMatchETag
          - delete
          type: string
    AttestationMechanism:
      description: Attestation mechanism for individualEnrollment as well as enrollmentGroup.
      required:
      - type
      type: object
      properties:
        type:
          description: Attestation Type.
          enum:
          - none
          - tpm
          - x509
          - symmetricKey
          type: string
        tpm:
          $ref: '#/components/schemas/TpmAttestation'
          description: TPM attestation method.
        x509:
          $ref: '#/components/schemas/X509Attestation'
          description: X509 attestation method.
        symmetricKey:
          $ref: '#/components/schemas/SymmetricKeyAttestation'
          description: Symmetric Key attestation method.
    X509CertificateInfo:
      description: X509 certificate info.
      required:
      - subjectName
      - sha1Thumbprint
      - sha256Thumbprint
      - issuerName
      - notBeforeUtc
      - notAfterUtc
      - serialNumber
      - version
      type: object
      properties:
        subjectName:
          type: string
        sha1Thumbprint:
          type: string
        sha256Thumbprint:
          type: string
        issuerName:
          type: string
        notBeforeUtc:
          format: date-time
          type: string
        notAfterUtc:
          format: date-time
          type: string
        serialNumber:
          type: string
        version:
          format: int32
          type: integer
    BulkEnrollmentOperationError:
      description: Bulk enrollment operation error
      required:
      - registrationId
      - errorCode
      - errorStatus
      type: object
      properties:
        registrationId:
          description: 'This id is used to uniquely identify a device registration of an enrollment.

            A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end.'
          type: string
        errorCode:
          format: int32
          description: Error code
          type: integer
        errorStatus:
          description: Error status.
          type: string
    X509CAReferences:
      description: Primary and secondary CA references.
      type: object
      properties:
        primary:
          type: string
        secondary:
          type: string
    Metadata:
      description: Metadata for the TwinCollection
      type: object
      properties:
        lastUpdated:
          format: date-time
          description: Last time the TwinCollection was updated
          type: string
        lastUpdatedVersion:
          format: int64
          description: This is null for reported properties metadata and is not null for desired properties metadata.
          type: integer
    QuerySpecification:
      required:
      - query
      type: object
      properties:
        query:
          type: string
    IndividualEnrollment:
      description: The device enrollment record.
      required:
      - registrationId
      - attestation
      type: object
      properties:
        registrationId:
          description: 'This id is used to uniquely identify a device registration of an enrollment.

            A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end.'
          type: string
        deviceId:
          description: Desired IoT Hub device ID (optional).
          type: string
        registrationState:
          $ref: '#/components/schemas/DeviceRegistrationState'
          description: Current registration status.
          readOnly: true
        optionalDeviceInformation:
          $ref: '#/components/schemas/TwinCollection'
          description: Optional Device Information.
        attestation:
          $ref: '#/components/schemas/AttestationMechanism'
          description: Attestation method used by the device.
        capabilities:
          $ref: '#/components/schemas/DeviceCapabilities'
          description: Capabilities of the device.
        iotHubHostName:
          description: The Iot Hub host name.
          type: string
        initialTwin:
          $ref: '#/components/schemas/InitialTwin'
          description: Initial device twin.
        etag:
          description: The entity tag associated with the resource.
          type: string
        provisioningStatus:
          description: The provisioning status.
          default: enabled
          enum:
          - enabled
          - disabled
          type: string
        reprovisionPolicy:
          $ref: '#/components/schemas/ReprovisionPolicy'
          description: The behavior when a device is re-provisioned to an IoT hub.
        createdDateTimeUtc:
          format: date-time
          description: The DateTime this resource was created.
          type: string
          readOnly: true
        lastUpdatedDateTimeUtc:
          format: date-time
          description: The DateTime this resource was last updated.
          type: string
          readOnly: true
        allocationPolicy:
          description: 'The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include ''hashed'': Linked IoT hubs are equally likely to have devices provisioned to them, ''geoLatency'':  Devices are provisioned to an IoT hub with the lowest latency to the device.If multiple linked IoT hubs would provide the same lowest latency, the provisioning service hashes devices across those hubs, ''static'' : Specification of the desired IoT hub in the enrollment list takes priority over the service-level allocation policy, ''custom'': Devices are provisioned to an IoT hub based on your own custom logic. The provisioning service passes information about the device to the logic, and the logic returns the desired IoT hub as well as the desired initial configuration. We recommend using Azure Functions to host your logic.'
          enum:
          - hashed
          - geoLatency
          - static
          - custom
          type: string
        iotHubs:
          description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs.
          type: array
          items:
            type: string
        customAllocationDefinition:
          $ref: '#/components/schemas/CustomAllocationDefinition'
          description: This tells DPS which webhook to call when using custom allocation.
    DeviceRegistrationState:
      description: Device registration state.
      type: object
      properties:
        registrationId:
          description: 'This id is used to uniquely identify a device registration of an enrollment.

            A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end.'
          type: string
          readOnly: true
        createdDateTimeUtc:
          format: date-time
          description: Registration create date time (in UTC).
          type: string
          readOnly: true
        assignedHub:
          description: Assigned Azure IoT Hub.
          type: string
          readOnly: true
        deviceId:
          description: Device ID.
          type: string
          readOnly: true
        status:
          description: Enrollment status.
          enum:
          - unassigned
          - assigning
          - assigned
          - failed
          - disabled
          type: string
          readOnly: true
        substatus:
          description: 'Substatus for ''Assigned'' devices. Possible values include - ''initialAssignment'': Device has been assigned to an IoT hub for the first time, ''deviceDataMigrated'': Device has been assigned to a different IoT hub and its device data was migrated from the previously assigned IoT hub. Device data was removed from the previously assigned IoT hub, ''deviceDataReset'':  Device has been assigned to a different IoT hub and its device data was populated from the initial state stored in the enrollment. Device data was removed from the previously assigned IoT hub, ''reprovisionedToInitialAssignment'': Device has been re-provisioned to a previously assigned IoT hub.'
          enum:
          - initialAssignment
          - deviceDataMigrated
          - deviceDataReset
          - reprovisionedToInitialAssignment
          type: string
          readOnly: true
        errorCode:
          format: int32
          description: Error code.
          type: integer
          readOnly: true
        errorMessage:
          description: Error message.
          type: string
          readOnly: true
        lastUpdatedDateTimeUtc:
          format: date-time
          description: Last updated date time (in UTC).
          type: string
          readOnly: true
        etag:
          description: The entity tag associated with the resource.
          type: string
          readOnly: true
        payload:
          description: Custom allocation payload returned from the webhook to the device.
          type: object
          readOnly: true
    InitialTwinProperties:
      description: Represents the initial properties that will be set on the device twin.
      type: object
      properties:
        desired:
          $ref: '#/components/schemas/TwinCollection'
          description: Gets and sets the InitialTwin desired properties.
    DeviceCapabilities:
      description: Device capabilities.
      required:
      - iotEdge
      type: object
      properties:
        iotEdge:
          description: If set to true, this device is an IoTEdge device.
          default: false
          type: boolean
    InitialTwin:
      description: Initial device twin. Contains a subset of the properties of Twin.
      type: object
      properties:
        tags:
          $ref: '#/components/schemas/TwinCollection'
          description: Twin tags.
        properties:
          $ref: '#/components/schemas/InitialTwinProperties'
          description: Twin desired properties.
    TwinCollection:
      description: Represents a collection of properties within a Twin
      type: object
      properties:
        version:
          format: int64
          description: Version of the TwinCollection
          type: integer
        count:
          description: Number of properties in the TwinCollection
          type: integer
        metadata:
          $ref: '#/components/schemas/Metadata'
          description: Metadata for the TwinCollection
      additionalProperties:
        type: object
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: 'The API version to use for the request. Supported versions include: 2021-10-01'
      required: true
      schema:
        type: string
        default: '2021-10-01'