Artifacts - Generate Arm Template

Serviço:

Dev Test Labs

Versão da API:

2018-09-15

Gera um modelo arm para o artefato especificado, carrega os arquivos necessários em uma conta de armazenamento e valida o artefato gerado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
artifactSourceName	path	True	string	O nome da origem do artefato.
labName	path	True	string	O nome do laboratório.
name	path	True	string	O nome do artefato.
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 da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
fileUploadOptions	FileUploadOptions	Opções para carregar os arquivos do artefato. UploadFilesAndGenerateSasTokens é o valor padrão.
location	string	O local da máquina virtual.
parameters	ParameterInfo[]	Os parâmetros do modelo do ARM.
virtualMachineName	string	O nome do recurso da máquina virtual.

Respostas

Nome	Tipo	Description
200 OK	ArmTemplateInfo	OKEY
Other Status Codes	CloudError	Solicitação Inválida

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

Artifacts_GenerateArmTemplate

Solicitação de exemplo

HTTP

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

{
  "fileUploadOptions": "None",
  "location": "{location}",
  "virtualMachineName": "{vmName}"
}

Java

import com.azure.resourcemanager.devtestlabs.models.FileUploadOptions;
import com.azure.resourcemanager.devtestlabs.models.GenerateArmTemplateRequest;

/**
 * Samples for Artifacts GenerateArmTemplate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/
     * Artifacts_GenerateArmTemplate.json
     */
    /**
     * Sample code: Artifacts_GenerateArmTemplate.
     * 
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void artifactsGenerateArmTemplate(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager.artifacts().generateArmTemplateWithResponse("resourceGroupName", "{labName}", "{artifactSourceName}",
            "{artifactName}", new GenerateArmTemplateRequest().withVirtualMachineName("{vmName}")
                .withLocation("{location}").withFileUploadOptions(FileUploadOptions.NONE),
            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 artifacts_generate_arm_template.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.artifacts.generate_arm_template(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        artifact_source_name="{artifactSourceName}",
        name="{artifactName}",
        generate_arm_template_request={
            "fileUploadOptions": "None",
            "location": "{location}",
            "virtualMachineName": "{vmName}",
        },
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Artifacts_GenerateArmTemplate.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/Artifacts_GenerateArmTemplate.json
func ExampleArtifactsClient_GenerateArmTemplate() {
	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.NewArtifactsClient().GenerateArmTemplate(ctx, "resourceGroupName", "{labName}", "{artifactSourceName}", "{artifactName}", armdevtestlabs.GenerateArmTemplateRequest{
		FileUploadOptions:  to.Ptr(armdevtestlabs.FileUploadOptionsNone),
		Location:           to.Ptr("{location}"),
		VirtualMachineName: to.Ptr("{vmName}"),
	}, 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.ArmTemplateInfo = armdevtestlabs.ArmTemplateInfo{
	// 	Parameters: map[string]any{
	// 		"extensionName":map[string]any{
	// 			"value": "{vmName}/CustomScriptExtension",
	// 		},
	// 		"location":map[string]any{
	// 			"value": "{location}",
	// 		},
	// 	},
	// 	Template: map[string]any{
	// 		"$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
	// 		"contentVersion": "1.0.0.0",
	// 		"parameters":map[string]any{
	// 			"extensionName":map[string]any{
	// 				"type": "string",
	// 			},
	// 			"location":map[string]any{
	// 				"type": "string",
	// 			},
	// 		},
	// 		"resources":[]any{
	// 			map[string]any{
	// 				"name": "[parameters('extensionName')]",
	// 				"type": "Microsoft.Compute/virtualMachines/extensions",
	// 				"apiVersion": "2015-06-15",
	// 				"location": "[parameters('location')]",
	// 				"properties":map[string]any{
	// 					"type": "CustomScriptExtension",
	// 					"autoUpgradeMinorVersion": "true",
	// 					"forceUpdateTag": "15/10/2018 00:00:00 +00:00",
	// 					"protectedSettings":map[string]any{
	// 						"commandToExecute": "[concat('cd {MsDtlScriptFolder}/scripts && ', variables('_commandToExecute'))]",
	// 					},
	// 					"publisher": "Microsoft.Compute",
	// 					"settings":map[string]any{
	// 						"commandToExecute": "",
	// 						"fileUris":[]any{
	// 							"{MsDtlArtifactFileUris}",
	// 						},
	// 					},
	// 					"typeHandlerVersion": "1.9",
	// 				},
	// 			},
	// 		},
	// 		"variables":map[string]any{
	// 			"_commandToExecute": "{commandToExecute}.",
	// 		},
	// 	},
	// }
}

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 Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.
 *
 * @summary Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Artifacts_GenerateArmTemplate.json
 */
async function artifactsGenerateArmTemplate() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const artifactSourceName = "{artifactSourceName}";
  const name = "{artifactName}";
  const generateArmTemplateRequest = {
    fileUploadOptions: "None",
    location: "{location}",
    virtualMachineName: "{vmName}",
  };
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.artifacts.generateArmTemplate(
    resourceGroupName,
    labName,
    artifactSourceName,
    name,
    generateArmTemplateRequest
  );
  console.log(result);
}

artifactsGenerateArmTemplate().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/Artifacts_GenerateArmTemplate.json
// this example is just showing the usage of "Artifacts_GenerateArmTemplate" 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 DevTestLabArtifactResource created on azure
// for more information of creating DevTestLabArtifactResource, please refer to the document of DevTestLabArtifactResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
string artifactSourceName = "{artifactSourceName}";
string name = "{artifactName}";
ResourceIdentifier devTestLabArtifactResourceId = DevTestLabArtifactResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName, artifactSourceName, name);
DevTestLabArtifactResource devTestLabArtifact = client.GetDevTestLabArtifactResource(devTestLabArtifactResourceId);

// invoke the operation
DevTestLabArtifactGenerateArmTemplateContent content = new DevTestLabArtifactGenerateArmTemplateContent
{
    VmName = "{vmName}",
    Location = new AzureLocation("{location}"),
    FileUploadOptions = DevTestLabFileUploadOption.None,
};
DevTestLabArmTemplateInfo result = await devTestLabArtifact.GenerateArmTemplateAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

{
  "template": {
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
      "location": {
        "type": "string"
      },
      "extensionName": {
        "type": "string"
      }
    },
    "variables": {
      "_commandToExecute": "{commandToExecute}."
    },
    "resources": [
      {
        "type": "Microsoft.Compute/virtualMachines/extensions",
        "name": "[parameters('extensionName')]",
        "apiVersion": "2015-06-15",
        "location": "[parameters('location')]",
        "properties": {
          "publisher": "Microsoft.Compute",
          "type": "CustomScriptExtension",
          "typeHandlerVersion": "1.9",
          "autoUpgradeMinorVersion": "true",
          "forceUpdateTag": "15/10/2018 00:00:00 +00:00",
          "settings": {
            "fileUris": [
              "{MsDtlArtifactFileUris}"
            ],
            "commandToExecute": ""
          },
          "protectedSettings": {
            "commandToExecute": "[concat('cd {MsDtlScriptFolder}/scripts && ', variables('_commandToExecute'))]"
          }
        }
      }
    ]
  },
  "parameters": {
    "extensionName": {
      "value": "{vmName}/CustomScriptExtension"
    },
    "location": {
      "value": "{location}"
    }
  }
}

Definições

Nome	Description
ArmTemplateInfo	Informações sobre um modelo do ARM gerado.
CloudError	Erro de uma solicitação REST.
CloudErrorBody	Corpo de um erro de uma solicitação REST.
FileUploadOptions	Opções para carregar os arquivos do artefato. UploadFilesAndGenerateSasTokens é o valor padrão.
GenerateArmTemplateRequest	Parâmetros para gerar um modelo do ARM para implantar artefatos.
ParameterInfo	Informações sobre o parâmetro de um artefato.

ArmTemplateInfo

Objeto

Informações sobre um modelo do ARM gerado.

Nome	Tipo	Description
parameters	object	Os parâmetros do modelo do ARM.
template	object	O conteúdo do modelo.

CloudError

Objeto

Erro de uma solicitação REST.

Nome	Tipo	Description
error	CloudErrorBody	O erro de nuvem que ocorreu

CloudErrorBody

Objeto

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.

FileUploadOptions

Enumeração

Opções para carregar os arquivos do artefato. UploadFilesAndGenerateSasTokens é o valor padrão.

Valor	Description
None
UploadFilesAndGenerateSasTokens

GenerateArmTemplateRequest

Objeto

Parâmetros para gerar um modelo do ARM para implantar artefatos.

Nome	Tipo	Description
fileUploadOptions	FileUploadOptions	Opções para carregar os arquivos do artefato. UploadFilesAndGenerateSasTokens é o valor padrão.
location	string	O local da máquina virtual.
parameters	ParameterInfo[]	Os parâmetros do modelo do ARM.
virtualMachineName	string	O nome do recurso da máquina virtual.

ParameterInfo

Objeto

Informações sobre o parâmetro de um artefato.

Nome	Tipo	Description
name	string	O nome do parâmetro de artefato.
value	string	O valor do parâmetro de artefato.