Template Specs - Create Or Update

Service:

Resource Management

API Version:

2021-05-01

テンプレート スペックを作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	すべてのサービス呼び出しの URI の一部を形成するサブスクリプション ID。
templateSpecName	path	True	string	テンプレート スペックの名前。 Regex pattern: ^[-\w\._\(\)]+$
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
location	True	string	テンプレート スペックの場所。テンプレート スペックの作成後に変更することはできません。 サポートされている Azure の場所のいずれかである必要があります。
properties.description		string	テンプレート スペックの説明。
properties.displayName		string	テンプレート スペックの表示名。
properties.metadata		object	テンプレート スペックのメタデータ。 メタデータはオープンエンド オブジェクトであり、通常はキーと値のペアのコレクションです。
tags		object	リソース タグ。

応答

名前	型	説明
200 OK	TemplateSpec	OK - テンプレート スペックの更新要求が成功しました。
201 Created	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	ユーザー アカウントの借用

例

TemplateSpecsCreateUpdate

Sample Request

HTTP

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

{
  "location": "eastus",
  "properties": {
    "description": "A very simple Template Spec"
  }
}

Go

package armtemplatespecs_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/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/TemplateSpecsCreate.json
func ExampleClient_CreateOrUpdate() {
	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.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<template-spec-name>",
		armtemplatespecs.TemplateSpec{
			Location: to.Ptr("<location>"),
			Properties: &armtemplatespecs.TemplateSpecProperties{
				Description: to.Ptr("<description>"),
			},
		},
		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 Creates or updates a Template Spec.
 *
 * @summary Creates or updates a Template Spec.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-05-01/examples/TemplateSpecsCreate.json
 */
async function templateSpecsCreateUpdate() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = "templateSpecRG";
  const templateSpecName = "simpleTemplateSpec";
  const templateSpec = {
    description: "A very simple Template Spec",
    location: "eastus",
  };
  const credential = new DefaultAzureCredential();
  const client = new TemplateSpecsClient(credential, subscriptionId);
  const result = await client.templateSpecs.createOrUpdate(
    resourceGroupName,
    templateSpecName,
    templateSpec
  );
  console.log(result);
}

templateSpecsCreateUpdate().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/TemplateSpecsCreate.json
// this example is just showing the usage of "TemplateSpecs_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 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";
TemplateSpecData data = new TemplateSpecData(new AzureLocation("eastus"))
{
    Description = "A very simple Template Spec",
};
ArmOperation<TemplateSpecResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, templateSpecName, data);
TemplateSpecResource 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
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-01T01:01:01.1075056Z"
  },
  "properties": {
    "description": "A very simple Template Spec"
  }
}

Status code:

201

{
  "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	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
systemData	リソースの作成と最後の変更に関連するメタデータ。
TemplateSpec	テンプレート スペック オブジェクト。
TemplateSpecsError	テンプレート スペックのエラー応答。
TemplateSpecVersionInfo	テンプレート スペック バージョンに関する概要情報。

createdByType

リソースを作成した ID の種類。

名前	型	説明
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	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TemplateSpec

テンプレート スペック オブジェクト。

名前	型	説明
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 Resource Manager メタデータ。
tags	object	リソース タグ。
type	string	このリソースの種類。

TemplateSpecsError

テンプレート スペックのエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答 失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは、OData エラー応答形式にも従います)。

TemplateSpecVersionInfo

テンプレート スペック バージョンに関する概要情報。

名前	型	説明
description	string	テンプレート スペックのバージョンの説明。
timeCreated	string	バージョンが作成されたときのタイムスタンプ。
timeModified	string	バージョンが最後に変更された日時のタイムスタンプ。