Compartilhar via

az communication email

  • Versão Prévia

Note

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

Esse grupo de comandos está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Gerenciar email de comunicação.

Comandos

Nome 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

Gerenciar domínio de email 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 recurso de Domínios no recurso emailService pai ou atualize um recurso de 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

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

 Extension Preview
az communication email domain sender-username

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

 Extension Preview
az communication email domain sender-username create

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

 Extension Preview
az communication email domain sender-username delete

Exclua 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 de 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 de Domínios no recurso emailService pai ou atualize um recurso de 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 email 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

Obtenha o status de um email 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

Versão Prévia

O grupo de comandos 'email de comunicação' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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 marcas

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.

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--location -l

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

Propriedade Valor
Grupo de parâmetros: Parameters Arguments
Valor padrão: Global
--no-wait

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

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--tags

Tags de recursos. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

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

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az communication email delete

Versão Prévia

O grupo de comandos 'email de comunicação' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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 se tornar obrigatórios para que o comando seja executado com sucesso.

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

O nome do recurso EmailService.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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 de recurso'.

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

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

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

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

Nome ou ID da assinatura. 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
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az communication email list

Versão Prévia

O grupo de comandos 'email de comunicação' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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 onde iniciar a paginação. Esse é o valor do 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 Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az communication email send

Versão Prévia

O grupo de comandos 'email de comunicação' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Envie um email 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 email 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 email do remetente de um domínio verificado.

--subject

Assunto da mensagem de email.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--attachment-types

Lista de tipos de anexo de email e tipos de anexo embutidos, na mesma ordem de anexos seguidos por anexos embutidos. Necessá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, xlsb, xlsm e xlsx.

--attachments

Lista de anexos de email. Optional.

--bcc

Endereços de email de cópia de carbono cego.

--cc

Endereços de email 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 de envolvimento do usuário deve ser desabilitado para essa solicitação específica. Isso só será aplicável se a configuração de acompanhamento de envolvimento do usuário no nível do recurso já estiver habilitada no plano de controle. Optional.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--html

Versão html da mensagem de email. Optional.

--importance

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

Propriedade Valor
Valor padrão: normal
Valores aceitos: high, low, normal
--inline-attachments

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

--reply-to

Endereço de email de resposta. Optional.

--text

Versão de texto sem formatação da mensagem de email. Optional.

--to

Os endereços de email de recepientes são separados por vírgula, se mais de um.

--wait-until

Indica se a operação do servidor deve ser iniciada ou concluída. Os valores aceitos são: iniciado, concluído, 1, 0.

Propriedade Valor
Valor padrão: completed
Valores aceitos: 0, 1, completed, started
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az communication email show

Versão Prévia

O grupo de comandos 'email de comunicação' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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 email

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 se tornar obrigatórios para que o comando seja executado com sucesso.

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

O nome do recurso EmailService.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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 de recurso'.

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 assinatura. 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 Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az communication email update

Versão Prévia

O grupo de comandos 'email de comunicação' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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 email com marcas

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--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 cadeia de caracteres em vez de tentar converter em JSON.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
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 de recurso'.

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

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

Propriedade Valor
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 <indexToRemove> OR --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 assinatura. 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. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

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

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az communication email wait

Versão Prévia

O grupo de comandos 'email de comunicação' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--created

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--custom

Aguarde até que a condição atenda 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
Valor padrão: 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
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 de recurso'.

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

Intervalo de sondagem em segundos.

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

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

Nome ou ID da assinatura. 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
Valor padrão: 3600
--updated

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False