Aspire.Hosting.Azure.CosmosDB
Official
📦 Aspire.Hosting.Azure.CosmosDB v13.2.0 50 Functions
17 Types
17 types and 6 members
Types
handle
AzureBicepResource 9 members handle
AzureCosmosDBContainerResource handle
AzureCosmosDBDatabaseResource 2 members handle
AzureCosmosDBEmulatorResource 4 members handle
AzureCosmosDBResource 6 members handle
AzureEnvironmentResource 2 members handle
AzureKeyVaultResource 5 members handle
AzureKeyVaultSecretResource handle
AzureProvisioningResource 1 members handle
AzureResourceInfrastructure 3 members handle
AzureUserAssignedIdentityResource handle
BicepOutputReference 3 members interface
IAzureKeyVaultResource interface
IAzureKeyVaultSecretReference interface
IAzureResource 9 members Functions
method
addAzureCosmosDB builder Adds an Azure Cosmos DB resource
addAzureCosmosDB(name: string): AzureCosmosDBResource method
addAzureEnvironment builder Adds the shared Azure environment resource to the application model
addAzureEnvironment(): AzureEnvironmentResource method
addAzureInfrastructure builder Adds an Azure provisioning resource to the application model
addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => Promise<void>): AzureProvisioningResource method
addAzureKeyVault builder Adds an Azure Key Vault resource
addAzureKeyVault(name: string): AzureKeyVaultResource method
addAzureProvisioning Adds Azure provisioning services to the distributed application builder
addAzureProvisioning(): IDistributedApplicationBuilder 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
addContainer builder Adds an Azure Cosmos DB container resource
addContainer(name: string, partitionKeyPath: string, containerName?: string): AzureCosmosDBContainerResource method
addContainerWithPartitionKeyPaths builder Adds an Azure Cosmos DB container resource with hierarchical partition keys
addContainerWithPartitionKeyPaths(name: string, partitionKeyPaths: string[], containerName?: string): AzureCosmosDBContainerResource method
addCosmosDatabase builder Adds an Azure Cosmos DB database resource
addCosmosDatabase(name: string, databaseName?: string): AzureCosmosDBDatabaseResource method
addSecret builder Adds a secret to the Azure Key Vault from a parameter resource
addSecret(name: string, parameterResource: ParameterResource): AzureKeyVaultSecretResource method
addSecretFromExpression builder Adds a secret to the Azure Key Vault from a reference expression
addSecretFromExpression(name: string, value: ReferenceExpression): AzureKeyVaultSecretResource method
addSecretWithName builder Adds a named secret to the Azure Key Vault from a parameter resource
addSecretWithName(name: string, secretName: string, parameterResource: ParameterResource): AzureKeyVaultSecretResource method
addSecretWithNameFromExpression builder Adds a named secret to the Azure Key Vault from a reference expression
addSecretWithNameFromExpression(name: string, secretName: string, value: ReferenceExpression): AzureKeyVaultSecretResource 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
getSecret Gets a secret reference from the Azure Key Vault
getSecret(secretName: string): IAzureKeyVaultSecretReference 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 Cosmos DB resource to run using the local emulator
runAsEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => Promise<void>): AzureCosmosDBResource 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
runAsPreviewEmulator builder Configures the Azure Cosmos DB resource to run using the preview emulator
runAsPreviewEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => Promise<void>): AzureCosmosDBResource method
withAccessKeyAuthentication builder Configures Azure Cosmos DB to use access key authentication
withAccessKeyAuthentication(): AzureCosmosDBResource method
withAccessKeyAuthenticationWithKeyVault builder Configures Azure Cosmos DB access key authentication using a specified Azure Key Vault resource
withAccessKeyAuthenticationWithKeyVault(keyVaultBuilder: IAzureKeyVaultResource): AzureCosmosDBResource method
withAzureUserAssignedIdentity builder Associates an Azure user-assigned identity with a compute resource
withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource method
withDataExplorer builder Exposes the Data Explorer endpoint for the preview emulator
withDataExplorer(port?: number): AzureCosmosDBEmulatorResource method
withDataVolume builder Adds a named volume for the data folder to an Azure Cosmos DB emulator resource
withDataVolume(name?: string): AzureCosmosDBEmulatorResource method
withDefaultAzureSku builder Configures Azure Cosmos DB to use the default Azure SKU
withDefaultAzureSku(): AzureCosmosDBResource 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
withGatewayPort builder Sets the host port for the Cosmos DB emulator gateway endpoint
withGatewayPort(port: number): AzureCosmosDBEmulatorResource method
withKeyVaultRoleAssignments builder Assigns Key Vault roles to a resource
withKeyVaultRoleAssignments(target: AzureKeyVaultResource, roles: AzureKeyVaultRole[]): IResource 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
withPartitionCount builder Sets the partition count for the Azure Cosmos DB emulator
withPartitionCount(count: number): AzureCosmosDBEmulatorResource method
withResourceGroup builder Sets the Azure resource group for the shared Azure environment resource
withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource