Capability Types - Get

Usługa:

Chaos Studio

Wersja interfejsu API:

2025-01-01

Pobierz zasób Typ możliwości dla danego typu docelowego i lokalizacji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
capabilityTypeName	path	True	string pattern: ^[a-zA-Z0-9\-\.]+-\d\.\d$	Ciąg reprezentujący nazwę zasobu Typ możliwości.
location	path	True	string minLength: 1	Nazwa regionu świadczenia usługi Azure.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
targetTypeName	path	True	string pattern: ^[a-zA-Z0-9_\-\.]+$	Ciąg reprezentujący nazwę zasobu typu docelowego.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CapabilityType	Operacja platformy Azure została ukończona pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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"
    ]
  }
}

Definicje

Nazwa	Opis
CapabilityType	Model reprezentujący zasób Typ możliwości.
CapabilityTypePropertiesRuntimeProperties	Właściwości środowiska uruchomieniowego tego typu możliwości.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CapabilityType

Objekt

Model reprezentujący zasób Typ możliwości.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.azureRbacActions	string[]	Akcje płaszczyzny sterowania niezbędne do wykonania typu możliwości.
properties.azureRbacDataActions	string[]	Akcje płaszczyzny danych niezbędne do wykonania typu możliwości.
properties.description	string	Zlokalizowany ciąg opisu.
properties.displayName	string	Zlokalizowany ciąg nazwy wyświetlanej.
properties.kind	string	Ciąg tego typu możliwości.
properties.parametersSchema	string maxLength: 2048	Adres URL umożliwiający pobranie schematu JSON parametrów typu możliwości.
properties.publisher	string	Ciąg wydawcy, który ten typ możliwości rozszerza.
properties.requiredAzureRoleDefinitionIds	string[]	Wymagane identyfikatory definicji roli platformy Azure do wykonania typu możliwości.
properties.runtimeProperties	CapabilityTypePropertiesRuntimeProperties	Właściwości środowiska uruchomieniowego tego typu możliwości.
properties.targetType	string	Ciąg typu docelowego, który ten typ możliwości rozszerza.
properties.urn	string maxLength: 2048	Ciąg identyfikatora URI dla tego typu możliwości.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

CapabilityTypePropertiesRuntimeProperties

Objekt

Właściwości środowiska uruchomieniowego tego typu możliwości.

Nazwa	Typ	Opis
kind	string	Ciąg typu akcji zasobu (ciągły lub dyskretny).

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.