Compartir a través de

az eventgrid namespace client

  • Vista previa

Note

This reference is part of the eventgrid extension for the Azure CLI (version 2.51.0 or higher). La extensión instalará automáticamente la primera vez que ejecute un comando az eventgrid namespace client. Learn more about extensions.

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.

 Extension Preview
az eventgrid namespace client delete

Elimine un cliente existente.

 Extension Preview
az eventgrid namespace client list

Enumere todo el cliente en un espacio de nombres.

 Extension Preview
az eventgrid namespace client show

Mostrar un cliente.

 Extension Preview
az eventgrid namespace client update

Actualizar un cliente.

 Extension Preview
az eventgrid namespace client wait

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

 Extension Preview

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

Create client

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--attributes

Atributos para el cliente. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad Valor
Parameter group: Properties Arguments
--authentication

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

Propiedad Valor
Parameter group: Properties Arguments
--authentication-name

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

Propiedad Valor
Parameter group: Properties Arguments
--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.

Propiedad Valor
Parameter group: Properties Arguments
--description

Descripción del recurso cliente.

Propiedad Valor
Parameter group: Properties Arguments
--no-wait

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

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

Propiedad Valor
Parameter group: Properties Arguments
Valor predeterminado: Enabled
Valores aceptados: Disabled, Enabled
Parámetros globales
--debug

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

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--client-name --name -n

Nombre del cliente.

Propiedad Valor
Parameter group: Resource Id Arguments
--ids

Uno o varios identificadores de recursos (delimitados por espacio). 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".

Propiedad Valor
Parameter group: Resource Id Arguments
--namespace-name

Nombre del espacio de nombres.

Propiedad Valor
Parameter group: Resource Id Arguments
--no-wait

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

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

Propiedad Valor
Parameter group: Resource Id Arguments
--subscription

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

Propiedad Valor
Parameter group: Resource Id Arguments
--yes -y

No solicita confirmación.

Propiedad Valor
Valor predeterminado: False
Parámetros globales
--debug

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

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

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

List client

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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 argumento de un comando posterior.

Propiedad Valor
Parameter group: Pagination Arguments
--next-token

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

Propiedad Valor
Parameter group: Pagination Arguments
--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 del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

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 --name]
                                   [--ids]
                                   [--namespace-name]
                                   [--resource-group]
                                   [--subscription]

Ejemplos

Show client

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

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--client-name --name -n

Nombre del cliente.

Propiedad Valor
Parameter group: Resource Id Arguments
--ids

Uno o varios identificadores de recursos (delimitados por espacio). 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".

Propiedad Valor
Parameter group: Resource Id Arguments
--namespace-name

Nombre del espacio de nombres.

Propiedad Valor
Parameter group: Resource Id Arguments
--resource-group -g

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

Propiedad Valor
Parameter group: Resource Id Arguments
--subscription

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

Propiedad Valor
Parameter group: Resource Id Arguments
Parámetros globales
--debug

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

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

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

Update client

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

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Propiedad Valor
Parameter group: Generic Update Arguments
--attributes

Atributos para el cliente. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad Valor
Parameter group: Properties Arguments
--authentication

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

Propiedad Valor
Parameter group: Properties Arguments
--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.

Propiedad Valor
Parameter group: Properties Arguments
--client-name --name -n

Nombre del cliente.

Propiedad Valor
Parameter group: Resource Id Arguments
--description

Descripción del recurso cliente.

Propiedad Valor
Parameter group: Properties Arguments
--force-string

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

Propiedad Valor
Parameter group: Generic Update Arguments
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uno o varios identificadores de recursos (delimitados por espacio). 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".

Propiedad Valor
Parameter group: Resource Id Arguments
--namespace-name

Nombre del espacio de nombres.

Propiedad Valor
Parameter group: Resource Id Arguments
--no-wait

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

Propiedad Valor
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 <indexToRemove> O --remove propertyToRemove.

Propiedad Valor
Parameter group: Generic Update Arguments
--resource-group -g

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

Propiedad Valor
Parameter group: Resource Id Arguments
--set

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

Propiedad Valor
Parameter group: Generic Update Arguments
--state

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

Propiedad Valor
Parameter group: Properties Arguments
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.

Propiedad Valor
Parameter group: Resource Id Arguments
Parámetros globales
--debug

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

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

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

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--client-name --name -n

Nombre del cliente.

Propiedad Valor
Parameter group: Resource Id Arguments
--created

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

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: False
--custom

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

Propiedad Valor
Parameter group: Wait Condition Arguments
--deleted

Espere hasta que se elimine.

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: False
--exists

Espere hasta que exista el recurso.

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: False
--ids

Uno o varios identificadores de recursos (delimitados por espacio). 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".

Propiedad Valor
Parameter group: Resource Id Arguments
--interval

Intervalo de sondeo en segundos.

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: 30
--namespace-name

Nombre del espacio de nombres.

Propiedad Valor
Parameter group: Resource Id Arguments
--resource-group -g

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

Propiedad Valor
Parameter group: Resource Id Arguments
--subscription

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

Propiedad Valor
Parameter group: Resource Id Arguments
--timeout

Espera máxima en segundos.

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: 3600
--updated

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

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: False
Parámetros globales
--debug

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

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False