Aspire.Hosting.Azure.EventHubs
Official
📦 Aspire.Hosting.Azure.EventHubs v13.2.0 54 Functions
25 Types
25 types and 11 members
Types
handle
AzureBicepResource 9 members handle
AzureBlobStorageContainerResource handle
AzureBlobStorageResource handle
AzureDataLakeStorageFileSystemResource handle
AzureDataLakeStorageResource handle
AzureEnvironmentResource 2 members handle
AzureEventHubConsumerGroupResource handle
AzureEventHubResource 7 members handle
AzureEventHubsEmulatorResource 2 members handle
AzureEventHubsResource 2 members handle
AzureProvisioningResource 1 members handle
AzureQueueStorageQueueResource handle
AzureQueueStorageResource handle
AzureResourceInfrastructure 3 members handle
AzureStorageEmulatorResource 6 members handle
AzureStorageResource 8 members handle
AzureTableStorageResource handle
AzureUserAssignedIdentityResource handle
BicepOutputReference 3 members interface
IAzureKeyVaultResource interface
IAzureKeyVaultSecretReference interface
IAzureResource 9 members Functions
method
addAzureEnvironment builder Adds the shared Azure environment resource to the application model
addAzureEnvironment(): AzureEnvironmentResource method
addAzureEventHubs builder Adds an Azure Event Hubs namespace resource
addAzureEventHubs(name: string): AzureEventHubsResource method
addAzureInfrastructure builder Adds an Azure provisioning resource to the application model
addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => Promise<void>): AzureProvisioningResource method
addAzureProvisioning Adds Azure provisioning services to the distributed application builder
addAzureProvisioning(): IDistributedApplicationBuilder method
addAzureStorage builder Adds an Azure Storage resource
addAzureStorage(name: string): AzureStorageResource method
addAzureUserAssignedIdentity builder Adds an Azure user-assigned identity resource
addAzureUserAssignedIdentity(name: string): AzureUserAssignedIdentityResource method
addBicepTemplate builder Adds an Azure Bicep template resource from a file
addBicepTemplate(name: string, bicepFile: string): AzureBicepResource method
addBicepTemplateString builder Adds an Azure Bicep template resource from inline Bicep content
addBicepTemplateString(name: string, bicepContent: string): AzureBicepResource method
addBlobContainer builder Adds an Azure Blob Storage container resource
addBlobContainer(name: string, blobContainerName?: string): AzureBlobStorageContainerResource method
addBlobs builder Adds an Azure Blob Storage resource
addBlobs(name: string): AzureBlobStorageResource method
addConsumerGroup builder Adds an Azure Event Hub consumer group resource
addConsumerGroup(name: string, groupName?: string): AzureEventHubConsumerGroupResource method
addDataLake builder Adds an Azure Data Lake Storage resource
addDataLake(name: string): AzureDataLakeStorageResource method
addDataLakeFileSystem builder Adds an Azure Data Lake Storage file system resource
addDataLakeFileSystem(name: string, dataLakeFileSystemName?: string): AzureDataLakeStorageFileSystemResource method
addHub builder Adds an Azure Event Hub resource
addHub(name: string, hubName?: string): AzureEventHubResource method
addQueue builder Adds an Azure Storage queue resource
addQueue(name: string, queueName?: string): AzureQueueStorageQueueResource method
addQueues builder Adds an Azure Queue Storage resource
addQueues(name: string): AzureQueueStorageResource method
addTables builder Adds an Azure Table Storage resource
addTables(name: string): AzureTableStorageResource method
asExisting builder Marks an Azure resource as existing in both run and publish modes by using parameter resources
asExisting(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource method
clearDefaultRoleAssignments builder Clears the default Azure role assignments from a resource
clearDefaultRoleAssignments(): IAzureResource method
configureInfrastructure builder Configures the Azure provisioning infrastructure callback
configureInfrastructure(configure: (obj: AzureResourceInfrastructure) => Promise<void>): AzureProvisioningResource method
getBicepIdentifier Gets the normalized Bicep identifier for an Azure resource
getBicepIdentifier(): string method
getOutput Gets an output reference from an Azure Bicep template resource
getOutput(name: string): BicepOutputReference method
isExisting Determines whether a resource is marked as existing
isExisting(): boolean method
publishAsConnectionString builder Publishes an Azure resource to the manifest as a connection string
publishAsConnectionString(): IAzureResource method
publishAsExisting builder Marks an Azure resource as existing in publish mode
publishAsExisting(name: string, resourceGroup: string): IAzureResource method
publishAsExistingFromParameters builder Marks an Azure resource as existing in publish mode by using parameter resources
publishAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource method
runAsEmulator builder Configures the Azure Event Hubs resource to run with the local emulator
runAsEmulator(configureContainer?: (obj: AzureEventHubsEmulatorResource) => Promise<void>): AzureEventHubsResource method
runAsEmulator builder Configures the Azure Storage resource to be emulated using Azurite
runAsEmulator(configureContainer?: (obj: AzureStorageEmulatorResource) => Promise<void>): AzureStorageResource method
runAsExisting builder Marks an Azure resource as existing in run mode
runAsExisting(name: string, resourceGroup: string): IAzureResource method
runAsExistingFromParameters builder Marks an Azure resource as existing in run mode by using parameter resources
runAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource method
withApiVersionCheck builder Configures whether the emulator checks API version validity
withApiVersionCheck(enable?: boolean): AzureStorageEmulatorResource method
withAzureUserAssignedIdentity builder Associates an Azure user-assigned identity with a compute resource
withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource method
withBlobPort builder Sets the host port for blob requests on the storage emulator
withBlobPort(port: number): AzureStorageEmulatorResource method
withConfigurationFile builder Sets the emulator configuration file path
withConfigurationFile(path: string): AzureEventHubsEmulatorResource method
withDataBindMount builder Adds a bind mount for the data folder to an Azure Storage emulator resource
withDataBindMount(path?: string, isReadOnly?: boolean): AzureStorageEmulatorResource method
withDataVolume builder Adds a named volume for the data folder to an Azure Storage emulator resource
withDataVolume(name?: string, isReadOnly?: boolean): AzureStorageEmulatorResource method
withEnvironmentFromKeyVaultSecret builder Sets an environment variable from an Azure Key Vault secret reference
withEnvironmentFromKeyVaultSecret(name: string, secretReference: IAzureKeyVaultSecretReference): IResourceWithEnvironment method
withEnvironmentFromOutput builder Sets an environment variable from a Bicep output reference
withEnvironmentFromOutput(name: string, bicepOutputReference: BicepOutputReference): IResourceWithEnvironment method
withEventHubsRoleAssignments builder Assigns Event Hubs roles to a resource
withEventHubsRoleAssignments(target: AzureEventHubsResource, roles: AzureEventHubsRole[]): IResource method
withHostPort builder Sets the host port for the Event Hubs emulator endpoint
withHostPort(port: number): AzureEventHubsEmulatorResource method
withLocation builder Sets the Azure location for the shared Azure environment resource
withLocation(location: ParameterResource): AzureEnvironmentResource method
withParameter builder Adds a Bicep parameter without a value
withParameter(name: string): AzureBicepResource method
withParameterFromConnectionString builder Adds a Bicep parameter from a connection string resource builder
withParameterFromConnectionString(name: string, value: IResourceWithConnectionString): AzureBicepResource method
withParameterFromEndpoint builder Adds a Bicep parameter from an endpoint reference
withParameterFromEndpoint(name: string, value: EndpointReference): AzureBicepResource method
withParameterFromOutput builder Adds a Bicep parameter from another Bicep output reference
withParameterFromOutput(name: string, value: BicepOutputReference): AzureBicepResource method
withParameterFromParameter builder Adds a Bicep parameter from a parameter resource builder
withParameterFromParameter(name: string, value: ParameterResource): AzureBicepResource method
withParameterFromReferenceExpression builder Adds a Bicep parameter from a reference expression
withParameterFromReferenceExpression(name: string, value: ReferenceExpression): AzureBicepResource method
withParameterStringValue builder Adds a Bicep parameter with a string value
withParameterStringValue(name: string, value: string): AzureBicepResource method
withParameterStringValues builder Adds a Bicep parameter with a string list value
withParameterStringValues(name: string, value: string[]): AzureBicepResource method
withProperties builder Configures properties of an Azure Event Hub
withProperties(configure: (obj: AzureEventHubResource) => Promise<void>): AzureEventHubResource method
withQueuePort builder Sets the host port for queue requests on the storage emulator
withQueuePort(port: number): AzureStorageEmulatorResource method
withResourceGroup builder Sets the Azure resource group for the shared Azure environment resource
withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource method
withStorageRoleAssignments builder Assigns Azure Storage roles to a resource
withStorageRoleAssignments(target: AzureStorageResource, roles: AzureStorageRole[]): IResource method
withTablePort builder Sets the host port for table requests on the storage emulator
withTablePort(port: number): AzureStorageEmulatorResource