Template Specs - List By Resource Group

服务:

Resource Management

API 版本:

2021-05-01

列出指定资源组中的所有模板规格。

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

具有可选参数:

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

URI 参数

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

响应

名称	类型	说明
200 OK	TemplateSpecsListResult	确定 - 返回模板规格数组。
Other Status Codes	TemplateSpecsError	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

TemplateSpecsListByResourceGroup

示例请求

HTTP

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.templatespecs import TemplateSpecsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-templatespecs
# USAGE
    python template_specs_list_by_resource_group.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 = TemplateSpecsClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.template_specs.list_by_resource_group(
        resource_group_name="templateSpecRG",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/templateSpecs/stable/2021-05-01/examples/TemplateSpecsListByResourceGroup.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

示例响应

状态代码:

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/templateSpecRG/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	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorResponse	错误响应
systemData	与创建和上次修改资源相关的元数据。
TemplateSpec	模板规格对象。
TemplateSpecExpandKind	允许在响应中扩展其他模板规格详细信息。 可选。
TemplateSpecsError	模板规格错误响应。
TemplateSpecsListResult	模板规格列表。
TemplateSpecVersionInfo	有关模板规格版本的概要信息。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorResponse

Object

错误响应

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

systemData

Object

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

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

TemplateSpec

Object

模板规格对象。

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

TemplateSpecExpandKind

枚举

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

值	说明
versions	包含模板规格的版本信息。

TemplateSpecsError

Object

模板规格错误响应。

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

TemplateSpecsListResult

Object

模板规格列表。

名称	类型	说明
nextLink	string	用于获取下一组结果的 URL。
value	TemplateSpec[]	模板规格数组。

TemplateSpecVersionInfo

Object

有关模板规格版本的概要信息。

名称	类型	说明
description	string	模板规格版本说明。
timeCreated	string (date-time)	创建版本的时间戳。
timeModified	string (date-time)	上次修改版本的时间戳。