# Aspire.Hosting.Azure.WebPubSub

- Module: `Aspire.Hosting.Azure.WebPubSub`
- Version: `13.2.0`
- Source: [GitHub](https://github.com/microsoft/aspire)
- Functions: `34`
- Types: `13`

## Types

- [AzureBicepResource](/reference/api/typescript/aspire.hosting.azure.webpubsub/azurebicepresource.md) -- `handle` - 9 members
- [AzureEnvironmentResource](/reference/api/typescript/aspire.hosting.azure.webpubsub/azureenvironmentresource.md) -- `handle` - 2 members
- [AzureProvisioningResource](/reference/api/typescript/aspire.hosting.azure.webpubsub/azureprovisioningresource.md) -- `handle` - 1 members
- [AzureResourceInfrastructure](/reference/api/typescript/aspire.hosting.azure.webpubsub/azureresourceinfrastructure.md) -- `handle` - 3 members
- [AzureUserAssignedIdentityResource](/reference/api/typescript/aspire.hosting.azure.webpubsub/azureuserassignedidentityresource.md) -- `handle` - 0 members
- [AzureWebPubSubHubResource](/reference/api/typescript/aspire.hosting.azure.webpubsub/azurewebpubsubhubresource.md) -- `handle` - 1 members
- [AzureWebPubSubResource](/reference/api/typescript/aspire.hosting.azure.webpubsub/azurewebpubsubresource.md) -- `handle` - 1 members
- [BicepOutputReference](/reference/api/typescript/aspire.hosting.azure.webpubsub/bicepoutputreference.md) -- `handle` - 3 members
- [IAzureKeyVaultResource](/reference/api/typescript/aspire.hosting.azure.webpubsub/iazurekeyvaultresource.md) -- `interface` - 0 members
- [IAzureKeyVaultSecretReference](/reference/api/typescript/aspire.hosting.azure.webpubsub/iazurekeyvaultsecretreference.md) -- `interface` - 0 members
- [IAzureResource](/reference/api/typescript/aspire.hosting.azure.webpubsub/iazureresource.md) -- `interface` - 9 members

## Functions

- [addAzureEnvironment](/reference/api/typescript/aspire.hosting.azure.webpubsub/addazureenvironment.md) -- `method` -- Adds the shared Azure environment resource to the application model
- [addAzureInfrastructure](/reference/api/typescript/aspire.hosting.azure.webpubsub/addazureinfrastructure.md) -- `method` -- Adds an Azure provisioning resource to the application model
- [addAzureProvisioning](/reference/api/typescript/aspire.hosting.azure.webpubsub/addazureprovisioning.md) -- `method` -- Adds Azure provisioning services to the distributed application builder
- [addAzureUserAssignedIdentity](/reference/api/typescript/aspire.hosting.azure.webpubsub/addazureuserassignedidentity.md) -- `method` -- Adds an Azure user-assigned identity resource
- [addAzureWebPubSub](/reference/api/typescript/aspire.hosting.azure.webpubsub/addazurewebpubsub.md) -- `method` -- Adds an Azure Web PubSub resource to the distributed application model.
- [addBicepTemplate](/reference/api/typescript/aspire.hosting.azure.webpubsub/addbiceptemplate.md) -- `method` -- Adds an Azure Bicep template resource from a file
- [addBicepTemplateString](/reference/api/typescript/aspire.hosting.azure.webpubsub/addbiceptemplatestring.md) -- `method` -- Adds an Azure Bicep template resource from inline Bicep content
- [addEventHandler](/reference/api/typescript/aspire.hosting.azure.webpubsub/addeventhandler.md) -- `method` -- Adds an event handler to an Azure Web PubSub hub.
- [addHub](/reference/api/typescript/aspire.hosting.azure.webpubsub/addhub.md) -- `method` -- Adds a hub to the Azure Web PubSub resource.
- [asExisting](/reference/api/typescript/aspire.hosting.azure.webpubsub/asexisting.md) -- `method` -- Marks an Azure resource as existing in both run and publish modes by using parameter resources
- [clearDefaultRoleAssignments](/reference/api/typescript/aspire.hosting.azure.webpubsub/cleardefaultroleassignments.md) -- `method` -- Clears the default Azure role assignments from a resource
- [configureInfrastructure](/reference/api/typescript/aspire.hosting.azure.webpubsub/configureinfrastructure.md) -- `method` -- Configures the Azure provisioning infrastructure callback
- [getBicepIdentifier](/reference/api/typescript/aspire.hosting.azure.webpubsub/getbicepidentifier.md) -- `method` -- Gets the normalized Bicep identifier for an Azure resource
- [getOutput](/reference/api/typescript/aspire.hosting.azure.webpubsub/getoutput.md) -- `method` -- Gets an output reference from an Azure Bicep template resource
- [isExisting](/reference/api/typescript/aspire.hosting.azure.webpubsub/isexisting.md) -- `method` -- Determines whether a resource is marked as existing
- [publishAsConnectionString](/reference/api/typescript/aspire.hosting.azure.webpubsub/publishasconnectionstring.md) -- `method` -- Publishes an Azure resource to the manifest as a connection string
- [publishAsExisting](/reference/api/typescript/aspire.hosting.azure.webpubsub/publishasexisting.md) -- `method` -- Marks an Azure resource as existing in publish mode
- [publishAsExistingFromParameters](/reference/api/typescript/aspire.hosting.azure.webpubsub/publishasexistingfromparameters.md) -- `method` -- Marks an Azure resource as existing in publish mode by using parameter resources
- [runAsExisting](/reference/api/typescript/aspire.hosting.azure.webpubsub/runasexisting.md) -- `method` -- Marks an Azure resource as existing in run mode
- [runAsExistingFromParameters](/reference/api/typescript/aspire.hosting.azure.webpubsub/runasexistingfromparameters.md) -- `method` -- Marks an Azure resource as existing in run mode by using parameter resources
- [withAzureUserAssignedIdentity](/reference/api/typescript/aspire.hosting.azure.webpubsub/withazureuserassignedidentity.md) -- `method` -- Associates an Azure user-assigned identity with a compute resource
- [withEnvironmentFromKeyVaultSecret](/reference/api/typescript/aspire.hosting.azure.webpubsub/withenvironmentfromkeyvaultsecret.md) -- `method` -- Sets an environment variable from an Azure Key Vault secret reference
- [withEnvironmentFromOutput](/reference/api/typescript/aspire.hosting.azure.webpubsub/withenvironmentfromoutput.md) -- `method` -- Sets an environment variable from a Bicep output reference
- [withLocation](/reference/api/typescript/aspire.hosting.azure.webpubsub/withlocation.md) -- `method` -- Sets the Azure location for the shared Azure environment resource
- [withParameter](/reference/api/typescript/aspire.hosting.azure.webpubsub/withparameter.md) -- `method` -- Adds a Bicep parameter without a value
- [withParameterFromConnectionString](/reference/api/typescript/aspire.hosting.azure.webpubsub/withparameterfromconnectionstring.md) -- `method` -- Adds a Bicep parameter from a connection string resource builder
- [withParameterFromEndpoint](/reference/api/typescript/aspire.hosting.azure.webpubsub/withparameterfromendpoint.md) -- `method` -- Adds a Bicep parameter from an endpoint reference
- [withParameterFromOutput](/reference/api/typescript/aspire.hosting.azure.webpubsub/withparameterfromoutput.md) -- `method` -- Adds a Bicep parameter from another Bicep output reference
- [withParameterFromParameter](/reference/api/typescript/aspire.hosting.azure.webpubsub/withparameterfromparameter.md) -- `method` -- Adds a Bicep parameter from a parameter resource builder
- [withParameterFromReferenceExpression](/reference/api/typescript/aspire.hosting.azure.webpubsub/withparameterfromreferenceexpression.md) -- `method` -- Adds a Bicep parameter from a reference expression
- [withParameterStringValue](/reference/api/typescript/aspire.hosting.azure.webpubsub/withparameterstringvalue.md) -- `method` -- Adds a Bicep parameter with a string value
- [withParameterStringValues](/reference/api/typescript/aspire.hosting.azure.webpubsub/withparameterstringvalues.md) -- `method` -- Adds a Bicep parameter with a string list value
- [withResourceGroup](/reference/api/typescript/aspire.hosting.azure.webpubsub/withresourcegroup.md) -- `method` -- Sets the Azure resource group for the shared Azure environment resource
- [withWebPubSubRoleAssignments](/reference/api/typescript/aspire.hosting.azure.webpubsub/withwebpubsubroleassignments.md) -- `method` -- Assigns Azure Web PubSub roles to a resource

## Enums

- [AzureWebPubSubRole](/reference/api/typescript/aspire.hosting.azure.webpubsub/azurewebpubsubrole.md) -- `enum` - 3 values
- [DeploymentScope](/reference/api/typescript/aspire.hosting.azure.webpubsub/deploymentscope.md) -- `enum` - 4 values