DeploymentEnvironmentsClient.GetEnvironmentDefinition Methode

Definition

Namespace:

Azure.Developer.DevCenter

Assembly:

Azure.Developer.DevCenter.dll

Paket:

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

[Protokollmethode] Rufen Sie eine Umgebungsdefinition aus einem Katalog ab.

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

public virtual Azure.Response GetEnvironmentDefinition (string projectName, string catalogName, string definitionName, Azure.RequestContext context);

abstract member GetEnvironmentDefinition : string * string * string * Azure.RequestContext -> Azure.Response
override this.GetEnvironmentDefinition : string * string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetEnvironmentDefinition (projectName As String, catalogName As String, definitionName As String, context As RequestContext) As Response

Parameter

projectName

String

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

catalogName

String

Der Name des Katalogs.

definitionName

String

Der Name der Umgebungsdefinition.

context

RequestContext

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

Gibt zurück

Response

Die vom Dienst zurückgegebene Antwort.

Ausnahmen

ArgumentNullException

projectName, catalogName oder definitionName ist NULL.

ArgumentException

projectNamedefinitionName oder catalogName ist eine leere Zeichenfolge, die nicht leer sein sollte.

RequestFailedException

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

Beispiele

In diesem Beispiel wird gezeigt, wie GetEnvironmentDefinition aufgerufen und das Ergebnis analysiert wird.

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

Response response = client.GetEnvironmentDefinition("<projectName>", "<catalogName>", "<definitionName>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());

In diesem Beispiel wird gezeigt, wie GetEnvironmentDefinition mit allen Parametern aufgerufen und das Ergebnis analysiert wird.

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

Response response = client.GetEnvironmentDefinition("<projectName>", "<catalogName>", "<definitionName>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("default").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("readOnly").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("required").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("allowed")[0].ToString());
Console.WriteLine(result.GetProperty("parametersSchema").ToString());
Console.WriteLine(result.GetProperty("templatePath").ToString());