az storage message

プレビュー
リファレンス

このコマンドグループはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

キューストレージメッセージを管理します。

コマンドの認証パラメーターとして、--auth-mode、--account-key、--connection-string、--sas-token のいずれかを指定してください。また、対応する環境変数を使用して、認証資格情報 (AZURE_STORAGE_KEY、AZURE_STORAGE_CONNECTION_STRING、AZURE_STORAGE_SAS_TOKENなど) を格納することもできます。

コマンド

名前	説明	型	状態
az storage message clear	指定したキューからすべてのメッセージを削除します。	コア	プレビュー
az storage message delete	指定したメッセージを削除します。	コア	プレビュー
az storage message get	キューの先頭から 1 つ以上のメッセージを取得します。	コア	プレビュー
az storage message peek	キューの先頭から 1 つ以上のメッセージを取得しますが、メッセージの可視性は変更しません。	コア	プレビュー
az storage message put	メッセージキューの背面に新しいメッセージを追加します。	コア	プレビュー
az storage message update	メッセージの表示タイムアウトを更新します。	コア	プレビュー

az storage message clear

編集

プレビュー

コマンドグループ "ストレージメッセージ" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

指定したキューからすべてのメッセージを削除します。

az storage message clear --queue-name
                         [--account-key]
                         [--account-name]
                         [--auth-mode {key, login}]
                         [--connection-string]
                         [--queue-endpoint]
                         [--sas-token]
                         [--timeout]

例

指定したキューからすべてのメッセージを削除します。

az storage message clear -q myqueue --account-name mystorageaccount

必須のパラメーター

--queue-name -q

キュー名。

省略可能のパラメーター

--account-key

ストレージアカウントキー。ストレージアカウント名またはサービスエンドポイントと組み合わせて使用する必要があります。環境変数: AZURE_STORAGE_KEY。

--account-name

ストレージアカウント名。関連する環境変数: AZURE_STORAGE_ACCOUNT。ストレージアカウントキーまたは SAS トークンと組み合わせて使用する必要があります。どちらも存在しない場合、コマンドは認証された Azure アカウントを使用してストレージアカウントキーのクエリを試みます。多数のストレージコマンドが実行されると、API クォータに達する可能性があります。

--auth-mode

コマンドを実行するモード。 "ログイン" モードでは、認証にログイン資格情報が直接使用されます。従来の "キー" モードでは、アカウントの認証パラメーターが指定されていない場合、アカウントキーのクエリが試行されます。環境変数: AZURE_STORAGE_AUTH_MODE。

指定可能な値: key, login

--connection-string

ストレージアカウントの接続文字列。環境変数: AZURE_STORAGE_CONNECTION_STRING。

--queue-endpoint

ストレージデータサービスエンドポイント。ストレージアカウントキーまたは SAS トークンと組み合わせて使用する必要があります。各サービスのプライマリエンドポイントは次を使用して az storage account show検索できます。環境変数: AZURE_STORAGE_Standard EditionRVICE_ENDPOINT。

--sas-token

Shared Access Signature (SAS)。ストレージアカウント名またはサービスエンドポイントと組み合わせて使用する必要があります。環境変数: AZURE_STORAGE_SAS_TOKEN。

--timeout

要求タイムアウト (秒単位)。サービスへの各呼び出しに適用されます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az storage message delete

編集

プレビュー

コマンドグループ "ストレージメッセージ" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

指定したメッセージを削除します。

az storage message delete --id
                          --pop-receipt
                          --queue-name
                          [--account-key]
                          [--account-name]
                          [--auth-mode {key, login}]
                          [--connection-string]
                          [--queue-endpoint]
                          [--sas-token]
                          [--timeout]

例

指定したメッセージを削除します。

az storage message delete --id messageid --pop-receipt popreceiptreturned -q myqueue --account-name mystorageaccount

必須のパラメーター

--id

削除するメッセージを識別するメッセージ ID。

--pop-receipt

:func: または :func:~get_messages~update_message 操作に対する以前の呼び出しから返された有効なポップレシート値。

--queue-name -q

キュー名。

省略可能のパラメーター

--account-key

--account-name

--auth-mode

指定可能な値: key, login

--connection-string

ストレージアカウントの接続文字列。環境変数: AZURE_STORAGE_CONNECTION_STRING。

--queue-endpoint

--sas-token

--timeout

要求タイムアウト (秒単位)。サービスへの各呼び出しに適用されます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az storage message get

編集

プレビュー

コマンドグループ "ストレージメッセージ" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

キューの先頭から 1 つ以上のメッセージを取得します。

az storage message get --queue-name
                       [--account-key]
                       [--account-name]
                       [--auth-mode {key, login}]
                       [--connection-string]
                       [--num-messages]
                       [--queue-endpoint]
                       [--sas-token]
                       [--timeout]
                       [--visibility-timeout]

例

キューの先頭から 1 つのメッセージを取得し、可視性のタイムアウトを 5 分後にリセットします。

az storage message get -q myqueue --visibility-timeout 300 --account-name mystorageaccount

必須のパラメーター

--queue-name -q

キュー名。

省略可能のパラメーター

--account-key

--account-name

--auth-mode

指定可能な値: key, login

--connection-string

ストレージアカウントの接続文字列。環境変数: AZURE_STORAGE_CONNECTION_STRING。

--num-messages

キューから取得するメッセージの数を指定する 0 以外の整数値 (最大 32)。表示されるメッセージが少ない場合は、表示されるメッセージが返されます。既定では、この操作でキューから 1 つのメッセージが取得されます。

規定値: 1

--queue-endpoint

--sas-token

--timeout

要求タイムアウト (秒単位)。サービスへの各呼び出しに適用されます。

--visibility-timeout

サーバー時刻を基準にして、新しい可視性タイムアウト値を秒単位で指定します。新しい値は 1 秒以上である必要があり、7 日を超えることはできません。メッセージの可視性タイムアウトは、有効期限より後の値に設定できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az storage message peek

編集

プレビュー

コマンドグループ "ストレージメッセージ" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

キューの先頭から 1 つ以上のメッセージを取得しますが、メッセージの可視性は変更しません。

az storage message peek --queue-name
                        [--account-key]
                        [--account-name]
                        [--auth-mode {key, login}]
                        [--connection-string]
                        [--num-messages]
                        [--queue-endpoint]
                        [--sas-token]
                        [--timeout]

例

キューの先頭から 5 つのメッセージを取得します (メッセージの可視性を変更しないでください)。

az storage message peek -q myqueue --num-messages 5 --account-name mystorageaccount

必須のパラメーター

--queue-name -q

キュー名。

省略可能のパラメーター

--account-key

--account-name

--auth-mode

指定可能な値: key, login

--connection-string

ストレージアカウントの接続文字列。環境変数: AZURE_STORAGE_CONNECTION_STRING。

--num-messages

キューからピークするメッセージの数を指定する 0 以外の整数値 (最大 32)。既定では、この操作でキューから 1 つのメッセージがピークされます。

--queue-endpoint

--sas-token

--timeout

要求タイムアウト (秒単位)。サービスへの各呼び出しに適用されます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az storage message put

編集

プレビュー

コマンドグループ "ストレージメッセージ" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

メッセージキューの背面に新しいメッセージを追加します。

az storage message put --content
                       --queue-name
                       [--account-key]
                       [--account-name]
                       [--auth-mode {key, login}]
                       [--connection-string]
                       [--queue-endpoint]
                       [--sas-token]
                       [--time-to-live]
                       [--timeout]
                       [--visibility-timeout]

例

1 日に配信される新しいメッセージを追加します。

az storage message put -q myqueue --content mymessagecontent --time-to-live 86400 --account-name mystorageaccount

必須のパラメーター

--content

最大 64 KB (キロバイト) サイズのメッセージコンテンツ。

--queue-name -q

キュー名。

省略可能のパラメーター

--account-key

--account-name

--auth-mode

指定可能な値: key, login

--connection-string

ストレージアカウントの接続文字列。環境変数: AZURE_STORAGE_CONNECTION_STRING。

--queue-endpoint

--sas-token

--time-to-live

メッセージの有効期間を秒単位で指定します。有効期間は、任意の正の数、または無限大の場合は -1 にすることができます。このパラメーターを省略すると、既定の有効期間は 7 日間です。

--timeout

要求タイムアウト (秒単位)。サービスへの各呼び出しに適用されます。

--visibility-timeout

指定しない場合、既定値は 0 です。サーバー時刻を基準にして、新しい可視性タイムアウト値を秒単位で指定します。値は 0 以上である必要があり、7 日を超えることはできません。メッセージの可視性タイムアウトを、有効期限より後の値に設定することはできません。 visibility_timeoutは、time_to_live値より小さい値に設定する必要があります。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az storage message update

編集

プレビュー

コマンドグループ "ストレージメッセージ" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

メッセージの表示タイムアウトを更新します。

az storage message update --id
                          --pop-receipt
                          --queue-name
                          [--account-key]
                          [--account-name]
                          [--auth-mode {key, login}]
                          [--connection-string]
                          [--content]
                          [--queue-endpoint]
                          [--sas-token]
                          [--timeout]
                          [--visibility-timeout]

例

メッセージの可視性のタイムアウトと内容を更新します。

az storage message update --id messageid --pop-receipt popreceiptreturned -q myqueue
--visibility-timeout 3600 --content newmessagecontent --account-name mystorageaccount

必須のパラメーター

--id

削除するメッセージを識別するメッセージ ID。

--pop-receipt

:func: または :func:~get_messages~update_message 操作に対する以前の呼び出しから返された有効なポップレシート値。

--queue-name -q

キュー名。

省略可能のパラメーター

--account-key

--account-name

--auth-mode

指定可能な値: key, login

--connection-string

ストレージアカウントの接続文字列。環境変数: AZURE_STORAGE_CONNECTION_STRING。

--content

最大 64 KB (キロバイト) サイズのメッセージコンテンツ。

--queue-endpoint

--sas-token

--timeout

要求タイムアウト (秒単位)。サービスへの各呼び出しに適用されます。

--visibility-timeout

指定しない場合、既定値は 0 です。サーバー時刻を基準にして、新しい可視性タイムアウト値を秒単位で指定します。新しい値は 0 以上である必要があり、7 日を超えることはできません。メッセージの可視性タイムアウトを、有効期限より後の値に設定することはできません。メッセージは、削除されるか期限切れになるまで更新できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az storage message

コマンド

az storage message clear

例

必須のパラメーター

省略可能のパラメーター

az storage message delete

例

必須のパラメーター

省略可能のパラメーター

az storage message get

例

必須のパラメーター

省略可能のパラメーター

az storage message peek

例

必須のパラメーター

省略可能のパラメーター

az storage message put

例

必須のパラメーター

省略可能のパラメーター

az storage message update

例

必須のパラメーター

省略可能のパラメーター

その他のリソース