DeploymentEnvironmentsClient.GetAllEnvironmentsAsync Methode

Definition

Namespace:

Azure.Developer.DevCenter

Assembly:

Azure.Developer.DevCenter.dll

Paket:

Azure.Developer.DevCenter v1.0.0-beta.3

[Protokollmethode] Listet die Umgebungen für ein Projekt auf.

• Diese Protokollmethode ermöglicht die explizite Erstellung der Anforderung und Verarbeitung der Antwort für erweiterte Szenarien.

public virtual Azure.AsyncPageable<BinaryData> GetAllEnvironmentsAsync (string projectName, int? maxCount, Azure.RequestContext context);

abstract member GetAllEnvironmentsAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetAllEnvironmentsAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetAllEnvironmentsAsync (projectName As String, maxCount As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)

Parameter

projectName

String

Das DevCenter-Projekt, auf dem Vorgänge ausgeführt werden sollen.

maxCount

Nullable<Int32>

Die maximale Anzahl von Ressourcen, die vom Vorgang zurückgegeben werden sollen. Beispiel: 'top=10'.

context

RequestContext

Der Anforderungskontext, der das Standardverhalten der Clientpipeline pro Aufruf außer Kraft setzen kann.

Gibt zurück

AsyncPageable<BinaryData>

Der AsyncPageable<T> aus dem Dienst, der eine Liste von BinaryData -Objekten enthält. Details zum Textkörperschema für jedes Element in der Auflistung finden Sie im Abschnitt Hinweise unten.

Ausnahmen

ArgumentNullException

projectName ist NULL.

ArgumentException

projectName ist eine leere Zeichenfolge und wurde erwartet, dass sie nicht leer ist.

RequestFailedException

Der Dienst hat einen nicht erfolgreichen status Code zurückgegeben.

Beispiele

In diesem Beispiel wird gezeigt, wie Sie GetAllEnvironmentsAsync aufrufen und das Ergebnis analysieren.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);

await foreach (BinaryData item in client.GetAllEnvironmentsAsync("<projectName>", null, null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("environmentType").ToString());
    Console.WriteLine(result.GetProperty("catalogName").ToString());
    Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
}

In diesem Beispiel wird gezeigt, wie Sie GetAllEnvironmentsAsync mit allen Parametern aufrufen und das Ergebnis analysieren.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);

await foreach (BinaryData item in client.GetAllEnvironmentsAsync("<projectName>", 1234, null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("parameters").ToString());
    Console.WriteLine(result.GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("environmentType").ToString());
    Console.WriteLine(result.GetProperty("user").ToString());
    Console.WriteLine(result.GetProperty("provisioningState").ToString());
    Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
    Console.WriteLine(result.GetProperty("catalogName").ToString());
    Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
    Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
    Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
    Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
    Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
}