Partilhar via

az communication email

  • Pré-visualizar

Note

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

Este grupo de comandos está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Gerencie o e-mail de comunicação.

Comandos

Name Description Tipo Status
az communication email create

Crie um novo EmailService ou atualize um EmailService existente.

 Extension Preview
az communication email delete

Excluir para excluir um EmailService.

 Extension Preview
az communication email domain

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

 Extension Preview
az communication email domain cancel-verification

Cancelar a verificação do registro DNS.

 Extension Preview
az communication email domain create

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

 Extension Preview
az communication email domain delete

Excluir para excluir um recurso de Domínios.

 Extension Preview
az communication email domain initiate-verification

Inicie a verificação do registro DNS.

 Extension Preview
az communication email domain list

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

 Extension Preview
az communication email domain sender-username

Gerencie o Remetente-Nome de Usuário do Domínio de E-mail de Comunicação.

 Extension Preview
az communication email domain sender-username create

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

 Extension Preview
az communication email domain sender-username delete

Excluir para excluir um recurso SenderUsernames.

 Extension Preview
az communication email domain sender-username list

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

 Extension Preview
az communication email domain sender-username show

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

 Extension Preview
az communication email domain sender-username update

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

 Extension Preview
az communication email domain show

Obtenha o recurso Domínios e suas propriedades.

 Extension Preview
az communication email domain update

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

 Extension Preview
az communication email domain wait

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

 Extension Preview
az communication email list

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

 Extension Preview
az communication email send

Envie um e-mail e obtenha o status final.

 Extension Preview
az communication email show

Obtenha o EmailService e suas propriedades.

 Extension Preview
az communication email status

Comandos para obter o status de emails enviados anteriormente usando o serviço de Email dos Serviços de Comunicação do Azure.

 Extension Preview
az communication email status get

Obter o status de um e-mail enviado anteriormente.

 Extension Preview
az communication email update

Atualize um novo EmailService ou atualize um EmailService existente.

 Extension Preview
az communication email wait

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

 Extension Preview

az communication email create

Pré-visualizar

O grupo de comando 'email de comunicação' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Crie um novo EmailService ou atualize um EmailService existente.

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]

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

--data-location

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

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--location -l

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

Propriedade Valor
Grupo de parâmetros: Parameters Arguments
Default value: Global
--no-wait

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

Propriedade Valor
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.

Propriedade Valor
Grupo de parâmetros: Parameters Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az communication email delete

Pré-visualizar

O grupo de comando 'email de comunicação' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Excluir para excluir um 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]

Exemplos

Excluir um recurso de email

az communication email delete -n ResourceName -g ResourceGroup

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

O nome do recurso EmailService.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

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

Propriedade Valor
Valores aceites: 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>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Default value: False

az communication email list

Pré-visualizar

O grupo de comando 'email de comunicação' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--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 em --next-token argumento de um comando subsequente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--resource-group -g

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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az communication email send

Pré-visualizar

O grupo de comando 'email de comunicação' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

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}]
                            [--inline-attachments]
                            [--reply-to]
                            [--text]
                            [--to]
                            [--wait-until {0, 1, completed, started}]

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--attachment-types

Lista de tipos de anexos de e-mail e tipos de anexos embutidos, na mesma ordem de anexos seguida por anexos embutidos. Obrigatório para cada anexo. Os valores conhecidos para anexos 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, xlsb, xlsm e xlsx.

--attachments

Lista de anexos de e-mail. Optional.

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

Propriedade Valor
Grupo de parâmetros: Communication Arguments
--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. Optional.

Propriedade Valor
Default value: False
Valores aceites: false, true
--html

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

--importance

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

Propriedade Valor
Default value: normal
Valores aceites: high, low, normal
--inline-attachments

Lista de anexos embutidos. Optional. Formato: FileLocation/ContentId exemplo: "ImageName.png/image".

--reply-to

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

--text

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

--to

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

--wait-until

Indica se a operação do servidor deve aguardar até que a operação do servidor seja iniciada ou concluída. Os valores aceites são: iniciado, concluído, 1, 0.

Propriedade Valor
Default value: completed
Valores aceites: 0, 1, completed, started
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az communication email show

Pré-visualizar

O grupo de comando 'email de comunicação' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Obtenha o EmailService e suas propriedades.

az communication email show [--email-service-name --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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

O nome do recurso EmailService.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Default value: False

az communication email update

Pré-visualizar

O grupo de comando 'email de comunicação' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualize um novo EmailService ou atualize um EmailService existente.

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]

Exemplos

Atualizar um recurso de e-mail com tags

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--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 or JSON string>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--email-service-name --name -n

O nome do recurso EmailService.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--force-string

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
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 que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

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

Propriedade Valor
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 <indexToRemove> OU --remove propertyToRemove.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--tags

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

Propriedade Valor
Grupo de parâmetros: Parameters Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Default value: False

az communication email wait

Pré-visualizar

O grupo de comando 'email de comunicação' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

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 --name]
                            [--exists]
                            [--ids]
                            [--interval]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--created

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--custom

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--email-service-name --name -n

O nome do recurso EmailService.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 30
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 3600
--updated

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Default value: False