Share via


az eventgrid namespace client

Nota:

Esta referencia forma parte de la extensión eventgrid para la CLI de Azure (versión 2.51.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az eventgrid namespace client . Obtenga más información sobre las extensiones.

El grupo de comandos "az eventgrid" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Administrar el cliente del espacio de nombres eventgrid.

Comandos

Nombre Description Tipo Estado
az eventgrid namespace client create

Cree un cliente.

Extensión Vista previa
az eventgrid namespace client delete

Elimine un cliente existente.

Extensión Vista previa
az eventgrid namespace client list

Enumere todo el cliente en un espacio de nombres.

Extensión Vista previa
az eventgrid namespace client show

Mostrar un cliente.

Extensión Vista previa
az eventgrid namespace client update

Actualizar un cliente.

Extensión Vista previa
az eventgrid namespace client wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición.

Extensión Vista previa

az eventgrid namespace client create

Vista previa

El grupo de comandos "az eventgrid namespace client" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Cree un 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}]

Ejemplos

Crear el 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 requeridos

--client-name --name -n

El nombre del cliente.

--namespace-name

Nombre del espacio de nombres.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--attributes

Atributos para el cliente. Admite json-file y yaml-file.

--authentication

Información de autenticación para el cliente. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--authentication-name

Nombre presentado por el cliente para la autenticación. El valor predeterminado es el nombre del recurso.

--client-certificate-authentication

Información de autenticación del certificado de cliente. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--description

Descripción del recurso cliente.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--state

Indica si el cliente está habilitado o no. El valor predeterminado es Habilitado.

valores aceptados: Disabled, Enabled
valor predeterminado: Enabled
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az eventgrid namespace client delete

Vista previa

El grupo de comandos "az eventgrid namespace client" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Elimine un 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]

Ejemplos

Delete client

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

Parámetros opcionales

--client-name --name -n

Nombre del cliente.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--namespace-name

Nombre del espacio de nombres.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

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

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--yes -y

No solicita confirmación.

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az eventgrid namespace client list

Vista previa

El grupo de comandos "az eventgrid namespace client" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Enumere todo el cliente en un espacio de nombres.

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

Ejemplos

Enumerar cliente

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

Parámetros requeridos

--namespace-name

Nombre del espacio de nombres.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--filter

Consulta que se usa para filtrar los resultados de búsqueda mediante la sintaxis de OData. El filtrado solo se permite en la propiedad "name" y con un número limitado de operaciones de OData. Estas operaciones son: la función "contains" así como las siguientes operaciones lógicas: no y, o eq (para igual) y ne (para no igual). No se admiten operaciones aritméticas. A continuación se muestra un ejemplo de filtro válido: $filter=contains(namE, 'PATTERN') y name ne 'PATTERN-1'. A continuación no se muestra un ejemplo de filtro válido: $filter=location eq 'westus'.

--max-items

Número total de elementos que se van a devolver en la salida del comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un token en la salida del comando. Para reanudar la paginación, proporcione el valor del token en --next-token el argumento de un comando posterior.

--next-token

Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.

--top

Número de resultados que se van a devolver por página para la operación de lista. El intervalo válido para el parámetro superior es de 1 a 100. Si no se especifica, el número predeterminado de resultados que se devolverá es de 20 elementos por página.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az eventgrid namespace client show

Vista previa

El grupo de comandos "az eventgrid namespace client" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Mostrar un cliente.

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

Ejemplos

Mostrar cliente

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

Parámetros opcionales

--client-name --name -n

Nombre del cliente.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--namespace-name

Nombre del espacio de nombres.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az eventgrid namespace client update

Vista previa

El grupo de comandos "az eventgrid namespace client" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Actualizar un 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]

Ejemplos

Actualizar cliente

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

Parámetros opcionales

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string o JSON string>.

--attributes

Atributos para el cliente. Admite json-file y yaml-file.

--authentication

Información de autenticación para el cliente. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--client-certificate-authentication

Información de autenticación del certificado de cliente. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--client-name --name -n

Nombre del cliente.

--description

Descripción del recurso cliente.

--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

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

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--namespace-name

Nombre del espacio de nombres.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

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

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=.

--state

Indica si el cliente está habilitado o no. El valor predeterminado es Habilitado.

valores aceptados: Disabled, Enabled
--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az eventgrid namespace client wait

Vista previa

El grupo de comandos "az eventgrid namespace client" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Coloque la CLI en un estado de espera hasta que se cumpla una condición.

az eventgrid namespace client wait [--client-name]
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--ids]
                                   [--interval]
                                   [--namespace-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Parámetros opcionales

--client-name --name -n

Nombre del cliente.

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere hasta que se elimine.

valor predeterminado: False
--exists

Espere hasta que exista el recurso.

valor predeterminado: False
--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--interval

Intervalo de sondeo en segundos.

valor predeterminado: 30
--namespace-name

Nombre del espacio de nombres.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--timeout

Espera máxima en segundos.

valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.