Capability Types - Get

Služba:

Chaos Studio

Verze rozhraní API:

2025-01-01

Získejte prostředek Typu schopností pro daný cílový typ a umístění.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
capabilityTypeName	path	True	string pattern: ^[a-zA-Z0-9\-\.]+-\d\.\d$	Řetězec, který představuje název prostředku Typu schopností
location	path	True	string minLength: 1	Název oblasti Azure.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
targetTypeName	path	True	string pattern: ^[a-zA-Z0-9_\-\.]+$	Řetězec, který představuje název prostředku Typu cíle.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	CapabilityType	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
CapabilityType	Model, který představuje prostředek typu schopností
CapabilityTypePropertiesRuntimeProperties	Vlastnosti modulu runtime tohoto typu schopnosti
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

CapabilityType

Objekt

Model, který představuje prostředek typu schopností

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.azureRbacActions	string[]	Akce řídicí roviny nezbytné ke spuštění typu schopností
properties.azureRbacDataActions	string[]	Akce roviny dat nezbytné ke spuštění typu schopností
properties.description	string	Lokalizovaný řetězec popisu.
properties.displayName	string	Lokalizovaný řetězec zobrazovaného názvu
properties.kind	string	Řetězec typu této funkce.
properties.parametersSchema	string maxLength: 2048	Adresa URL pro načtení schématu JSON parametrů typu schopností
properties.publisher	string	Řetězec vydavatele, který tento typ schopnosti rozšiřuje.
properties.requiredAzureRoleDefinitionIds	string[]	Požadované ID definice role Azure ke spuštění typu schopností
properties.runtimeProperties	CapabilityTypePropertiesRuntimeProperties	Vlastnosti modulu runtime tohoto typu schopnosti
properties.targetType	string	Řetězec cílového typu, který tento typ schopnosti rozšiřuje.
properties.urn	string maxLength: 2048	Řetězec URN pro tento typ schopnosti
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

CapabilityTypePropertiesRuntimeProperties

Objekt

Vlastnosti modulu runtime tohoto typu schopnosti

Name	Typ	Description
kind	string	Řetězec typu akce prostředku (souvislý nebo diskrétní).

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.