Capability Types - Get

Dienst:

Chaos Studio

API-Version:

2025-01-01

Rufen Sie eine Funktionstypressource für den angegebenen Zieltyp und den angegebenen Speicherort ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/targetTypes/{targetTypeName}/capabilityTypes/{capabilityTypeName}?api-version=2025-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
capabilityTypeName	path	True	string pattern: ^[a-zA-Z0-9\-\.]+-\d\.\d$	Zeichenfolge, die einen Ressourcennamen des Funktionstyps darstellt.
location	path	True	string minLength: 1	Der Name der Azure-Region.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
targetTypeName	path	True	string pattern: ^[a-zA-Z0-9_\-\.]+$	Zeichenfolge, die einen Ressourcennamen des Zieltyps darstellt.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	CapabilityType	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get a Capability Type for a virtual machine Target resource on westus2 location.

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "name": "Shutdown-1.0",
  "type": "Microsoft.Chaos/locations/targetTypes/capabilityTypes",
  "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/providers/Microsoft.Chaos/locations/westus2/targetTypes/Microsoft-VirtualMachine/capabilityTypes/Shutdown-1.0",
  "properties": {
    "description": "Shutdown an Azure Virtual Machine for a defined period of time.",
    "displayName": "Shutdown VM",
    "kind": "fault",
    "parametersSchema": "https://schema.centralus.chaos-prod.azure.com/targets/Microsoft-VirtualMachine/capabilities/Shutdown-1.0.json",
    "publisher": "Microsoft",
    "runtimeProperties": {
      "kind": "continuous"
    },
    "targetType": "VirtualMachine",
    "urn": "urn:csci:microsoft:virtualMachine:shutdown/1.0",
    "azureRbacActions": [
      "Microsoft.Compute/virtualMachines/poweroff/action",
      "Microsoft.Compute/virtualMachines/start/action",
      "Microsoft.Compute/virtualMachines/instanceView/read",
      "Microsoft.Compute/virtualMachines/read",
      "Microsoft.Compute/locations/operations/read"
    ],
    "requiredAzureRoleDefinitionIds": [
      "acdd72a7-3385-48ef-bd42-f606fba81ae0"
    ]
  }
}

Definitionen

Name	Beschreibung
CapabilityType	Modell, das eine Funktionstypressource darstellt.
CapabilityTypePropertiesRuntimeProperties	Laufzeiteigenschaften dieses Funktionstyps.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CapabilityType

Objekt

Modell, das eine Funktionstypressource darstellt.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.azureRbacActions	string[]	Steuern Von Ebenenaktionen, die zum Ausführen des Funktionstyps erforderlich sind.
properties.azureRbacDataActions	string[]	Datenebenenaktionen, die zum Ausführen des Funktionstyps erforderlich sind.
properties.description	string	Lokalisierte Zeichenfolge der Beschreibung.
properties.displayName	string	Lokalisierte Zeichenfolge des Anzeigenamens.
properties.kind	string	Zeichenfolge der Art dieses Funktionstyps.
properties.parametersSchema	string maxLength: 2048	URL zum Abrufen des JSON-Schemas der Funktionstypparameter.
properties.publisher	string	Die Zeichenfolge des Herausgebers, den dieser Funktionstyp erweitert.
properties.requiredAzureRoleDefinitionIds	string[]	Erforderliche Azure-Rollendefinitions-IDs zum Ausführen des Funktionstyps.
properties.runtimeProperties	CapabilityTypePropertiesRuntimeProperties	Laufzeiteigenschaften dieses Funktionstyps.
properties.targetType	string	Zeichenfolge des Zieltyps, den dieser Funktionstyp erweitert.
properties.urn	string maxLength: 2048	Zeichenfolge des URN für diesen Funktionstyp.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

CapabilityTypePropertiesRuntimeProperties

Objekt

Laufzeiteigenschaften dieses Funktionstyps.

Name	Typ	Beschreibung
kind	string	Zeichenfolge der Art des Aktionstyps der Ressource (fortlaufend oder diskret).

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.