Capability Types - List

Get a list of Capability Type resources for given Target Type and location.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}/capabilityTypes?api-version=2022-10-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}/capabilityTypes?api-version=2022-10-01-preview&continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
locationName
path True
  • string

String that represents a Location resource name.

Regex pattern: ^[a-zA-Z0-9_\-\.]+$

subscriptionId
path True
  • string

GUID that represents an Azure subscription ID.

Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

targetTypeName
path True
  • string

String that represents a Target Type resource name.

Regex pattern: ^[a-zA-Z0-9_\-\.]+$

api-version
query True
  • string

String that sets the API version.

Regex pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(|-preview)$

continuationToken
query
  • string

String that sets the continuation token.

Responses

Name Type Description
200 OK

List of Capability Type resources returned if request was successful.

Other Status Codes

Error response returned if request was unsuccessful.

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

List all Capability Types for a virtual machine Target resource on westus2 location.

Sample Request

GET https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/providers/Microsoft.Chaos/locations/westus2/targetTypes/Microsoft-VirtualMachine/capabilityTypes?api-version=2022-10-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/providers/Microsoft.Chaos/locations/westus2/targetTypes/Microsoft-VirtualMachine/capabilityTypes/Shutdown-1.0",
      "type": "Microsoft.Chaos/locations/targetTypes/capabilityTypes",
      "name": "Shutdown-1.0",
      "properties": {
        "kind": "fault",
        "publisher": "Microsoft",
        "targetType": "VirtualMachine",
        "displayName": "Shutdown VM",
        "description": "Shutdown an Azure Virtual Machine for a defined period of time.",
        "parametersSchema": "https://schema.centralus.chaos-prod.azure.com/targets/Microsoft-VirtualMachine/capabilities/Shutdown-1.0.json",
        "runtimeProperties": {
          "kind": "continuous"
        },
        "urn": "urn:csci:microsoft:virtualMachine:shutdown/1.0"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/providers/Microsoft.Chaos/locations/westus2/targetTypes/Microsoft-VirtualMachine/capabilityTypes?continuationToken=&api-version=2022-10-01-preview"
}

Definitions

capabilityType

Model that represents a Capability Type resource.

capabilityTypeListResult

Model that represents a list of Capability Type resources and a link for pagination.

createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

RuntimeProperties

Runtime properties of this Capability Type.

systemData

Metadata pertaining to creation and last modification of the resource.

capabilityType

Model that represents a Capability Type resource.

Name Type Description
id
  • string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

Location of the Capability Type resource.

name
  • string

The name of the resource

properties.description
  • string

Localized string of the description.

properties.displayName
  • string

Localized string of the display name.

properties.kind
  • string

String of the kind of this Capability Type.

properties.parametersSchema
  • string

URL to retrieve JSON schema of the Capability Type parameters.

properties.publisher
  • string

String of the Publisher that this Capability Type extends.

properties.runtimeProperties

Runtime properties of this Capability Type.

properties.targetType
  • string

String of the Target Type that this Capability Type extends.

properties.urn
  • string

String of the URN for this Capability Type.

systemData

The system metadata properties of the capability type resource.

type
  • string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

capabilityTypeListResult

Model that represents a list of Capability Type resources and a link for pagination.

Name Type Description
nextLink
  • string

URL to retrieve the next page of Capability Type resources.

value

List of Capability Type resources.

createdByType

The type of identity that created the resource.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

ErrorResponse

Error response

Name Type Description
error

The error object.

RuntimeProperties

Runtime properties of this Capability Type.

Name Type Description
kind
  • string

String of the kind of the resource's action type (continuous or discrete).

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt
  • string

The timestamp of resource creation (UTC).

createdBy
  • string

The identity that created the resource.

createdByType

The type of identity that created the resource.

lastModifiedAt
  • string

The timestamp of resource last modification (UTC)

lastModifiedBy
  • string

The identity that last modified the resource.

lastModifiedByType

The type of identity that last modified the resource.