Register-AzAutomationDscNode

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

Windows OS を実行する Azure 仮想マシンを Automation アカウントの DSC ノードとして登録します。

構文

Register-AzAutomationDscNode
        -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-AzAutomationDscNode コマンドレットは、Azure Automation アカウントの APS Desired State Configuration (DSC) ノードとして Azure 仮想マシンを登録します。 このコマンドレットは、Windows OS を実行している VM のみをアカウントの Automation DSC ノードとして登録します。

別のサブスクリプションの Automation アカウントにノードを登録する必要がある場合は、コマンドレットではなく ARM テンプレートを使用する必要があります。 詳細については、Azure Automation のドキュメント を参照してください。

例

例 1: Azure 仮想マシンを Azure DSC ノードとして登録する

Register-AzAutomationDscNode -AutomationAccountName "Contoso17" -AzureVMName "VirtualMachine01" -ResourceGroupName "ResourceGroup01"-NodeConfigurationName "ContosoConfiguration.webserver"

このコマンドは、VirtualMachine01 という名前の Azure 仮想マシンを Contoso17 という名前の Automation アカウントの DSC ノードとして登録します。

パラメーター

-ActionAfterReboot

仮想マシンが再起動後に実行するアクションを指定します。 有効な値は次の通りです。

  • ContinueConfiguration
  • StopConfiguration
Type:String
Accepted values:ContinueConfiguration, StopConfiguration
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AllowModuleOverwrite

この DSC ノードが Azure Automation DSC プル サーバーからダウンロードする新しい構成が、ターゲット ノードに既に存在するモジュールを置き換えるかどうかを指定します。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AutomationAccountName

このコマンドレットが仮想マシンを登録する Automation アカウントの名前を指定します。

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

-AzureVMLocation

Azure VM の場所。

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

-AzureVMName

Azure Automation DSC で管理するために登録する Azure 仮想マシンの名前。

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

-AzureVMResourceGroup

Azure VM リソース グループ名。

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

-ConfigurationMode

DSC 構成モードを指定します。 有効な値は次の通りです。

  • ApplyAndMonitor
  • ApplyAndAutocorrect
  • ApplyOnly
Type:String
Accepted values:ApplyAndMonitor, ApplyAndAutocorrect, ApplyOnly
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ConfigurationModeFrequencyMins

DSC のバックグラウンド アプリケーションがターゲット ノードに現在の構成を実装しようとする頻度を分単位で指定します。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

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

-NodeConfigurationName

このコマンドレットが Azure Automation DSC からプルするように仮想マシンを構成するノード構成の名前を指定します。

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

-RebootNodeIfNeeded

必要に応じて、仮想マシンを再起動するかどうかを指定します。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-RefreshFrequencyMins

ローカルの Configuration Manager が Azure Automation DSC プル サーバーに接続して最新のノード構成をダウンロードする頻度を分単位で指定します。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

リソース グループの名前を指定します。 このコマンドレットで仮想マシンを登録する Automation アカウントは、このパラメーターが指定するリソース グループに属します。

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

入力

String

Int32

Boolean

出力

Void