Artifact Sources - List

Referência

Serviço:: Dev Test Labs

Versão da API:: 2018-09-15

Listar fontes de artefato em um determinado laboratório.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources?api-version=2018-09-15

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
labName	path	True	string	O nome do lab.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	A ID da assinatura.
api-version	query	True	string	Versão de API do cliente.
$expand	query		string	Especifique a consulta $expand. Exemplo: 'properties($select=displayName)'
$filter	query		string	O filtro a ser aplicado à operação. Exemplo: '$filter=contains(name,'myName')
$orderby	query		string	A expressão de ordenação para os resultados, usando a notação OData. Exemplo: '$orderby=name desc'
$top	query		integer int32	O número máximo de recursos a serem retornados da operação. Exemplo: '$top=10'

Respostas

Nome	Tipo	Description
200 OK	ArtifactSourceList	OK
Other Status Codes	CloudError	BadRequest

Segurança

azure_auth

Concessão Implícita OAuth2

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	Acessar o Microsoft Azure

Exemplos

ArtifactSources_List

Solicitação de exemplo

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources?api-version=2018-09-15


/**
 * Samples for ArtifactSources List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArtifactSources_List.
     * json
     */
    /**
     * Sample code: ArtifactSources_List.
     * 
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void artifactSourcesList(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager.artifactSources().list("resourceGroupName", "{labName}", null, null, null, 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python artifact_sources_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.artifact_sources.list(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArtifactSources_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArtifactSources_List.json
func ExampleArtifactSourcesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewArtifactSourcesClient().NewListPager("resourceGroupName", "{labName}", &armdevtestlabs.ArtifactSourcesClientListOptions{Expand: nil,
		Filter:  nil,
		Top:     nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ArtifactSourceList = armdevtestlabs.ArtifactSourceList{
		// 	Value: []*armdevtestlabs.ArtifactSource{
		// 		{
		// 			Name: to.Ptr("{artifactSourceName}"),
		// 			Type: to.Ptr("Microsoft.DevTestLab/labs/artifactsources"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}"),
		// 			Location: to.Ptr("{location}"),
		// 			Tags: map[string]*string{
		// 				"tagName1": to.Ptr("tagValue1"),
		// 			},
		// 			Properties: &armdevtestlabs.ArtifactSourceProperties{
		// 				ArmTemplateFolderPath: to.Ptr("{armTemplateFolderPath}"),
		// 				BranchRef: to.Ptr("{branchRef}"),
		// 				CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-16T23:53:02.483Z"); return t}()),
		// 				DisplayName: to.Ptr("{displayName}"),
		// 				FolderPath: to.Ptr("{folderPath}"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SecurityToken: to.Ptr("{securityToken}"),
		// 				SourceType: to.Ptr(armdevtestlabs.SourceControlType("{VsoGit|GitHub|StorageAccount}")),
		// 				Status: to.Ptr(armdevtestlabs.EnableStatus("{Enabled|Disabled}")),
		// 				UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
		// 				URI: to.Ptr("{artifactSourceUri}"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

/**
 * This sample demonstrates how to List artifact sources in a given lab.
 *
 * @summary List artifact sources in a given lab.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArtifactSources_List.json
 */
async function artifactSourcesList() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.artifactSources.list(resourceGroupName, labName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

artifactSourcesList().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DevTestLabs;
using Azure.ResourceManager.DevTestLabs.Models;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArtifactSources_List.json
// this example is just showing the usage of "ArtifactSources_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 DevTestLabResource created on azure
// for more information of creating DevTestLabResource, please refer to the document of DevTestLabResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
ResourceIdentifier devTestLabResourceId = DevTestLabResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName);
DevTestLabResource devTestLab = client.GetDevTestLabResource(devTestLabResourceId);

// get the collection of this DevTestLabArtifactSourceResource
DevTestLabArtifactSourceCollection collection = devTestLab.GetDevTestLabArtifactSources();

// invoke the operation and iterate over the result
await foreach (DevTestLabArtifactSourceResource 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
    DevTestLabArtifactSourceData 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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "properties": {
        "displayName": "{displayName}",
        "uri": "{artifactSourceUri}",
        "sourceType": "{VsoGit|GitHub|StorageAccount}",
        "folderPath": "{folderPath}",
        "armTemplateFolderPath": "{armTemplateFolderPath}",
        "branchRef": "{branchRef}",
        "securityToken": "{securityToken}",
        "status": "{Enabled|Disabled}",
        "createdDate": "2020-12-16T16:53:02.4830866-07:00",
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}",
      "name": "{artifactSourceName}",
      "type": "Microsoft.DevTestLab/labs/artifactsources",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Definições

Nome	Description
ArtifactSource	Propriedades de uma fonte de artefato.
ArtifactSourceList	A resposta de uma operação de lista.
CloudError	Erro de uma solicitação REST.
CloudErrorBody	Corpo de um erro de uma solicitação REST.
EnableStatus	O status do agendamento (ou seja, Habilitado, Desabilitado)
SourceControlType	O tipo da origem do artefato.

ArtifactSource

Propriedades de uma fonte de artefato.

Nome	Tipo	Description
id	string	O identificador do recurso.
location	string	A localização do recurso.
name	string	O nome do recurso.
properties.armTemplateFolderPath	string	A pasta que contém modelos de Resource Manager do Azure.
properties.branchRef	string	A referência de branch da origem do artefato.
properties.createdDate	string	A data de criação da fonte do artefato.
properties.displayName	string	O nome de exibição da origem do artefato.
properties.folderPath	string	A pasta que contém artefatos.
properties.provisioningState	string	O status de provisionamento do recurso.
properties.securityToken	string	O token de segurança a ser autenticado na origem do artefato.
properties.sourceType	SourceControlType	O tipo da origem do artefato.
properties.status	EnableStatus	Indica se a origem do artefato está habilitada (valores: Habilitado, Desabilitado).
properties.uniqueIdentifier	string	O identificador imutável exclusivo de um recurso (Guid).
properties.uri	string	O URI da origem do artefato.
tags	object	As marcas do recurso.
type	string	Tipo do recurso.

ArtifactSourceList

A resposta de uma operação de lista.

Nome	Tipo	Description
nextLink	string	Link para o próximo conjunto de resultados.
value	ArtifactSource[]	Resultados da operação de lista.

CloudError

Erro de uma solicitação REST.

Nome	Tipo	Description
error	CloudErrorBody	O erro de nuvem que ocorreu

CloudErrorBody

Corpo de um erro de uma solicitação REST.

Nome	Tipo	Description
code	string	O código de erro.
details	CloudErrorBody[]	Erros internos.
message	string	A mensagem de erro.
target	string	O destino do erro.

EnableStatus

O status do agendamento (ou seja, Habilitado, Desabilitado)

Nome	Tipo	Description
Disabled	string
Enabled	string

SourceControlType

O tipo da origem do artefato.

Nome	Tipo	Description
GitHub	string
StorageAccount	string
VsoGit	string