Targets - List

Dienst:

Chaos Studio

API-Version:

2025-01-01

Dient zum Abrufen einer Liste der Zielressourcen, die eine nachverfolgte regionale Ressource erweitern.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets?api-version=2025-01-01

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets?api-version=2025-01-01&continuationToken={continuationToken}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
parentProviderNamespace	path	True	string maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Der namespace des übergeordneten Ressourcenanbieters.
parentResourceName	path	True	string maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Der übergeordnete Ressourcenname.
parentResourceType	path	True	string maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Der übergeordnete Ressourcentyp.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
continuationToken	query		string	Zeichenfolge, die das Fortsetzungstoken festlegt.

Antworten

Name	Typ	Beschreibung
200 OK	TargetListResult	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List all Targets that extend a virtual machine resource.

Beispielanforderung

HTTP

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

Java

/**
 * Samples for Targets List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/Targets_List.json
     */
    /**
     * Sample code: List all Targets that extend a virtual machine resource.
     * 
     * @param manager Entry point to ChaosManager.
     */
    public static void
        listAllTargetsThatExtendAVirtualMachineResource(com.azure.resourcemanager.chaos.ChaosManager manager) {
        manager.targets().list("exampleRG", "Microsoft.Compute", "virtualMachines", "exampleVM", 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

JavaScript

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

/**
 * This sample demonstrates how to get a list of Target resources that extend a tracked regional resource.
 *
 * @summary get a list of Target resources that extend a tracked regional resource.
 * x-ms-original-file: 2025-01-01/Targets_List.json
 */
async function listAllTargetsThatExtendAVirtualMachineResource() {
  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.targets.list(
    "exampleRG",
    "Microsoft.Compute",
    "virtualMachines",
    "exampleVM",
  )) {
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
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/Targets_List.json
// this example is just showing the usage of "Target_List" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "6b052e15-03d3-4f17-b2e1-be7f07588291";
string resourceGroupName = "exampleRG";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ChaosTargetResource
string parentProviderNamespace = "Microsoft.Compute";
string parentResourceType = "virtualMachines";
string parentResourceName = "exampleVM";
ChaosTargetCollection collection = resourceGroupResource.GetChaosTargets(parentProviderNamespace, parentResourceType, parentResourceName);

// invoke the operation and iterate over the result
await foreach (ChaosTargetResource item in collection.GetAllAsync())
{
    // 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
    ChaosTargetData 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

Beispiel für eine Antwort

Statuscode:

200

{
  "nextLink": "https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/exampleVM/providers/Microsoft.Chaos/targets?continuationToken=&api-version=2024-11-01-preview",
  "value": [
    {
      "name": "Microsoft-Agent",
      "type": "Microsoft.Chaos/targets",
      "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/exampleVM/providers/Microsoft.Chaos/targets/Microsoft-Agent",
      "location": "centraluseuap",
      "properties": {
        "agentProfileId": "ac4e8251-fdc9-4277-8e87-dc57fe5794cf",
        "identities": [
          {
            "type": "CertificateSubjectIssuer",
            "subject": "CN=example.subject"
          }
        ]
      },
      "systemData": {
        "createdAt": "2021-07-01T00:00:00.0Z",
        "lastModifiedAt": "2021-07-01T00:00:00.0Z"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
Target	Modell, das eine Zielressource darstellt.
TargetListResult	Modell, das eine Liste der Zielressourcen und einen Link für die Paginierung darstellt.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Target

Objekt

Modell, das eine Zielressource darstellt.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Azure-Ressourcenspeicherort.
name	string	Der Name der Ressource
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

TargetListResult

Objekt

Modell, das eine Liste der Zielressourcen und einen Link für die Paginierung darstellt.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	Target[]	Die Zielelemente auf dieser Seite