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。

命令

名稱	Description	類型	狀態
az storage message clear	刪除指定佇列中的所有訊息。	核心	預覽版
az storage message delete	刪除指定的訊息。	核心	預覽版
az storage message get	從佇列前端擷取一或多個訊息。	核心	預覽版
az storage message peek	從佇列前方擷取一或多個訊息，但不會改變訊息的可見度。	核心	預覽版
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_SERVICE_ENDPOINT。

--sas-token

共用存取簽章 （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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

識別要刪除之訊息的訊息識別碼。

--pop-receipt

從先前呼叫 ：func： 或 ：func： ~get_messages ~update_message 作業傳回的有效快顯收據值。

--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_SERVICE_ENDPOINT。

--sas-token

共用存取簽章 （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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az storage message get

預覽

命令群組 「儲存體訊息」處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

從佇列前端擷取一或多個訊息。

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]

範例

從佇列前端擷取一則訊息，並將可見度逾時重設為 5 分鐘後。

az storage message get -q myqueue --visibility-timeout 300 --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。

--num-messages

非零整數值，指定要從佇列擷取的訊息數目，最多 32 個。 如果可見的較少，則會傳回可見的訊息。 根據預設，會使用這項作業從佇列擷取單一訊息。

預設值: 1

--queue-endpoint

儲存體資料服務端點。 必須與儲存體帳戶金鑰或 SAS 權杖搭配使用。 您可以使用 找到每個服務主要端點 az storage account show 。 環境變數：AZURE_STORAGE_SERVICE_ENDPOINT。

--sas-token

共用存取簽章 （SAS）。 必須與儲存體帳戶名稱或服務端點搭配使用。 環境變數：AZURE_STORAGE_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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az storage message peek

預覽

命令群組 「儲存體訊息」處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

從佇列前方擷取一或多個訊息，但不會改變訊息的可見度。

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

儲存體帳戶金鑰。 必須與儲存體帳戶名稱或服務端點搭配使用。 環境變數：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。

--num-messages

非零整數值，指定要從佇列查看的訊息數目，最多 32 個。 根據預設，會使用此作業從佇列中查看單一訊息。

--queue-endpoint

儲存體資料服務端點。 必須與儲存體帳戶金鑰或 SAS 權杖搭配使用。 您可以使用 找到每個服務主要端點 az storage account show 。 環境變數：AZURE_STORAGE_SERVICE_ENDPOINT。

--sas-token

共用存取簽章 （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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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]

範例

新增一天將直播的新訊息。

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

必要參數

--content

訊息內容，大小上限為 64KB。

--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_SERVICE_ENDPOINT。

--sas-token

共用存取簽章 （SAS）。 必須與儲存體帳戶名稱或服務端點搭配使用。 環境變數：AZURE_STORAGE_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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

識別要刪除之訊息的訊息識別碼。

--pop-receipt

從先前呼叫 ：func： 或 ：func： ~get_messages ~update_message 作業傳回的有效快顯收據值。

--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。

--content

訊息內容，大小上限為 64KB。

--queue-endpoint

儲存體資料服務端點。 必須與儲存體帳戶金鑰或 SAS 權杖搭配使用。 您可以使用 找到每個服務主要端點 az storage account show 。 環境變數：AZURE_STORAGE_SERVICE_ENDPOINT。

--sas-token

共用存取簽章 （SAS）。 必須與儲存體帳戶名稱或服務端點搭配使用。 環境變數：AZURE_STORAGE_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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。