Compartilhar via

az communication email

  • Referência

Observação

Essa referência faz parte da extensão de comunicação da CLI do Azure (versão 2.59.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az communication email . Saiba mais sobre extensões.

Gerenciar e-mails de comunicação.

Comandos

Nome Description Tipo Status
az communication email create

Crie um novo EmailService ou atualize um EmailService existente.

 Extensão GA
az communication email delete

Excluir para excluir um EmailService.

 Extensão GA
az communication email domain

Gerenciar domínio de e-mail de comunicação.

 Extensão GA
az communication email domain cancel-verification

Cancelar a verificação do registro DNS.

 Extensão GA
az communication email domain create

Crie um novo recurso Domínios no recurso EmailService pai ou atualize um recurso Domínios existente.

 Extensão GA
az communication email domain delete

Excluir para excluir um recurso Domínios.

 Extensão GA
az communication email domain initiate-verification

Inicie a verificação do registro DNS.

 Extensão GA
az communication email domain list

Listar solicitações para listar todos os recursos de Domínios no recurso pai do EmailServices.

 Extensão GA
az communication email domain sender-username

Gerenciar remetente-nome de usuário do domínio de e-mail de comunicação.

 Extensão GA
az communication email domain sender-username create

Crie um novo recurso SenderUsername no recurso Domínios pai ou atualize um recurso SenderUsername existente.

 Extensão GA
az communication email domain sender-username delete

Excluir para excluir um recurso SenderUsernames.

 Extensão GA
az communication email domain sender-username list

Listar todos os nomes de usuário de remetente válidos para um recurso de domínios.

 Extensão GA
az communication email domain sender-username show

Obter um nome de usuário de remetente válido para um recurso de domínios.

 Extensão GA
az communication email domain sender-username update

Atualize um novo recurso SenderUsername no recurso Domínios pai ou atualize um recurso SenderUsername existente.

 Extensão GA
az communication email domain show

Obtenha o recurso Domínios e suas propriedades.

 Extensão GA
az communication email domain update

Atualize um novo recurso Domínios no recurso EmailService pai ou atualize um recurso Domínios existente.

 Extensão GA
az communication email domain wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Extensão GA
az communication email list

Listar solicitações para listar todos os recursos em uma assinatura.

 Extensão GA
az communication email send

Envie um e-mail e obtenha o status final.

 Extensão GA
az communication email show

Obtenha o EmailService e suas propriedades.

 Extensão GA
az communication email update

Atualize um novo EmailService ou atualize um EmailService existente.

 Extensão GA
az communication email wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Extensão GA

az communication email create

Crie um novo EmailService ou atualize um EmailService existente.

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

Exemplos

Criar um recurso de email com tags

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

Parâmetros Exigidos

--data-location

O local onde o serviço de email armazena seus dados em repouso.

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

O nome do recurso EmailService.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--location -l

A localização geográfica onde o recurso reside Quando não especificado, o local do grupo de recursos será usado.

valor padrão: Global
--no-wait

Não aguarde a conclusão da operação de execução longa.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--tags

Tags de recursos. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az communication email delete

Excluir para excluir um EmailService.

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

Exemplos

Excluir um recurso de email

az communication email delete -n ResourceName -g ResourceGroup

Parâmetros Opcionais

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

O nome do recurso EmailService.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--no-wait

Não aguarde a conclusão da operação de execução longa.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--yes -y

Não solicite confirmação.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az communication email list

Listar solicitações para listar todos os recursos em uma assinatura.

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

Exemplos

Obter todos os recursos de uma assinatura

az communication email list --subscription SubscriptionId

Obter todos os recursos de um grupo de recursos

az communication email list -g ResourceGroup

Parâmetros Opcionais

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token no --next-token argumento de um comando subsequente.

--next-token

Token para especificar onde iniciar a paginação. Esse é o valor de token de uma resposta truncada anteriormente.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az communication email send

Envie um e-mail e obtenha o status final.

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

Exemplos

Enviar um e-mail de um domínio existente

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."

Parâmetros Exigidos

--sender

Endereço de e-mail do remetente de um domínio verificado.

--subject

Assunto da mensagem de e-mail.

Parâmetros Opcionais

--attachment-types

Lista de tipos de anexos de e-mail, na mesma ordem de anexos. Obrigatório para cada anexo. Os valores conhecidos são: 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 e xlsx.

--attachments

Lista de anexos de e-mail. Opcional.

--bcc

Endereços de e-mail de cópia oculta.

--cc

Carbon copiar endereços de e-mail.

--connection-string

Cadeia de conexão de comunicação. Variável de ambiente: AZURE_COMMUNICATION_CONNECTION_STRING.

--disable-tracking

Indica se o rastreamento de envolvimento do usuário deve ser desabilitado para essa solicitação específica. Isso só será aplicável se a configuração de rastreamento de engajamento do usuário no nível de recurso já estiver habilitada no plano de controle. Opcional.

valores aceitos: false, true
valor padrão: False
--html

Versão html da mensagem de e-mail. Opcional.

--importance

O tipo de importância para o e-mail. Os valores conhecidos são: alto, normal e baixo. O padrão é o normal. Opcional.

valores aceitos: high, low, normal
valor padrão: normal
--reply-to

Endereço de email de resposta. Opcional.

--text

Versão de texto simples da mensagem de email. Opcional.

--to

Endereços de e-mail de recepção separados por vírgula se houver mais de um.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az communication email show

Obtenha o EmailService e suas propriedades.

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

Exemplos

Obter propriedades de um serviço de e-mail

az communication email show -n ResourceName -g ResourceGroup

Parâmetros Opcionais

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

O nome do recurso EmailService.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az communication email update

Atualize um novo EmailService ou atualize um EmailService existente.

az communication email update [--add]
                              [--email-service-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]

Exemplos

Atualizar um recurso de email com tags

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

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string ou string> JSON.

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

O nome do recurso EmailService.

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--no-wait

Não aguarde a conclusão da operação de execução longa.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OU --remove propertyToRemove.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--tags

Tags de recursos. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az communication email wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

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

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

valor padrão: False
--email-service-name --name -n

O nome do recurso EmailService.

--exists

Aguarde até que o recurso exista.

valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--interval

Intervalo de sondagem em segundos.

valor padrão: 30
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--timeout

Espera máxima em segundos.

valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.