Experiments - List All

Servicio:: Chaos Studio

Versión de la API:: 2025-01-01

Obtenga una lista de recursos de experimento en una suscripción.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/experiments?api-version=2025-01-01

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/experiments?api-version=2025-01-01&running={running}&continuationToken={continuationToken}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
continuationToken	query		string	Cadena que establece el token de continuación.
running	query		boolean	Valor opcional que indica si se van a filtrar los resultados en función de si el experimento se está ejecutando actualmente. Si es null, los resultados no se filtrarán.

Respuestas

Nombre	Tipo	Description
200 OK	ExperimentListResult	La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

List all Experiments in a subscription.

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/providers/Microsoft.Chaos/experiments?api-version=2025-01-01&continuationToken=


/**
 * Samples for Experiments List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/Experiments_ListAll.json
     */
    /**
     * Sample code: List all Experiments in a subscription.
     * 
     * @param manager Entry point to ChaosManager.
     */
    public static void listAllExperimentsInASubscription(com.azure.resourcemanager.chaos.ChaosManager manager) {
        manager.experiments().list(null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ChaosManagementClient } = require("@azure/arm-chaos");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get a list of Experiment resources in a subscription.
 *
 * @summary get a list of Experiment resources in a subscription.
 * x-ms-original-file: 2025-01-01/Experiments_ListAll.json
 */
async function listAllExperimentsInASubscription() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "6b052e15-03d3-4f17-b2e1-be7f07588291";
  const client = new ChaosManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.experiments.listAll()) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Chaos;

// Generated from example definition: 2025-01-01/Experiments_ListAll.json
// this example is just showing the usage of "Experiment_ListAll" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "6b052e15-03d3-4f17-b2e1-be7f07588291";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (ChaosExperimentResource item in subscriptionResource.GetChaosExperimentsAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ChaosExperimentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/providers/Microsoft.Chaos/experiments?continuationToken=&api-version=2024-11-01-preview",
  "value": [
    {
      "name": "exampleExperiment",
      "type": "Microsoft.Chaos/experiments",
      "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Chaos/experiments/exampleExperiment",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "d04ab567-2c07-43ef-a7f4-4527626b7f56",
        "tenantId": "8c3e2fb2-fe7a-4bf1-b779-d73990782fe6"
      },
      "location": "centraluseuap",
      "properties": {
        "selectors": [
          {
            "type": "List",
            "id": "selector1",
            "targets": [
              {
                "type": "ChaosTarget",
                "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/exampleVM/providers/Microsoft.Chaos/targets/Microsoft-VirtualMachine"
              }
            ]
          }
        ],
        "steps": [
          {
            "name": "step1",
            "branches": [
              {
                "name": "branch1",
                "actions": [
                  {
                    "name": "urn:csci:provider:providername:Shutdown/1.0",
                    "type": "continuous",
                    "duration": "PT10M",
                    "parameters": [
                      {
                        "key": "abruptShutdown",
                        "value": "false"
                      }
                    ],
                    "selectorId": "selector1"
                  }
                ]
              }
            ]
          }
        ]
      },
      "systemData": {
        "createdAt": "2021-07-01T00:00:00.0Z",
        "createdBy": "User",
        "createdByType": "b3a41dba-4415-4d36-9ee8-e5eaa86db976",
        "lastModifiedAt": "2021-07-01T00:00:00.0Z",
        "lastModifiedBy": "User",
        "lastModifiedByType": "b3a41dba-4415-4d36-9ee8-e5eaa86db976"
      }
    }
  ]
}

Definiciones

Nombre	Description
ChaosExperimentBranch	Modelo que representa una rama en el paso. 9 total por experimento.
ChaosExperimentStep	Modelo que representa un paso en el recurso Experimento.
ChaosTargetListSelector	Modelo que representa un selector de lista.
ChaosTargetQuerySelector	Modelo que representa un selector de consultas.
ChaosTargetSimpleFilter	Modelo que representa un filtro de destino simple.
ChaosTargetSimpleFilterParameters	Modelo que representa los parámetros de filtro simple.
ContinuousAction	Modelo que representa una acción continua.
createdByType	Tipo de identidad que creó el recurso.
DelayAction	Modelo que representa una acción de retraso.
DiscreteAction	Modelo que representa una acción discreta.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Experiment	Modelo que representa un recurso experiment.
ExperimentActionType	Unión de enumeración de tipos de acción del experimento de Chaos.
ExperimentListResult	Modelo que representa una lista de recursos de experimento y un vínculo para la paginación.
FilterType	Enumeración que discrimina entre los tipos de filtro. Actualmente solo se admite `Simple` tipo.
KeyValuePair	Mapa para describir la configuración de una acción.
ManagedServiceIdentity	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)
ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
ProvisioningState	Estado de aprovisionamiento actual para un recurso de Azure Chaos determinado.
SelectorType	Enumeración del tipo de selector.
systemData	Metadatos relativos a la creación y última modificación del recurso.
TargetReference	Modelo que representa una referencia a un destino en el selector.
TargetReferenceType	Enumeración del tipo de referencia target.
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario

ChaosExperimentBranch

Object

Modelo que representa una rama en el paso. 9 total por experimento.

Nombre	Tipo	Description
actions	ChaosExperimentAction[]: ContinuousAction[] DelayAction[] DiscreteAction[]	Lista de acciones.
name	string minLength: 1	Cadena del nombre de la rama.

ChaosExperimentStep

Object

Modelo que representa un paso en el recurso Experimento.

Nombre	Tipo	Description
branches	ChaosExperimentBranch[]	Lista de ramas.
name	string minLength: 1	Cadena del nombre del paso.

ChaosTargetListSelector

Object

Modelo que representa un selector de lista.

Nombre	Tipo	Description
filter	ChaosTargetFilter: ChaosTargetSimpleFilter	Modelo que representa los tipos de filtro disponibles que se pueden aplicar a una lista de destinos.
id	string minLength: 1	Cadena del identificador del selector.
targets	TargetReference[]	Lista de referencias de destino.
type	string: List	Tipo de discriminador del selector de destino de Chaos

ChaosTargetQuerySelector

Object

Modelo que representa un selector de consultas.

Nombre	Tipo	Description
filter	ChaosTargetFilter: ChaosTargetSimpleFilter	Modelo que representa los tipos de filtro disponibles que se pueden aplicar a una lista de destinos.
id	string minLength: 1	Cadena del identificador del selector.
queryString	string	Consulta del lenguaje de consulta de Azure Resource Graph (ARG) para los recursos de destino.
subscriptionIds	string[]	Lista de identificadores de suscripción para definir el ámbito de la consulta de recursos.
type	string: Query	Tipo de discriminador del selector de destino de Chaos

ChaosTargetSimpleFilter

Object

Modelo que representa un filtro de destino simple.

Nombre	Tipo	Description
parameters	ChaosTargetSimpleFilterParameters	Modelo que representa los parámetros de filtro simple.
type	string: Simple	Tipo de discriminador de filtro de destino de Chaos

ChaosTargetSimpleFilterParameters

Object

Modelo que representa los parámetros de filtro simple.

Nombre	Tipo	Description
zones	string[]	Lista de zonas de disponibilidad de Azure para filtrar destinos por.

ContinuousAction

Object

Modelo que representa una acción continua.

Nombre	Tipo	Description
duration	string (duration)	ISO8601 cadena con formato que representa una duración.
name	string maxLength: 2048	Cadena que representa un URN de funcionalidad.
parameters	KeyValuePair[]	Lista de pares clave-valor.
selectorId	string minLength: 1	Cadena que representa un selector.
type	string: continuous	Tipo de discriminador de acción del experimento de Caos

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DelayAction

Object

Modelo que representa una acción de retraso.

Nombre	Tipo	Description
duration	string (duration)	ISO8601 cadena con formato que representa una duración.
name	string maxLength: 2048	Cadena que representa un URN de funcionalidad.
type	string: delay	Tipo de discriminador de acción del experimento de Caos

DiscreteAction

Object

Modelo que representa una acción discreta.

Nombre	Tipo	Description
name	string maxLength: 2048	Cadena que representa un URN de funcionalidad.
parameters	KeyValuePair[]	Lista de pares clave-valor.
selectorId	string minLength: 1	Cadena que representa un selector.
type	string: discrete	Tipo de discriminador de acción del experimento de Caos

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Experiment

Object

Modelo que representa un recurso experiment.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Identidades de servicio administradas asignadas a este recurso.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento más reciente para el recurso de experimento determinado.
properties.selectors	ChaosTargetSelector[]: ChaosTargetListSelector[] ChaosTargetQuerySelector[]	Lista de selectores.
properties.steps	ChaosExperimentStep[]	Lista de pasos.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ExperimentActionType

Enumeración

Unión de enumeración de tipos de acción del experimento de Chaos.

Valor	Description
continuous
delay
discrete

ExperimentListResult

Object

Modelo que representa una lista de recursos de experimento y un vínculo para la paginación.

Nombre	Tipo	Description
nextLink	string (uri)	Vínculo a la página siguiente de elementos
value	Experiment[]	Los elementos del experimento de esta página

FilterType

Enumeración

Enumeración que discrimina entre los tipos de filtro. Actualmente solo se admite Simple tipo.

Valor	Description
Simple	Tipo de filtro simple.

KeyValuePair

Object

Mapa para describir la configuración de una acción.

Nombre	Tipo	Description
key	string minLength: 1	Nombre de la configuración de la acción.
value	string minLength: 1	Valor de la configuración de la acción.

ManagedServiceIdentity

Object

Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string (uuid)	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identidades de User-Assigned Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.

ManagedServiceIdentityType

Enumeración

Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).

Valor	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

ProvisioningState

Enumeración

Estado de aprovisionamiento actual para un recurso de Azure Chaos determinado.

Valor	Description
Canceled	Se canceló la creación de recursos.
Creating	Creación inicial en curso.
Deleting	Eliminación en curso.
Failed	Error en la creación de recursos.
Succeeded	Se ha creado el recurso.
Updating	Actualización en curso.

SelectorType

Enumeración

Enumeración del tipo de selector.

Valor	Description
List	Tipo de selector de lista.
Query	Tipo de selector de consulta.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TargetReference

Object

Modelo que representa una referencia a un destino en el selector.

Nombre	Tipo	Description
id	string (arm-id)	Cadena del identificador de recurso de un recurso de destino.
type	TargetReferenceType	Enumeración del tipo de referencia target.

TargetReferenceType

Enumeración

Enumeración del tipo de referencia target.

Valor	Description
ChaosTarget	Tipo de referencia de destino chaos.

UserAssignedIdentity

Object

Propiedades de identidad asignadas por el usuario

Nombre	Tipo	Description
clientId	string (uuid)	Identificador de cliente de la identidad asignada.
principalId	string (uuid)	Identificador de entidad de seguridad de la identidad asignada.

Compartir a través de

Experiments - List All

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

List all Experiments in a subscription.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ChaosExperimentBranch

ChaosExperimentStep

ChaosTargetListSelector

ChaosTargetQuerySelector

ChaosTargetSimpleFilter

ChaosTargetSimpleFilterParameters

ContinuousAction

createdByType

DelayAction

DiscreteAction

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Experiment

ExperimentActionType

ExperimentListResult

FilterType

KeyValuePair

ManagedServiceIdentity

ManagedServiceIdentityType

ProvisioningState

SelectorType

systemData

TargetReference

TargetReferenceType

UserAssignedIdentity