Microsoft Azure GET API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes
19 operations
across 19 paths,
and defines 73 schemas.
It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
The identity and technical contract details declared by the specification.
PrivateLinkResources
object
The available private link resources for an IotHub
1 property
EndpointHealthDataListResult
object
The JSON-serialized array of EndpointHealthData objects with a next link.
2 properties
GroupIdInformation
object
The group information for creating a private endpoint on an IotHub
4 properties
1 required
DeviceRegistrationState
object
Device registration state.
11 properties
RoutingServiceBusQueueEndpointProperties
object
The properties related to service bus queue endpoint types.
9 properties
1 required
PrivateLinkServiceConnectionState
object
The current state of a private endpoint connection
3 properties
2 required
GroupIdInformationProperties
object
The properties for a group information object
3 properties
ErrorDetails
object
Error details.
4 properties
IotHubDescriptionListResult
object
The JSON-serialized array of IotHubDescription objects with a next link.
2 properties
UserSubscriptionQuota
object
User subscription quota response
6 properties
InitialTwinProperties
object
Represents the initial properties that will be set on the device twin.
1 property
IotHubCapacity
object
IoT Hub capacity information.
4 properties
ArmUserIdentity
object
2 properties
RoutingServiceBusTopicEndpointProperties
object
The properties related to service bus topic endpoint types.
9 properties
1 required
X509CertificateWithInfo
object
Certificate and Certificate info
2 properties
CustomAllocationDefinition
object
This tells DPS which webhook to call when using custom allocation.
2 properties
2 required
PrivateEndpointConnectionProperties
object
The properties of a private endpoint connection
2 properties
1 required
EnrichmentProperties
object
The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.
3 properties
3 required
RoutingEventHubProperties
object
The properties related to an event hub endpoint.
9 properties
1 required
FallbackRouteProperties
object
The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.
5 properties
3 required
NetworkRuleSetIpRule
object
IP Rule to be applied as part of Network Rule Set
3 properties
2 required
IotHubProperties
object
The properties of an IoT hub.
26 properties
EnrollmentGroup
object
Enrollment group record.
13 properties
2 required
ProvisioningServiceErrorDetails
object
Contains the properties of an error returned by the Azure IoT Hub Provisioning Service.
5 properties
EventHubProperties
object
The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
5 properties
RegistryStatistics
object
Identity registry statistics.
3 properties
TpmAttestation
object
Attestation via TPM.
2 properties
1 required
InitialTwin
object
Initial device twin. Contains a subset of the properties of Twin.
2 properties
SharedAccessSignatureAuthorizationRule
object
The properties of an IoT hub shared access policy.
4 properties
2 required
ArmIdentity
object
4 properties
SymmetricKeyAttestation
object
Attestation via SymmetricKey.
2 properties
JobResponseListResult
object
The JSON-serialized array of JobResponse objects with a next link.
2 properties
EncryptionPropertiesDescription
object
The encryption properties for the IoT hub.
2 properties
systemData
object
Metadata pertaining to creation and last modification of the resource.
6 properties
IotHubQuotaMetricInfoListResult
object
The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.
2 properties
EventHubConsumerGroupInfo
object
The properties of the EventHubConsumerGroupInfo object.
5 properties
JobResponse
object
The properties of the Job Response object.
8 properties
PrivateEndpoint
object
The private endpoint property of a private endpoint connection
1 property
IotHubLocationDescription
object
Public representation of one of the locations where a resource is provisioned.
2 properties
Metadata
object
Metadata for the TwinCollection
2 properties
RoutingStorageContainerProperties
object
The properties related to a storage container endpoint.
13 properties
2 required
TwinCollection
object
Represents a collection of properties within a Twin
3 properties
ManagedIdentity
object
The properties of the Managed identity.
1 property
KeyVaultKeyProperties
object
The properties of the KeyVault key.
2 properties
PrivateEndpointConnection
object
The private endpoint connection of an IotHub
4 properties
1 required
FeedbackProperties
object
The properties of the feedback queue for cloud-to-device messages.
3 properties
AttestationMechanism
object
Attestation mechanism for individualEnrollment as well as enrollmentGroup.
4 properties
1 required
IotHubDescription
object
The description of the IoT hub.
5 properties
1 required
DeviceCapabilities
object
Device capabilities.
1 property
1 required
IotHubQuotaMetricInfo
object
Quota metrics properties.
3 properties
IndividualEnrollment
object
The device enrollment record.
16 properties
2 required
ReprovisionPolicy
object
The behavior of the service when a device is re-provisioned to an IoT hub.
2 properties
2 required
IotHubSkuDescription
object
SKU properties.
3 properties
2 required
X509Attestation
object
Attestation via X509.
3 properties
RouteProperties
object
The properties of a routing rule that your IoT hub uses to route messages to endpoints.
5 properties
4 required
EndpointHealthData
object
The health data for an endpoint
6 properties
X509Certificates
object
Primary and secondary certificates
2 properties
IotHubSkuDescriptionListResult
object
The JSON-serialized array of IotHubSkuDescription objects with a next link.
2 properties
UserSubscriptionQuotaListResult
object
Json-serialized array of User subscription quota response
2 properties
CloudToDeviceProperties
object
The IoT hub cloud-to-device messaging properties.
3 properties
RoutingProperties
object
The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
4 properties
StorageEndpointProperties
object
The properties of the Azure Storage endpoint for file upload.
5 properties
2 required
Resource
object
The common properties of an Azure resource.
5 properties
1 required
PrivateEndpointConnectionsList
array
The list of private endpoint connections for an IotHub
X509CertificateInfo
object
X509 certificate info.
8 properties
8 required
RoutingEndpoints
object
The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed a…
4 properties
MessagingEndpointProperties
object
The properties of the messaging endpoints used by this IoT hub.
3 properties
NetworkRuleSetProperties
object
Network Rule Set Properties of IotHub
3 properties
2 required
EventHubConsumerGroupsListResult
object
The JSON-serialized array of Event Hub-compatible consumer group names with a next link.
2 properties
IpFilterRule
object
The IP filter rules for the IoT hub.
3 properties
3 required
X509CAReferences
object
Primary and secondary CA references.
2 properties
IotHubSkuInfo
object
Information about the SKU of the IoT hub.
3 properties
1 required
Name
object
Name of Iot Hub type
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure publishes across the network.