Share via


az storage queue

此命令群組處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

管理儲存體佇列。

命令

名稱 Description 類型 狀態
az storage queue create

在指定的帳號下建立佇列。

核心 預覽版
az storage queue delete

刪除指定的佇列及其包含的任何訊息。

核心 預覽版
az storage queue exists

傳回布林值,指出佇列是否存在。

核心 預覽版
az storage queue generate-sas

產生佇列的共用存取簽章。使用傳回的簽章搭配 QueueService 的 sas_token 參數。

核心 預覽版
az storage queue list

列出儲存體帳戶中的佇列。

核心 預覽版
az storage queue metadata

管理儲存體佇列的中繼資料。

核心 預覽版
az storage queue metadata show

傳回指定佇列的所有使用者定義中繼資料。

核心 預覽版
az storage queue metadata update

在指定的佇列上設定使用者定義的中繼資料。

核心 預覽版
az storage queue policy

管理儲存體佇列的共用存取原則。

核心 預覽版
az storage queue policy create

在包含的物件上建立預存存取原則。

核心 預覽版
az storage queue policy delete

刪除包含物件的預存存取原則。

核心 預覽版
az storage queue policy list

列出包含物件的預存存取原則。

核心 預覽版
az storage queue policy show

在包含的物件上顯示預存存取原則。

核心 預覽版
az storage queue policy update

在包含的物件上設定預存存取原則。

核心 預覽版
az storage queue stats

擷取佇列服務複寫的相關統計資料。 只有在儲存體帳戶啟用讀取權限異地備援複寫時,才能使用。

核心 預覽版

az storage queue create

預覽

命令群組 'storage queue' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

在指定的帳號下建立佇列。

az storage queue create --name
                        [--account-key]
                        [--account-name]
                        [--auth-mode {key, login}]
                        [--connection-string]
                        [--fail-on-exist]
                        [--metadata]
                        [--queue-endpoint]
                        [--sas-token]
                        [--timeout]

範例

使用中繼資料在指定的帳號下建立佇列。

az storage queue create -n myqueue --metadata key1=value1 key2=value2 --account-name mystorageaccount

必要參數

--name -n

佇列名稱。

選擇性參數

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

--fail-on-exist

指定如果佇列已經存在,是否要擲回例外狀況。

預設值: False
--metadata

空格分隔索引鍵=值組中的中繼資料。 這會覆寫任何現有的中繼資料。

--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 queue delete

預覽

命令群組 'storage queue' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

刪除指定的佇列及其包含的任何訊息。

az storage queue delete --name
                        [--account-key]
                        [--account-name]
                        [--auth-mode {key, login}]
                        [--connection-string]
                        [--fail-not-exist]
                        [--queue-endpoint]
                        [--sas-token]
                        [--timeout]

範例

刪除指定的佇列,如果佇列不存在,則擲回例外狀況。

az storage queue delete -n myqueue --fail-not-exist --account-name mystorageaccount

必要參數

--name -n

佇列名稱。

選擇性參數

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

--fail-not-exist

指定如果佇列不存在,是否要擲回例外狀況。

預設值: False
--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 queue exists

預覽

命令群組 'storage queue' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

傳回布林值,指出佇列是否存在。

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

範例

檢查佇列是否存在。

az storage queue exists -n myqueue --account-name mystorageaccount

必要參數

--name -n

佇列名稱。

選擇性參數

--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 queue generate-sas

預覽

命令群組 'storage queue' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

產生佇列的共用存取簽章。使用傳回的簽章搭配 QueueService 的 sas_token 參數。

az storage queue generate-sas --name
                              [--account-key]
                              [--account-name]
                              [--connection-string]
                              [--expiry]
                              [--https-only]
                              [--ip]
                              [--permissions]
                              [--policy-name]
                              [--queue-endpoint]
                              [--start]

範例

為具有唯讀許可權的佇列產生 SAS 權杖。

end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage queue generate-sas -n myqueue --account-name mystorageaccount --permissions r --expiry $end --https-only

為指定 ip 範圍的佇列產生 sas 權杖。

end=`date -u -d "30 minutes" '+%Y-%m-%dT%H:%MZ'`
az storage queue generate-sas -n myqueue --account-name mystorageaccount --ip "176.134.171.0-176.134.171.255" --permissions r --expiry $end --https-only

必要參數

--name -n

佇列名稱。

選擇性參數

--account-key

儲存體帳戶金鑰。 必須與儲存體帳戶名稱或服務端點搭配使用。 環境變數:AZURE_STORAGE_KEY。

--account-name

儲存體帳戶名稱。 相關的環境變數:AZURE_STORAGE_ACCOUNT。 必須與儲存體帳戶金鑰或 SAS 權杖搭配使用。 如果兩者都不存在,命令會嘗試使用已驗證的 Azure 帳戶來查詢儲存體帳戶金鑰。 如果執行大量儲存體命令,可能會叫用 API 配額。

--connection-string

儲存體帳戶連接字串。 環境變數:AZURE_STORAGE_CONNECTION_STRING。

--expiry

指定 SAS 不正確 UTC 日期時間(Y-m-d'T'H:M'Z')。 如果以指定此值的 --policy-name 參考預存存取原則,請勿使用 。

--https-only

只允許使用 HTTPS 通訊協定提出的要求。 如果省略,則允許來自 HTTP 和 HTTPS 通訊協定的要求。

--ip

指定要接受要求的 IP 位址或 IP 位址範圍。 僅支援 IPv4 樣式位址。

--permissions

SAS 授與的許可權。 允許的值:(a)dd (p)rocess (r)ead (u)pdate。 如果以指定此值的 --id 參考預存存取原則,請勿使用 。 可以合併。

--policy-name

共用 ACL 內預存存取原則的名稱。

--queue-endpoint

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

--start

指定 SAS 生效的 UTC 日期時間(Y-m-d'T'H:M'Z')。 如果以指定此值的 --policy-name 參考預存存取原則,請勿使用 。 預設為要求的時間。

全域參數
--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 queue list

預覽

命令群組 'storage queue' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

列出儲存體帳戶中的佇列。

az storage queue list [--account-key]
                      [--account-name]
                      [--auth-mode {key, login}]
                      [--connection-string]
                      [--include-metadata]
                      [--marker]
                      [--num-results]
                      [--prefix]
                      [--queue-endpoint]
                      [--sas-token]
                      [--show-next-marker]
                      [--timeout]

範例

列出名稱開頭為儲存體帳戶 'mystorageaccount' 底下的 'myprefix' 的佇列(帳戶名稱)

az storage queue list --prefix myprefix --account-name mystorageaccount

選擇性參數

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

--include-metadata

指定在回應中傳回佇列中繼資料。

預設值: False
--marker

字串值,識別要隨著下一個清單作業傳回之容器清單的部分。 如果清單作業未傳回剩餘的所有容器,則此作業會傳迴響應主體內的 NextMarker 值,以與目前頁面一起列出。 如果指定,這個產生器會從前一個產生器停止的點開始傳回結果。

--num-results

指定要傳回的最大數目。 如果要求未指定num_results,或指定大於 5000 的值,伺服器將傳回最多 5000 個專案。 請注意,如果清單作業跨越資料分割界限,則服務會傳回接續權杖,以擷取其餘的結果。 提供 「*」 以傳回全部。

預設值: 5000
--prefix

篩選結果,只傳回名稱開頭為指定前置詞的佇列。

--queue-endpoint

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

--sas-token

共用存取簽章 (SAS)。 必須與儲存體帳戶名稱或服務端點搭配使用。 環境變數:AZURE_STORAGE_SAS_TOKEN。

--show-next-marker

指定時,在結果中顯示 nextMarker。

--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 queue stats

預覽

命令群組 'storage queue' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

擷取佇列服務複寫的相關統計資料。 只有在儲存體帳戶啟用讀取權限異地備援複寫時,才能使用。

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

範例

顯示佇列服務複寫的相關統計資料。

az storage queue stats --account-name mystorageaccount

選擇性參數

--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 來取得完整偵錯記錄。