Operations - List

Lists all of the available Microsoft.Devices REST API operations.

GET https://management.azure.com/providers/Microsoft.Devices/operations?api-version=2022-12-12

URI Parameters

Name In Required Type Description
api-version
query True

string

The version of the API.

Responses

Name Type Description
200 OK

OperationListResult

OK. The request has succeeded.

Other Status Codes

ErrorDetails

Default error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

DPSOperations

Sample Request

GET https://management.azure.com/providers/Microsoft.Devices/operations?api-version=2022-12-12

Sample Response

{
  "value": [
    {
      "name": "Microsoft.Devices/register/action",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Register Resource Provider"
      }
    },
    {
      "name": "Microsoft.Devices/IotHubs/diagnosticSettings/read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Get Diagnostic Setting"
      }
    },
    {
      "name": "Microsoft.Devices/IotHubs/diagnosticSettings/write",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Set Diagnostic Setting"
      }
    },
    {
      "name": "Microsoft.Devices/IotHubs/metricDefinitions/read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Read IotHub service metric definitions"
      }
    },
    {
      "name": "Microsoft.Devices/IotHubs/logDefinitions/read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Read IotHub service log definitions"
      }
    },
    {
      "name": "Microsoft.Devices/operations/Read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Get All ResourceProvider Operations"
      }
    },
    {
      "name": "Microsoft.Devices/checkNameAvailability/Action",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Check If IotHub name is available"
      }
    },
    {
      "name": "Microsoft.Devices/usages/Read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Get Subscription Usages"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/Read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Get IotHub(s)"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/Write",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Create or update IotHub Resource"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/Delete",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Delete IotHub Resource"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/iotHubStats/Read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Get IotHub Statistics"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/skus/Read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Get valid IotHub Skus"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/listkeys/Action",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "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"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Write",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Create EventHub Consumer Group"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Get EventHub Consumer Group(s)"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Delete",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Delete EventHub Consumer Group"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/exportDevices/Action",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Export Devices"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/importDevices/Action",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Import Devices"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/jobs/Read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Get the Job(s) on IotHub"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/quotaMetrics/Read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Get Quota Metrics"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/routing/routes/$testall/Action",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Routing Rule Test All"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/routing/routes/$testnew/Action",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Routing Rule Test Route"
      }
    },
    {
      "name": "Microsoft.Devices/iotHubs/routingEndpointsHealth/Read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Get Endpoint Health"
      }
    },
    {
      "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Get Diagnostic Setting"
      }
    },
    {
      "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/write",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Set Diagnostic Setting"
      }
    },
    {
      "name": "Microsoft.Devices/ProvisioningServices/metricDefinitions/read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Read DPS service metric definitions"
      }
    },
    {
      "name": "Microsoft.Devices/ProvisioningServices/logDefinitions/read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "IotHubs",
        "operation": "Read DPS service log definitions"
      }
    },
    {
      "name": "Microsoft.Devices/checkProvisioningServiceNameAvailability/Action",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "ProvisioningServives",
        "operation": "Check If Provisioning Service name is available"
      }
    },
    {
      "name": "Microsoft.Devices/provisioningServices/Read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "ProvisioningServices",
        "operation": "Get Provisioning Service resource"
      }
    },
    {
      "name": "Microsoft.Devices/provisioningServices/Write",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "ProvisioningServices",
        "operation": "Create Provisioning Service resource"
      }
    },
    {
      "name": "Microsoft.Devices/provisioningServices/Delete",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "ProvisioningServices",
        "operation": "Delete Provisioning Service resource"
      }
    },
    {
      "name": "Microsoft.Devices/provisioningServices/skus/Read",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "ProvisioningServices",
        "operation": "Delete Provisioning Service resource"
      }
    },
    {
      "name": "Microsoft.Devices/provisioningServices/listkeys/Action",
      "display": {
        "provider": "Microsoft Devices",
        "resource": "ProvisioningServices",
        "operation": "get security related metadata"
      }
    }
  ]
}

Definitions

Name Description
Display

The object that represents the operation.

ErrorDetails

Error details.

Operation

Provisioning Service REST API operation.

OperationListResult

Result of the request to list provisioning service operations. It contains a list of operations and a URL link to get the next set of results.

Display

The object that represents the operation.

Name Type Description
operation

string

Name of the operation.

provider

string

Service provider: Microsoft Devices.

resource

string

Resource Type: ProvisioningServices.

ErrorDetails

Error details.

Name Type Description
code

integer

The error code.

details

string

The error details.

httpStatusCode

string

The HTTP status code.

message

string

The error message.

Operation

Provisioning Service REST API operation.

Name Type Description
display

Display

The object that represents the operation.

name

string

Operation name: {provider}/{resource}/{read | write | action | delete}

OperationListResult

Result of the request to list provisioning service operations. It contains a list of operations and a URL link to get the next set of results.

Name Type Description
nextLink

string

URL to get the next set of operation list results if there are any.

value

Operation[]

Provisioning service operations supported by the Microsoft.Devices resource provider.