Set-AzureSchedulerStorageQueueJob

  • リファレンス
モジュール:
Azure

ストレージ アクションを持つスケジューラ ジョブを更新します。

Note

このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください。

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される PowerShell モジュールです。

構文

Set-AzureSchedulerStorageQueueJob
   -Location <String>
   -JobCollectionName <String>
   -JobName <String>
   [-StorageQueueAccount <String>]
   [-StorageQueueName <String>]
   [-SASToken <String>]
   [-StorageQueueMessage <String>]
   [-StartTime <DateTime>]
   [-Interval <Int32>]
   [-Frequency <String>]
   [-EndTime <DateTime>]
   [-ExecutionCount <Int32>]
   [-JobState <String>]
   [-ErrorActionMethod <String>]
   [-ErrorActionURI <Uri>]
   [-ErrorActionRequestBody <String>]
   [-ErrorActionHeaders <Hashtable>]
   [-ErrorActionStorageAccount <String>]
   [-ErrorActionStorageQueue <String>]
   [-ErrorActionSASToken <String>]
   [-ErrorActionQueueMessageBody <String>]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Set-AzureSchedulerStorageQueueJob
   [-Interval <Int32>]
   [-Frequency <String>]
   [-EndTime <DateTime>]
   [-ExecutionCount <Int32>]
   [-JobState <String>]
   [-ErrorActionHeaders <Hashtable>]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

説明

このトピックでは、Microsoft Azure PowerShell モジュールの 0.8.10 バージョンのコマンドレットについて説明します。 使用しているモジュールのバージョンを取得するには、Azure PowerShell コンソールで「.」と入力します (Get-Module -Name Azure).Version。

Set-AzureSchedulerStorageQueueJob コマンドレットは、Azure Storage アクションを持つスケジューラ ジョブを更新します。

例

例 1: ストレージ キュー メッセージを更新する

PS C:\> Set-AzureSchedulerStorageQueueJob -Location "North Central US" -JobCollectionName "JobCollection01 -JobName "Job12" -StorageQueueMessage "Updated message"

このコマンドは、Job12 という名前のストレージ ジョブのキュー メッセージを更新します。 このコマンドは、ジョブ コレクション名と場所を指定します。

例 2: ストレージ キュー ジョブを有効にする

PS C:\> Set-AzureSchedulerStorageQueueJob -Location "North Central US" -JobCollectionName "JobCollection02" -JobName "Job16" -JobState "Enabled"

このコマンドにより、Job16 という名前のジョブが有効になります。 このコマンドは、JobState パラメーターの値を指定して、ジョブの状態を Enabled に変更します。

パラメーター

-EndTime

スケジューラがジョブの開始を 停止する時刻を DateTime オブジェクトとして指定します。 DateTime オブジェクトを取得するには、Get-Date コマンドレットを使用します。 詳細を表示するには「Get-Help Get-Date」を入力します。

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

-ErrorActionHeaders

ヘッダーをハッシュ テーブルとして指定します。

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

-ErrorActionMethod

HTTP および HTTPS アクションの種類のメソッドを指定します。 有効な値は次の通りです。

  • GET
  • PUT
  • 投稿
  • HEAD
  • DELETE
型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ErrorActionQueueMessageBody

ストレージ ジョブ アクションの本文を指定します。

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

-ErrorActionRequestBody

PUT および POST ジョブ アクションの本文を指定します。

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

-ErrorActionSASToken

ストレージ キューの Shared Access Signature (SAS) トークンを指定します。

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

-ErrorActionStorageAccount

ストレージ アカウントの名前を指定します。

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

-ErrorActionStorageQueue

ストレージ キューの名前を指定します。

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

-ErrorActionURI

エラー ジョブ アクションの URI を指定します。

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

-ExecutionCount

実行するジョブの出現回数を指定します。 既定では、ジョブは無期限に繰り返されます。

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

-Frequency

このスケジューラ ジョブの最大頻度を指定します。

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

-Interval

Frequency パラメーターを使用して指定した頻度での繰り返しの間隔を指定します。

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

-JobCollectionName

スケジューラ ジョブを格納するコレクションの名前を指定します。

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

-JobName

更新するスケジューラ ジョブの名前を指定します。

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

-JobState

スケジューラ ジョブの状態を指定します。

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

-Location

クラウド サービスをホストする場所の名前を指定します。 有効な値は次の通りです。

  • アジア地域
  • ヨーロッパ地域
  • アメリカ合衆国地域
  • 東アジア
  • 米国東部
  • 米国中北部
  • 北ヨーロッパ
  • 米国中南部
  • 東南アジア
  • 西ヨーロッパ
  • 米国西部
型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-PassThru

このコマンドレットは、そのコマンドレットが動作する項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。

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

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

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

-SASToken

ストレージ キューの SAS トークンを指定します。

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

-StartTime

ジョブを開始する時刻を DateTime オブジェクトとして指定します。

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

-StorageQueueAccount

ストレージ アカウント名を指定します。

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

-StorageQueueMessage

ストレージ ジョブのキュー メッセージを指定します。

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

-StorageQueueName

ストレージ キューの名前を指定します。

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