Microsoft.Resources 範本Specs 2022-02-01

Bicep 資源定義

templateSpecs 資源類型可以部署到:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

備註

建議您不要使用 ARM 範本或 Bicep 檔案來定義範本規格,而是建議您在 azure CLI 中使用New-AzTemplateSpec Azure PowerShell 或az ts create來建立範本規格。這些命令會自動將連結的範本轉換成連線至主要範本的成品。 當您使用 ARM 範本來建立範本規格時,您必須手動將這些連結的範本新增為成品,而這可能會很複雜。 如需詳細資訊,請參閱 快速入門:建立和部署範本規格

資源格式

若要建立 Microsoft.Resources/templateSpecs 資源,請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Resources/templateSpecs@2022-02-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
  }
}

屬性值

templateSpecs

名稱 描述
NAME 資源名稱 字串 (必要)

字元限制:1-90

有效字元:
英數字元、底線、括弧、連字號和句號。
location 範本規格的位置。建立範本規格之後,就無法變更它。 它必須是其中一個支援的 Azure 位置。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
properties 範本規格屬性。 TemplateSpecProperties

TemplateSpecProperties

名稱 描述
description 範本規格描述。 字串
displayName 範本規格顯示名稱。 字串
中繼資料 範本規格中繼資料。 中繼資料是開放式物件,通常是索引鍵/值組的集合。 針對 Bicep,您可以使用 any () 函式。

ARM 範本資源定義

templateSpecs 資源類型可以部署到:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

備註

建議您不要使用 ARM 範本或 Bicep 檔案來定義範本規格,而是建議您在 azure CLI 中使用New-AzTemplateSpec Azure PowerShell 或az ts create來建立範本規格。這些命令會自動將連結的範本轉換成連線至主要範本的成品。 當您使用 ARM 範本來建立範本規格時,您必須手動將這些連結的範本新增為成品,而這可能會很複雜。 如需詳細資訊,請參閱 快速入門:建立和部署範本規格

資源格式

若要建立 Microsoft.Resources/templateSpecs 資源,請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.Resources/templateSpecs",
  "apiVersion": "2022-02-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {}
  }
}

屬性值

templateSpecs

名稱 描述
type 資源類型 'Microsoft.Resources/templateSpecs'
apiVersion 資源 API 版本 '2022-02-01'
NAME 資源名稱 字串 (必要)

字元限制:1-90

有效字元:
英數字元、底線、括弧、連字號和句號。
location 範本規格的位置。建立範本規格之後,就無法變更它。 它必須是其中一個支援的 Azure 位置。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
properties 範本規格屬性。 TemplateSpecProperties

TemplateSpecProperties

名稱 描述
description 範本規格描述。 字串
displayName 範本規格顯示名稱。 字串
中繼資料 範本規格中繼資料。 中繼資料是開放式物件,通常是索引鍵/值組的集合。

Terraform (AzAPI 提供者) 資源定義

templateSpecs 資源類型可以部署到:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Resources/templateSpecs 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/templateSpecs@2022-02-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
    }
  })
}

屬性值

templateSpecs

名稱 描述
type 資源類型 「Microsoft.Resources/templateSpecs@2022-02-01」
NAME 資源名稱 需要字串 ()

字元限制:1-90

有效字元:
英數字元、底線、括弧、連字號和句號。
location 範本規格的位置。建立範本規格之後就無法變更。 它必須是其中一個支援的 Azure 位置。 需要字串 ()
parent_id 若要部署至資源群組,請使用該資源群組的識別碼。 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。
properties 範本規格屬性。 TemplateSpecProperties

TemplateSpecProperties

名稱 描述
description 範本規格描述。 字串
displayName 範本規格顯示名稱。 字串
中繼資料 範本規格中繼資料。 中繼資料是開放式物件,通常是索引鍵/值組的集合。