az ts

  • リファレンス

サブスクリプションまたはリソース グループ スコープでテンプレート スペックを管理します。

コマンド

名前 説明 型 Status
az ts create

テンプレート スペックとテンプレート スペック バージョンを作成します。

 コア GA
az ts delete

指定したテンプレート スペックまたはテンプレート スペックのバージョンを名前またはリソース ID で削除します。

 コア GA
az ts export

指定したテンプレート スペックのバージョンと成果物 (存在する場合) を、指定した出力フォルダーにエクスポートします。

 コア GA
az ts list

テンプレート スペックまたはテンプレート スペックのバージョンを一覧表示します。

 コア GA
az ts show

指定したテンプレート スペックまたはテンプレート スペック バージョンを取得します。

 コア GA
az ts update

テンプレート スペックのバージョンを更新します。

 コア GA

az ts create

テンプレート スペックとテンプレート スペック バージョンを作成します。

az ts create --name
             --resource-group
             [--description]
             [--display-name]
             [--location]
             [--tags]
             [--template-file]
             [--ui-form-definition]
             [--version]
             [--version-description]
             [--yes]

例

テンプレート スペックを作成します。

az ts create -g testRG --name TemplateSpecName -l WestUS --display-name "MyDisplayName" --description "Simple template spec" --tags key1=value1

テンプレート スペック バージョンを作成します。

az ts create -g testRG --name TemplateSpecName -v 2.0 -l WestUS --template-file templateSpec.json --version-description "Less simple template spec" --tags key1=value1 key3=value3

テンプレート スペックとテンプレート スペックのバージョンを作成します。

az ts create -g testRG --name TemplateSpecName -v 1.0 -l WestUS --template-file templateSpec.json --display-name "MyDisplayName" --description "Simple template spec" --version-description "Version of simple template spec" --tags key1=value1 key2=value2

必須のパラメーター

--name -n

テンプレート スペックの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--description

親テンプレート スペックの説明。

--display-name -d

テンプレート スペックの表示名。

--location -l

テンプレート スペックとテンプレート スペック バージョンを格納する場所。 作成後に変更することはできません。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--template-file -f

ファイル システム内のテンプレート ファイルまたは Bicep ファイルへのパス。

--ui-form-definition

テンプレート スペック バージョンのファイル システム内の uiFormDefinition ファイル パス。

--version -v

テンプレート スペックのバージョン。

--version-description

テンプレート スペック バージョンの説明。

--yes -y

確認のダイアログを表示しません。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ts delete

指定したテンプレート スペックまたはテンプレート スペックのバージョンを名前またはリソース ID で削除します。

az ts delete [--name]
             [--resource-group]
             [--template-spec]
             [--version]
             [--yes]

例

指定したテンプレート スペックとすべてのバージョンを削除します。

az ts delete -g MyResourceGroup --name TemplateSpecName

テンプレート スペックから指定したバージョンを削除します。

az ts delete -g MyResourceGroup --name TemplateSpecName --version VersionName

リソース ID に基づいてテンプレート スペックまたはバージョンを削除します。

az ts delete --template-spec resourceID

省略可能のパラメーター

--name -n

テンプレート スペックの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--template-spec -s

テンプレート スペックのリソース ID。

--version -v

テンプレート スペックのバージョン。

--yes -y

確認のダイアログを表示しません。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ts export

指定したテンプレート スペックのバージョンと成果物 (存在する場合) を、指定した出力フォルダーにエクスポートします。

az ts export --output-folder
             [--name]
             [--resource-group]
             [--template-spec]
             [--version]

例

リソース ID に基づいて、指定したテンプレート スペック バージョンをエクスポートします。

az ts export -s resourceID --output-folder C:/path/

指定したテンプレート スペック バージョンをエクスポートします。

az ts export -g testrg --name TemplateSpecName --version VersionName --output-folder C:/path/

必須のパラメーター

--output-folder

エクスポートを出力する既存のフォルダー。

省略可能のパラメーター

--name -n

テンプレート スペックの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--template-spec -s

テンプレート スペックのリソース ID。

--version -v

テンプレート スペックのバージョン。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ts list

テンプレート スペックまたはテンプレート スペックのバージョンを一覧表示します。

az ts list [--name]
           [--resource-group]

例

現在の既定のサブスクリプションのすべてのテンプレート スペックを一覧表示します。

az ts list

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

az ts list --subscription Subscription

リソース グループ内のすべてのテンプレート スペックを一覧表示します。

az ts list -g MyResourceGroup

親テンプレート スペックのすべてのバージョンを一覧表示します。

az ts list -g MyResourceGroup -n TemplateSpecName

省略可能のパラメーター

--name -n

テンプレート スペックの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ts show

指定したテンプレート スペックまたはテンプレート スペック バージョンを取得します。

az ts show [--name]
           [--resource-group]
           [--template-spec]
           [--version]

例

指定したテンプレート スペックを表示します。

az ts show -g testrg --name TemplateSpecName

指定したテンプレート スペックのバージョンを表示します。

az ts show -g testrg --name TemplateSpecName --version VersionName

リソース ID に基づいて、指定したテンプレート スペックまたはテンプレート スペックのバージョンを表示します。

az ts show --template-spec resourceID

省略可能のパラメーター

--name -n

テンプレート スペックの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--template-spec -s

テンプレート スペックのリソース ID。

--version -v

テンプレート スペックのバージョン。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ts update

テンプレート スペックのバージョンを更新します。

az ts update [--description]
             [--display-name]
             [--name]
             [--resource-group]
             [--tags]
             [--template-file]
             [--template-spec]
             [--ui-form-definition]
             [--version]
             [--version-description]
             [--yes]

例

リソース ID に基づいて、テンプレート スペックまたはテンプレート スペック バージョンのテンプレート コンテンツを更新します。

az ts update --template-spec resourceID -f updatedFile.json

リソース ID に基づいて、テンプレート スペックの表示名とタグを更新します。

az ts update --template-spec resourceID --display-name "NewParentDisplayName" --tags key1=value1

プロンプトなしでテンプレート スペック バージョンの説明を更新します。

az ts update -g ExistingRG --name ExistingName -v 3.0 --version-description "New description" --yes

テンプレート スペック バージョンのすべてのプロパティを更新します。

az ts update -g ExistingRG --name ExistingName -v 3.0 -f updatedTemplate.json --display-name "New parent display name" --description "New parent description" --version-description "New child description" --ui-form-definition formDefinition.json

プロンプトなしでテンプレート スペック バージョンからタグを削除します。

az ts update -g ExistingRG --name ExistingName -v 3.0 -f updatedTemplate.json --tags --yes

省略可能のパラメーター

--description

親テンプレート スペックの説明。

--display-name -d

テンプレート スペックの表示名。

--name -n

テンプレート スペックの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--template-file -f

ファイル システム内のテンプレート ファイルまたは Bicep ファイルへのパス。

--template-spec -s

テンプレート スペックのリソース ID。

--ui-form-definition

テンプレート スペック バージョンのファイル システム内の uiFormDefinition ファイル パス。

--version -v

テンプレート スペックのバージョン。

--version-description

テンプレート スペック バージョンの説明。

--yes -y

確認のダイアログを表示しません。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。