Unregister-AzAutomationDscNode

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

Automation アカウントによる管理から DSC ノードを削除します。

構文

Unregister-AzAutomationDscNode
          -Id <Guid>
          [-Force]
          [-ResourceGroupName] <String>
          [-AutomationAccountName] <String>
          [-DefaultProfile <IAzureContextContainer>]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

説明

Unregister-AzAutomationDscNode コマンドレットは、Azure Automation アカウントによる管理から APS Desired State Configuration (DSC) ノードを削除します。

例

例 1: Automation アカウントによる管理から Azure DSC ノードを削除する

Unregister-AzAutomationDscNode -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -Id 064a8929-c98b-25e4-80hh-111ca86067j8

このコマンドは、Contoso17 という名前の Automation アカウントによる管理から、指定された GUID を持つ DSC ノードを削除します。

例 2: DSC ノード名を指定して Automation アカウントによる管理から Azure DSC ノードを削除する

$dscNodeNameToRemove = "MyMachine1"
$automationAccountName = "Contoso17"
$resourceGroupName = "ResourceGroup01"
$nodeToRemove = Get-AzAutomationDscNode -Name $dscNodeNameToRemove -AutomationAccountName $automationAccountName -ResourceGroupName $resourceGroupName
$nodeToRemove | Unregister-AzAutomationDscNode -AutomationAccountName $automationAccountName -ResourceGroupName $resourceGroupName

このコマンドは、Contoso17 という名前の Automation アカウントによる管理から、"MyMachine1" という名前の DSC ノードを削除します。

パラメーター

-AutomationAccountName

このコマンドレットが DSC ノードを削除する Automation アカウントの名前を指定します。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
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

-Force

ps_force

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

-Id

このコマンドレットが削除する DSC ノードの一意の ID を指定します。

Type:Guid
Aliases:NodeId
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

このコマンドレットが DSC ノードの登録を解除するリソース グループの名前を指定します。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

Guid

String

出力

DscNode