Artifact Sources - List

Service:

Dev Test Labs

API-versie:

2018-09-15

Artefactbronnen in een bepaald lab weergeven.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
labName	path	True	string	De naam van het lab.
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	De abonnements-id.
api-version	query	True	string	Client-API-versie.
$expand	query		string	Geef de $expand query op. Voorbeeld: 'properties($select=displayName)'
$filter	query		string	Het filter dat moet worden toegepast op de bewerking. Voorbeeld: '$filter=contains(name,'myName')
$orderby	query		string	De volgorde-expressie voor de resultaten, met behulp van OData-notatie. Voorbeeld: '$orderby=name desc'
$top	query		integer int32	Het maximum aantal resources dat door de bewerking moet worden geretourneerd. Voorbeeld: '$top=10'

Antwoorden

Name	Type	Description
200 OK	ArtifactSourceList	OK
Other Status Codes	CloudError	BadRequest

Beveiliging

azure_auth

Impliciete OAuth2-toekenning

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Toegang tot Microsoft Azure

Voorbeelden

ArtifactSources_List

Voorbeeldaanvraag

HTTP

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

Java

/**
 * 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

Python

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

Go

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

JavaScript

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

dotnet

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

// 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

Voorbeeldrespons

Statuscode:

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"
      }
    }
  ]
}

Definities

Name	Description
ArtifactSource	Eigenschappen van een artefactbron.
ArtifactSourceList	Het antwoord van een lijstbewerking.
CloudError	Fout van een REST-aanvraag.
CloudErrorBody	Hoofdtekst van een fout van een REST-aanvraag.
EnableStatus	De status van de planning (ingeschakeld, uitgeschakeld)
SourceControlType	Het type artefactbron.

ArtifactSource

Eigenschappen van een artefactbron.

Name	Type	Description
id	string	De id van de resource.
location	string	De locatie van de resource.
name	string	De naam van de resource.
properties.armTemplateFolderPath	string	De map met Azure Resource Manager-sjablonen.
properties.branchRef	string	De vertakkingsreferentie van de artefactbron.
properties.createdDate	string	De aanmaakdatum van de artefactbron.
properties.displayName	string	De weergavenaam van de artefactbron.
properties.folderPath	string	De map met artefacten.
properties.provisioningState	string	De inrichtingsstatus van de resource.
properties.securityToken	string	Het beveiligingstoken dat moet worden geverifieerd bij de artefactbron.
properties.sourceType	SourceControlType	Het type artefactbron.
properties.status	EnableStatus	Geeft aan of de artefactbron is ingeschakeld (waarden: Ingeschakeld, Uitgeschakeld).
properties.uniqueIdentifier	string	De unieke onveranderbare id van een resource (GUID).
properties.uri	string	De URI van de artefactbron.
tags	object	De tags van de resource.
type	string	Het type resource.

ArtifactSourceList

Het antwoord van een lijstbewerking.

Name	Type	Description
nextLink	string	Koppeling voor de volgende set resultaten.
value	ArtifactSource[]	Resultaten van de lijstbewerking.

CloudError

Fout van een REST-aanvraag.

Name	Type	Description
error	CloudErrorBody	De cloudfout die is opgetreden

CloudErrorBody

Hoofdtekst van een fout van een REST-aanvraag.

Name	Type	Description
code	string	De foutcode.
details	CloudErrorBody[]	Interne fouten.
message	string	Het foutbericht.
target	string	Het foutdoel.

EnableStatus

De status van de planning (ingeschakeld, uitgeschakeld)

Name	Type	Description
Disabled	string
Enabled	string

SourceControlType

Het type artefactbron.

Name	Type	Description
GitHub	string
StorageAccount	string
VsoGit	string