Remove-AzBatchJobSchedule

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

Batch ジョブ スケジュールを削除します。

構文

Remove-AzBatchJobSchedule
      [-Id] <String>
      [-Force]
      -BatchContext <BatchAccountContext>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzBatchJobSchedule コマンドレットは、Azure Batch ジョブ スケジュールを削除します。

例

例 1: バッチ ジョブ スケジュールを削除する

Remove-AzBatchJobSchedule -Id "MyJobSchedule" -BatchContext $Context

このコマンドは、ID MyJobSchedule を持つジョブ スケジュールを削除します。 コマンドは、ジョブを削除する前に確認を求められます。 Get-AzBatchAccountKey コマンドレットを使用して、$Context変数にコンテキストを割り当てます。

例 2: パイプラインを使用して確認なしで Batch ジョブを削除する

Get-AzBatchJobSchedule -Id "MyJobSchedule" -BatchContext $Context | Remove-AzBatchJobSchedule -Force -BatchContext $Context

このコマンドは、Get-AzBatchJobSchedule コマンドレットを使用して、ID MyJobSchedule を持つジョブ スケジュールを取得します。 このコマンドは、パイプライン 演算子を使用して、そのジョブ スケジュールを現在のコマンドレットに渡します。 このコマンドは、そのジョブ スケジュールを削除します。 コマンドには Force パラメーターが含まれているため、確認を求めるメッセージは表示されません。

パラメーター

-BatchContext

このコマンドレットが Batch サービスとの対話に使用する BatchAccountContext インスタンスを指定します。 Get-AzBatchAccount コマンドレットを使用して BatchAccountContext を取得する場合、Batch サービスと対話するときに Microsoft Entra 認証が使用されます。 代わりに共有キー認証を使用するには、Get-AzBatchAccountKey コマンドレットを使用して、アクセス キーが設定された BatchAccountContext オブジェクトを取得します。 共有キー認証を使用する場合、プライマリ アクセス キーは既定で使用されます。 使用するキーを変更するには、BatchAccountContext.KeyInUse プロパティを設定します。

型:BatchAccountContext
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Confirm

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

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultProfile

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

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Id

削除するジョブ スケジュールの ID を指定します。

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WhatIf

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

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

String

BatchAccountContext

出力

Void