@pulumi/azure-native/eventhub/eventHub.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
 * Single item in List or Get Event Hub operation
 *
 * Uses Azure REST API version 2024-01-01. In version 2.x of the Azure Native provider, it used API version 2022-10-01-preview.
 *
 * Other available API versions: 2018-01-01-preview, 2021-01-01-preview, 2021-06-01-preview, 2021-11-01, 2022-01-01-preview, 2022-10-01-preview, 2023-01-01-preview, 2024-05-01-preview, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native eventhub [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
 */
export declare class EventHub extends pulumi.CustomResource {
    /**
     * Get an existing EventHub resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): EventHub;
    /**
     * Returns true if the given object is an instance of EventHub.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is EventHub;
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: pulumi.Output<string>;
    /**
     * Properties of capture description
     */
    readonly captureDescription: pulumi.Output<outputs.eventhub.CaptureDescriptionResponse | undefined>;
    /**
     * Exact time the Event Hub was created.
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * The geo-location where the resource lives
     */
    readonly location: pulumi.Output<string>;
    /**
     * Number of days to retain the events for this Event Hub, value should be 1 to 7 days
     */
    readonly messageRetentionInDays: pulumi.Output<number | undefined>;
    /**
     * The name of the resource
     */
    readonly name: pulumi.Output<string>;
    /**
     * Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.
     */
    readonly partitionCount: pulumi.Output<number | undefined>;
    /**
     * Current number of shards on the Event Hub.
     */
    readonly partitionIds: pulumi.Output<string[]>;
    /**
     * Event Hub retention settings
     */
    readonly retentionDescription: pulumi.Output<outputs.eventhub.RetentionDescriptionResponse | undefined>;
    /**
     * Enumerates the possible values for the status of the Event Hub.
     */
    readonly status: pulumi.Output<string | undefined>;
    /**
     * The system meta data relating to this resource.
     */
    readonly systemData: pulumi.Output<outputs.eventhub.SystemDataResponse>;
    /**
     * The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
     */
    readonly type: pulumi.Output<string>;
    /**
     * The exact time the message was updated.
     */
    readonly updatedAt: pulumi.Output<string>;
    /**
     * Gets and Sets Metadata of User.
     */
    readonly userMetadata: pulumi.Output<string | undefined>;
    /**
     * Create a EventHub resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: EventHubArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a EventHub resource.
 */
export interface EventHubArgs {
    /**
     * Properties of capture description
     */
    captureDescription?: pulumi.Input<inputs.eventhub.CaptureDescriptionArgs>;
    /**
     * The Event Hub name
     */
    eventHubName?: pulumi.Input<string>;
    /**
     * Number of days to retain the events for this Event Hub, value should be 1 to 7 days
     */
    messageRetentionInDays?: pulumi.Input<number>;
    /**
     * The Namespace name
     */
    namespaceName: pulumi.Input<string>;
    /**
     * Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.
     */
    partitionCount?: pulumi.Input<number>;
    /**
     * Name of the resource group within the azure subscription.
     */
    resourceGroupName: pulumi.Input<string>;
    /**
     * Event Hub retention settings
     */
    retentionDescription?: pulumi.Input<inputs.eventhub.RetentionDescriptionArgs>;
    /**
     * Enumerates the possible values for the status of the Event Hub.
     */
    status?: pulumi.Input<enums.eventhub.EntityStatus>;
    /**
     * Gets and Sets Metadata of User.
     */
    userMetadata?: pulumi.Input<string>;
}