@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets an Event Hubs description for the specified Event Hub.
*
* Uses Azure REST API version 2024-01-01.
*
* 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 function getEventHub(args: GetEventHubArgs, opts?: pulumi.InvokeOptions): Promise<GetEventHubResult>;
export interface GetEventHubArgs {
/**
* The Event Hub name
*/
eventHubName: string;
/**
* The Namespace name
*/
namespaceName: string;
/**
* Name of the resource group within the azure subscription.
*/
resourceGroupName: string;
}
/**
* Single item in List or Get Event Hub operation
*/
export interface GetEventHubResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Properties of capture description
*/
readonly captureDescription?: outputs.eventhub.CaptureDescriptionResponse;
/**
* Exact time the Event Hub was created.
*/
readonly createdAt: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* Number of days to retain the events for this Event Hub, value should be 1 to 7 days
*/
readonly messageRetentionInDays?: number;
/**
* The name of the resource
*/
readonly name: string;
/**
* Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.
*/
readonly partitionCount?: number;
/**
* Current number of shards on the Event Hub.
*/
readonly partitionIds: string[];
/**
* Event Hub retention settings
*/
readonly retentionDescription?: outputs.eventhub.RetentionDescriptionResponse;
/**
* Enumerates the possible values for the status of the Event Hub.
*/
readonly status?: string;
/**
* The system meta data relating to this resource.
*/
readonly systemData: outputs.eventhub.SystemDataResponse;
/**
* The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
*/
readonly type: string;
/**
* The exact time the message was updated.
*/
readonly updatedAt: string;
/**
* Gets and Sets Metadata of User.
*/
readonly userMetadata?: string;
}
/**
* Gets an Event Hubs description for the specified Event Hub.
*
* Uses Azure REST API version 2024-01-01.
*
* 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 function getEventHubOutput(args: GetEventHubOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetEventHubResult>;
export interface GetEventHubOutputArgs {
/**
* The Event Hub name
*/
eventHubName: pulumi.Input<string>;
/**
* The Namespace name
*/
namespaceName: pulumi.Input<string>;
/**
* Name of the resource group within the azure subscription.
*/
resourceGroupName: pulumi.Input<string>;
}