Get-AzTemplateSpec

  • リファレンス
モジュール:
Az.Resources

テンプレート スペックを取得または一覧表示します。

構文

Get-AzTemplateSpec
   [[-ResourceGroupName] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzTemplateSpec
   [-ResourceGroupName] <String>
   [-Name] <String>
   [[-Version] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzTemplateSpec
   [[-Version] <String>]
   [-ResourceId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

このコマンドレットを使用すると、サブスクリプション/リソース グループ内のテンプレート スペックを一覧表示したり、名前または ID で特定のテンプレート スペックを取得したりできます。名前/ID で特定のテンプレート スペックを取得する場合、-Version パラメーターを使用してバージョン名を指定することで、必要に応じて特定のバージョンを取得できます。 Version を使用すると、*内に特定のバージョンの詳細のみが表示されます。返された Template Spec オブジェクトのバージョン。 名前/ID でテンプレート スペックを取得するときに特定のバージョンが指定されていない場合、すべてのバージョンが *内に存在します。返されるオブジェクトの Versions プロパティ。

注: サブスクリプションまたはリソース グループ内のすべてのテンプレート スペックを一覧表示すると、各テンプレート スペックが返されます。Versions" プロパティは null になります。 バージョン情報は、-Name パラメーターまたは -ResourceId パラメーターが指定されている場合にのみ含まれます (たとえば、特定のテンプレート スペック/バージョンを要求している場合)。

例

例 1: 現在のサブスクリプションのテンプレート スペックを一覧表示する

Get-AzTemplateSpec

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

例 2: リソース グループ内のテンプレート スペックを一覧表示する

Get-AzTemplateSpec -ResourceGroupName 'myRG'

現在のサブスクリプションのリソース グループ 'myRG' 内のすべてのテンプレート スペックを一覧表示します。

例 3: テンプレート スペック (すべてのバージョンを含む) を名前で取得する

Get-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'MyTemplateSpec'

リソース グループ 'myRG' 内の 'MyTemplateSpec' という名前のテンプレート スペックに関する情報を取得します。

注: テンプレート スペックのすべてのバージョンは、".Versions" プロパティの戻り値オブジェクト。

例 4: 名前でテンプレート スペック (特定のバージョン) を取得する

Get-AzTemplateSpec -ResourceGroupName 'myRG' -Name 'MyTemplateSpec' -Version 'v1.0'

リソース グループ 'myRG' 内の 'MyTemplateSpec' という名前のテンプレート スペックのバージョン 'v1.0' に関する情報を取得します。

注: "> 返されるオブジェクトの Versions" プロパティには、要求された特定のバージョンのみが含まれます。

例 5: リソース ID でテンプレート スペック (すべてのバージョンを含む) を取得する

Get-AzTemplateSpec -ResourceId '/subscriptions/{subId}/resourceGroups/myRG/providers/Microsoft.Resources/templateSpecs/MyTemplateSpec'

サブスクリプション {subId} のリソース グループ 'myRG' 内の 'MyTemplateSpec' という名前のテンプレート スペックに関する情報を取得します。

注: テンプレート スペックのすべてのバージョンは、".Versions" プロパティの戻り値オブジェクト。

例 6: リソース ID でテンプレート スペック (特定のバージョン) を取得する

Get-AzTemplateSpec -ResourceId '/subscriptions/{subId}/resourceGroups/myRG/providers/Microsoft.Resources/templateSpecs/MyTemplateSpec' -Version 'v1.0'

サブスクリプション {subId} のリソース グループ 'myRG' 内の 'MyTemplateSpec' という名前のテンプレート スペックのバージョン 'v1.0' に関する情報を取得します。

注: "> 返されるオブジェクトの Versions" プロパティには、要求された特定のバージョンのみが含まれます。

パラメーター

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

リソース グループの名前。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

テンプレート スペックの完全修飾リソース ID。例: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}

Type:String
Aliases:Id
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Version

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

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

入力

String

出力

PSTemplateSpec