RedisResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
RedisResource.
public class RedisResource : Azure.Provisioning.Primitives.ProvisionableResource
public class RedisResource : Azure.Provisioning.Primitives.Resource
type RedisResource = class
inherit ProvisionableResource
type RedisResource = class
inherit Resource
Public Class RedisResource
Inherits ProvisionableResource
Public Class RedisResource
Inherits Resource
- Inheritance
- Inheritance
Constructors
RedisResource(String, String) |
Creates a new RedisResource. |
Properties
AccessKeys |
The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache. |
BicepIdentifier |
Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisionableConstruct) |
DependsOn |
Declares explicit dependencies on other resources. (Inherited from ProvisionableResource) |
DependsOn |
Declares explicit dependencies on other resources. (Inherited from Resource) |
EnableNonSslPort |
Specifies whether the non-ssl Redis server port (6379) is enabled. |
HostName |
Redis host name. |
Id |
Gets the Id. |
IdentifierName |
Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisioningConstruct) |
Identity |
The identity of the resource. |
Instances |
List of the Redis instances associated with the cache. |
IsAccessKeyAuthenticationDisabled |
Authentication to Redis through access keys is disabled when set as true. Default value is false. |
IsExistingResource |
Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from ProvisionableResource) |
IsExistingResource |
Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from Resource) |
LinkedServers |
List of the linked servers associated with the cache. |
Location |
The geo-location where the resource lives. |
MinimumTlsVersion |
Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2'). |
Name |
The name of the Redis cache. |
Port |
Redis non-SSL port. |
PrivateEndpointConnections |
List of private endpoint connection associated with the specified redis cache. |
ProvisioningState |
Redis instance provisioning status. |
PublicNetworkAccess |
Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'. |
RedisConfiguration |
All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc. |
RedisVersion |
Redis version. This should be in the form 'major[.minor]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is 'latest'. |
ReplicasPerMaster |
The number of replicas to be created per primary. |
ReplicasPerPrimary |
The number of replicas to be created per primary. |
ResourceType |
Gets the type of the resource. (Inherited from ProvisionableResource) |
ResourceType |
Gets the type of the resource. (Inherited from Resource) |
ResourceVersion |
Gets or sets the version of the resource. (Inherited from ProvisionableResource) |
ResourceVersion |
Gets or sets the version of the resource. (Inherited from Resource) |
ShardCount |
The number of shards to be created on a Premium Cluster Cache. |
Sku |
The SKU of the Redis cache to deploy. |
SslPort |
Redis SSL port. |
StaticIP |
Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. |
SubnetId |
The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1. |
SystemData |
Gets the SystemData. |
Tags |
Resource tags. |
TenantSettings |
A dictionary of tenant settings. |
UpdateChannel |
Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using 'Preview' update channel get latest Redis updates at least 4 weeks ahead of 'Stable' channel caches. Default value is 'Stable'. |
Zones |
A list of availability zones denoting where the resource needs to come from. |
Methods
AssignOrReplace<T>(T, T) | (Inherited from ProvisionableConstruct) |
Build(ProvisioningBuildOptions) |
Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from ProvisionableResource) |
Build(ProvisioningContext) |
Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from Resource) |
Compile() |
Compile the resource into a set of Bicep statements. (Inherited from ProvisionableResource) |
Compile() |
Compile the resource into a set of Bicep statements. (Inherited from Resource) |
CreateRoleAssignment(RedisBuiltInRole, BicepValue<RoleManagementPrincipalType>, BicepValue<Guid>, String) |
Creates a role assignment for a principal that grants access to this RedisResource. |
CreateRoleAssignment(RedisBuiltInRole, UserAssignedIdentity) |
Creates a role assignment for a user-assigned identity that grants access to this RedisResource. |
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) | (Inherited from ProvisionableConstruct) |
DefineListProperty<T>(String, String[], Boolean, Boolean) | (Inherited from ProvisionableConstruct) |
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) | (Inherited from ProvisionableConstruct) |
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) | (Inherited from ProvisionableConstruct) |
DefineProvisionableProperties() |
Define all the provisionable properties of RedisResource. |
DefineResource<T>(String, String[], Boolean, Boolean, T) | (Inherited from ProvisionableResource) |
FromExisting(String, String) |
Creates a reference to an existing RedisResource. |
GetKeys() |
Get access keys for this RedisResource resource. |
GetProvisionableResources() |
Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable) |
GetResources() |
Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable) |
Initialize() |
Initialize this construct. (Inherited from ProvisionableConstruct) |
OverrideWithExpression(BicepExpression) | (Inherited from ProvisionableConstruct) |
OverrideWithExpression(Expression) |
Set this construct to represent the result of an expression. This is
primarily meant to be called via |
Resolve(ProvisioningBuildOptions) |
Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisionableConstruct) |
Resolve(ProvisioningBuildOptions) |
Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable) |
Resolve(ProvisioningContext) |
Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable) |
Resolve(ProvisioningContext) |
Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisioningConstruct) |
Validate(ProvisioningBuildOptions) |
Validate the presence of any required members. (Inherited from ProvisionableResource) |
Validate(ProvisioningBuildOptions) |
Validate the presence of any required members. (Inherited from Provisionable) |
Validate(ProvisioningContext) |
Validate the presence of any required members. (Inherited from Provisionable) |
Validate(ProvisioningContext) |
Validate the presence of any required members. (Inherited from Resource) |
Explicit Interface Implementations
IBicepValue.Assign(IBicepValue) |
Assign a value to this property. (Inherited from ProvisionableConstruct) |
IBicepValue.Compile() |
Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct) |
IBicepValue.Expression |
Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct) |
IBicepValue.IsEmpty |
Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct) |
IBicepValue.IsOutput |
Tracks whether this is an output only property. (Inherited from ProvisionableConstruct) |
IBicepValue.IsRequired |
Tracks whether this property is required. (Inherited from ProvisionableConstruct) |
IBicepValue.IsSecure |
Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct) |
IBicepValue.Kind |
Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct) |
IBicepValue.LiteralValue |
Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct) |
IBicepValue.Self |
Gets information about where this value was defined. (Inherited from ProvisionableConstruct) |
IBicepValue.SetReadOnly() |
Make this value readonly. (Inherited from ProvisionableConstruct) |
IBicepValue.Source |
Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct) |
Applies to
Azure SDK for .NET