Resource Groups - Export Template

サービス:

Resource Management

API バージョン:

2021-04-01

指定したリソース グループをテンプレートとしてキャプチャします。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate?api-version=2021-04-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string	Microsoft Azure サブスクリプション ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
options	string	テンプレートのエクスポート オプション。 次の 0 個以上を含む CSV 形式のリスト: 'IncludeParameterDefaultValue'、'IncludeComments'、'SkipResourceNameParameterization'、'SkipAllParameterization'
resources	string[]	エクスポートをフィルター処理するリソースの ID。 すべてのリソースをエクスポートするには、単一のエントリ '*' を持つ配列を指定します。

応答

名前	型	説明
200 OK	ResourceGroupExportResult	OK - エクスポートの結果を返します。
202 Accepted		受け入れられた
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Export a resource group

Export a resource group with filtering

Export a resource group

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/exportTemplate?api-version=2021-04-01

{
  "resources": [
    "*"
  ],
  "options": "IncludeParameterDefaultValue,IncludeComments"
}

応答のサンプル

状態コード:

202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01

状態コード:

200

{
  "template": {
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
      "myResourceType_myFirstResource_name": {
        "defaultValue": "myFirstResource",
        "type": "String"
      },
      "myResourceType_mySecondResource_name": {
        "defaultValue": "mySecondResource",
        "type": "String"
      },
      "myResourceType_myFirstResource_secret": {
        "defaultValue": null,
        "type": "SecureString"
      }
    },
    "variables": {},
    "resources": [
      {
        "type": "My.RP/myResourceType",
        "apiVersion": "2019-01-01",
        "name": "[parameters('myResourceType_myFirstResource_name')]",
        "location": "West US",
        "properties": {
          "secret": "[parameters('myResourceType_myFirstResource_secret')]"
        }
      },
      {
        "type": "My.RP/myResourceType",
        "apiVersion": "2019-01-01",
        "name": "[parameters('myResourceType_mySecondResource_name')]",
        "location": "West US",
        "properties": {
          "customProperty": "hello!"
        }
      }
    ]
  },
  "error": {
    "code": "ExportTemplateCompletedWithErrors",
    "message": "Export template operation completed with errors. Some resources were not exported. Please see details for more information.",
    "details": []
  }
}

Export a resource group with filtering

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/exportTemplate?api-version=2021-04-01

{
  "resources": [
    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/My.RP/myResourceType/myFirstResource"
  ],
  "options": "SkipResourceNameParameterization"
}

応答のサンプル

状態コード:

202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01

状態コード:

200

{
  "template": {
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
      "myResourceType_myFirstResource_secret": {
        "defaultValue": null,
        "type": "SecureString"
      }
    },
    "variables": {},
    "resources": [
      {
        "type": "My.RP/myResourceType",
        "apiVersion": "2019-01-01",
        "name": "myFirstResource",
        "location": "West US",
        "properties": {
          "secret": "[parameters('myResourceType_myFirstResource_secret')]"
        }
      }
    ]
  }
}

定義

名前	説明
CloudError	リソース管理要求のエラー応答。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
ExportTemplateRequest	リソース グループ テンプレート要求パラメーターをエクスポートします。
ResourceGroupExportResult	リソース グループのエクスポート結果。

CloudError

Object

リソース管理要求のエラー応答。

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

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorResponse

Object

エラー応答

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorResponse[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ExportTemplateRequest

Object

リソース グループ テンプレート要求パラメーターをエクスポートします。

名前	型	説明
options	string	テンプレートのエクスポート オプション。 次の 0 個以上を含む CSV 形式のリスト: 'IncludeParameterDefaultValue'、'IncludeComments'、'SkipResourceNameParameterization'、'SkipAllParameterization'
resources	string[]	エクスポートをフィルター処理するリソースの ID。 すべてのリソースをエクスポートするには、単一のエントリ '*' を持つ配列を指定します。

ResourceGroupExportResult

Object

リソース グループのエクスポート結果。

名前	型	説明
error	ErrorResponse	エラー応答 テンプレートのエクスポート エラー。
template	object	テンプレートの内容。