你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Template Specs - Get

Service:

Resource Management

API Version:

2021-05-01

获取具有给定名称的模板规格。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}?api-version=2021-05-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}?$expand=versions&api-version=2021-05-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。 此名称不区分大小写。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	订阅 ID，构成每个服务调用的 URI 的一部分。
templateSpecName	path	True	string	模板规范的名称。 Regex pattern: ^[-\w\._\(\)]+$
api-version	query	True	string	客户端 Api 版本。
$expand	query		TemplateSpecExpandKind	允许扩展响应中的其他模板规格详细信息。 可选。

响应

名称	类型	说明
200 OK	TemplateSpec	正常 - 返回有关模板规范的信息。
Other Status Codes	TemplateSpecsError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

TemplateSpecsGet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec?$expand=versions&api-version=2021-05-01

Go

package armtemplatespecs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armtemplatespecs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resources/resource-manager/Microsoft.Resources/stable/2021-05-01/examples/TemplateSpecsGet.json
func ExampleClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armtemplatespecs.NewClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<template-spec-name>",
		&armtemplatespecs.ClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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 { TemplateSpecsClient } = require("@azure/arm-templatespecs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a Template Spec with a given name.
 *
 * @summary Gets a Template Spec with a given name.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-05-01/examples/TemplateSpecsGet.json
 */
async function templateSpecsGet() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = "templateSpecRG";
  const templateSpecName = "simpleTemplateSpec";
  const credential = new DefaultAzureCredential();
  const client = new TemplateSpecsClient(credential, subscriptionId);
  const result = await client.templateSpecs.get(resourceGroupName, templateSpecName);
  console.log(result);
}

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

// Generated from example definition: specification/resources/resource-manager/Microsoft.Resources/stable/2021-05-01/examples/TemplateSpecsGet.json
// this example is just showing the usage of "TemplateSpecs_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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "templateSpecRG";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this TemplateSpecResource
TemplateSpecCollection collection = resourceGroupResource.GetTemplateSpecs();

// invoke the operation
string templateSpecName = "simpleTemplateSpec";
NullableResponse<TemplateSpecResource> response = await collection.GetIfExistsAsync(templateSpecName);
TemplateSpecResource 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
    TemplateSpecData 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

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec",
  "type": "Microsoft.Resources/templateSpecs",
  "name": "simpleTemplateSpec",
  "location": "eastus",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  },
  "properties": {
    "description": "A very simple Template Spec"
  }
}

定义

名称	说明
createdByType	创建资源的标识类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorResponse	错误响应
systemData	与资源的创建和上次修改相关的元数据。
TemplateSpec	Template Spec 对象。
TemplateSpecExpandKind	允许扩展响应中的其他模板规格详细信息。 可选。
TemplateSpecsError	模板规范错误响应。
TemplateSpecVersionInfo	有关模板规范版本的高级信息。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorResponse

错误响应

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorResponse[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

TemplateSpec

Template Spec 对象。

名称	类型	说明
id	string	用于在 Azure 上查找任何资源的字符串 ID。
location	string	模板规范的位置。创建模板规范后无法更改它。 它必须是受支持的 Azure 位置之一。
name	string	此资源的名称。
properties.description	string	模板规格说明。
properties.displayName	string	模板规格显示名称。
properties.metadata	object	模板规范元数据。 元数据是一个开放式对象，通常是键值对的集合。
properties.versions	<string,  TemplateSpecVersionInfo>	有关此模板规范中的版本的高级信息。键是版本名称。 仅当$expand查询参数设置为“versions”时才填充。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	此资源的类型。

TemplateSpecExpandKind

允许扩展响应中的其他模板规格详细信息。 可选。

名称	类型	说明
versions	string	包含包含模板规格的版本信息。

TemplateSpecsError

模板规范错误响应。

名称	类型	说明
error	ErrorResponse	错误响应 对所有 Azure 资源管理器 API 的常见错误响应，可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式。)

TemplateSpecVersionInfo

有关模板规范版本的高级信息。

名称	类型	说明
description	string	模板规范版本说明。
timeCreated	string	创建版本时的时间戳。
timeModified	string	上次修改版本时的时间戳。