Template Specs - List By Subscription

Service:

Resource Management

API Version:

2021-05-01

Lijsten alle sjabloonspecificaties binnen de opgegeven abonnementen.

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-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	Abonnements-id die deel uitmaakt van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.
$expand	query		TemplateSpecExpandKind	Hiermee kunt u aanvullende details van sjabloonspecificaties in het antwoord uitbreiden. Optioneel.

Antwoorden

Name	Type	Description
200 OK	TemplateSpecsListResult	OK: retourneert een matrix met sjabloonspecificaties.
Other Status Codes	TemplateSpecsError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

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"
      }
    }
  ]
}

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Foutreactie
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
TemplateSpec	Sjabloonspecificatieobject.
TemplateSpecExpandKind	Hiermee kunt u aanvullende details van sjabloonspecificaties in het antwoord uitbreiden. Optioneel.
TemplateSpecsError	Foutreactie sjabloonspecificaties.
TemplateSpecsListResult	Lijst met sjabloonspecificaties.
TemplateSpecVersionInfo	Informatie op hoog niveau over een sjabloonspecificatieversie.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorResponse

Foutreactie

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

TemplateSpec

Sjabloonspecificatieobject.

Name	Type	Description
id	string	Tekenreeks-id die wordt gebruikt om een resource in Azure te zoeken.
location	string	De locatie van de sjabloonspecificatie. Deze kan niet worden gewijzigd nadat de sjabloonspecificatie is gemaakt. Dit moet een van de ondersteunde Azure-locaties zijn.
name	string	Naam van deze resource.
properties.description	string	Beschrijving van sjabloonspecificatie.
properties.displayName	string	Weergavenaam van sjabloonspecificatie.
properties.metadata	object	De metagegevens van sjabloonspecificatie. Metagegevens zijn een open-eindeobject en zijn meestal een verzameling sleutel-waardeparen.
properties.versions	<string,  TemplateSpecVersionInfo>	Informatie op hoog niveau over de versies binnen deze sjabloonspecificatie. De sleutels zijn de versienamen. Alleen ingevuld als de queryparameter $expand is ingesteld op 'versions'.
systemData	systemData	Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy.
tags	object	Resourcetags.
type	string	Type van deze resource.

TemplateSpecExpandKind

Hiermee kunt u aanvullende details van sjabloonspecificaties in het antwoord uitbreiden. Optioneel.

Name	Type	Description
versions	string	Bevat versiegegevens met de sjabloonspecificatie.

TemplateSpecsError

Foutreactie sjabloonspecificaties.

Name	Type	Description
error	ErrorResponse	Foutreactie Algemene foutreactie voor alle Azure Resource Manager API's om foutdetails voor mislukte bewerkingen te retourneren. (Dit volgt ook de OData-foutreactieindeling.)

TemplateSpecsListResult

Lijst met sjabloonspecificaties.

Name	Type	Description
nextLink	string	De URL die moet worden gebruikt om de volgende set resultaten op te halen.
value	TemplateSpec[]	Een matrix met sjabloonspecificaties.

TemplateSpecVersionInfo

Informatie op hoog niveau over een sjabloonspecificatieversie.

Name	Type	Description
description	string	Beschrijving van de versie van sjabloonspecificatie.
timeCreated	string	De tijdstempel van wanneer de versie is gemaakt.
timeModified	string	Het tijdstempel van wanneer de versie voor het laatst is gewijzigd.