Artifact Sources - Update

Serviço:

Dev Test Labs

Versão da API:

2018-09-15

Permite modificar etiquetas de origens de artefactos. Todas as outras propriedades serão ignoradas.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
labName	path	True	string	O nome do laboratório.
name	path	True	string	O nome da origem do artefacto.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	O ID da subscrição.
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

Name	Tipo	Description
tags	object	As etiquetas do recurso.

Respostas

Name	Tipo	Description
200 OK	ArtifactSource	OK
Other Status Codes	CloudError	BadRequest

Segurança

azure_auth

Concessão Implícita OAuth2

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

Âmbitos

Name	Description
user_impersonation	Aceder ao Microsoft Azure

Exemplos

ArtifactSources_Update

Pedido de amostra

HTTP

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

{
  "tags": {
    "tagName1": "tagValue1"
  }
}

Java

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

/**
 * Samples for ArtifactSources Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArtifactSources_Update
     * .json
     */
    /**
     * Sample code: ArtifactSources_Update.
     * 
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void artifactSourcesUpdate(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        ArtifactSource resource = manager.artifactSources().getWithResponse("resourceGroupName", "{labName}",
            "{artifactSourceName}", null, com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf("tagName1", "tagValue1")).apply();
    }

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

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_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.update(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        name="{artifactSourceName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArtifactSources_Update.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/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_Update.json
func ExampleArtifactSourcesClient_Update() {
	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().Update(ctx, "resourceGroupName", "{labName}", "{artifactSourceName}", armdevtestlabs.ArtifactSourceFragment{
		Tags: map[string]*string{
			"tagName1": to.Ptr("tagValue1"),
		},
	}, 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

JavaScript

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

/**
 * This sample demonstrates how to Allows modifying tags of artifact sources. All other properties will be ignored.
 *
 * @summary Allows modifying tags of artifact sources. All other properties will be ignored.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArtifactSources_Update.json
 */
async function artifactSourcesUpdate() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const name = "{artifactSourceName}";
  const artifactSource = {
    tags: { tagName1: "tagValue1" },
  };
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.artifactSources.update(
    resourceGroupName,
    labName,
    name,
    artifactSource
  );
  console.log(result);
}

artifactSourcesUpdate().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 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_Update.json
// this example is just showing the usage of "ArtifactSources_Update" 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 DevTestLabArtifactSourceResource created on azure
// for more information of creating DevTestLabArtifactSourceResource, please refer to the document of DevTestLabArtifactSourceResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
string name = "{artifactSourceName}";
ResourceIdentifier devTestLabArtifactSourceResourceId = DevTestLabArtifactSourceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName, name);
DevTestLabArtifactSourceResource devTestLabArtifactSource = client.GetDevTestLabArtifactSourceResource(devTestLabArtifactSourceResourceId);

// invoke the operation
DevTestLabArtifactSourcePatch patch = new DevTestLabArtifactSourcePatch()
{
    Tags =
    {
    ["tagName1"] = "tagValue1",
    },
};
DevTestLabArtifactSourceResource result = await devTestLabArtifactSource.UpdateAsync(patch);

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
ArtifactSource	Propriedades de uma origem de artefacto.
ArtifactSourceFragment	Propriedades de uma origem de artefacto.
CloudError	Erro de um pedido REST.
CloudErrorBody	Corpo de um erro de um pedido REST.
EnableStatus	O estado da agenda (ou seja, Ativado, Desativado)
SourceControlType	O tipo da origem do artefacto.

ArtifactSource

Propriedades de uma origem de artefacto.

Name	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	Referência do ramo da origem do artefacto.
properties.createdDate	string	A data de criação da origem do artefacto.
properties.displayName	string	O nome a apresentar da origem do artefacto.
properties.folderPath	string	A pasta que contém artefactos.
properties.provisioningState	string	O estado de aprovisionamento do recurso.
properties.securityToken	string	O token de segurança a autenticar na origem do artefacto.
properties.sourceType	SourceControlType	O tipo da origem do artefacto.
properties.status	EnableStatus	Indica se a origem do artefacto está ativada (valores: Ativado, Desativado).
properties.uniqueIdentifier	string	O identificador imutável exclusivo de um recurso (Guid).
properties.uri	string	O URI da origem do artefacto.
tags	object	As etiquetas do recurso.
type	string	O tipo do recurso.

ArtifactSourceFragment

Propriedades de uma origem de artefacto.

Name	Tipo	Description
tags	object	As etiquetas do recurso.

CloudError

Erro de um pedido REST.

Name	Tipo	Description
error	CloudErrorBody	O erro na cloud que ocorreu

CloudErrorBody

Corpo de um erro de um pedido REST.

Name	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 estado da agenda (ou seja, Ativado, Desativado)

Name	Tipo	Description
Disabled	string
Enabled	string

SourceControlType

O tipo da origem do artefacto.

Name	Tipo	Description
GitHub	string
StorageAccount	string
VsoGit	string