# RabbitMQServerResource

- Module: [Aspire.Hosting.RabbitMQ](/reference/api/typescript/aspire.hosting.rabbitmq.md)
- Version: `13.4.0`
- Kind: `handle`
- Source: [GitHub](https://github.com/microsoft/aspire)

A resource that represents a RabbitMQ resource.

## Definition

```typescript
interface RabbitMQServerResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly host: EndpointReferenceExpression;
  readonly managementEndpoint: EndpointReference;
  readonly passwordParameter: ParameterResource;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly uriExpression: ReferenceExpression;
  readonly userNameParameter: ParameterResource;
  readonly userNameReference: ReferenceExpression;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): RabbitMQServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): RabbitMQServerResource;
  withManagementPlugin(port?: number): RabbitMQServerResource;
}
```

## Properties

- `connectionStringExpression`: `ReferenceExpression` `get` -- Gets the connection string expression for the RabbitMQ server.
- `host`: `EndpointReferenceExpression` `get` -- Gets the host endpoint reference for this resource.
- `managementEndpoint`: `EndpointReference` `get` -- Gets the management endpoint for the RabbitMQ server.
- `passwordParameter`: `ParameterResource` `get` -- Gets the parameter that contains the RabbitMQ server password.
- `port`: `EndpointReferenceExpression` `get` -- Gets the port endpoint reference for this resource.
- `primaryEndpoint`: `EndpointReference` `get` -- Gets the primary endpoint for the RabbitMQ server.
- `uriExpression`: `ReferenceExpression` `get` -- Gets the connection URI expression for the RabbitMQ server.
- `userNameParameter`: `ParameterResource` `get` -- Gets the parameter that contains the RabbitMQ server user name.
- `userNameReference`: `ReferenceExpression` `get` -- Gets a reference to the user name for the RabbitMQ server.

## Methods

- [withDataBindMount](/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/withdatabindmount.md) -- `method` -- Adds a bind mount for the data folder to a RabbitMQ container resource.
    ```typescript
  withDataBindMount(source: string, isReadOnly?: boolean): RabbitMQServerResource
  ```
- [withDataVolume](/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/withdatavolume.md) -- `method` -- Adds a named volume for the data folder to a RabbitMQ container resource.
    ```typescript
  withDataVolume(name?: string, isReadOnly?: boolean): RabbitMQServerResource
  ```
- [withManagementPlugin](/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/withmanagementplugin.md) -- `method` -- Enables the RabbitMQ management plugin
    ```typescript
  withManagementPlugin(port?: number): RabbitMQServerResource
  ```