Arm Templates - Get

Servicio:

Dev Test Labs

Versión de la API:

2018-09-15

Obtenga la plantilla de Azure Resource Manager.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
artifactSourceName	path	True	string	Nombre del origen del artefacto.
labName	path	True	string	Nombre del laboratorio.
name	path	True	string	Nombre de la plantilla de Azure Resource Manager.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Identificador de suscripción.
api-version	query	True	string	Versión de la API de cliente.
$expand	query		string	Especifique la consulta $expand. Ejemplo: 'properties($select=displayName)'

Respuestas

Nombre	Tipo	Description
200 OK	ArmTemplate	De acuerdo
Other Status Codes	CloudError	Solicitud incorrecta

Seguridad

azure_auth

Concesión implícita de OAuth2

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	Acceso a Microsoft Azure

Ejemplos

ArmTemplates_Get

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for ArmTemplates Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArmTemplates_Get.json
     */
    /**
     * Sample code: ArmTemplates_Get.
     * 
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void armTemplatesGet(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager.armTemplates().getWithResponse("resourceGroupName", "{labName}", "{artifactSourceName}",
            "{armTemplateName}", 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 arm_templates_get.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.arm_templates.get(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        artifact_source_name="{artifactSourceName}",
        name="{armTemplateName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArmTemplates_Get.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/ArmTemplates_Get.json
func ExampleArmTemplatesClient_Get() {
	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.NewArmTemplatesClient().Get(ctx, "resourceGroupName", "{labName}", "{artifactSourceName}", "{armTemplateName}", &armdevtestlabs.ArmTemplatesClientGetOptions{Expand: 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.ArmTemplate = armdevtestlabs.ArmTemplate{
	// 	Name: to.Ptr("Template1"),
	// 	Type: to.Ptr("Microsoft.DevTestLab/labs/artifactSources/armTemplates"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"),
	// 	Location: to.Ptr("{location}"),
	// 	Tags: map[string]*string{
	// 		"MyTag": to.Ptr("MyValue"),
	// 	},
	// 	Properties: &armdevtestlabs.ArmTemplateProperties{
	// 		Contents: map[string]any{
	// 			"$schema": "http://schema.management.azure.com/schemas/2014-04-01-preview/deploymentTemplate.json#",
	// 			"contentVersion": "1.0.0.0",
	// 			"parameters":map[string]any{
	// 			},
	// 			"resources":[]any{
	// 			},
	// 			"variables":map[string]any{
	// 				"hostingPlanName": "[toLower(concat(variables('resourceNamePrefix'), '-', take(uniqueString(resourceGroup().id), 6), '-sp'))]",
	// 				"resourceNamePrefix": "[take(uniqueString(resourceGroup().id), 3)]",
	// 				"siteName": "[toLower(concat(variables('resourceNamePrefix'), '-', take(uniqueString(resourceGroup().id), 6)))]",
	// 			},
	// 		},
	// 		DisplayName: to.Ptr("Template1"),
	// 		Enabled: to.Ptr(true),
	// 		ParametersValueFilesInfo: []*armdevtestlabs.ParametersValueFileInfo{
	// 		},
	// 		Publisher: to.Ptr("Microsoft"),
	// 	},
	// }
}

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 Get azure resource manager template.
 *
 * @summary Get azure resource manager template.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArmTemplates_Get.json
 */
async function armTemplatesGet() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const artifactSourceName = "{artifactSourceName}";
  const name = "{armTemplateName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.armTemplates.get(
    resourceGroupName,
    labName,
    artifactSourceName,
    name
  );
  console.log(result);
}

armTemplatesGet().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;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ArmTemplates_Get.json
// this example is just showing the usage of "ArmTemplates_Get" 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 artifactSourceName = "{artifactSourceName}";
ResourceIdentifier devTestLabArtifactSourceResourceId = DevTestLabArtifactSourceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName, artifactSourceName);
DevTestLabArtifactSourceResource devTestLabArtifactSource = client.GetDevTestLabArtifactSourceResource(devTestLabArtifactSourceResourceId);

// get the collection of this DevTestLabArmTemplateResource
DevTestLabArmTemplateCollection collection = devTestLabArtifactSource.GetDevTestLabArmTemplates();

// invoke the operation
string name = "{armTemplateName}";
NullableResponse<DevTestLabArmTemplateResource> response = await collection.GetIfExistsAsync(name);
DevTestLabArmTemplateResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    DevTestLabArmTemplateData 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

Respuesta de muestra

status code:

200

{
  "properties": {
    "displayName": "Template1",
    "publisher": "Microsoft",
    "contents": {
      "$schema": "http://schema.management.azure.com/schemas/2014-04-01-preview/deploymentTemplate.json#",
      "contentVersion": "1.0.0.0",
      "parameters": {},
      "variables": {
        "resourceNamePrefix": "[take(uniqueString(resourceGroup().id), 3)]",
        "hostingPlanName": "[toLower(concat(variables('resourceNamePrefix'), '-', take(uniqueString(resourceGroup().id), 6), '-sp'))]",
        "siteName": "[toLower(concat(variables('resourceNamePrefix'), '-', take(uniqueString(resourceGroup().id), 6)))]"
      },
      "resources": []
    },
    "parametersValueFilesInfo": [],
    "enabled": true
  },
  "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}",
  "name": "Template1",
  "type": "Microsoft.DevTestLab/labs/artifactSources/armTemplates",
  "location": "{location}",
  "tags": {
    "MyTag": "MyValue"
  }
}

Definiciones

Nombre	Description
ArmTemplate	Una plantilla de Azure Resource Manager
CloudError	Error de una solicitud REST.
CloudErrorBody	Cuerpo de un error de una solicitud REST.
ParametersValueFileInfo	Un archivo que contiene un conjunto de valores de parámetro para una plantilla de ARM.

ArmTemplate

Object

Una plantilla de Azure Resource Manager

Nombre	Tipo	Description
id	string	Identificador del recurso.
location	string	La ubicación del recurso.
name	string	Nombre del recurso.
properties.contents	object	Contenido de la plantilla de ARM.
properties.createdDate	string (date-time)	Fecha de creación de armTemplate.
properties.description	string	Descripción de la plantilla de ARM.
properties.displayName	string	Nombre para mostrar de la plantilla de ARM.
properties.enabled	boolean	Si la plantilla de ARM está habilitada o no para su uso por parte del usuario del laboratorio.
properties.icon	string	Identificador URI del icono de la plantilla de ARM.
properties.parametersValueFilesInfo	ParametersValueFileInfo[]	Información sobre el nombre de archivo y los valores de parámetro de todas las.parameters.json azuredeploy.* de la plantilla de ARM.
properties.publisher	string	Publicador de la plantilla de ARM.
tags	object	Etiquetas del recurso.
type	string	Tipo del recurso.

CloudError

Object

Error de una solicitud REST.

Nombre	Tipo	Description
error	CloudErrorBody	Error en la nube que se produjo

CloudErrorBody

Object

Cuerpo de un error de una solicitud REST.

Nombre	Tipo	Description
code	string	Código de error.
details	CloudErrorBody[]	Errores internos.
message	string	Mensaje de error.
target	string	Destino del error.

ParametersValueFileInfo

Object

Un archivo que contiene un conjunto de valores de parámetro para una plantilla de ARM.

Nombre	Tipo	Description
fileName	string	Nombre de archivo.
parametersValueInfo	object	Contenido del archivo.