1. Packages
  2. Azure Native
  3. API Docs
  4. redis
  5. getRedis
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.redis.getRedis

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets a Redis cache (resource description).

Uses Azure REST API version 2024-11-01.

Other available API versions: 2015-08-01, 2016-04-01, 2017-02-01, 2017-10-01, 2018-03-01, 2019-07-01, 2020-06-01, 2020-12-01, 2021-06-01, 2022-05-01, 2022-06-01, 2023-04-01, 2023-05-01-preview, 2023-08-01, 2024-03-01, 2024-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native redis [ApiVersion]. See the version guide for details.

Using getRedis

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRedis(args: GetRedisArgs, opts?: InvokeOptions): Promise<GetRedisResult>
function getRedisOutput(args: GetRedisOutputArgs, opts?: InvokeOptions): Output<GetRedisResult>
Copy
def get_redis(name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetRedisResult
def get_redis_output(name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRedisResult]
Copy
func LookupRedis(ctx *Context, args *LookupRedisArgs, opts ...InvokeOption) (*LookupRedisResult, error)
func LookupRedisOutput(ctx *Context, args *LookupRedisOutputArgs, opts ...InvokeOption) LookupRedisResultOutput
Copy

> Note: This function is named LookupRedis in the Go SDK.

public static class GetRedis 
{
    public static Task<GetRedisResult> InvokeAsync(GetRedisArgs args, InvokeOptions? opts = null)
    public static Output<GetRedisResult> Invoke(GetRedisInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRedisResult> getRedis(GetRedisArgs args, InvokeOptions options)
public static Output<GetRedisResult> getRedis(GetRedisArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:redis:getRedis
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the Redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Redis cache.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the Redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getRedis Result

The following output properties are available:

AccessKeys Pulumi.AzureNative.Redis.Outputs.RedisAccessKeysResponse
The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache
AzureApiVersion string
The Azure API version of the resource.
HostName string
Redis host name.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Instances List<Pulumi.AzureNative.Redis.Outputs.RedisInstanceDetailsResponse>
List of the Redis instances associated with the cache
LinkedServers List<Pulumi.AzureNative.Redis.Outputs.RedisLinkedServerResponse>
List of the linked servers associated with the cache
Location string
The geo-location where the resource lives
Name string
The name of the resource
Port int
Redis non-SSL port.
PrivateEndpointConnections List<Pulumi.AzureNative.Redis.Outputs.PrivateEndpointConnectionResponse>
List of private endpoint connection associated with the specified redis cache
ProvisioningState string
Redis instance provisioning status.
Sku Pulumi.AzureNative.Redis.Outputs.SkuResponse
The SKU of the Redis cache to deploy.
SslPort int
Redis SSL port.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DisableAccessKeyAuthentication bool
Authentication to Redis through access keys is disabled when set as true. Default value is false.
EnableNonSslPort bool
Specifies whether the non-ssl Redis server port (6379) is enabled.
Identity Pulumi.AzureNative.Redis.Outputs.ManagedServiceIdentityResponse
The identity of the resource.
MinimumTlsVersion string
Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
PublicNetworkAccess string
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 Pulumi.AzureNative.Redis.Outputs.RedisCommonPropertiesResponseRedisConfiguration
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 string
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 int
The number of replicas to be created per primary.
ReplicasPerPrimary int
The number of replicas to be created per primary.
ShardCount int
The number of shards to be created on a Premium Cluster Cache.
StaticIP string
Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.
SubnetId string
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
Tags Dictionary<string, string>
Resource tags.
TenantSettings Dictionary<string, string>
A dictionary of tenant settings
UpdateChannel string
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'.
ZonalAllocationPolicy string
Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.
Zones List<string>
A list of availability zones denoting where the resource needs to come from.
AccessKeys RedisAccessKeysResponse
The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache
AzureApiVersion string
The Azure API version of the resource.
HostName string
Redis host name.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Instances []RedisInstanceDetailsResponse
List of the Redis instances associated with the cache
LinkedServers []RedisLinkedServerResponse
List of the linked servers associated with the cache
Location string
The geo-location where the resource lives
Name string
The name of the resource
Port int
Redis non-SSL port.
PrivateEndpointConnections []PrivateEndpointConnectionResponse
List of private endpoint connection associated with the specified redis cache
ProvisioningState string
Redis instance provisioning status.
Sku SkuResponse
The SKU of the Redis cache to deploy.
SslPort int
Redis SSL port.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DisableAccessKeyAuthentication bool
Authentication to Redis through access keys is disabled when set as true. Default value is false.
EnableNonSslPort bool
Specifies whether the non-ssl Redis server port (6379) is enabled.
Identity ManagedServiceIdentityResponse
The identity of the resource.
MinimumTlsVersion string
Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
PublicNetworkAccess string
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 RedisCommonPropertiesResponseRedisConfiguration
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 string
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 int
The number of replicas to be created per primary.
ReplicasPerPrimary int
The number of replicas to be created per primary.
ShardCount int
The number of shards to be created on a Premium Cluster Cache.
StaticIP string
Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.
SubnetId string
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
Tags map[string]string
Resource tags.
TenantSettings map[string]string
A dictionary of tenant settings
UpdateChannel string
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'.
ZonalAllocationPolicy string
Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.
Zones []string
A list of availability zones denoting where the resource needs to come from.
accessKeys RedisAccessKeysResponse
The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache
azureApiVersion String
The Azure API version of the resource.
hostName String
Redis host name.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
instances List<RedisInstanceDetailsResponse>
List of the Redis instances associated with the cache
linkedServers List<RedisLinkedServerResponse>
List of the linked servers associated with the cache
location String
The geo-location where the resource lives
name String
The name of the resource
port Integer
Redis non-SSL port.
privateEndpointConnections List<PrivateEndpointConnectionResponse>
List of private endpoint connection associated with the specified redis cache
provisioningState String
Redis instance provisioning status.
sku SkuResponse
The SKU of the Redis cache to deploy.
sslPort Integer
Redis SSL port.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disableAccessKeyAuthentication Boolean
Authentication to Redis through access keys is disabled when set as true. Default value is false.
enableNonSslPort Boolean
Specifies whether the non-ssl Redis server port (6379) is enabled.
identity ManagedServiceIdentityResponse
The identity of the resource.
minimumTlsVersion String
Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
publicNetworkAccess String
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 RedisCommonPropertiesResponseRedisConfiguration
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 String
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 Integer
The number of replicas to be created per primary.
replicasPerPrimary Integer
The number of replicas to be created per primary.
shardCount Integer
The number of shards to be created on a Premium Cluster Cache.
staticIP String
Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.
subnetId String
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
tags Map<String,String>
Resource tags.
tenantSettings Map<String,String>
A dictionary of tenant settings
updateChannel String
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'.
zonalAllocationPolicy String
Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.
zones List<String>
A list of availability zones denoting where the resource needs to come from.
accessKeys RedisAccessKeysResponse
The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache
azureApiVersion string
The Azure API version of the resource.
hostName string
Redis host name.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
instances RedisInstanceDetailsResponse[]
List of the Redis instances associated with the cache
linkedServers RedisLinkedServerResponse[]
List of the linked servers associated with the cache
location string
The geo-location where the resource lives
name string
The name of the resource
port number
Redis non-SSL port.
privateEndpointConnections PrivateEndpointConnectionResponse[]
List of private endpoint connection associated with the specified redis cache
provisioningState string
Redis instance provisioning status.
sku SkuResponse
The SKU of the Redis cache to deploy.
sslPort number
Redis SSL port.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disableAccessKeyAuthentication boolean
Authentication to Redis through access keys is disabled when set as true. Default value is false.
enableNonSslPort boolean
Specifies whether the non-ssl Redis server port (6379) is enabled.
identity ManagedServiceIdentityResponse
The identity of the resource.
minimumTlsVersion string
Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
publicNetworkAccess string
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 RedisCommonPropertiesResponseRedisConfiguration
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 string
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 number
The number of replicas to be created per primary.
replicasPerPrimary number
The number of replicas to be created per primary.
shardCount number
The number of shards to be created on a Premium Cluster Cache.
staticIP string
Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.
subnetId string
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
tags {[key: string]: string}
Resource tags.
tenantSettings {[key: string]: string}
A dictionary of tenant settings
updateChannel string
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'.
zonalAllocationPolicy string
Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.
zones string[]
A list of availability zones denoting where the resource needs to come from.
access_keys RedisAccessKeysResponse
The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache
azure_api_version str
The Azure API version of the resource.
host_name str
Redis host name.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
instances Sequence[RedisInstanceDetailsResponse]
List of the Redis instances associated with the cache
linked_servers Sequence[RedisLinkedServerResponse]
List of the linked servers associated with the cache
location str
The geo-location where the resource lives
name str
The name of the resource
port int
Redis non-SSL port.
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
List of private endpoint connection associated with the specified redis cache
provisioning_state str
Redis instance provisioning status.
sku SkuResponse
The SKU of the Redis cache to deploy.
ssl_port int
Redis SSL port.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disable_access_key_authentication bool
Authentication to Redis through access keys is disabled when set as true. Default value is false.
enable_non_ssl_port bool
Specifies whether the non-ssl Redis server port (6379) is enabled.
identity ManagedServiceIdentityResponse
The identity of the resource.
minimum_tls_version str
Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
public_network_access str
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'
redis_configuration RedisCommonPropertiesResponseRedisConfiguration
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.
redis_version str
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'.
replicas_per_master int
The number of replicas to be created per primary.
replicas_per_primary int
The number of replicas to be created per primary.
shard_count int
The number of shards to be created on a Premium Cluster Cache.
static_ip str
Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.
subnet_id str
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
tags Mapping[str, str]
Resource tags.
tenant_settings Mapping[str, str]
A dictionary of tenant settings
update_channel str
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'.
zonal_allocation_policy str
Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.
zones Sequence[str]
A list of availability zones denoting where the resource needs to come from.
accessKeys Property Map
The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache
azureApiVersion String
The Azure API version of the resource.
hostName String
Redis host name.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
instances List<Property Map>
List of the Redis instances associated with the cache
linkedServers List<Property Map>
List of the linked servers associated with the cache
location String
The geo-location where the resource lives
name String
The name of the resource
port Number
Redis non-SSL port.
privateEndpointConnections List<Property Map>
List of private endpoint connection associated with the specified redis cache
provisioningState String
Redis instance provisioning status.
sku Property Map
The SKU of the Redis cache to deploy.
sslPort Number
Redis SSL port.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disableAccessKeyAuthentication Boolean
Authentication to Redis through access keys is disabled when set as true. Default value is false.
enableNonSslPort Boolean
Specifies whether the non-ssl Redis server port (6379) is enabled.
identity Property Map
The identity of the resource.
minimumTlsVersion String
Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
publicNetworkAccess String
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 Property Map
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 String
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 Number
The number of replicas to be created per primary.
replicasPerPrimary Number
The number of replicas to be created per primary.
shardCount Number
The number of shards to be created on a Premium Cluster Cache.
staticIP String
Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.
subnetId String
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
tags Map<String>
Resource tags.
tenantSettings Map<String>
A dictionary of tenant settings
updateChannel String
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'.
zonalAllocationPolicy String
Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.
zones List<String>
A list of availability zones denoting where the resource needs to come from.

Supporting Types

ManagedServiceIdentityResponse

PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Redis.Inputs.UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities map[string]UserAssignedIdentityResponse
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<String,UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principal_id This property is required. str
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. str
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<Property Map>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

PrivateEndpointConnectionResponse

Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.Redis.Inputs.PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint Pulumi.AzureNative.Redis.Inputs.PrivateEndpointResponse
The resource of private end point.
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. string
The name of the resource
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. str
The name of the resource
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioning_state This property is required. str
The provisioning state of the private endpoint connection resource.
type This property is required. str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
private_endpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
privateLinkServiceConnectionState This property is required. Property Map
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint Property Map
The resource of private end point.

PrivateEndpointResponse

Id This property is required. string
The ARM identifier for Private Endpoint
Id This property is required. string
The ARM identifier for Private Endpoint
id This property is required. String
The ARM identifier for Private Endpoint
id This property is required. string
The ARM identifier for Private Endpoint
id This property is required. str
The ARM identifier for Private Endpoint
id This property is required. String
The ARM identifier for Private Endpoint

PrivateLinkServiceConnectionStateResponse

ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The reason for approval/rejection of the connection.
Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The reason for approval/rejection of the connection.
Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The reason for approval/rejection of the connection.
status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
description string
The reason for approval/rejection of the connection.
status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actions_required str
A message indicating if changes on the service provider require any updates on the consumer.
description str
The reason for approval/rejection of the connection.
status str
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The reason for approval/rejection of the connection.
status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

RedisAccessKeysResponse

PrimaryKey This property is required. string
The current primary key that clients can use to authenticate with Redis cache.
SecondaryKey This property is required. string
The current secondary key that clients can use to authenticate with Redis cache.
PrimaryKey This property is required. string
The current primary key that clients can use to authenticate with Redis cache.
SecondaryKey This property is required. string
The current secondary key that clients can use to authenticate with Redis cache.
primaryKey This property is required. String
The current primary key that clients can use to authenticate with Redis cache.
secondaryKey This property is required. String
The current secondary key that clients can use to authenticate with Redis cache.
primaryKey This property is required. string
The current primary key that clients can use to authenticate with Redis cache.
secondaryKey This property is required. string
The current secondary key that clients can use to authenticate with Redis cache.
primary_key This property is required. str
The current primary key that clients can use to authenticate with Redis cache.
secondary_key This property is required. str
The current secondary key that clients can use to authenticate with Redis cache.
primaryKey This property is required. String
The current primary key that clients can use to authenticate with Redis cache.
secondaryKey This property is required. String
The current secondary key that clients can use to authenticate with Redis cache.

RedisCommonPropertiesResponseRedisConfiguration

Maxclients This property is required. string
The max clients config
PreferredDataArchiveAuthMethod This property is required. string
Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS
ZonalConfiguration This property is required. string
Zonal Configuration
AadEnabled string
Specifies whether AAD based authentication has been enabled or disabled for the cache
AofBackupEnabled string
Specifies whether the aof backup is enabled
AofStorageConnectionString0 string
First storage account connection string
AofStorageConnectionString1 string
Second storage account connection string
Authnotrequired string
Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view.
MaxfragmentationmemoryReserved string
Value in megabytes reserved for fragmentation per shard
MaxmemoryDelta string
Value in megabytes reserved for non-cache usage per shard e.g. failover.
MaxmemoryPolicy string
The eviction strategy used when your data won't fit within its memory limit.
MaxmemoryReserved string
Value in megabytes reserved for non-cache usage per shard e.g. failover.
NotifyKeyspaceEvents string
The keyspace events which should be monitored.
PreferredDataPersistenceAuthMethod string
Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS
RdbBackupEnabled string
Specifies whether the rdb backup is enabled
RdbBackupFrequency string
Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440)
RdbBackupMaxSnapshotCount string
Specifies the maximum number of snapshots for rdb backup
RdbStorageConnectionString string
The storage account connection string for storing rdb file
StorageSubscriptionId string
SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity.
Maxclients This property is required. string
The max clients config
PreferredDataArchiveAuthMethod This property is required. string
Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS
ZonalConfiguration This property is required. string
Zonal Configuration
AadEnabled string
Specifies whether AAD based authentication has been enabled or disabled for the cache
AofBackupEnabled string
Specifies whether the aof backup is enabled
AofStorageConnectionString0 string
First storage account connection string
AofStorageConnectionString1 string
Second storage account connection string
Authnotrequired string
Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view.
MaxfragmentationmemoryReserved string
Value in megabytes reserved for fragmentation per shard
MaxmemoryDelta string
Value in megabytes reserved for non-cache usage per shard e.g. failover.
MaxmemoryPolicy string
The eviction strategy used when your data won't fit within its memory limit.
MaxmemoryReserved string
Value in megabytes reserved for non-cache usage per shard e.g. failover.
NotifyKeyspaceEvents string
The keyspace events which should be monitored.
PreferredDataPersistenceAuthMethod string
Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS
RdbBackupEnabled string
Specifies whether the rdb backup is enabled
RdbBackupFrequency string
Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440)
RdbBackupMaxSnapshotCount string
Specifies the maximum number of snapshots for rdb backup
RdbStorageConnectionString string
The storage account connection string for storing rdb file
StorageSubscriptionId string
SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity.
maxclients This property is required. String
The max clients config
preferredDataArchiveAuthMethod This property is required. String
Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS
zonalConfiguration This property is required. String
Zonal Configuration
aadEnabled String
Specifies whether AAD based authentication has been enabled or disabled for the cache
aofBackupEnabled String
Specifies whether the aof backup is enabled
aofStorageConnectionString0 String
First storage account connection string
aofStorageConnectionString1 String
Second storage account connection string
authnotrequired String
Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view.
maxfragmentationmemoryReserved String
Value in megabytes reserved for fragmentation per shard
maxmemoryDelta String
Value in megabytes reserved for non-cache usage per shard e.g. failover.
maxmemoryPolicy String
The eviction strategy used when your data won't fit within its memory limit.
maxmemoryReserved String
Value in megabytes reserved for non-cache usage per shard e.g. failover.
notifyKeyspaceEvents String
The keyspace events which should be monitored.
preferredDataPersistenceAuthMethod String
Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS
rdbBackupEnabled String
Specifies whether the rdb backup is enabled
rdbBackupFrequency String
Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440)
rdbBackupMaxSnapshotCount String
Specifies the maximum number of snapshots for rdb backup
rdbStorageConnectionString String
The storage account connection string for storing rdb file
storageSubscriptionId String
SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity.
maxclients This property is required. string
The max clients config
preferredDataArchiveAuthMethod This property is required. string
Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS
zonalConfiguration This property is required. string
Zonal Configuration
aadEnabled string
Specifies whether AAD based authentication has been enabled or disabled for the cache
aofBackupEnabled string
Specifies whether the aof backup is enabled
aofStorageConnectionString0 string
First storage account connection string
aofStorageConnectionString1 string
Second storage account connection string
authnotrequired string
Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view.
maxfragmentationmemoryReserved string
Value in megabytes reserved for fragmentation per shard
maxmemoryDelta string
Value in megabytes reserved for non-cache usage per shard e.g. failover.
maxmemoryPolicy string
The eviction strategy used when your data won't fit within its memory limit.
maxmemoryReserved string
Value in megabytes reserved for non-cache usage per shard e.g. failover.
notifyKeyspaceEvents string
The keyspace events which should be monitored.
preferredDataPersistenceAuthMethod string
Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS
rdbBackupEnabled string
Specifies whether the rdb backup is enabled
rdbBackupFrequency string
Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440)
rdbBackupMaxSnapshotCount string
Specifies the maximum number of snapshots for rdb backup
rdbStorageConnectionString string
The storage account connection string for storing rdb file
storageSubscriptionId string
SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity.
maxclients This property is required. str
The max clients config
preferred_data_archive_auth_method This property is required. str
Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS
zonal_configuration This property is required. str
Zonal Configuration
aad_enabled str
Specifies whether AAD based authentication has been enabled or disabled for the cache
aof_backup_enabled str
Specifies whether the aof backup is enabled
aof_storage_connection_string0 str
First storage account connection string
aof_storage_connection_string1 str
Second storage account connection string
authnotrequired str
Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view.
maxfragmentationmemory_reserved str
Value in megabytes reserved for fragmentation per shard
maxmemory_delta str
Value in megabytes reserved for non-cache usage per shard e.g. failover.
maxmemory_policy str
The eviction strategy used when your data won't fit within its memory limit.
maxmemory_reserved str
Value in megabytes reserved for non-cache usage per shard e.g. failover.
notify_keyspace_events str
The keyspace events which should be monitored.
preferred_data_persistence_auth_method str
Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS
rdb_backup_enabled str
Specifies whether the rdb backup is enabled
rdb_backup_frequency str
Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440)
rdb_backup_max_snapshot_count str
Specifies the maximum number of snapshots for rdb backup
rdb_storage_connection_string str
The storage account connection string for storing rdb file
storage_subscription_id str
SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity.
maxclients This property is required. String
The max clients config
preferredDataArchiveAuthMethod This property is required. String
Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS
zonalConfiguration This property is required. String
Zonal Configuration
aadEnabled String
Specifies whether AAD based authentication has been enabled or disabled for the cache
aofBackupEnabled String
Specifies whether the aof backup is enabled
aofStorageConnectionString0 String
First storage account connection string
aofStorageConnectionString1 String
Second storage account connection string
authnotrequired String
Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view.
maxfragmentationmemoryReserved String
Value in megabytes reserved for fragmentation per shard
maxmemoryDelta String
Value in megabytes reserved for non-cache usage per shard e.g. failover.
maxmemoryPolicy String
The eviction strategy used when your data won't fit within its memory limit.
maxmemoryReserved String
Value in megabytes reserved for non-cache usage per shard e.g. failover.
notifyKeyspaceEvents String
The keyspace events which should be monitored.
preferredDataPersistenceAuthMethod String
Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS
rdbBackupEnabled String
Specifies whether the rdb backup is enabled
rdbBackupFrequency String
Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440)
rdbBackupMaxSnapshotCount String
Specifies the maximum number of snapshots for rdb backup
rdbStorageConnectionString String
The storage account connection string for storing rdb file
storageSubscriptionId String
SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity.

RedisInstanceDetailsResponse

IsMaster This property is required. bool
Specifies whether the instance is a primary node.
IsPrimary This property is required. bool
Specifies whether the instance is a primary node.
NonSslPort This property is required. int
If enableNonSslPort is true, provides Redis instance Non-SSL port.
ShardId This property is required. int
If clustering is enabled, the Shard ID of Redis Instance
SslPort This property is required. int
Redis instance SSL port.
Zone This property is required. string
If the Cache uses availability zones, specifies availability zone where this instance is located.
IsMaster This property is required. bool
Specifies whether the instance is a primary node.
IsPrimary This property is required. bool
Specifies whether the instance is a primary node.
NonSslPort This property is required. int
If enableNonSslPort is true, provides Redis instance Non-SSL port.
ShardId This property is required. int
If clustering is enabled, the Shard ID of Redis Instance
SslPort This property is required. int
Redis instance SSL port.
Zone This property is required. string
If the Cache uses availability zones, specifies availability zone where this instance is located.
isMaster This property is required. Boolean
Specifies whether the instance is a primary node.
isPrimary This property is required. Boolean
Specifies whether the instance is a primary node.
nonSslPort This property is required. Integer
If enableNonSslPort is true, provides Redis instance Non-SSL port.
shardId This property is required. Integer
If clustering is enabled, the Shard ID of Redis Instance
sslPort This property is required. Integer
Redis instance SSL port.
zone This property is required. String
If the Cache uses availability zones, specifies availability zone where this instance is located.
isMaster This property is required. boolean
Specifies whether the instance is a primary node.
isPrimary This property is required. boolean
Specifies whether the instance is a primary node.
nonSslPort This property is required. number
If enableNonSslPort is true, provides Redis instance Non-SSL port.
shardId This property is required. number
If clustering is enabled, the Shard ID of Redis Instance
sslPort This property is required. number
Redis instance SSL port.
zone This property is required. string
If the Cache uses availability zones, specifies availability zone where this instance is located.
is_master This property is required. bool
Specifies whether the instance is a primary node.
is_primary This property is required. bool
Specifies whether the instance is a primary node.
non_ssl_port This property is required. int
If enableNonSslPort is true, provides Redis instance Non-SSL port.
shard_id This property is required. int
If clustering is enabled, the Shard ID of Redis Instance
ssl_port This property is required. int
Redis instance SSL port.
zone This property is required. str
If the Cache uses availability zones, specifies availability zone where this instance is located.
isMaster This property is required. Boolean
Specifies whether the instance is a primary node.
isPrimary This property is required. Boolean
Specifies whether the instance is a primary node.
nonSslPort This property is required. Number
If enableNonSslPort is true, provides Redis instance Non-SSL port.
shardId This property is required. Number
If clustering is enabled, the Shard ID of Redis Instance
sslPort This property is required. Number
Redis instance SSL port.
zone This property is required. String
If the Cache uses availability zones, specifies availability zone where this instance is located.

RedisLinkedServerResponse

Id This property is required. string
Linked server Id.
Id This property is required. string
Linked server Id.
id This property is required. String
Linked server Id.
id This property is required. string
Linked server Id.
id This property is required. str
Linked server Id.
id This property is required. String
Linked server Id.

SkuResponse

Capacity This property is required. int
The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).
Family This property is required. string
The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
Name This property is required. string
The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
Capacity This property is required. int
The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).
Family This property is required. string
The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
Name This property is required. string
The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
capacity This property is required. Integer
The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).
family This property is required. String
The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
name This property is required. String
The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
capacity This property is required. number
The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).
family This property is required. string
The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
name This property is required. string
The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
capacity This property is required. int
The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).
family This property is required. str
The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
name This property is required. str
The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
capacity This property is required. Number
The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).
family This property is required. String
The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
name This property is required. String
The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)

UserAssignedIdentityResponse

ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.
clientId This property is required. string
The client ID of the assigned identity.
principalId This property is required. string
The principal ID of the assigned identity.
client_id This property is required. str
The client ID of the assigned identity.
principal_id This property is required. str
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi