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 |
指定したキューからすべてのメッセージを削除します。 |
Core | Preview |
az storage message delete |
指定したメッセージを削除します。 |
Core | Preview |
az storage message get |
キューの先頭から 1 つ以上のメッセージを取得します。 |
Core | Preview |
az storage message peek |
キューの先頭から 1 つ以上のメッセージを取得しますが、メッセージの可視性は変更しません。 |
Core | Preview |
az storage message put |
メッセージ キューの背面に新しいメッセージを追加します。 |
Core | Preview |
az storage message update |
メッセージの表示タイムアウトを更新します。 |
Core | Preview |
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
必須のパラメーター
キュー名。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ストレージ アカウント キー。 ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_KEY。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
ストレージ アカウント名。 関連する環境変数: AZURE_STORAGE_ACCOUNT。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 どちらも存在しない場合、コマンドは認証された Azure アカウントを使用してストレージ アカウント キーのクエリを試みます。 多数のストレージ コマンドが実行されると、API クォータに達する可能性があります。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
コマンドを実行するモード。 "ログイン" モードでは、認証にログイン資格情報が直接使用されます。 従来の "キー" モードでは、アカウントの認証パラメーターが指定されていない場合、アカウント キーのクエリが試行されます。 環境変数: AZURE_STORAGE_AUTH_MODE。
プロパティ | 値 |
---|---|
指定可能な値: | key, login |
ストレージ アカウントの接続文字列。 環境変数: AZURE_STORAGE_CONNECTION_STRING。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
ストレージ データ サービス エンドポイント。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。
az storage account show
を使用して各サービス プライマリ エンドポイントを見つけることができます。 環境変数: AZURE_STORAGE_SERVICE_ENDPOINT。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
共有アクセス署名 (SAS) ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_SAS_TOKEN。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
要求タイムアウト (秒単位)。 サービスへの各呼び出しに適用されます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
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。
:func:~get_messages
または :func:~update_message
操作に対する以前の呼び出しから返された有効なポップレシート値。
キュー名。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ストレージ アカウント キー。 ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_KEY。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
ストレージ アカウント名。 関連する環境変数: AZURE_STORAGE_ACCOUNT。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 どちらも存在しない場合、コマンドは認証された Azure アカウントを使用してストレージ アカウント キーのクエリを試みます。 多数のストレージ コマンドが実行されると、API クォータに達する可能性があります。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
コマンドを実行するモード。 "ログイン" モードでは、認証にログイン資格情報が直接使用されます。 従来の "キー" モードでは、アカウントの認証パラメーターが指定されていない場合、アカウント キーのクエリが試行されます。 環境変数: AZURE_STORAGE_AUTH_MODE。
プロパティ | 値 |
---|---|
指定可能な値: | key, login |
ストレージ アカウントの接続文字列。 環境変数: AZURE_STORAGE_CONNECTION_STRING。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
ストレージ データ サービス エンドポイント。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。
az storage account show
を使用して各サービス プライマリ エンドポイントを見つけることができます。 環境変数: AZURE_STORAGE_SERVICE_ENDPOINT。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
共有アクセス署名 (SAS) ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_SAS_TOKEN。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
要求タイムアウト (秒単位)。 サービスへの各呼び出しに適用されます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
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
必須のパラメーター
キュー名。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ストレージ アカウント キー。 ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_KEY。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
ストレージ アカウント名。 関連する環境変数: AZURE_STORAGE_ACCOUNT。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 どちらも存在しない場合、コマンドは認証された Azure アカウントを使用してストレージ アカウント キーのクエリを試みます。 多数のストレージ コマンドが実行されると、API クォータに達する可能性があります。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
コマンドを実行するモード。 "ログイン" モードでは、認証にログイン資格情報が直接使用されます。 従来の "キー" モードでは、アカウントの認証パラメーターが指定されていない場合、アカウント キーのクエリが試行されます。 環境変数: AZURE_STORAGE_AUTH_MODE。
プロパティ | 値 |
---|---|
指定可能な値: | key, login |
ストレージ アカウントの接続文字列。 環境変数: AZURE_STORAGE_CONNECTION_STRING。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
キューから取得するメッセージの数を指定する 0 以外の整数値 (最大 32)。 表示されるメッセージが少ない場合は、表示されるメッセージが返されます。 既定では、この操作でキューから 1 つのメッセージが取得されます。
プロパティ | 値 |
---|---|
規定値: | 1 |
ストレージ データ サービス エンドポイント。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。
az storage account show
を使用して各サービス プライマリ エンドポイントを見つけることができます。 環境変数: AZURE_STORAGE_SERVICE_ENDPOINT。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
共有アクセス署名 (SAS) ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_SAS_TOKEN。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
要求タイムアウト (秒単位)。 サービスへの各呼び出しに適用されます。
サーバー時刻を基準にして、新しい可視性タイムアウト値を秒単位で指定します。 新しい値は 1 秒以上である必要があり、7 日を超えることはできません。 メッセージの可視性タイムアウトは、有効期限より後の値に設定できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
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
必須のパラメーター
キュー名。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ストレージ アカウント キー。 ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_KEY。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
ストレージ アカウント名。 関連する環境変数: AZURE_STORAGE_ACCOUNT。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 どちらも存在しない場合、コマンドは認証された Azure アカウントを使用してストレージ アカウント キーのクエリを試みます。 多数のストレージ コマンドが実行されると、API クォータに達する可能性があります。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
コマンドを実行するモード。 "ログイン" モードでは、認証にログイン資格情報が直接使用されます。 従来の "キー" モードでは、アカウントの認証パラメーターが指定されていない場合、アカウント キーのクエリが試行されます。 環境変数: AZURE_STORAGE_AUTH_MODE。
プロパティ | 値 |
---|---|
指定可能な値: | key, login |
ストレージ アカウントの接続文字列。 環境変数: AZURE_STORAGE_CONNECTION_STRING。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
キューからピークするメッセージの数を指定する 0 以外の整数値 (最大 32)。 既定では、この操作でキューから 1 つのメッセージがピークされます。
ストレージ データ サービス エンドポイント。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。
az storage account show
を使用して各サービス プライマリ エンドポイントを見つけることができます。 環境変数: AZURE_STORAGE_SERVICE_ENDPOINT。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
共有アクセス署名 (SAS) ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_SAS_TOKEN。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
要求タイムアウト (秒単位)。 サービスへの各呼び出しに適用されます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
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
必須のパラメーター
メッセージの内容。最大 64 KB のサイズ。
キュー名。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ストレージ アカウント キー。 ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_KEY。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
ストレージ アカウント名。 関連する環境変数: AZURE_STORAGE_ACCOUNT。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 どちらも存在しない場合、コマンドは認証された Azure アカウントを使用してストレージ アカウント キーのクエリを試みます。 多数のストレージ コマンドが実行されると、API クォータに達する可能性があります。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
コマンドを実行するモード。 "ログイン" モードでは、認証にログイン資格情報が直接使用されます。 従来の "キー" モードでは、アカウントの認証パラメーターが指定されていない場合、アカウント キーのクエリが試行されます。 環境変数: AZURE_STORAGE_AUTH_MODE。
プロパティ | 値 |
---|---|
指定可能な値: | key, login |
ストレージ アカウントの接続文字列。 環境変数: AZURE_STORAGE_CONNECTION_STRING。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
ストレージ データ サービス エンドポイント。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。
az storage account show
を使用して各サービス プライマリ エンドポイントを見つけることができます。 環境変数: AZURE_STORAGE_SERVICE_ENDPOINT。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
共有アクセス署名 (SAS) ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_SAS_TOKEN。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
メッセージの有効期間を秒単位で指定します。 有効期間には、任意の正の数または無限大の -1 を指定できます。 このパラメーターを省略すると、既定の有効期間は 7 日間です。
要求タイムアウト (秒単位)。 サービスへの各呼び出しに適用されます。
指定しない場合、既定値は 0 です。 サーバー時刻を基準にして、新しい可視性タイムアウト値を秒単位で指定します。 値は 0 以上である必要があり、7 日を超えることはできません。 メッセージの可視性タイムアウトを、有効期限より後の値に設定することはできません。 visibility_timeoutは、time_to_live値より小さい値に設定する必要があります。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
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。
:func:~get_messages
または :func:~update_message
操作に対する以前の呼び出しから返された有効なポップレシート値。
キュー名。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ストレージ アカウント キー。 ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_KEY。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
ストレージ アカウント名。 関連する環境変数: AZURE_STORAGE_ACCOUNT。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 どちらも存在しない場合、コマンドは認証された Azure アカウントを使用してストレージ アカウント キーのクエリを試みます。 多数のストレージ コマンドが実行されると、API クォータに達する可能性があります。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
コマンドを実行するモード。 "ログイン" モードでは、認証にログイン資格情報が直接使用されます。 従来の "キー" モードでは、アカウントの認証パラメーターが指定されていない場合、アカウント キーのクエリが試行されます。 環境変数: AZURE_STORAGE_AUTH_MODE。
プロパティ | 値 |
---|---|
指定可能な値: | key, login |
ストレージ アカウントの接続文字列。 環境変数: AZURE_STORAGE_CONNECTION_STRING。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
メッセージの内容。最大 64 KB のサイズ。
ストレージ データ サービス エンドポイント。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。
az storage account show
を使用して各サービス プライマリ エンドポイントを見つけることができます。 環境変数: AZURE_STORAGE_SERVICE_ENDPOINT。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
共有アクセス署名 (SAS) ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_SAS_TOKEN。
プロパティ | 値 |
---|---|
Parameter group: | Storage Account Arguments |
要求タイムアウト (秒単位)。 サービスへの各呼び出しに適用されます。
指定しない場合、既定値は 0 です。 サーバー時刻を基準にして、新しい可視性タイムアウト値を秒単位で指定します。 新しい値は 0 以上である必要があり、7 日を超えることはできません。 メッセージの可視性タイムアウトを、有効期限より後の値に設定することはできません。 メッセージは、削除されるか期限切れになるまで更新できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |