@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 3.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Single item in List or Get Consumer group 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 ConsumerGroup extends pulumi.CustomResource {
/**
* Get an existing ConsumerGroup 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): ConsumerGroup;
/**
* Returns true if the given object is an instance of ConsumerGroup. 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 ConsumerGroup;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Exact time the message was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* 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>;
/**
* User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.
*/
readonly userMetadata: pulumi.Output<string | undefined>;
/**
* Create a ConsumerGroup 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: ConsumerGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ConsumerGroup resource.
*/
export interface ConsumerGroupArgs {
/**
* The consumer group name
*/
consumerGroupName?: pulumi.Input<string>;
/**
* 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>;
/**
* User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.
*/
userMetadata?: pulumi.Input<string>;
}