Operations - List
Listen alle verfügbaren IoT Hub REST-API-Vorgänge.
GET https://management.azure.com/providers/Microsoft.Devices/operations?api-version=2023-06-30
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
api-version
|
query | True |
string |
Die Version der API. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK. Die Anforderung wurde erfolgreich durchgeführt. |
|
Other Status Codes |
DefaultErrorResponse |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
Operations_List
Beispielanforderung
GET https://management.azure.com/providers/Microsoft.Devices/operations?api-version=2023-06-30
Beispiel für eine Antwort
{
"value": [
{
"name": "Microsoft.Devices/register/action",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Register Resource Provider",
"description": "Register the subscription for the IotHub resource provider and enables the creation of IotHub resources"
}
},
{
"name": "Microsoft.Devices/IotHubs/diagnosticSettings/read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get Diagnostic Setting",
"description": "Gets the diagnostic setting for the resource"
}
},
{
"name": "Microsoft.Devices/IotHubs/diagnosticSettings/write",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Set Diagnostic Setting",
"description": "Creates or updates the diagnostic setting for the resource"
}
},
{
"name": "Microsoft.Devices/IotHubs/metricDefinitions/read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Read IotHub service metric definitions",
"description": "Gets the available metrics for the IotHub service"
}
},
{
"name": "Microsoft.Devices/IotHubs/logDefinitions/read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Read IotHub service log definitions",
"description": "Gets the available log definitions for the IotHub Service"
}
},
{
"name": "Microsoft.Devices/operations/Read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get All ResourceProvider Operations",
"description": "Get All ResourceProvider Operations"
}
},
{
"name": "Microsoft.Devices/checkNameAvailability/Action",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Check If IotHub name is available",
"description": "Check If IotHub name is available"
}
},
{
"name": "Microsoft.Devices/usages/Read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get Subscription Usages",
"description": "Get subscription usage details for this provider."
}
},
{
"name": "Microsoft.Devices/iotHubs/Read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get IotHub(s)",
"description": "Gets the IotHub resource(s)"
}
},
{
"name": "Microsoft.Devices/iotHubs/Write",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Create or update IotHub Resource",
"description": "Create or update IotHub Resource"
}
},
{
"name": "Microsoft.Devices/iotHubs/Delete",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Delete IotHub Resource",
"description": "Delete IotHub Resource"
}
},
{
"name": "Microsoft.Devices/iotHubs/iotHubStats/Read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get IotHub Statistics",
"description": "Get IotHub Statistics"
}
},
{
"name": "Microsoft.Devices/iotHubs/skus/Read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get valid IotHub Skus",
"description": "Get valid IotHub Skus"
}
},
{
"name": "Microsoft.Devices/iotHubs/listkeys/Action",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get all IotHub Keys",
"description": "Get all IotHub Keys"
}
},
{
"name": "Microsoft.Devices/iotHubs/iotHubKeys/listkeys/Action",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get IotHub Key for the given name",
"description": "Get IotHub Key for the given name"
}
},
{
"name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Write",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Create EventHub Consumer Group",
"description": "Create EventHub Consumer Group"
}
},
{
"name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get EventHub Consumer Group(s)",
"description": "Get EventHub Consumer Group(s)"
}
},
{
"name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Delete",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Delete EventHub Consumer Group",
"description": "Delete EventHub Consumer Group"
}
},
{
"name": "Microsoft.Devices/iotHubs/exportDevices/Action",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Export Devices",
"description": "Export Devices"
}
},
{
"name": "Microsoft.Devices/iotHubs/importDevices/Action",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Import Devices",
"description": "Import Devices"
}
},
{
"name": "Microsoft.Devices/iotHubs/jobs/Read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get the Job(s) on IotHub",
"description": "Get Job(s) details submitted on given IotHub"
}
},
{
"name": "Microsoft.Devices/iotHubs/quotaMetrics/Read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get Quota Metrics",
"description": "Get Quota Metrics"
}
},
{
"name": "Microsoft.Devices/iotHubs/routing/routes/$testall/Action",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Routing Rule Test All",
"description": "Test a message against all existing Routes"
}
},
{
"name": "Microsoft.Devices/iotHubs/routing/routes/$testnew/Action",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Routing Rule Test Route",
"description": "Test a message against a provided test Route"
}
},
{
"name": "Microsoft.Devices/iotHubs/routingEndpointsHealth/Read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get Endpoint Health",
"description": "Gets the health of all routing Endpoints for an IotHub"
}
},
{
"name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Get Diagnostic Setting",
"description": "Gets the diagnostic setting for the resource"
}
},
{
"name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/write",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Set Diagnostic Setting",
"description": "Creates or updates the diagnostic setting for the resource"
}
},
{
"name": "Microsoft.Devices/ProvisioningServices/metricDefinitions/read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Read DPS service metric definitions",
"description": "Gets the available metrics for the DPS service"
}
},
{
"name": "Microsoft.Devices/ProvisioningServices/logDefinitions/read",
"display": {
"provider": "Microsoft Devices",
"resource": "IotHubs",
"operation": "Read DPS service log definitions",
"description": "Gets the available log definitions for the DPS Service"
}
},
{
"name": "Microsoft.Devices/checkProvisioningServiceNameAvailability/Action",
"display": {
"provider": "Microsoft Devices",
"resource": "ProvisioningServives",
"operation": "Check If Provisioning Service name is available",
"description": "Check If Provisioning Service name is available"
}
},
{
"name": "Microsoft.Devices/provisioningServices/Read",
"display": {
"provider": "Microsoft Devices",
"resource": "ProvisioningServices",
"operation": "Get Provisioning Service resource",
"description": "Get Provisioning Service resource"
}
},
{
"name": "Microsoft.Devices/provisioningServices/Write",
"display": {
"provider": "Microsoft Devices",
"resource": "ProvisioningServices",
"operation": "Create Provisioning Service resource",
"description": "Create Provisioning Service resource"
}
},
{
"name": "Microsoft.Devices/provisioningServices/Delete",
"display": {
"provider": "Microsoft Devices",
"resource": "ProvisioningServices",
"operation": "Delete Provisioning Service resource",
"description": "Delete Provisioning Service resource"
}
},
{
"name": "Microsoft.Devices/provisioningServices/skus/Read",
"display": {
"provider": "Microsoft Devices",
"resource": "ProvisioningServices",
"operation": "Delete Provisioning Service resource",
"description": "Delete Provisioning Service resource"
}
},
{
"name": "Microsoft.Devices/provisioningServices/listkeys/Action",
"display": {
"provider": "Microsoft Devices",
"resource": "ProvisioningServices",
"operation": "get security related metadata",
"description": "get security related metadata"
}
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Display |
Das Objekt, das den Vorgang darstellt. |
Error |
Fehlerdetails. |
Operation |
IoT Hub REST-API-Vorgang |
Operation |
Ergebnis der Anforderung, IoT Hub Vorgänge aufzulisten. Sie enthält eine Liste von Vorgängen und einen URL-Link zum Abrufen der nächsten Gruppe von Ergebnissen. |
Display
Das Objekt, das den Vorgang darstellt.
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Beschreibung des Vorgangs |
operation |
string |
Name des Vorgangs. |
provider |
string |
Dienstanbieter: Microsoft-Geräte |
resource |
string |
Ressourcentyp: IotHubs |
ErrorDetails
Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
details |
string |
Die Fehlerdetails. |
httpStatusCode |
string |
Der HTTP-Statuscode. |
message |
string |
Die Fehlermeldung. |
Operation
IoT Hub REST-API-Vorgang
Name | Typ | Beschreibung |
---|---|---|
display |
Das Objekt, das den Vorgang darstellt. |
|
name |
string |
Vorgangsname: {provider}/{resource}/{read | write | action | delete} |
OperationListResult
Ergebnis der Anforderung, IoT Hub Vorgänge aufzulisten. Sie enthält eine Liste von Vorgängen und einen URL-Link zum Abrufen der nächsten Gruppe von Ergebnissen.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
URL, um den nächsten Satz von Vorgangslistenergebnissen abzurufen, falls vorhanden. |
value |
Liste der IoT Hub Vorgänge, die vom Ressourcenanbieter Microsoft.Devices unterstützt werden. |