# EventHubsClusterProxy

- Module: [Aspire.Hosting.Azure.Provisioning.EventHubs](/reference/api/typescript/aspire.hosting.azure.provisioning.eventhubs.md)
- Version: `13.6.0-preview.1.26478.8`
- Kind: `handle`
- Source: [GitHub](https://github.com/microsoft/aspire/tree/f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62)

Represents the EventHubsCluster Azure Provisioning model.

## Definition

```typescript
interface EventHubsClusterProxy {
  readonly createdOn: BicepValueProxy | datetimeoffset;
  readonly id: BicepValueProxy;
  location: BicepValueProxy;
  readonly metricId: BicepValueProxy | string;
  name: BicepValueProxy | string;
  readonly provisioningState: BicepValueProxy | EventHubsClusterProvisioningState;
  sku: EventHubsClusterSkuProxy;
  readonly status: BicepValueProxy | string;
  supportsScaling: BicepValueProxy | boolean;
  readonly systemData: EventHubsSystemDataProxy;
  tags: Aspire_Hosting_Azure_Provisioning_EventHubs_Generated_DictionaryOfStringProxy;
  readonly updatedOn: BicepValueProxy | datetimeoffset;
  addTo(infrastructure: AzureResourceInfrastructure): void;
  clearLocation(): void;
  clearName(): void;
  clearSupportsScaling(): void;
  createRoleAssignment(
      role: EventHubsBuiltInRoleProxy,
      principalType: BicepValueProxy | RoleManagementPrincipalType,
      principalId: BicepValueProxy | guid,
      bicepIdentifierSuffix: string): EventHubsRoleAssignmentProxy;
}
```

## Properties

- `createdOn`: `BicepValueProxy | datetimeoffset` `get` -- Gets the CreatedOn provisioning property.
- `id`: `BicepValueProxy` `get` -- Gets the Id provisioning property.
- `location`: `BicepValueProxy` `get - set` -- Gets or sets the Location provisioning property.
- `metricId`: `BicepValueProxy | string` `get` -- Gets the MetricId provisioning property.
- `name`: `BicepValueProxy | string` `get - set` -- Gets or sets the Name provisioning property.
- `provisioningState`: `BicepValueProxy | EventHubsClusterProvisioningState` `get` -- Gets the ProvisioningState provisioning property.
- `sku`: [EventHubsClusterSkuProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.eventhubs/eventhubsclusterskuproxy.md) `get - set` -- Gets or sets the Sku provisioning property.
- `status`: `BicepValueProxy | string` `get` -- Gets the Status provisioning property.
- `supportsScaling`: `BicepValueProxy | boolean` `get - set` -- Gets or sets the SupportsScaling provisioning property.
- `systemData`: [EventHubsSystemDataProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.eventhubs/eventhubssystemdataproxy.md) `get` -- Gets the SystemData provisioning property.
- `tags`: [Aspire_Hosting_Azure_Provisioning_EventHubs_Generated_DictionaryOfStringProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.eventhubs/aspire-hosting-azure-provisioning-eventhubs-generated-dictionaryofstringproxy.md) `get - set` -- Gets or sets the Tags provisioning property.
- `updatedOn`: `BicepValueProxy | datetimeoffset` `get` -- Gets the UpdatedOn provisioning property.

## Methods

- [addTo](/reference/api/typescript/aspire.hosting.azure.provisioning.eventhubs/eventhubsclusterproxy/addto.md) -- `method` -- Adds this provisioning resource to the Azure resource infrastructure.
    ```typescript
  addTo(infrastructure: AzureResourceInfrastructure): void
  ```
- [clearLocation](/reference/api/typescript/aspire.hosting.azure.provisioning.eventhubs/eventhubsclusterproxy/clearlocation.md) -- `method` -- Clears the Location provisioning property.
    ```typescript
  clearLocation(): void
  ```
- [clearName](/reference/api/typescript/aspire.hosting.azure.provisioning.eventhubs/eventhubsclusterproxy/clearname.md) -- `method` -- Clears the Name provisioning property.
    ```typescript
  clearName(): void
  ```
- [clearSupportsScaling](/reference/api/typescript/aspire.hosting.azure.provisioning.eventhubs/eventhubsclusterproxy/clearsupportsscaling.md) -- `method` -- Clears the SupportsScaling provisioning property.
    ```typescript
  clearSupportsScaling(): void
  ```
- [createRoleAssignment](/reference/api/typescript/aspire.hosting.azure.provisioning.eventhubs/eventhubsclusterproxy/createroleassignment.md) -- `method` -- Invokes CreateRoleAssignment on the EventHubsCluster provisioning model.
    ```typescript
  createRoleAssignment(role: EventHubsBuiltInRoleProxy, principalType: BicepValueProxy | RoleManagementPrincipalType, principalId: BicepValueProxy | guid, bicepIdentifierSuffix: string): EventHubsRoleAssignmentProxy
  ```