Stop-AzureRmAutomationDscNodeConfigurationDeployment
Automation での DSC ノード構成のデプロイを停止します。 現在のデプロイ ジョブのみが停止されますが、既に割り当てられているノード構成の割り当てを解除することはありません。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日に正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールの機能は今後も使用できますが、メンテナンスやサポートは行われないため、引き続きの使用はユーザーの判断に委ねられ、リスクが発生することがあります。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Stop-AzureRmAutomationDscNodeConfigurationDeployment
-JobId <Guid>
[-Force]
[-PassThru]
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Stop-AzureRmAutomationDscNodeConfigurationDeployment
[-PassThru]
-InputObject <NodeConfigurationDeployment>
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Stop-AzureRmAutomationDscNodeConfigurationDeployment コマンドレットは、Azure Automation での Desired State Configuration (DSC) ノード構成のデプロイを停止します。 ノードのグループへのノード構成の割り当てが停止されます (割り当て済みのノードが残っているが、割り当て済みのノードは割り当て解除されない場合)。 スケジュールされたジョブの登録を解除するには、JobScheduleId と共に Unregister-AzureRmAutomationScheduledRunbook を使用して、既存のスケジュールされたジョブの割り当てを解除してください。
例
例 1: Automation で Azure DSC ノード構成をデプロイする
PS C:\> Stop-AzureRmAutomationDscNodeConfigurationDeployment -AutomationAccountName "Contoso01" -ResourceGroupName "ResourceGroup01" -JobId 00000000-0000-0000-0000-000000000000上記のコマンドは、jobId が渡された DSC ノード構成デプロイ ジョブを停止します。
パラメーター
-AutomationAccountName
このコマンドレットがコンパイルする DSC 構成を含む Automation アカウントの名前を指定します。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
| 型: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Force
ps_force
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InputObject
配管の入力オブジェクト
| 型: | NodeConfigurationDeployment |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-JobId
既存のデプロイ ジョブのジョブ ID を指定します。
| 型: | Guid |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PassThru
作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ResourceGroupName
このコマンドレットが構成をコンパイルするリソース グループの名前を指定します。
| 型: | String |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
Parameters: InputObject (ByValue)