az eventgrid namespace client

Nota

Essa referência faz parte da extensão eventgrid para a CLI do Azure (versão 2.51.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az eventgrid namespace client . Saiba mais sobre extensões.

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

Gerencie o cliente de namespace eventgrid.

Comandos

Name	Description	Tipo	Estado
az eventgrid namespace client create	Crie um cliente.	Extensão	Pré-visualizar
az eventgrid namespace client delete	Exclua um cliente existente.	Extensão	Pré-visualizar
az eventgrid namespace client list	Liste todo o cliente em um namespace.	Extensão	Pré-visualizar
az eventgrid namespace client show	Mostrar um cliente.	Extensão	Pré-visualizar
az eventgrid namespace client update	Atualize um cliente.	Extensão	Pré-visualizar
az eventgrid namespace client wait	Coloque a CLI em um estado de espera até que uma condição seja atendida.	Extensão	Pré-visualizar

az eventgrid namespace client create

Pré-visualizar

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

Crie um cliente.

az eventgrid namespace client create --client-name
                                     --namespace-name
                                     --resource-group
                                     [--attributes]
                                     [--authentication]
                                     [--authentication-name]
                                     [--client-certificate-authentication]
                                     [--description]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--state {Disabled, Enabled}]

Exemplos

Criar cliente

az eventgrid namespace client create -g rg --namespace-name name -n client-name  --attributes "{'room':'345','floor':5}" --client-certificate-authentication "{validationScheme:SubjectMatchesAuthenticationName}"

Parâmetros Obrigatórios

--client-name --name -n

O nome do cliente.

--namespace-name

Nome do namespace.

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

--attributes

Atributos para o cliente. Suporte json-file e yaml-file.

--authentication

Informações de autenticação para o cliente. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--authentication-name

O nome apresentado pelo cliente para autenticação. O valor padrão é o nome do recurso.

--client-certificate-authentication

As informações de autenticação do certificado do cliente. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--description

Descrição do recurso Cliente.

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

--state

Indica se o cliente está habilitado ou não. O valor padrão é Enabled.

valores aceites: Disabled, Enabled

valor predefinido: Enabled

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 eventgrid namespace client delete

Pré-visualizar

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

Exclua um cliente existente.

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

Exemplos

Excluir cliente

az eventgrid namespace client delete -g rg --namespace-name name -n client-name

Parâmetros Opcionais

--client-name --name -n

Nome do cliente.

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

--namespace-name

Nome do namespace.

--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 eventgrid namespace client list

Pré-visualizar

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

Liste todo o cliente em um namespace.

az eventgrid namespace client list --namespace-name
                                   --resource-group
                                   [--filter]
                                   [--max-items]
                                   [--next-token]
                                   [--top]

Exemplos

Listar cliente

az eventgrid namespace client list -g rg --namespace-name name

Parâmetros Obrigatórios

--namespace-name

Nome do namespace.

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

--filter

A consulta usada para filtrar os resultados da pesquisa usando a sintaxe OData. A filtragem é permitida apenas na propriedade 'name' e com um número limitado de operações OData. Estas operações são: a função «contém», bem como as seguintes operações lógicas: not, e, ou, eq (para igual) e ne (para não igual). Nenhuma operação aritmética é suportada. Segue-se um exemplo de filtro válido: $filter=contains(namE, 'PATTERN') e name ne 'PATTERN-1'. O seguinte não é um exemplo de filtro válido: $filter=location eq 'westus'.

--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 do token de uma resposta truncada anteriormente.

--top

O número de resultados a serem retornados por página para a operação de lista. O intervalo válido para o parâmetro superior é de 1 a 100. Se não for especificado, o número padrão de resultados a serem retornados é de 20 itens por página.

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 eventgrid namespace client show

Pré-visualizar

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

Mostrar um cliente.

az eventgrid namespace client show [--client-name]
                                   [--ids]
                                   [--namespace-name]
                                   [--resource-group]
                                   [--subscription]

Exemplos

Mostrar cliente

az eventgrid namespace client show -g rg --namespace-name name -n client-name

Parâmetros Opcionais

--client-name --name -n

Nome do cliente.

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

--namespace-name

Nome do namespace.

--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 eventgrid namespace client update

Pré-visualizar

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

Atualize um cliente.

az eventgrid namespace client update [--add]
                                     [--attributes]
                                     [--authentication]
                                     [--client-certificate-authentication]
                                     [--client-name]
                                     [--description]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--ids]
                                     [--namespace-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--state {Disabled, Enabled}]
                                     [--subscription]

Exemplos

Cliente de atualização

az eventgrid namespace client update -g rg --namespace-name name -n client-name --description test

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

--attributes

Atributos para o cliente. Suporte json-file e yaml-file.

--authentication

Informações de autenticação para o cliente. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--client-certificate-authentication

As informações de autenticação do certificado do cliente. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--client-name --name -n

Nome do cliente.

--description

Descrição do recurso Cliente.

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

--namespace-name

Nome do namespace.

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

--state

Indica se o cliente está habilitado ou não. O valor padrão é Enabled.

valores aceites: Disabled, Enabled

--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 eventgrid namespace client wait

Pré-visualizar

O grupo de comandos 'az eventgrid namespace client' 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 eventgrid namespace client wait [--client-name]
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--ids]
                                   [--interval]
                                   [--namespace-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Parâmetros Opcionais

--client-name --name -n

Nome do cliente.

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

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

--namespace-name

Nome do namespace.

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