Artifact Sources - Create Or Update

Référence

Service:: Dev Test Labs

Version d'API:: 2018-09-15

Créez ou remplacez une source d’artefact existante.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
labName	path	True	string	Nom du lab.
name	path	True	string	Nom de la source de l’artefact.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	L'ID de l'abonnement.
api-version	query	True	string	Version d’API client.

Corps de la demande

Nom	Type	Description
location	string	Emplacement de la ressource.
properties.armTemplateFolderPath	string	Dossier contenant des modèles de Resource Manager Azure.
properties.branchRef	string	Référence de branche de la source d’artefact.
properties.displayName	string	Nom complet de la source de l’artefact.
properties.folderPath	string	Dossier contenant des artefacts.
properties.securityToken	string	Jeton de sécurité à authentifier auprès de la source de l’artefact.
properties.sourceType	SourceControlType	Type de la source de l’artefact.
properties.status	EnableStatus	Indique si la source de l’artefact est activée (valeurs : Activé, Désactivé).
properties.uri	string	URI de la source d’artefact.
tags	object	Balises de la ressource.

Réponses

Nom	Type	Description
200 OK	ArtifactSource	Ok
201 Created	ArtifactSource	Date de création
Other Status Codes	CloudError	BadRequest

Sécurité

azure_auth

Octroi implicite OAuth2

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Accéder à Microsoft Azure

Exemples

ArtifactSources_CreateOrUpdate

Exemple de requête

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

{
  "properties": {
    "displayName": "{displayName}",
    "uri": "{artifactSourceUri}",
    "sourceType": "{VsoGit|GitHub|StorageAccount}",
    "folderPath": "{folderPath}",
    "armTemplateFolderPath": "{armTemplateFolderPath}",
    "branchRef": "{branchRef}",
    "securityToken": "{securityToken}",
    "status": "{Enabled|Disabled}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}


import com.azure.resourcemanager.devtestlabs.models.EnableStatus;
import com.azure.resourcemanager.devtestlabs.models.SourceControlType;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for ArtifactSources CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/
     * ArtifactSources_CreateOrUpdate.json
     */
    /**
     * Sample code: ArtifactSources_CreateOrUpdate.
     * 
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void artifactSourcesCreateOrUpdate(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager.artifactSources().define("{artifactSourceName}").withRegion((String) null)
            .withExistingLab("resourceGroupName", "{labName}").withTags(mapOf("tagName1", "tagValue1"))
            .withDisplayName("{displayName}").withUri("{artifactSourceUri}")
            .withSourceType(SourceControlType.fromString("{VsoGit|GitHub|StorageAccount}"))
            .withFolderPath("{folderPath}").withArmTemplateFolderPath("{armTemplateFolderPath}")
            .withBranchRef("{branchRef}").withSecurityToken("{securityToken}")
            .withStatus(EnableStatus.fromString("{Enabled|Disabled}")).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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_create_or_update.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.create_or_update(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        name="{artifactSourceName}",
        artifact_source={
            "properties": {
                "armTemplateFolderPath": "{armTemplateFolderPath}",
                "branchRef": "{branchRef}",
                "displayName": "{displayName}",
                "folderPath": "{folderPath}",
                "securityToken": "{securityToken}",
                "sourceType": "{VsoGit|GitHub|StorageAccount}",
                "status": "{Enabled|Disabled}",
                "uri": "{artifactSourceUri}",
            },
            "tags": {"tagName1": "tagValue1"},
        },
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArtifactSources_CreateOrUpdate.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/azcore/to"
	"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_CreateOrUpdate.json
func ExampleArtifactSourcesClient_CreateOrUpdate() {
	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)
	}
	res, err := clientFactory.NewArtifactSourcesClient().CreateOrUpdate(ctx, "resourceGroupName", "{labName}", "{artifactSourceName}", armdevtestlabs.ArtifactSource{
		Tags: map[string]*string{
			"tagName1": to.Ptr("tagValue1"),
		},
		Properties: &armdevtestlabs.ArtifactSourceProperties{
			ArmTemplateFolderPath: to.Ptr("{armTemplateFolderPath}"),
			BranchRef:             to.Ptr("{branchRef}"),
			DisplayName:           to.Ptr("{displayName}"),
			FolderPath:            to.Ptr("{folderPath}"),
			SecurityToken:         to.Ptr("{securityToken}"),
			SourceType:            to.Ptr(armdevtestlabs.SourceControlType("{VsoGit|GitHub|StorageAccount}")),
			Status:                to.Ptr(armdevtestlabs.EnableStatus("{Enabled|Disabled}")),
			URI:                   to.Ptr("{artifactSourceUri}"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ArtifactSource = 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 Create or replace an existing artifact source.
 *
 * @summary Create or replace an existing artifact source.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArtifactSources_CreateOrUpdate.json
 */
async function artifactSourcesCreateOrUpdate() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const name = "{artifactSourceName}";
  const artifactSource = {
    armTemplateFolderPath: "{armTemplateFolderPath}",
    branchRef: "{branchRef}",
    displayName: "{displayName}",
    folderPath: "{folderPath}",
    securityToken: "{securityToken}",
    sourceType: "{VsoGit|GitHub|StorageAccount}",
    status: "{Enabled|Disabled}",
    tags: { tagName1: "tagValue1" },
    uri: "{artifactSourceUri}",
  };
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.artifactSources.createOrUpdate(
    resourceGroupName,
    labName,
    name,
    artifactSource
  );
  console.log(result);
}

artifactSourcesCreateOrUpdate().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_CreateOrUpdate.json
// this example is just showing the usage of "ArtifactSources_CreateOrUpdate" 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
string name = "{artifactSourceName}";
DevTestLabArtifactSourceData data = new DevTestLabArtifactSourceData(new AzureLocation("placeholder"))
{
    DisplayName = "{displayName}",
    Uri = new Uri("{artifactSourceUri}"),
    SourceType = new DevTestLabSourceControlType("{VsoGit|GitHub|StorageAccount}"),
    FolderPath = "{folderPath}",
    ArmTemplateFolderPath = "{armTemplateFolderPath}",
    BranchRef = "{branchRef}",
    SecurityToken = "{securityToken}",
    Status = new DevTestLabEnableStatus("{Enabled|Disabled}"),
    Tags =
    {
    ["tagName1"] = "tagValue1",
    },
};
ArmOperation<DevTestLabArtifactSourceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, name, data);
DevTestLabArtifactSourceResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exemple de réponse

Code d’état:: 200

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

Code d’état:: 201

{
  "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": "Created",
    "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"
  }
}

Définitions

Nom	Description
ArtifactSource	Propriétés d’une source d’artefact.
CloudError	Erreur d’une requête REST.
CloudErrorBody	Corps d’une erreur à partir d’une requête REST.
EnableStatus	Status de la planification (par exemple, Activé, Désactivé)
SourceControlType	Type de la source de l’artefact.

ArtifactSource

Propriétés d’une source d’artefact.

Nom	Type	Description
id	string	Identificateur de la ressource.
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.armTemplateFolderPath	string	Dossier contenant des modèles de Resource Manager Azure.
properties.branchRef	string	Référence de branche de la source d’artefact.
properties.createdDate	string	Date de création de la source de l’artefact.
properties.displayName	string	Nom complet de la source de l’artefact.
properties.folderPath	string	Dossier contenant des artefacts.
properties.provisioningState	string	Status d’approvisionnement de la ressource.
properties.securityToken	string	Jeton de sécurité à authentifier auprès de la source de l’artefact.
properties.sourceType	SourceControlType	Type de la source de l’artefact.
properties.status	EnableStatus	Indique si la source de l’artefact est activée (valeurs : Activé, Désactivé).
properties.uniqueIdentifier	string	Identificateur immuable unique d’une ressource (GUID).
properties.uri	string	URI de la source d’artefact.
tags	object	Balises de la ressource.
type	string	Type de la ressource.

CloudError

Erreur d’une requête REST.

Nom	Type	Description
error	CloudErrorBody	Erreur cloud qui s’est produite

CloudErrorBody

Corps d’une erreur à partir d’une requête REST.

Nom	Type	Description
code	string	Code d'erreur.
details	CloudErrorBody[]	Erreurs internes.
message	string	Message d’erreur.
target	string	Cible d’erreur.

EnableStatus

Status de la planification (par exemple, Activé, Désactivé)

Nom	Type	Description
Disabled	string
Enabled	string

SourceControlType

Type de la source de l’artefact.

Nom	Type	Description
GitHub	string
StorageAccount	string
VsoGit	string