Capability Types - Get

Tjänst:

Chaos Studio

API-version:

2025-01-01

Hämta en resurs för kapacitetstyp för angiven måltyp och plats.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
capabilityTypeName	path	True	string pattern: ^[a-zA-Z0-9\-\.]+-\d\.\d$	Sträng som representerar resursnamnet för kapacitetstypen.
location	path	True	string minLength: 1	Namnet på Azure-regionen.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
targetTypeName	path	True	string pattern: ^[a-zA-Z0-9_\-\.]+$	Sträng som representerar ett resursnamn för måltyp.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	CapabilityType	Azure-åtgärden har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
CapabilityType	Modell som representerar en resurs av kapacitetstyp.
CapabilityTypePropertiesRuntimeProperties	Körningsegenskaper för den här kapacitetstypen.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
systemData	Metadata som rör skapande och senaste ändring av resursen.

CapabilityType

Objekt

Modell som representerar en resurs av kapacitetstyp.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.azureRbacActions	string[]	Kontrollplansåtgärder som krävs för att köra kapacitetstypen.
properties.azureRbacDataActions	string[]	Dataplansåtgärder som krävs för att köra kapacitetstypen.
properties.description	string	Beskrivningens lokaliserade sträng.
properties.displayName	string	Lokaliserad sträng för visningsnamnet.
properties.kind	string	Sträng av den här typen av kapacitetstyp.
properties.parametersSchema	string maxLength: 2048	URL för att hämta JSON-schemat för parametrarna för kapacitetstyp.
properties.publisher	string	Sträng för utgivaren som den här funktionstypen utökar.
properties.requiredAzureRoleDefinitionIds	string[]	Nödvändiga Azure-rolldefinitions-ID:er för att köra kapacitetstyp.
properties.runtimeProperties	CapabilityTypePropertiesRuntimeProperties	Körningsegenskaper för den här kapacitetstypen.
properties.targetType	string	Sträng av den måltyp som den här kapacitetstypen utökar.
properties.urn	string maxLength: 2048	Sträng för URN för den här kapacitetstypen.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

CapabilityTypePropertiesRuntimeProperties

Objekt

Körningsegenskaper för den här kapacitetstypen.

Name	Typ	Description
kind	string	Sträng av typen av resursens åtgärdstyp (kontinuerlig eller diskret).

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.