Share via

az communication email

  • Referência

Nota

Essa referência faz parte da extensão de comunicação para a 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.

Gerencie o e-mail de comunicação.

Comandos

Name Description Tipo Estado
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

Gerencie o 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 de 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

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

 Extensão GA
az communication email domain sender-username

Gerencie o 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

Liste 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

Obtenha 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 --email-service-name
                              --resource-group
                              [--data-location]
                              [--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 Obrigatórios

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

O nome do recurso EmailService.

--resource-group -g

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

Parâmetros Opcionais

--data-location

O local onde o serviço de e-mail armazena seus dados em repouso.

--location -l

A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.

--no-wait

Não espere que a operação de longa duração termine.

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

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--no-wait

Não espere que a operação de longa duração termine.

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

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 subscrição

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 por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

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

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

--connection-string

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

--disable-tracking

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

valores aceites: false, true
valor predefinido: 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 é normal. Opcional.

valores aceites: high, low, normal
valor predefinido: normal
--reply-to

Endereço de e-mail de resposta. Opcional.

--text

Versão de texto simples da mensagem de e-mail. Opcional.

--to

Recepients endereços de e-mail vírgula separada se mais de um.

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 as 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

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 e-mail 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 valor de chave. Exemplo: --add property.listProperty <key=value, string ou JSON string>.

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

O nome do recurso EmailService.

--force-string

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

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

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--no-wait

Não espere que a operação de longa duração termine.

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

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

--resource-group -g

o 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 ser definido. Exemplo: --set property1.property2=.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--tags

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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é ser criado com 'provisioningState' em 'Succeeded'.

valor predefinido: 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 predefinido: False
--email-service-name --name -n

O nome do recurso EmailService.

--exists

Aguarde até que o recurso exista.

valor predefinido: False
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--interval

Intervalo de sondagem em segundos.

valor predefinido: 30
--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--timeout

Espera máxima em segundos.

valor predefinido: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.