az eventhubs eventhub

Administración del centro de eventos y la regla de autorización de Azure EventHubs.

Comandos

Nombre	Description	Tipo	Estado
az eventhubs eventhub authorization-rule	Regla de autorización del centro de eventos.	Core	GA
az eventhubs eventhub authorization-rule create	Cree una authorizationRule para el centro de eventos especificado. La creación o actualización de AuthorizationRule tardará unos segundos en surtir efecto.	Core	GA
az eventhubs eventhub authorization-rule delete	Elimine una authorizationRule del centro de eventos.	Core	GA
az eventhubs eventhub authorization-rule keys	Claves de regla de autorización.	Core	GA
az eventhubs eventhub authorization-rule keys list	Obtiene las cadenas de conexión de ACS y SAS para el centro de eventos.	Core	GA
az eventhubs eventhub authorization-rule keys renew	Regenera las cadenas de conexión de ACS y SAS para el centro de eventos.	Core	GA
az eventhubs eventhub authorization-rule list	Enumera las reglas de autorización de un centro de eventos.	Core	GA
az eventhubs eventhub authorization-rule show	Obtenga una authorizationRule para un centro de eventos por nombre de regla.	Core	GA
az eventhubs eventhub authorization-rule update	Actualice authorizationRule para el centro de eventos especificado. La creación o actualización de AuthorizationRule tardará unos segundos en surtir efecto.	Core	GA
az eventhubs eventhub consumer-group	Administre el grupo de consumidores de Azure Event Hubs.	Core	GA
az eventhubs eventhub consumer-group create	Cree un grupo de consumidores de Event Hubs como un recurso anidado dentro de un espacio de nombres.	Core	GA
az eventhubs eventhub consumer-group delete	Elimine un grupo de consumidores del centro de eventos y el grupo de recursos especificados.	Core	GA
az eventhubs eventhub consumer-group list	Enumere todos los grupos de consumidores de un espacio de nombres. Se devuelve una fuente vacía si no existe ningún grupo de consumidores en el espacio de nombres.	Core	GA
az eventhubs eventhub consumer-group show	Obtenga una descripción para el grupo de consumidores especificado.	Core	GA
az eventhubs eventhub consumer-group update	Actualice un grupo de consumidores de Event Hubs como un recurso anidado dentro de un espacio de nombres.	Core	GA
az eventhubs eventhub create	Crea el centro de eventos EventHubs.	Core	GA
az eventhubs eventhub delete	Elimine un centro de eventos del espacio de nombres y el grupo de recursos especificados.	Core	GA
az eventhubs eventhub list	Enumere todos los Centros de eventos de un espacio de nombres.	Core	GA
az eventhubs eventhub show	Obtenga una descripción de Event Hubs para el centro de eventos especificado.	Core	GA
az eventhubs eventhub update	Actualice un nuevo centro de eventos como un recurso anidado dentro de un espacio de nombres.	Core	GA

az eventhubs eventhub create

Editar

Crea el centro de eventos EventHubs.

az eventhubs eventhub create --name
                             --namespace-name
                             --resource-group
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--cleanup-policy {Compact, Delete, DeleteOrCompact}]
                             [--destination-name]
                             [--enable-capture {false, true}]
                             [--mi-system-assigned {false, true}]
                             [--mi-user-assigned]
                             [--min-compaction-lag-in-mins --min-lag]
                             [--partition-count]
                             [--retention-time --retention-time-in-hours]
                             [--skip-empty-archives {false, true}]
                             [--status {Active, Disabled, SendDisabled}]
                             [--storage-account]
                             [--timestamp-type {Create, LogAppend}]
                             [--tombstone-retention-time-in-hours --tombstone-time]
                             [--user-metadata]

Ejemplos

Cree un centro de eventos.

az eventhubs eventhub create --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub --cleanup-policy Delete --partition-count 15

Parámetros requeridos

--name -n

Nombre del centro de eventos.

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

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--archive-name-format

Convención de nomenclatura de blobs para el archivo, por ejemplo, {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Aquí todos los parámetros (Espacio de nombres, EventHub, etc.) son obligatorios independientemente del orden.

Propiedad	Valor
Grupo de parámetros:	Capture-Destination Arguments

--blob-container

Nombre del contenedor de blobs.

Propiedad	Valor
Grupo de parámetros:	Capture-Destination Arguments

--capture-interval

Permite establecer la frecuencia con la que se producirá la captura en blobs de Azure, el valor debe estar comprendido entre 60 y 900 segundos.

Propiedad	Valor
Grupo de parámetros:	Capture Arguments

--capture-size-limit

Define la cantidad de datos integrados en el centro de eventos antes de una operación de captura, el valor debe estar entre 10485760 a 524288000 bytes.

Propiedad	Valor
Grupo de parámetros:	Capture Arguments

--cleanup-policy

Enumera los valores posibles para la directiva de limpieza.

Propiedad	Valor
Grupo de parámetros:	Retention-Description Arguments
Valores aceptados:	Compact, Delete, DeleteOrCompact

--destination-name

El nombre del destino de captura debe ser EventHubArchive.AzureBlockBlob.

Propiedad	Valor
Grupo de parámetros:	Capture-Destination Arguments

--enable-capture

Valor booleano que indica si la captura está habilitada.

Propiedad	Valor
Grupo de parámetros:	Capture Arguments
Valores aceptados:	false, true

--mi-system-assigned

Habilite la identidad asignada por el sistema.

Propiedad	Valor
Grupo de parámetros:	Capture-Destination Arguments
Valor predeterminado:	False
Valores aceptados:	false, true

--mi-user-assigned

Lista de identificadores de identidad asignadas por el usuario.

Propiedad	Valor
Grupo de parámetros:	Capture-Destination Arguments

--min-compaction-lag-in-mins --min-lag

El tiempo mínimo que un mensaje permanecerá inelegible para la compactación en el registro. Este valor se usa cuando cleanupPolicy es Compact o DeleteOrCompact.

Propiedad	Valor
Grupo de parámetros:	Retention-Description Arguments

--partition-count

Número de particiones creadas para el centro de eventos. De forma predeterminada, los valores permitidos son 2-32. El valor inferior de 1 se admite con espacios de nombres habilitados para Kafka. En presencia de una cuota personalizada, el límite superior coincidirá con el límite superior de la cuota.

--retention-time --retention-time-in-hours

Número de horas para conservar los eventos de este centro de eventos. Este valor solo se usa cuando cleanupPolicy es Delete. Si cleanupPolicy es Compaction, el valor devuelto de esta propiedad es Long.MaxValue.

Propiedad	Valor
Grupo de parámetros:	Retention-Description Arguments

--skip-empty-archives

Valor booleano que indica si se va a Omitir vacío.

Propiedad	Valor
Valores aceptados:	false, true

--status

Estado del centro de eventos.

Propiedad	Valor
Valores aceptados:	Active, Disabled, SendDisabled

--storage-account

Nombre (si está dentro del mismo grupo de recursos y no del tipo Almacenamiento clásico) o identificador de ARM de la cuenta de almacenamiento que se va a usar para crear los blobs.

Propiedad	Valor
Grupo de parámetros:	Capture-Destination Arguments

--timestamp-type

Indica el tipo de marca de tiempo que contendrá el mensaje.

Propiedad	Valor
Valores aceptados:	Create, LogAppend

--tombstone-retention-time-in-hours --tombstone-time

Número de horas para conservar los marcadores de lápiz de un centro de eventos compacto. Este valor solo se usa cuando cleanupPolicy es Compaction. El consumidor debe completar la lectura del marcador de lápiz dentro de esta cantidad de tiempo especificada si el consumidor comienza desde el desplazamiento inicial para asegurarse de que obtienen una instantánea válida para la clave específica descrita por el marcador de lápiz dentro del centro de eventos compactado.

Propiedad	Valor
Grupo de parámetros:	Retention-Description Arguments

--user-metadata

Obtiene y establece los metadatos del usuario.

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

Formato de salida.

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 eventhubs eventhub delete

Editar

Elimine un centro de eventos del espacio de nombres y el grupo de recursos especificados.

az eventhubs eventhub delete [--event-hub-name --name]
                             [--ids]
                             [--namespace-name]
                             [--resource-group]
                             [--subscription]

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--event-hub-name --name -n

Nombre del centro de eventos.

Propiedad	Valor
Grupo de parámetros:	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
Grupo de parámetros:	Resource Id Arguments

--namespace-name

Nombre del espacio de nombres.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--resource-group -g

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

Propiedad	Valor
Grupo de parámetros:	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
Grupo de parámetros:	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

Formato de salida.

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 eventhubs eventhub list

Editar

Enumere todos los Centros de eventos de un espacio de nombres.

az eventhubs eventhub list --namespace-name
                           --resource-group
                           [--max-items]
                           [--next-token]
                           [--skip]
                           [--top]

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

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--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
Grupo de parámetros:	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
Grupo de parámetros:	Pagination Arguments

--skip

Skip solo se usa si una operación anterior devolvió un resultado parcial. Si una respuesta anterior contiene un elemento nextLink, el valor del elemento nextLink incluirá un parámetro skip que especifica un punto de partida que se usará para las llamadas posteriores.

--top

Se puede usar para limitar el número de resultados a los N usageDetails más recientes.

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

Formato de salida.

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 eventhubs eventhub show

Editar

Obtenga una descripción de Event Hubs para el centro de eventos especificado.

az eventhubs eventhub show [--event-hub-name --name]
                           [--ids]
                           [--namespace-name]
                           [--resource-group]
                           [--subscription]

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--event-hub-name --name -n

Nombre del centro de eventos.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--namespace-name

Nombre del espacio de nombres.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--resource-group -g

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

Propiedad	Valor
Grupo de parámetros:	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
Grupo de parámetros:	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

Formato de salida.

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 eventhubs eventhub update

Editar

Actualice un nuevo centro de eventos como un recurso anidado dentro de un espacio de nombres.

az eventhubs eventhub update [--add]
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--cleanup-policy {Compact, Delete, DeleteOrCompact}]
                             [--destination-name]
                             [--enable-capture {0, 1, f, false, n, no, t, true, y, yes}]
                             [--encoding {Avro, AvroDeflate}]
                             [--event-hub-name --name]
                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                             [--identity]
                             [--ids]
                             [--min-compaction-lag-in-mins --min-lag]
                             [--namespace-name]
                             [--partition-count]
                             [--remove]
                             [--resource-group]
                             [--retention-time --retention-time-in-hours]
                             [--set]
                             [--skip-empty-archives {0, 1, f, false, n, no, t, true, y, yes}]
                             [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]
                             [--storage-account]
                             [--subscription]
                             [--timestamp-type {Create, LogAppend}]
                             [--tombstone-retention-time-in-hours]
                             [--user-metadata]

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--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
Grupo de parámetros:	Generic Update Arguments

--archive-name-format

Propiedad	Valor
Grupo de parámetros:	CaptureDescription Arguments

--blob-container

Nombre del contenedor de blobs.

Propiedad	Valor
Grupo de parámetros:	CaptureDescription Arguments

--capture-interval

El período de tiempo permite establecer la frecuencia con la que se producirá la captura en blobs de Azure, el valor debe estar comprendido entre 60 y 900 segundos.

Propiedad	Valor
Grupo de parámetros:	CaptureDescription Arguments

--capture-size-limit

La ventana de tamaño define la cantidad de datos integrados en el centro de eventos antes de una operación de captura, el valor debe estar entre 10485760 a 524288000 bytes.

Propiedad	Valor
Grupo de parámetros:	CaptureDescription Arguments

--cleanup-policy

Enumera los valores posibles para la directiva de limpieza.

Propiedad	Valor
Grupo de parámetros:	RetentionDescription Arguments
Valores aceptados:	Compact, Delete, DeleteOrCompact

--destination-name

Nombre del destino de captura.

Propiedad	Valor
Grupo de parámetros:	CaptureDescription Arguments

--enable-capture

Valor que indica si la descripción de captura está habilitada.

Propiedad	Valor
Grupo de parámetros:	CaptureDescription Arguments
Valores aceptados:	0, 1, f, false, n, no, t, true, y, yes

--encoding

Enumera los valores posibles para el formato de codificación de la descripción de captura. Nota: "AvroDeflate" quedará en desuso en nueva versión de LA API.

Propiedad	Valor
Grupo de parámetros:	CaptureDescription Arguments
Valores aceptados:	Avro, AvroDeflate

--event-hub-name --name -n

Nombre del centro de eventos.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--force-string

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

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valores aceptados:	0, 1, f, false, n, no, t, true, y, yes

--identity

Valor que indica si la descripción de captura está habilitada. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Destination Arguments

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--min-compaction-lag-in-mins --min-lag

El tiempo mínimo que un mensaje permanecerá inelegible para la compactación en el registro. Este valor se usa cuando cleanupPolicy es Compact o DeleteOrCompact.

Propiedad	Valor
Grupo de parámetros:	RetentionDescription Arguments

--namespace-name

Nombre del espacio de nombres.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--partition-count

Número de particiones creadas para el centro de eventos, los valores permitidos son de 1 a 32 particiones.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments

--resource-group -g

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

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--retention-time --retention-time-in-hours

Propiedad	Valor
Grupo de parámetros:	RetentionDescription 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
Grupo de parámetros:	Generic Update Arguments

--skip-empty-archives

Valor que indica si se va a omitir archivos vacíos.

Propiedad	Valor
Grupo de parámetros:	CaptureDescription Arguments
Valores aceptados:	0, 1, f, false, n, no, t, true, y, yes

--status

Enumera los valores posibles para el estado del centro de eventos.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments
Valores aceptados:	Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown

--storage-account

Identificador de recurso de la cuenta de almacenamiento que se va a usar para crear los blobs.

Propiedad	Valor
Grupo de parámetros:	CaptureDescription 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
Grupo de parámetros:	Resource Id Arguments

--timestamp-type

Indica el tipo de marca de tiempo que contendrá el mensaje. Dos tipos de tipos de marca de tiempo: "AppendTime" y "CreateTime". AppendTime hace referencia a la hora en la que se anexó el mensaje dentro del registro del agente. CreateTime hace referencia a la hora en la que se generó el mensaje en el lado de origen y los productores pueden establecer esta marca de tiempo al enviar el mensaje. El valor predeterminado es AppendTime. Si usa el protocolo AMQP, CreateTime es igual a AppendTime y su comportamiento sigue siendo el mismo.

Propiedad	Valor
Grupo de parámetros:	MessageTimestampDescription Arguments
Valores aceptados:	Create, LogAppend

--tombstone-retention-time-in-hours -t

Propiedad	Valor
Grupo de parámetros:	RetentionDescription Arguments

--user-metadata

Obtiene y establece los metadatos del usuario.

Propiedad	Valor
Grupo de parámetros:	Properties 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

Formato de salida.

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

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

az eventhubs eventhub

Comandos

az eventhubs eventhub create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az eventhubs eventhub delete

Parámetros opcionales

az eventhubs eventhub list

Parámetros requeridos

Parámetros opcionales

az eventhubs eventhub show

Parámetros opcionales

az eventhubs eventhub update

Parámetros opcionales

Comentarios