DeploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalogAsync Método

Referência

Definição

Namespace:: Azure.Developer.DevCenter

Assembly:: Azure.Developer.DevCenter.dll

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

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

[Método protocol] Lista todas as definições de ambiente disponíveis em um catálogo.

Esse método de protocolo permite a criação explícita da solicitação e o processamento da resposta para cenários avançados.

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

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

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

Parâmetros

projectName: String

O Projeto do DevCenter no qual executar operações.

catalogName: String

O nome do catálogo.

maxCount: Nullable<Int32>

O número máximo de recursos a serem retornados da operação. Exemplo: 'top=10'.

context: RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

AsyncPageable<BinaryData>

O AsyncPageable<T> do serviço que contém uma lista de BinaryData objetos. Os detalhes do esquema do corpo de cada item na coleção estão na seção Comentários abaixo.

Exceções

ArgumentNullException

projectName ou catalogName é nulo.

ArgumentException

projectName ou catalogName é uma cadeia de caracteres vazia e esperava-se que não estivesse vazia.

RequestFailedException

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar GetEnvironmentDefinitionsByCatalogAsync e analisar o resultado.

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.GetEnvironmentDefinitionsByCatalogAsync("<projectName>", "<catalogName>", null, null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("catalogName").ToString());
}

Este exemplo mostra como chamar GetEnvironmentDefinitionsByCatalogAsync com todos os parâmetros e analisar o resultado.

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.GetEnvironmentDefinitionsByCatalogAsync("<projectName>", "<catalogName>", 1234, null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).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());
}

Aplica-se a

Compartilhar via