DevCenterClient.GetProjectsAsync Método

Definição

Namespace:

Azure.Developer.DevCenter

Assembly:

Azure.Developer.DevCenter.dll

Pacote:

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

[Método protocol] Lista todos os projetos.

• 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> GetProjectsAsync (string filter, int? maxCount, Azure.RequestContext context);

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

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

Parâmetros

filter

String

Uma cláusula de filtro OData a ser aplicada à operação.

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

RequestFailedException

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

Exemplos

Este exemplo mostra como chamar GetProjectsAsync e analisar o resultado.

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

await foreach (BinaryData item in client.GetProjectsAsync(null, null, null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("name").ToString());
}

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

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

await foreach (BinaryData item in client.GetProjectsAsync("<filter>", 1234, null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("maxDevBoxesPerUser").ToString());
}

Comentários

Abaixo está o esquema JSON de um item na resposta paginável.

Corpo da resposta:

Esquema para ProjectListResultValue:

{
  name: string, # Optional. Name of the project
  description: string, # Optional. Description of the project.
}