Capability Types - Get

Service:

Chaos Studio

Version d'API:

2025-01-01

Obtenir une ressource de type de capacité pour le type cible et l’emplacement donnés.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
capabilityTypeName	path	True	string pattern: ^[a-zA-Z0-9\-\.]+-\d\.\d$	Chaîne qui représente un nom de ressource type de capacité.
location	path	True	string minLength: 1	Nom de la région Azure.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
targetTypeName	path	True	string pattern: ^[a-zA-Z0-9_\-\.]+$	Chaîne qui représente un nom de ressource type cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	CapabilityType	L’opération Azure s’est terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
CapabilityType	Modèle qui représente une ressource de type de capacité.
CapabilityTypePropertiesRuntimeProperties	Propriétés d’exécution de ce type de fonctionnalité.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CapabilityType

Object

Modèle qui représente une ressource de type de capacité.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.azureRbacActions	string[]	Actions du plan de contrôle nécessaires pour exécuter le type de fonctionnalité.
properties.azureRbacDataActions	string[]	Actions de plan de données nécessaires pour exécuter le type de fonctionnalité.
properties.description	string	Chaîne localisée de la description.
properties.displayName	string	Chaîne localisée du nom complet.
properties.kind	string	Chaîne du type de ce type de fonctionnalité.
properties.parametersSchema	string maxLength: 2048	URL permettant de récupérer le schéma JSON des paramètres de type de capacité.
properties.publisher	string	Chaîne du serveur de publication étendu par ce type de fonctionnalité.
properties.requiredAzureRoleDefinitionIds	string[]	Id de définition de rôle Azure requis pour exécuter le type de fonctionnalité.
properties.runtimeProperties	CapabilityTypePropertiesRuntimeProperties	Propriétés d’exécution de ce type de fonctionnalité.
properties.targetType	string	Chaîne du type cible étendu par ce type de fonctionnalité.
properties.urn	string maxLength: 2048	Chaîne de l’URN pour ce type de fonctionnalité.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

CapabilityTypePropertiesRuntimeProperties

Object

Propriétés d’exécution de ce type de fonctionnalité.

Nom	Type	Description
kind	string	Chaîne du type d’action de la ressource (continu ou discret).

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.