Reference: applications.datastores/rediscaches@2023-10-01-preview
Detailed reference documentation for applications.datastores/rediscaches@2023-10-01-preview
Schema
Top-Level Resource
Properties
| Property | Type | Description |
|---|---|---|
| apiVersion | ‘2023-10-01-preview’ | The resource api version (ReadOnly, DeployTimeConstant) |
| application | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) (ReadOnly) |
| environment | string | Fully qualified resource ID for the environment that the portable resource is linked to (ReadOnly) |
| host | string | The host name of the target Redis cache (ReadOnly) |
| id | string | The resource id (ReadOnly, DeployTimeConstant) |
| location | string | The geo-location where the resource lives |
| name | string | The resource name (Required, DeployTimeConstant, Identifier) |
| port | int | The port value of the target Redis cache (ReadOnly) |
| properties | RedisCacheProperties | The resource-specific properties for this resource. (Required) |
| provisioningState | ‘Accepted’ | ‘Canceled’ |
| recipe | Recipe | The recipe used to automatically deploy underlying infrastructure for the resource (ReadOnly) |
| resourceProvisioning | ‘manual’ | ‘recipe’ |
| resources | ResourceReference[] | List of the resource IDs that support the Redis resource (ReadOnly) |
| secrets | RedisCacheSecrets | Secrets provided by resource (ReadOnly) |
| status | ResourceStatus | Status of a resource. (ReadOnly) |
| systemData | SystemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. (ReadOnly) |
| tags | Record | Resource tags. |
| tls | bool | Specifies whether to enable SSL connections to the Redis cache (ReadOnly) |
| type | ‘Applications.Datastores/redisCaches’ | The resource type (ReadOnly, DeployTimeConstant) |
| username | string | The username for Redis cache (ReadOnly) |
RedisCacheProperties
Properties
| Property | Type | Description |
|---|---|---|
| application | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) |
| environment | string | Fully qualified resource ID for the environment that the portable resource is linked to (Required) |
| host | string | The host name of the target Redis cache |
| port | int | The port value of the target Redis cache |
| provisioningState | ‘Accepted’ | ‘Canceled’ |
| recipe | Recipe | The recipe used to automatically deploy underlying infrastructure for the resource |
| resourceProvisioning | ‘manual’ | ‘recipe’ |
| resources | ResourceReference[] | List of the resource IDs that support the Redis resource |
| secrets | RedisCacheSecrets | Secrets provided by resource |
| status | ResourceStatus | Status of a resource. (ReadOnly) |
| tls | bool | Specifies whether to enable SSL connections to the Redis cache |
| username | string | The username for Redis cache |
Recipe
Properties
| Property | Type | Description |
|---|---|---|
| name | string | The name of the recipe within the environment to use (Required) |
| parameters | Record | Key/value parameters to pass into the recipe at deployment |
Record
Properties
- none
Additional Properties
- Additional Properties Type: any
ResourceReference
Properties
| Property | Type | Description |
|---|---|---|
| id | string | Resource id of an existing resource (Required) |
RedisCacheSecrets
Properties
| Property | Type | Description |
|---|---|---|
| connectionString | string | The connection string used to connect to the Redis cache |
| password | string | The password for this Redis cache instance |
| url | string | The URL used to connect to the Redis cache |
ResourceStatus
Properties
| Property | Type | Description |
|---|---|---|
| compute | EnvironmentCompute | The compute resource associated with the resource. |
| outputResources | OutputResource[] | Properties of an output resource |
| recipe | RecipeStatus | The recipe data at the time of deployment (ReadOnly) |
EnvironmentCompute
- Discriminator: kind
Base Properties
| Property | Type | Description |
|---|---|---|
| identity | IdentitySettings | Configuration for supported external identity providers |
| resourceId | string | The resource id of the compute resource for application environment. |
AzureContainerInstanceCompute
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘aci’ | The Azure container instance compute kind (Required) |
| resourceGroup | string | The resource group to use for the environment. |
KubernetesCompute
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘kubernetes’ | The Kubernetes compute kind (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’ |
Record
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.