Watch Aspire live streamsDocsTry Aspire

EventHubsClusterProxy

Handle
📦 Aspire.Hosting.Azure.Provisioning.EventHubs v13.6.0-preview.1.26478.8
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

propertycreatedOnBicepValueProxy | datetimeoffsetget
Gets the CreatedOn provisioning property.
propertyidBicepValueProxyget
Gets the Id provisioning property.
propertylocationBicepValueProxyget · set
Gets or sets the Location provisioning property.
propertymetricIdBicepValueProxy | stringget
Gets the MetricId provisioning property.
propertynameBicepValueProxy | stringget · set
Gets or sets the Name provisioning property.
propertyprovisioningStateBicepValueProxy | EventHubsClusterProvisioningStateget
Gets the ProvisioningState provisioning property.
propertyskuEventHubsClusterSkuProxyget · set
Gets or sets the Sku provisioning property.
propertystatusBicepValueProxy | stringget
Gets the Status provisioning property.
propertysupportsScalingBicepValueProxy | booleanget · set
Gets or sets the SupportsScaling provisioning property.
propertysystemDataEventHubsSystemDataProxyget
Gets the SystemData provisioning property.
propertytagsAspire_Hosting_Azure_Provisioning_EventHubs_Generated_DictionaryOfStringProxyget · set
Gets or sets the Tags provisioning property.
propertyupdatedOnBicepValueProxy | datetimeoffsetget
Gets the UpdatedOn provisioning property.

Methods

methodaddTo
Adds this provisioning resource to the Azure resource infrastructure.
addTo(infrastructure: AzureResourceInfrastructure): void
infrastructureAzureResourceInfrastructure
Clears the Location provisioning property.
clearLocation(): void
methodclearName
Clears the Name provisioning property.
clearName(): void
Clears the SupportsScaling provisioning property.
clearSupportsScaling(): void
Invokes CreateRoleAssignment on the EventHubsCluster provisioning model.
createRoleAssignment(
role: EventHubsBuiltInRoleProxy,
principalType: BicepValueProxy | RoleManagementPrincipalType,
principalId: BicepValueProxy | guid,
bicepIdentifierSuffix: string): EventHubsRoleAssignmentProxy
roleEventHubsBuiltInRoleProxy
principalTypeBicepValueProxy | RoleManagementPrincipalType
principalIdBicepValueProxy | guid
bicepIdentifierSuffixstring
EventHubsRoleAssignmentProxy