Template Specs - List By Subscription

Service:

Resource Management

API Version:

2021-05-01

指定したサブスクリプション内のすべてのテンプレート スペックをListsします。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	すべてのサービス呼び出しの URI の一部を形成するサブスクリプション ID。
api-version	query	True	string	クライアント API のバージョン。
$expand	query		TemplateSpecExpandKind	応答で追加のテンプレート スペックの詳細を拡張できます。 省略可能。

応答

名前	型	説明
200 OK	TemplateSpecsListResult	OK - テンプレート スペックの配列を返します。
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	ユーザー アカウントの借用

例

TemplatesSpecsListBySubscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Resources/templateSpecs/?$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/TemplateSpecsListBySubscription.json
func ExampleClient_NewListBySubscriptionPager() {
	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
	}
	pager := client.NewListBySubscriptionPager(&armtemplatespecs.ClientListBySubscriptionOptions{Expand: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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 Lists all the Template Specs within the specified subscriptions.
 *
 * @summary Lists all the Template Specs within the specified subscriptions.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-05-01/examples/TemplateSpecsListBySubscription.json
 */
async function templatesSpecsListBySubscription() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new TemplateSpecsClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.templateSpecs.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

templatesSpecsListBySubscription().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;
using Azure.ResourceManager.Resources.Models;

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

// invoke the operation and iterate over the result
await foreach (TemplateSpecResource item in subscriptionResource.GetTemplateSpecsAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "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"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG2/providers/Microsoft.Resources/templateSpecs/anotherSimpleTemplateSpec",
      "type": "Microsoft.Resources/templateSpecs",
      "name": "anotherSimpleTemplateSpec",
      "location": "westus",
      "systemData": {
        "createdBy": "string",
        "createdByType": "Application",
        "createdAt": "2020-02-02T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2020-02-03T02:03:01.1974346Z"
      },
      "properties": {
        "description": "Another very simple Template Spec"
      }
    }
  ]
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
systemData	リソースの作成と最後の変更に関連するメタデータ。
TemplateSpec	Template Spec オブジェクト。
TemplateSpecExpandKind	応答で追加のテンプレート スペックの詳細を拡張できます。 省略可能。
TemplateSpecsError	テンプレート スペックのエラー応答。
TemplateSpecsListResult	テンプレート スペックの一覧。
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

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

TemplateSpecExpandKind

応答で追加のテンプレート スペックの詳細を拡張できます。 省略可能。

名前	型	説明
versions	string	テンプレート スペックのバージョン情報が含まれています。

TemplateSpecsError

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

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

TemplateSpecsListResult

テンプレート スペックの一覧。

名前	型	説明
nextLink	string	次の結果セットを取得するために使用する URL。
value	TemplateSpec[]	テンプレート スペックの配列。

TemplateSpecVersionInfo

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

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