Diagnostics - List

Service:

Compute

API Version:

2025-02-01-preview

Lists all available Compute diagnostics for a subscription in a location.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/diagnostics?api-version=2025-02-01-preview

URI Parameters

Name	In	Required	Type	Description
location	path	True	string minLength: 1	The name of the Azure region.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ComputeDiagnosticsList	Success
Other Status Codes	ErrorResponse	Error response describing why the listing call failed.

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

Gets the status of a scheduled disk inspection request.

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/diagnostics?api-version=2025-02-01-preview

Sample response

Status code:

200

x-ms-request-id: 27b7c568-16ec-46f3-bcf1-5bea3f2529b1

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/diagnostics/diskInspection",
      "name": "diskInspection",
      "type": "Microsoft.Compute/locations/diagnostics",
      "properties": {
        "supportedResourceTypes": [
          "Microsoft.Compute/virtualMachines"
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/{location}/diagnostics/spotPlacementRecommender",
      "name": "spotPlacementRecommender",
      "type": "Microsoft.Compute/locations/diagnostics",
      "properties": {
        "supportedResourceTypes": [
          "Microsoft.Compute/virtualMachines"
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/{location}/placementScores/spot",
      "name": "spotPlacementRecommender",
      "type": "Microsoft.Compute/placementScores",
      "properties": {
        "supportedResourceTypes": [
          "Microsoft.Compute/virtualMachines"
        ]
      }
    }
  ]
}

Definitions

Name	Description
ComputeDiagnosticBase	Contains metadata of a diagnostic type
ComputeDiagnosticsList	Lists all available Compute diagnostics for a subscription in a location.
createdByType	The type of identity that created the resource.
DiagnosticProperties	Contains additional properties of a diagnostic
ErrorDetail	Error Detail message.
ErrorResponse	An error response from the Compute Diagnostic Resource Provider service.
InnerError	Inner error details.
systemData	Metadata pertaining to creation and last modification of the resource.

ComputeDiagnosticBase

Object

Contains metadata of a diagnostic type

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	DiagnosticProperties	Contains additional properties of a diagnostic
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ComputeDiagnosticsList

Object

Lists all available Compute diagnostics for a subscription in a location.

Name	Type	Description
nextLink	string	The continuation token.
value	ComputeDiagnosticBase[]	The collection of available Compute diagnostics returned by the listing operation.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DiagnosticProperties

Object

Contains additional properties of a diagnostic

Name	Type	Description
supportedResourceTypes	string[]	Describes what are the supported resource types for a diagnostic.

ErrorDetail

Object

Error Detail message.

Name	Type	Description
code	string	The error code.
details	ErrorDetail[]	The Api error details
innerError	InnerError	The Api inner error
message	string	User friendly error message.
target	string	The target of the particular error.

ErrorResponse

Object

An error response from the Compute Diagnostic Resource Provider service.

Name	Type	Description
error	ErrorDetail	Error Detail message.

InnerError

Object

Inner error details.

Name	Type	Description
errordetail	string	The internal error message or exception dump.
exceptiontype	string	The exception type.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.