Reference: applications.datastores/mongodatabases@2023-10-01-preview
Detailed reference documentation for applications.datastores/mongodatabases@2023-10-01-preview
Schema
Top-Level Resource
Properties
| Property | Type | Description |
|---|---|---|
| apiVersion | ‘2023-10-01-preview’ | The resource api version (ReadOnly, DeployTimeConstant) |
| id | string | The resource id (ReadOnly, DeployTimeConstant) |
| location | string | The geo-location where the resource lives |
| name | string | The resource name (Required, DeployTimeConstant, Identifier) |
| properties | MongoDatabaseProperties | MongoDatabase portable resource properties (Required) |
| systemData | SystemData | Metadata pertaining to creation and last modification of the resource. (ReadOnly) |
| tags | TrackedResourceTags | Resource tags. |
| type | ‘Applications.Datastores/mongoDatabases’ | The resource type (ReadOnly, DeployTimeConstant) |
MongoDatabaseProperties
Properties
| Property | Type | Description |
|---|---|---|
| application | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) |
| database | string | Database name of the target Mongo database |
| environment | string | Fully qualified resource ID for the environment that the portable resource is linked to (Required) |
| host | string | Host name of the target Mongo database |
| port | int | Port value of the target Mongo database |
| provisioningState | ‘Accepted’ | ‘Canceled’ |
| recipe | Recipe | The recipe used to automatically deploy underlying infrastructure for a portable resource |
| resourceProvisioning | ‘manual’ | ‘recipe’ |
| resources | ResourceReference[] | List of the resource IDs that support the MongoDB resource |
| secrets | MongoDatabaseSecrets | The secret values for the given MongoDatabase resource |
| status | ResourceStatus | Status of a resource. (ReadOnly) |
| username | string | Username to use when connecting to the target Mongo database |
Recipe
Properties
| Property | Type | Description |
|---|---|---|
| name | string | The name of the recipe within the environment to use (Required) |
| parameters | any | Any object |
ResourceReference
Properties
| Property | Type | Description |
|---|---|---|
| id | string | Resource id of an existing resource (Required) |
MongoDatabaseSecrets
Properties
| Property | Type | Description |
|---|---|---|
| connectionString | string | Connection string used to connect to the target Mongo database |
| password | string | Password to use when connecting to the target Mongo database |
ResourceStatus
Properties
| Property | Type | Description |
|---|---|---|
| compute | EnvironmentCompute | Represents backing compute resource |
| outputResources | OutputResource[] | Properties of an output resource |
| recipe | RecipeStatus | Recipe status at deployment time for a resource. (ReadOnly) |
EnvironmentCompute
- Discriminator: kind
Base Properties
| Property | Type | Description |
|---|---|---|
| identity | IdentitySettings | IdentitySettings is the external identity setting. |
| resourceId | string | The resource id of the compute resource for application environment. |
AzureContainerInstanceCompute
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘aci’ | Discriminator property for EnvironmentCompute. (Required) |
| resourceGroup | string | The resource group to use for the environment. |
KubernetesCompute
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘kubernetes’ | Discriminator property for EnvironmentCompute. (Required) |
| namespace | string | The namespace to use for the environment. (Required) |
IdentitySettings
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘azure.com.workload’ | ‘systemAssigned’ |
| managedIdentity | string[] | The list of user assigned managed identities |
| oidcIssuer | string | The URI for your compute platform’s OIDC issuer |
| resource | string | The resource ID of the provisioned identity |
OutputResource
Properties
| Property | Type | Description |
|---|---|---|
| id | string | The UCP resource ID of the underlying resource. |
| localId | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. |
| radiusManaged | bool | Determines whether Radius manages the lifecycle of the underlying resource. |
RecipeStatus
Properties
| Property | Type | Description |
|---|---|---|
| templateKind | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment. (Required) |
| templatePath | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment. (Required) |
| templateVersion | string | TemplateVersion is the version number of the template. |
SystemData
Properties
| Property | Type | Description |
|---|---|---|
| createdAt | string | The timestamp of resource creation (UTC). |
| createdBy | string | The identity that created the resource. |
| createdByType | ‘Application’ | ‘Key’ |
| lastModifiedAt | string | The timestamp of resource last modification (UTC) |
| lastModifiedBy | string | The identity that last modified the resource. |
| lastModifiedByType | ‘Application’ | ‘Key’ |
TrackedResourceTags
Properties
- none
Additional Properties
- Additional Properties Type: string
Feedback
Was this page helpful?
Glad to hear it! Please feel free to star our repo and join our Discord server to stay up to date with the project.
Sorry to hear that. If you would like to also contribute a suggestion visit and tell us how we can improve.