Aspire.Hosting.Azure.CosmosDB
Official
📦 Aspire.Hosting.Azure.CosmosDB v13.2.0-preview.1.26159.1 50 Functions
17 Types
17 types and 44 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
function
addAzureCosmosDB builder Adds an Azure Cosmos DB resource
addAzureCosmosDB(name: string): AzureCosmosDBResource function
addAzureEnvironment builder Adds the shared Azure environment resource to the application model
addAzureEnvironment(): AzureEnvironmentResource function
addAzureInfrastructure builder Adds an Azure provisioning resource to the application model
addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => void): AzureProvisioningResource function
addAzureKeyVault builder Adds an Azure Key Vault resource
addAzureKeyVault(name: string): AzureKeyVaultResource function
addAzureProvisioning Adds Azure provisioning services to the distributed application builder
addAzureProvisioning(): IDistributedApplicationBuilder function
addAzureUserAssignedIdentity builder Adds an Azure user-assigned identity resource
addAzureUserAssignedIdentity(name: string): AzureUserAssignedIdentityResource function
addBicepTemplate builder Adds an Azure Bicep template resource from a file
addBicepTemplate(name: string, bicepFile: string): AzureBicepResource function
addBicepTemplateString builder Adds an Azure Bicep template resource from inline Bicep content
addBicepTemplateString(name: string, bicepContent: string): AzureBicepResource function
addContainer builder Adds an Azure Cosmos DB container resource
addContainer(name: string, partitionKeyPath: string, containerName?: string): AzureCosmosDBContainerResource function
addContainerWithPartitionKeyPaths builder Adds an Azure Cosmos DB container resource with hierarchical partition keys
addContainerWithPartitionKeyPaths(name: string, partitionKeyPaths: string[], containerName?: string): AzureCosmosDBContainerResource function
addCosmosDatabase builder Adds an Azure Cosmos DB database resource
addCosmosDatabase(name: string, databaseName?: string): AzureCosmosDBDatabaseResource function
addSecret builder Adds a secret to the Azure Key Vault from a parameter resource
addSecret(name: string, parameterResource: ParameterResource): AzureKeyVaultSecretResource function
addSecretFromExpression builder Adds a secret to the Azure Key Vault from a reference expression
addSecretFromExpression(name: string, value: ReferenceExpression): AzureKeyVaultSecretResource function
addSecretWithName builder Adds a named secret to the Azure Key Vault from a parameter resource
addSecretWithName(name: string, secretName: string, parameterResource: ParameterResource): AzureKeyVaultSecretResource function
addSecretWithNameFromExpression builder Adds a named secret to the Azure Key Vault from a reference expression
addSecretWithNameFromExpression(name: string, secretName: string, value: ReferenceExpression): AzureKeyVaultSecretResource function
asExisting builder Marks an Azure resource as existing in both run and publish modes
asExisting(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
clearDefaultRoleAssignments builder Clears the default Azure role assignments from a resource
clearDefaultRoleAssignments(): IAzureResource function
configureInfrastructure builder Configures the Azure provisioning infrastructure callback
configureInfrastructure(configure: (obj: AzureResourceInfrastructure) => void): AzureProvisioningResource function
getBicepIdentifier Gets the normalized Bicep identifier for an Azure resource
getBicepIdentifier(): string function
getOutput Gets an output reference from an Azure Bicep template resource
getOutput(name: string): BicepOutputReference function
getSecret Gets a secret reference from the Azure Key Vault
getSecret(secretName: string): IAzureKeyVaultSecretReference function
isExisting Determines whether a resource is marked as existing
isExisting(): boolean function
publishAsConnectionString builder Publishes an Azure resource to the manifest as a connection string
publishAsConnectionString(): IAzureResource function
publishAsExisting builder Marks an Azure resource as existing in publish mode
publishAsExisting(name: string, resourceGroup: string): IAzureResource function
publishAsExistingFromParameters builder Marks an Azure resource as existing in publish mode by using parameter resources
publishAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
runAsEmulator builder Configures the Azure Cosmos DB resource to run using the local emulator
runAsEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => void): AzureCosmosDBResource function
runAsExisting builder Marks an Azure resource as existing in run mode
runAsExisting(name: string, resourceGroup: string): IAzureResource function
runAsExistingFromParameters builder Marks an Azure resource as existing in run mode by using parameter resources
runAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
runAsPreviewEmulator builder Configures the Azure Cosmos DB resource to run using the preview emulator
runAsPreviewEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => void): AzureCosmosDBResource function
withAccessKeyAuthentication builder Configures Azure Cosmos DB to use access key authentication
withAccessKeyAuthentication(): AzureCosmosDBResource function
withAccessKeyAuthenticationWithKeyVault builder Configures Azure Cosmos DB access key authentication using a specified Azure Key Vault resource
withAccessKeyAuthenticationWithKeyVault(keyVaultBuilder: IAzureKeyVaultResource): AzureCosmosDBResource function
withAzureUserAssignedIdentity builder Associates an Azure user-assigned identity with a compute resource
withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource function
withDataExplorer builder Exposes the Data Explorer endpoint for the preview emulator
withDataExplorer(port?: number): AzureCosmosDBEmulatorResource function
withDataVolume builder Adds a named volume for the data folder to an Azure Cosmos DB emulator resource
withDataVolume(name?: string): AzureCosmosDBEmulatorResource function
withDefaultAzureSku builder Configures Azure Cosmos DB to use the default Azure SKU
withDefaultAzureSku(): AzureCosmosDBResource function
withEnvironmentFromKeyVaultSecret builder Sets an environment variable from an Azure Key Vault secret reference
withEnvironmentFromKeyVaultSecret(name: string, secretReference: IAzureKeyVaultSecretReference): IResourceWithEnvironment function
withEnvironmentFromOutput builder Sets an environment variable from a Bicep output reference
withEnvironmentFromOutput(name: string, bicepOutputReference: BicepOutputReference): IResourceWithEnvironment function
withGatewayPort builder Sets the host port for the Cosmos DB emulator gateway endpoint
withGatewayPort(port: number): AzureCosmosDBEmulatorResource function
withKeyVaultRoleAssignments builder Assigns Key Vault roles to a resource
withKeyVaultRoleAssignments(target: AzureKeyVaultResource, roles: AzureKeyVaultRole[]): IResource function
withLocation builder Sets the Azure location for the shared Azure environment resource
withLocation(location: ParameterResource): AzureEnvironmentResource function
withParameter builder Adds a Bicep parameter without a value
withParameter(name: string): AzureBicepResource function
withParameterFromConnectionString builder Adds a Bicep parameter from a connection string resource builder
withParameterFromConnectionString(name: string, value: IResourceWithConnectionString): AzureBicepResource function
withParameterFromEndpoint builder Adds a Bicep parameter from an endpoint reference
withParameterFromEndpoint(name: string, value: EndpointReference): AzureBicepResource function
withParameterFromOutput builder Adds a Bicep parameter from another Bicep output reference
withParameterFromOutput(name: string, value: BicepOutputReference): AzureBicepResource function
withParameterFromParameter builder Adds a Bicep parameter from a parameter resource builder
withParameterFromParameter(name: string, value: ParameterResource): AzureBicepResource function
withParameterFromReferenceExpression builder Adds a Bicep parameter from a reference expression
withParameterFromReferenceExpression(name: string, value: ReferenceExpression): AzureBicepResource function
withParameterStringValue builder Adds a Bicep parameter with a string value
withParameterStringValue(name: string, value: string): AzureBicepResource function
withParameterStringValues builder Adds a Bicep parameter with a string list value
withParameterStringValues(name: string, value: string[]): AzureBicepResource function
withPartitionCount builder Sets the partition count for the Azure Cosmos DB emulator
withPartitionCount(count: number): AzureCosmosDBEmulatorResource function
withResourceGroup builder Sets the Azure resource group for the shared Azure environment resource
withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource