New-AzureRmResourceGroupDeployment
リソース グループに Azure デプロイを追加します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateFile <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterObject <Hashtable>
-TemplateFile <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterObject <Hashtable>
-TemplateUri <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterFile <String>
-TemplateFile <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterFile <String>
-TemplateUri <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterUri <String>
-TemplateFile <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterUri <String>
-TemplateUri <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateUri <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
New-AzureRmResourceGroupDeployment コマンドレットは、既存のリソース グループにデプロイを追加します。 これには、デプロイに必要なリソースが含まれます。 Azure リソースは、データベース サーバー、データベース、Web サイト、仮想マシン、ストレージ アカウントなど、ユーザーが管理する Azure エンティティです。 Azure リソース グループは、財務 Web サイトに必要な Web サイト、データベース サーバー、データベースなど、単位としてデプロイされる Azure リソースのコレクションです。 リソース グループのデプロイでは、テンプレートを使用してリソースをリソース グループに追加し、Azure で使用できるように発行します。 テンプレートを使用せずにリソース グループにリソースを追加するには、New-AzureRmResource コマンドレットを使用します。 リソース グループのデプロイを追加するには、既存のリソース グループの名前とリソース グループ テンプレートを指定します。 リソース グループ テンプレートは、Web ポータルなどの複雑なクラウドベースのサービスのリソース グループを表す JSON 文字列です。 テンプレートには、必要なリソースのパラメーター プレースホルダーと、名前やサイズなどの構成可能なプロパティ値が含まれています。 Azure テンプレート ギャラリーには多数のテンプレートがあります。また、独自のテンプレートを作成することもできます。 Get-AzureRmResourceGroupGalleryTemplate コマンドレットを使用して、ギャラリー内のテンプレートを検索できます。 カスタム テンプレートを使用してリソース グループを作成するには、TemplateFile パラメーターまたは TemplateUri パラメーターを指定します。 各テンプレートには、構成可能なプロパティのパラメーターがあります。 テンプレート パラメーターの値を指定するには、TemplateParameterFile パラメーターまたは TemplateParameterObject パラメーターを指定します。 または、テンプレートを指定するときにコマンドに動的に追加されるテンプレート パラメーターを使用することもできます。 動的パラメーターを使用するには、コマンド プロンプトでパラメーターを入力するか、マイナス記号 (-) を入力してパラメーターを指定し、Tab キーを使用して使用可能なパラメーターを循環させます。 コマンド プロンプトで入力したテンプレート パラメーター値は、テンプレート パラメーター オブジェクトまたはテンプレート ファイルの値よりも優先されます。
例
例 1: カスタム テンプレートとパラメーター ファイルを使用してデプロイを作成する
PS C:\>New-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json"このコマンドは、カスタム テンプレートとディスク上のテンプレート ファイルを使用して、新しいデプロイを作成します。 このコマンドでは、TemplateFile パラメーターを使用してテンプレートを指定し、TemplateParameterFile パラメーターを使用して、パラメーターとパラメーター値が含まれるファイルを指定します。
パラメーター
-ApiVersion
リソース プロバイダーでサポートされている API バージョンを指定します。 既定のバージョンとは異なるバージョンを指定できます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-AsJob
バックグラウンドでコマンドレットを実行する
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
| 型: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DeploymentDebugLogLevel
デバッグ ログ レベルを指定します。 このパラメーターの有効値は、次のとおりです。
- RequestContent
- ResponseContent
- すべて
- なし
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Force
ユーザーに確認せずに、直ちにコマンドを実行します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Mode
展開モードを指定します。 このパラメーターの有効値は、次のとおりです。
- 完了
- インクリメンタル 完全モードでは、リソース グループに存在するが、テンプレートでは指定されていないリソースが Resource Manager によって削除されます。 増分モードでは、Resource Manager はリソース グループに存在するが、テンプレートに指定されていないリソースを変更せず、そのまま残します。
| 型: | DeploymentMode |
| 配置: | Named |
| 規定値: | Incremental |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
作成するリソース グループデプロイの名前を指定します。
| 型: | String |
| Aliases: | DeploymentName |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Pre
このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ResourceGroupName
デプロイするリソース グループの名前を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-RollBackDeploymentName
-RollbackToLastDeployment を使用する場合は、リソース グループ内の指定された名前で正常なデプロイにロールバックしないでください。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-RollbackToLastDeployment
-RollBackDeploymentName が使用されている場合は、リソース グループ内の最後に成功したデプロイにロールバックしないでください。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-TemplateFile
JSON テンプレート ファイルの完全なパスを指定します。 これは、カスタム テンプレートまたは JSON ファイルとして保存されるギャラリー テンプレート (Save-AzureRmResourceGroupGalleryTemplate コマンドレットを使用して作成されたものなど) です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-TemplateParameterFile
テンプレート パラメーターの名前と値を含む JSON ファイルの完全なパスを指定します。 テンプレートにパラメーターがある場合は、TemplateParameterFile パラメーターまたは TemplateParameterObject パラメーターを使用してパラメーター値を指定する必要があります。 テンプレート パラメーターは、テンプレートを指定するとコマンドに動的に追加されます。 動的パラメーターを使用するには、マイナス記号 (-) を入力してパラメーター名を指定し、Tab キーを使用して使用可能なパラメーターを循環させます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-TemplateParameterObject
テンプレート パラメーターの名前と値のハッシュ テーブルを指定します。
Windows PowerShell のハッシュ テーブルのヘルプについては、「.」と入力します Get-Help about_Hash_Tables。
テンプレートにパラメーターがある場合は、パラメーター値を指定する必要があります。
テンプレート パラメーターは、テンプレートを指定するとコマンドに動的に追加されます。
| 型: | Hashtable |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-TemplateParameterUri
テンプレート パラメーター ファイルの URI を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-TemplateUri
JSON テンプレート ファイルの URI を指定します。 このファイルには、Save-AzureRmResourceGroupGalleryTemplate などを使用して JSON ファイルとして保存されるカスタム テンプレートまたはギャラリー テンプレートを指定できます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
None
出力
Microsoft.Azure.Commands.ResourceManager.Models.PSResourceGroupDeployment