共用方式為


az communication email

Note

此參考是 Azure CLI 通訊延伸模組 的一部分(2.67.0 版或更高版本)。 擴充功能會在您第一次執行 az communication email 命令時自動安裝。 深入了解擴充功能。

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

管理通訊電子郵件。

命令

名稱 Description 類型 狀態
az communication email create

建立新的 EmailService 或更新現有的 EmailService。

Extension Preview
az communication email delete

刪除以刪除 EmailService。

Extension Preview
az communication email domain

管理通訊電子郵件網域。

Extension Preview
az communication email domain cancel-verification

取消 DNS 記錄的驗證。

Extension Preview
az communication email domain create

在父 EmailService 資源下建立新的 Domains 資源,或更新現有的網域資源。

Extension Preview
az communication email domain delete

刪除以刪除網域資源。

Extension Preview
az communication email domain initiate-verification

起始 DNS 記錄的驗證。

Extension Preview
az communication email domain list

列出在父 EmailServices 資源下列出所有網域資源的要求。

Extension Preview
az communication email domain sender-username

管理通訊電子郵件網域發件者-用戶名稱。

Extension Preview
az communication email domain sender-username create

在父網域資源下建立新的 SenderUsername 資源,或更新現有的 SenderUsername 資源。

Extension Preview
az communication email domain sender-username delete

刪除以刪除 SenderUsernames 資源。

Extension Preview
az communication email domain sender-username list

列出網域資源的所有有效寄件者用戶名稱。

Extension Preview
az communication email domain sender-username show

取得網域資源的有效寄件者用戶名稱。

Extension Preview
az communication email domain sender-username update

在父網域資源下更新新的 SenderUsername 資源,或更新現有的 SenderUsername 資源。

Extension Preview
az communication email domain show

取得網域資源及其屬性。

Extension Preview
az communication email domain update

在父 EmailService 資源下更新新的網域資源,或更新現有的網域資源。

Extension Preview
az communication email domain wait

將 CLI 置於等候狀態,直到符合條件為止。

Extension Preview
az communication email list

列出列出訂用帳戶中所有資源的要求。

Extension Preview
az communication email send

傳送電子郵件並取得最終狀態。

Extension Preview
az communication email show

取得 EmailService 及其屬性。

Extension Preview
az communication email status

取得先前使用 Azure 通訊服務電子郵件服務傳送之電子郵件狀態的命令。

Extension Preview
az communication email status get

取得先前傳送的電子郵件狀態。

Extension Preview
az communication email update

更新新的 EmailService 或更新現有的 EmailService。

Extension Preview
az communication email wait

將 CLI 置於等候狀態,直到符合條件為止。

Extension Preview

az communication email create

預覽

命令群組「通訊電子郵件」處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

建立新的 EmailService 或更新現有的 EmailService。

az communication email create --data-location
                              --email-service-name --name
                              --resource-group
                              [--location]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--tags]

範例

使用標籤建立電子郵件資源

az communication email create -n ResourceName -g ResourceGroup --location global --data-location unitedstates --tags "{tag:tag}"

必要參數

--data-location

電子郵件服務儲存待用數據的位置。

屬性
參數群組: Properties Arguments
--email-service-name --name -n

EmailService 資源的名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--location -l

未指定資源所在的地理位置,將會使用資源群組的位置。

屬性
參數群組: Parameters Arguments
預設值: Global
--no-wait

請勿等候長時間執行的作業完成。

屬性
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

屬性
參數群組: Parameters Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az communication email delete

預覽

命令群組「通訊電子郵件」處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

刪除以刪除 EmailService。

az communication email delete [--email-service-name --name]
                              [--ids]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--resource-group]
                              [--subscription]
                              [--yes]

範例

刪除電子郵件資源

az communication email delete -n ResourceName -g ResourceGroup

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--email-service-name --name -n

EmailService 資源的名稱。

屬性
參數群組: Resource Id Arguments
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--no-wait

請勿等候長時間執行的作業完成。

屬性
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--subscription

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

屬性
參數群組: Resource Id Arguments
--yes -y

請勿提示確認。

屬性
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az communication email list

預覽

命令群組「通訊電子郵件」處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

列出列出訂用帳戶中所有資源的要求。

az communication email list [--max-items]
                            [--next-token]
                            [--resource-group]

範例

從訂用帳戶取得所有資源

az communication email list --subscription SubscriptionId

從資源群組取得所有資源

az communication email list -g ResourceGroup

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--max-items

命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值,則會在命令的輸出中提供令牌。 若要繼續分頁,請在後續命令的 --next-token 自變數中提供令牌值。

屬性
參數群組: Pagination Arguments
--next-token

標記,指定要開始分頁的位置。 這是先前截斷回應中的令牌值。

屬性
參數群組: Pagination Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az communication email send

預覽

命令群組「通訊電子郵件」處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

傳送電子郵件並取得最終狀態。

az communication email send --sender
                            --subject
                            [--attachment-types]
                            [--attachments]
                            [--bcc]
                            [--cc]
                            [--connection-string]
                            [--disable-tracking {false, true}]
                            [--html]
                            [--importance {high, low, normal}]
                            [--inline-attachments]
                            [--reply-to]
                            [--text]
                            [--to]
                            [--wait-until {0, 1, completed, started}]

範例

從現有網域傳送電子郵件

az communication email send --sender "NoReply@contoso.com" --subject "Contoso Update" --to "user1@user1-domain.com" "user2@user2-domain.com" --text "Hello valued client. There is an update."

必要參數

--sender

來自已驗證網域的發件者電子郵件位址。

--subject

電子郵件訊息的主旨。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--attachment-types

電子郵件附件類型和內嵌附件類型的清單,順序相同,後面接著內嵌附件。 每個附件都需要。 附件的已知值為:avi、bmp、doc、docm、docx、gif、jpeg、mp3、one、pdf、png、ppsm、ppsx、ppt、pptm、pptx、pub、rpmsg、rtf、tif、txt、vsd、wav、wma、xls、xlsb、xlsm 和 xlsx。

--attachments

電子郵件附件清單。 Optional.

--bcc

盲目碳複製電子郵件位址。

--cc

副本電子郵件位址。

--connection-string

通訊連接字串。 環境變數:AZURE_COMMUNICATION_CONNECTION_STRING。

屬性
參數群組: Communication Arguments
--disable-tracking

指出是否應針對此特定要求停用用戶參與追蹤。 只有在控制平面中已啟用資源層級的用戶參與追蹤設定時,才適用這項設定。 Optional.

屬性
預設值: False
接受的值: false, true
--html

電子郵件訊息的 Html 版本。 Optional.

--importance

電子郵件的重要性類型。 已知值為:高、一般和低。 預設值為一般。 Optional.

屬性
預設值: normal
接受的值: high, low, normal
--inline-attachments

內嵌附件的清單。 Optional. 格式:FileLocation/ContentId 範例:“ImageName.png/image”。

--reply-to

回復電子郵件位址。 Optional.

--text

電子郵件訊息的純文字版本。 Optional.

--to

如果有多個電子郵件位址,請以逗號分隔。

--wait-until

指出是否要等到伺服器作業啟動或完成為止。 接受的值包括:started、completed、1、0。

屬性
預設值: completed
接受的值: 0, 1, completed, started
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az communication email show

預覽

命令群組「通訊電子郵件」處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

取得 EmailService 及其屬性。

az communication email show [--email-service-name --name]
                            [--ids]
                            [--resource-group]
                            [--subscription]

範例

取得電子郵件服務的屬性

az communication email show -n ResourceName -g ResourceGroup

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--email-service-name --name -n

EmailService 資源的名稱。

屬性
參數群組: Resource Id Arguments
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--subscription

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

屬性
參數群組: Resource Id Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az communication email update

預覽

命令群組「通訊電子郵件」處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

更新新的 EmailService 或更新現有的 EmailService。

az communication email update [--add]
                              [--email-service-name --name]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--subscription]
                              [--tags]

範例

使用標籤更新電子郵件資源

az communication email update -n ResourceName -g ResourceGroup --tags "{tag:tag}"

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--add

藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例: --add property.listProperty <key=value, string or JSON string>.

屬性
參數群組: Generic Update Arguments
--email-service-name --name -n

EmailService 資源的名稱。

屬性
參數群組: Resource Id Arguments
--force-string

使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。

屬性
參數群組: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--no-wait

請勿等候長時間執行的作業完成。

屬性
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--remove

從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove>--remove propertyToRemove

屬性
參數群組: Generic Update Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--set

指定要設定的屬性路徑和值,以更新物件。 範例: --set property1.property2=<value>.

屬性
參數群組: Generic Update Arguments
--subscription

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

屬性
參數群組: Resource Id Arguments
--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

屬性
參數群組: Parameters Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az communication email wait

預覽

命令群組「通訊電子郵件」處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

將 CLI 置於等候狀態,直到符合條件為止。

az communication email wait [--created]
                            [--custom]
                            [--deleted]
                            [--email-service-name --name]
                            [--exists]
                            [--ids]
                            [--interval]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

屬性
參數群組: Wait Condition Arguments
預設值: False
--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。

屬性
參數群組: Wait Condition Arguments
--deleted

等到刪除為止。

屬性
參數群組: Wait Condition Arguments
預設值: False
--email-service-name --name -n

EmailService 資源的名稱。

屬性
參數群組: Resource Id Arguments
--exists

等候資源存在。

屬性
參數群組: Wait Condition Arguments
預設值: False
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--interval

輪詢間隔以秒為單位。

屬性
參數群組: Wait Condition Arguments
預設值: 30
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--subscription

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

屬性
參數群組: Resource Id Arguments
--timeout

以秒為單位的等候上限。

屬性
參數群組: Wait Condition Arguments
預設值: 3600
--updated

等到 provisioningState 更新為 'Succeeded'。

屬性
參數群組: Wait Condition Arguments
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False