Set-AzEventHub
Actualiza una entidad de EventHub
Sintaxis
Set-AzEventHub
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-CaptureEnabled]
[-Encoding <String>]
[-IntervalInSeconds <Int32>]
[-SizeLimitInBytes <Int32>]
[-SkipEmptyArchive]
[-RetentionTimeInHour <Int64>]
[-TombstoneRetentionTimeInHour <Int32>]
[-Status <String>]
[-DestinationName <String>]
[-IdentityType <String>]
[-UserAssignedIdentityId <String>]
[-PartitionCount <Int64>]
[-StorageAccountResourceId <String>]
[-ArchiveNameFormat <String>]
[-BlobContainer <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzEventHub
-InputObject <IEventHubIdentity>
[-CaptureEnabled]
[-Encoding <String>]
[-IntervalInSeconds <Int32>]
[-SizeLimitInBytes <Int32>]
[-SkipEmptyArchive]
[-RetentionTimeInHour <Int64>]
[-TombstoneRetentionTimeInHour <Int32>]
[-Status <String>]
[-DestinationName <String>]
[-IdentityType <String>]
[-UserAssignedIdentityId <String>]
[-PartitionCount <Int64>]
[-StorageAccountResourceId <String>]
[-ArchiveNameFormat <String>]
[-BlobContainer <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Actualiza una entidad de EventHub
Ejemplos
Ejemplo 1: Establecimiento de la captura en una entidad de EventHub existente
Set-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -ArchiveNameFormat "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" -BlobContainer container -CaptureEnabled -DestinationName EventHubArchive.AzureBlockBlob -Encoding Avro -IntervalInSeconds 600 -SizeLimitInBytes 11000000 -SkipEmptyArchive -StorageAccountResourceId "/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"
ArchiveNameFormat : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}
BlobContainer : container
CaptureEnabled : True
CleanupPolicy : Delete
CreatedAt : 1/1/0001 12:00:00 AM
DataLakeAccountName :
DataLakeFolderPath :
DataLakeSubscriptionId :
DestinationName : EventHubArchive.AzureBlockBlob
Encoding : Avro
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/namespace3/eventhubs/myEventHub
IntervalInSeconds : 600
Location : eastus
MessageRetentionInDay : 7
Name : myEventHub
PartitionCount : 5
PartitionId : {}
ResourceGroupName : myResourceGroup
RetentionTimeInHour : 168
SizeLimitInBytes : 11000000
SkipEmptyArchive : True
Status : Active
StorageAccountResourceId : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt : 1/1/0001 12:00:00 AM
Actualiza la entidad myEventHub
eventHub del espacio de nombres myNamespace
para habilitar la captura en él.
Ejemplo 2: Actualización de la entidad EventHub de EventHub mediante el conjunto de parámetros InputObject
$eventhub = Get-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace
Set-AzEventHub -InputObject $eventhub -RetentionTimeInHour 72
ArchiveNameFormat : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}
BlobContainer : container1entHub]>
CaptureEnabled : True
CleanupPolicy : Delete
CreatedAt : 1/1/0001 12:00:00 AM
DataLakeAccountName :
DataLakeFolderPath :
DataLakeSubscriptionId :
DestinationName : EventHubArchive.AzureBlockBlob
Encoding : Avro
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds : 600
Location : eastus
MessageRetentionInDay : 3
Name : myEventHub
PartitionCount : 5
PartitionId : {}
ResourceGroupName : myResourceGroup
RetentionTimeInHour : 72
SizeLimitInBytes : 11000000
SkipEmptyArchive : True
Status : Active
StorageAccountResourceId : /subscriptions/subscriptionId/resourceGroups/myResourcegroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount
1
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt : 1/1/0001 12:00:00 AM
Actualiza RetentionTimeInHour
la entidad myEventHub
de EventHub a 72 horas.
Parámetros
-ArchiveNameFormat
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.
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-AsJob
Ejecución del comando como trabajo
Tipo: | SwitchParameter |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-BlobContainer
Nombre del contenedor de blobs
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-CaptureEnabled
Valor que indica si la descripción de captura está habilitada.
Tipo: | SwitchParameter |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-Confirm
Le solicita su confirmación antes de ejecutar el cmdlet.
Tipo: | SwitchParameter |
Alias: | cf |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-DefaultProfile
Credenciales, cuenta, inquilino y suscripción usados para la comunicación con Azure.
Tipo: | PSObject |
Alias: | AzureRMContext, AzureCredential |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-DestinationName
Nombre del destino de captura
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-Encoding
Enumera los valores posibles para el formato de codificación de la descripción de captura. Nota: "AvroDeflate" quedará en desuso en la nueva versión de LA API
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-IdentityType
Tipo de identidad de servicio administrada.
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-InputObject
Parámetro de identidad. Para construir, vea la sección NOTES para las propiedades INPUTOBJECT y crear una tabla hash.
Tipo: | IEventHubIdentity |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | True |
Aceptar entrada de canalización: | True |
Aceptar caracteres comodín: | False |
-IntervalInSeconds
El período de tiempo le 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.
Tipo: | Int32 |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-Name
Nombre de la entidad de EventHub.
Tipo: | String |
Alias: | EventHubName |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | True |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-NamespaceName
Nombre del espacio de nombres de EventHub.
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | True |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-NoWait
Ejecutar el comando de forma asincrónica
Tipo: | SwitchParameter |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-PartitionCount
Número de particiones creadas para el centro de eventos. los valores permitidos son de 1 a 32 particiones.
Tipo: | Int64 |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-ResourceGroupName
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | True |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-RetentionTimeInHour
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.
Tipo: | Int64 |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-SizeLimitInBytes
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.
Tipo: | Int32 |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-SkipEmptyArchive
Valor que indica si se omitirán los archivos vacíos.
Tipo: | SwitchParameter |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-Status
Enumera los valores posibles para el estado del centro de eventos.
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-StorageAccountResourceId
Identificador de recurso de la cuenta de almacenamiento que se va a usar para crear los blobs
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-SubscriptionId
Identificador de la suscripción de destino.
Tipo: | String |
Posición: | Named |
Valor predeterminado: | (Get-AzContext).Subscription.Id |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-TombstoneRetentionTimeInHour
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.
Tipo: | Int32 |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-UserAssignedIdentityId
Propiedades de identidades asignadas por el usuario
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-WhatIf
Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.
Tipo: | SwitchParameter |
Alias: | wi |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |