Register-AzureRmAutomationDscNode
Azure 仮想マシンを Automation アカウントの DSC ノードとして登録します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Register-AzureRmAutomationDscNode
-AzureVMName <String>
[-NodeConfigurationName <String>]
[-ConfigurationMode <String>]
[-ConfigurationModeFrequencyMins <Int32>]
[-RefreshFrequencyMins <Int32>]
[-RebootNodeIfNeeded <Boolean>]
[-ActionAfterReboot <String>]
[-AllowModuleOverwrite <Boolean>]
[-AzureVMResourceGroup <String>]
[-AzureVMLocation <String>]
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Register-AzureRmAutomationDscNode コマンドレットは、Azure Automation アカウントの APS Desired State Configuration (DSC) ノードとして Azure 仮想マシンを登録します。
例
例 1: Azure 仮想マシンを Azure DSC ノードとして登録する
PS C:\>Register-AzureRmAutomationDscNode -AutomationAccountName "Contoso17" -AzureVMName "VirtualMachine01" -ResourceGroupName "ResourceGroup01"-NodeConfigurationName "ContosoConfiguration.webserver"
このコマンドは、VirtualMachine01 という名前の Azure 仮想マシンを Contoso17 という名前の Automation アカウントの DSC ノードとして登録します。
パラメーター
-ActionAfterReboot
仮想マシンが再起動後に実行するアクションを指定します。 有効な値は次の通りです。
- ContinueConfiguration
- StopConfiguration
型: | String |
指定可能な値: | ContinueConfiguration, StopConfiguration |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-AllowModuleOverwrite
この DSC ノードが Azure Automation DSC プル サーバーからダウンロードする新しい構成が、ターゲット ノードに既に存在するモジュールを置き換えるかどうかを指定します。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-AutomationAccountName
このコマンドレットが仮想マシンを登録する Automation アカウントの名前を指定します。
型: | String |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-AzureVMLocation
このコマンドレットが仮想マシンを登録する場所を指定します。 有効な場所を取得するには、Get-AzureRMLocation コマンドレットを使用します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-AzureVMName
このコマンドレットが管理用に登録する Azure 仮想マシンの名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-AzureVMResourceGroup
このコマンドレットが登録する Azure 仮想マシンのリソース グループの名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ConfigurationMode
DSC 構成モードを指定します。 有効な値は次の通りです。
- ApplyAndMonitor
- ApplyAndAutocorrect
- ApplyOnly
型: | String |
指定可能な値: | ApplyAndMonitor, ApplyAndAutocorrect, ApplyOnly |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ConfigurationModeFrequencyMins
DSC のバックグラウンド アプリケーションがターゲット ノードに現在の構成を実装しようとする頻度を分単位で指定します。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-NodeConfigurationName
このコマンドレットが Azure Automation DSC からプルするように仮想マシンを構成するノード構成の名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-RebootNodeIfNeeded
必要に応じて、仮想マシンを再起動するかどうかを指定します。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-RefreshFrequencyMins
ローカルの Configuration Manager が Azure Automation DSC プル サーバーに接続して最新のノード構成をダウンロードする頻度を分単位で指定します。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
リソース グループの名前を指定します。 このコマンドレットで仮想マシンを登録する Automation アカウントは、このパラメーターが指定するリソース グループに属します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |