cache.azure.com/v1beta20210301

cache.azure.com/v1beta20210301

Package v1beta20210301 contains API Schema definitions for the cache v1beta20210301 API group

Resource Types:

    ClusterPropertiesARM

    (Appears on:RedisEnterprise_SpecARM)

    Field Description
    minimumTlsVersion
    ClusterPropertiesMinimumTlsVersion

    MinimumTlsVersion: The minimum TLS version for the cluster to support, e.g. ‘1.2’.

    ClusterPropertiesMinimumTlsVersion (string alias)

    (Appears on:ClusterPropertiesARM, RedisEnterprise_Spec)

    Value Description

    "1.0"

    "1.1"

    "1.2"

    ClusterPropertiesStatusMinimumTlsVersion (string alias)

    (Appears on:ClusterProperties_StatusARM, Cluster_Status)

    Value Description

    "1.0"

    "1.1"

    "1.2"

    ClusterProperties_StatusARM

    (Appears on:Cluster_StatusARM)

    Field Description
    hostName
    string

    HostName: DNS name of the cluster endpoint

    minimumTlsVersion
    ClusterPropertiesStatusMinimumTlsVersion

    MinimumTlsVersion: The minimum TLS version for the cluster to support, e.g. ‘1.2’

    privateEndpointConnections
    []PrivateEndpointConnection_Status_SubResourceEmbeddedARM

    PrivateEndpointConnections: List of private endpoint connections associated with the specified RedisEnterprise cluster

    provisioningState
    ProvisioningState_Status

    ProvisioningState: Current provisioning status of the cluster

    redisVersion
    string

    RedisVersion: Version of redis the cluster supports, e.g. ‘6’

    resourceState
    ResourceState_Status

    ResourceState: Current resource status of the cluster

    Cluster_Status

    (Appears on:RedisEnterprise)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    hostName
    string

    HostName: DNS name of the cluster endpoint

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    minimumTlsVersion
    ClusterPropertiesStatusMinimumTlsVersion

    MinimumTlsVersion: The minimum TLS version for the cluster to support, e.g. ‘1.2’

    name
    string

    Name: The name of the resource

    privateEndpointConnections
    []PrivateEndpointConnection_Status_SubResourceEmbedded

    PrivateEndpointConnections: List of private endpoint connections associated with the specified RedisEnterprise cluster

    provisioningState
    ProvisioningState_Status

    ProvisioningState: Current provisioning status of the cluster

    redisVersion
    string

    RedisVersion: Version of redis the cluster supports, e.g. ‘6’

    resourceState
    ResourceState_Status

    ResourceState: Current resource status of the cluster

    sku
    Sku_Status

    Sku: The SKU to create, which affects price, performance, and features.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    zones
    []string

    Zones: The Availability Zones where this cluster will be deployed.

    Cluster_StatusARM

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    ClusterProperties_StatusARM

    Properties: Other properties of the cluster.

    sku
    Sku_StatusARM

    Sku: The SKU to create, which affects price, performance, and features.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    zones
    []string

    Zones: The Availability Zones where this cluster will be deployed.

    DatabasePropertiesARM

    (Appears on:RedisEnterpriseDatabases_SpecARM)

    Field Description
    clientProtocol
    DatabasePropertiesClientProtocol

    ClientProtocol: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

    clusteringPolicy
    DatabasePropertiesClusteringPolicy

    ClusteringPolicy: Clustering policy - default is OSSCluster. Specified at create time.

    evictionPolicy
    DatabasePropertiesEvictionPolicy

    EvictionPolicy: Redis eviction policy - default is VolatileLRU.

    modules
    []ModuleARM

    Modules: Optional set of redis modules to enable in this database - modules can only be added at creation time.

    persistence
    PersistenceARM

    Persistence: Persistence-related configuration for the RedisEnterprise database

    port
    int

    Port: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

    DatabasePropertiesClientProtocol (string alias)

    (Appears on:DatabasePropertiesARM, RedisEnterpriseDatabases_Spec)

    Value Description

    "Encrypted"

    "Plaintext"

    DatabasePropertiesClusteringPolicy (string alias)

    (Appears on:DatabasePropertiesARM, RedisEnterpriseDatabases_Spec)

    Value Description

    "EnterpriseCluster"

    "OSSCluster"

    DatabasePropertiesEvictionPolicy (string alias)

    (Appears on:DatabasePropertiesARM, RedisEnterpriseDatabases_Spec)

    Value Description

    "AllKeysLFU"

    "AllKeysLRU"

    "AllKeysRandom"

    "NoEviction"

    "VolatileLFU"

    "VolatileLRU"

    "VolatileRandom"

    "VolatileTTL"

    DatabasePropertiesStatusClientProtocol (string alias)

    (Appears on:DatabaseProperties_StatusARM, Database_Status)

    Value Description

    "Encrypted"

    "Plaintext"

    DatabasePropertiesStatusClusteringPolicy (string alias)

    (Appears on:DatabaseProperties_StatusARM, Database_Status)

    Value Description

    "EnterpriseCluster"

    "OSSCluster"

    DatabasePropertiesStatusEvictionPolicy (string alias)

    (Appears on:DatabaseProperties_StatusARM, Database_Status)

    Value Description

    "AllKeysLFU"

    "AllKeysLRU"

    "AllKeysRandom"

    "NoEviction"

    "VolatileLFU"

    "VolatileLRU"

    "VolatileRandom"

    "VolatileTTL"

    DatabaseProperties_StatusARM

    (Appears on:Database_StatusARM)

    Field Description
    clientProtocol
    DatabasePropertiesStatusClientProtocol

    ClientProtocol: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

    clusteringPolicy
    DatabasePropertiesStatusClusteringPolicy

    ClusteringPolicy: Clustering policy - default is OSSCluster. Specified at create time.

    evictionPolicy
    DatabasePropertiesStatusEvictionPolicy

    EvictionPolicy: Redis eviction policy - default is VolatileLRU

    modules
    []Module_StatusARM

    Modules: Optional set of redis modules to enable in this database - modules can only be added at creation time.

    persistence
    Persistence_StatusARM

    Persistence: Persistence settings

    port
    int

    Port: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

    provisioningState
    ProvisioningState_Status

    ProvisioningState: Current provisioning status of the database

    resourceState
    ResourceState_Status

    ResourceState: Current resource status of the database

    Database_Status

    (Appears on:RedisEnterpriseDatabase)

    Field Description
    clientProtocol
    DatabasePropertiesStatusClientProtocol

    ClientProtocol: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

    clusteringPolicy
    DatabasePropertiesStatusClusteringPolicy

    ClusteringPolicy: Clustering policy - default is OSSCluster. Specified at create time.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    evictionPolicy
    DatabasePropertiesStatusEvictionPolicy

    EvictionPolicy: Redis eviction policy - default is VolatileLRU

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    modules
    []Module_Status

    Modules: Optional set of redis modules to enable in this database - modules can only be added at creation time.

    name
    string

    Name: The name of the resource

    persistence
    Persistence_Status

    Persistence: Persistence settings

    port
    int

    Port: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

    provisioningState
    ProvisioningState_Status

    ProvisioningState: Current provisioning status of the database

    resourceState
    ResourceState_Status

    ResourceState: Current resource status of the database

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    Database_StatusARM

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    name
    string

    Name: The name of the resource

    properties
    DatabaseProperties_StatusARM

    Properties: Other properties of the database.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    Module

    (Appears on:RedisEnterpriseDatabases_Spec)

    Field Description
    args
    string

    Args: Configuration options for the module, e.g. ‘ERROR_RATE 0.00 INITIAL_SIZE 400’.

    name
    string

    Name: The name of the module, e.g. ‘RedisBloom’, ‘RediSearch’, ‘RedisTimeSeries’

    ModuleARM

    (Appears on:DatabasePropertiesARM)

    Field Description
    args
    string

    Args: Configuration options for the module, e.g. ‘ERROR_RATE 0.00 INITIAL_SIZE 400’.

    name
    string

    Name: The name of the module, e.g. ‘RedisBloom’, ‘RediSearch’, ‘RedisTimeSeries’

    Module_Status

    (Appears on:Database_Status)

    Field Description
    args
    string

    Args: Configuration options for the module, e.g. ‘ERROR_RATE 0.00 INITIAL_SIZE 400’.

    name
    string

    Name: The name of the module, e.g. ‘RedisBloom’, ‘RediSearch’, ‘RedisTimeSeries’

    version
    string

    Version: The version of the module, e.g. ‘1.0’.

    Module_StatusARM

    (Appears on:DatabaseProperties_StatusARM)

    Field Description
    args
    string

    Args: Configuration options for the module, e.g. ‘ERROR_RATE 0.00 INITIAL_SIZE 400’.

    name
    string

    Name: The name of the module, e.g. ‘RedisBloom’, ‘RediSearch’, ‘RedisTimeSeries’

    version
    string

    Version: The version of the module, e.g. ‘1.0’.

    Persistence

    (Appears on:RedisEnterpriseDatabases_Spec)

    Field Description
    aofEnabled
    bool

    AofEnabled: Sets whether AOF is enabled.

    aofFrequency
    PersistenceAofFrequency

    AofFrequency: Sets the frequency at which data is written to disk.

    rdbEnabled
    bool

    RdbEnabled: Sets whether RDB is enabled.

    rdbFrequency
    PersistenceRdbFrequency

    RdbFrequency: Sets the frequency at which a snapshot of the database is created.

    PersistenceARM

    (Appears on:DatabasePropertiesARM)

    Field Description
    aofEnabled
    bool

    AofEnabled: Sets whether AOF is enabled.

    aofFrequency
    PersistenceAofFrequency

    AofFrequency: Sets the frequency at which data is written to disk.

    rdbEnabled
    bool

    RdbEnabled: Sets whether RDB is enabled.

    rdbFrequency
    PersistenceRdbFrequency

    RdbFrequency: Sets the frequency at which a snapshot of the database is created.

    PersistenceAofFrequency (string alias)

    (Appears on:Persistence, PersistenceARM)

    Value Description

    "1s"

    "always"

    PersistenceRdbFrequency (string alias)

    (Appears on:Persistence, PersistenceARM)

    Value Description

    "12h"

    "1h"

    "6h"

    PersistenceStatusAofFrequency (string alias)

    (Appears on:Persistence_Status, Persistence_StatusARM)

    Value Description

    "1s"

    "always"

    PersistenceStatusRdbFrequency (string alias)

    (Appears on:Persistence_Status, Persistence_StatusARM)

    Value Description

    "12h"

    "1h"

    "6h"

    Persistence_Status

    (Appears on:Database_Status)

    Field Description
    aofEnabled
    bool

    AofEnabled: Sets whether AOF is enabled.

    aofFrequency
    PersistenceStatusAofFrequency

    AofFrequency: Sets the frequency at which data is written to disk.

    rdbEnabled
    bool

    RdbEnabled: Sets whether RDB is enabled.

    rdbFrequency
    PersistenceStatusRdbFrequency

    RdbFrequency: Sets the frequency at which a snapshot of the database is created.

    Persistence_StatusARM

    (Appears on:DatabaseProperties_StatusARM)

    Field Description
    aofEnabled
    bool

    AofEnabled: Sets whether AOF is enabled.

    aofFrequency
    PersistenceStatusAofFrequency

    AofFrequency: Sets the frequency at which data is written to disk.

    rdbEnabled
    bool

    RdbEnabled: Sets whether RDB is enabled.

    rdbFrequency
    PersistenceStatusRdbFrequency

    RdbFrequency: Sets the frequency at which a snapshot of the database is created.

    PrivateEndpointConnection_Status_SubResourceEmbedded

    (Appears on:Cluster_Status)

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    PrivateEndpointConnection_Status_SubResourceEmbeddedARM

    (Appears on:ClusterProperties_StatusARM)

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    ProvisioningState_Status (string alias)

    (Appears on:ClusterProperties_StatusARM, Cluster_Status, DatabaseProperties_StatusARM, Database_Status)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    RedisEnterprise

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    RedisEnterprise_Spec


    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    location
    string

    Location: The geo-location where the resource lives

    minimumTlsVersion
    ClusterPropertiesMinimumTlsVersion

    MinimumTlsVersion: The minimum TLS version for the cluster to support, e.g. ‘1.2’.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    sku
    Sku

    Sku: SKU parameters supplied to the create RedisEnterprise operation.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    zones
    []string

    Zones: The Availability Zones where this cluster will be deployed.

    status
    Cluster_Status

    RedisEnterpriseDatabase

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    RedisEnterpriseDatabases_Spec


    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    clientProtocol
    DatabasePropertiesClientProtocol

    ClientProtocol: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

    clusteringPolicy
    DatabasePropertiesClusteringPolicy

    ClusteringPolicy: Clustering policy - default is OSSCluster. Specified at create time.

    evictionPolicy
    DatabasePropertiesEvictionPolicy

    EvictionPolicy: Redis eviction policy - default is VolatileLRU.

    location
    string

    Location: Location to deploy resource to

    modules
    []Module

    Modules: Optional set of redis modules to enable in this database - modules can only be added at creation time.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cache.azure.com/RedisEnterprise resource

    persistence
    Persistence

    Persistence: Persistence-related configuration for the RedisEnterprise database

    port
    int

    Port: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    status
    Database_Status

    RedisEnterpriseDatabasesSpecAPIVersion (string alias)

    Value Description

    "2021-03-01"

    RedisEnterpriseDatabases_Spec

    (Appears on:RedisEnterpriseDatabase)

    Field Description
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    clientProtocol
    DatabasePropertiesClientProtocol

    ClientProtocol: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

    clusteringPolicy
    DatabasePropertiesClusteringPolicy

    ClusteringPolicy: Clustering policy - default is OSSCluster. Specified at create time.

    evictionPolicy
    DatabasePropertiesEvictionPolicy

    EvictionPolicy: Redis eviction policy - default is VolatileLRU.

    location
    string

    Location: Location to deploy resource to

    modules
    []Module

    Modules: Optional set of redis modules to enable in this database - modules can only be added at creation time.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cache.azure.com/RedisEnterprise resource

    persistence
    Persistence

    Persistence: Persistence-related configuration for the RedisEnterprise database

    port
    int

    Port: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    RedisEnterpriseDatabases_SpecARM

    Field Description
    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: The name of the database.

    properties
    DatabasePropertiesARM

    Properties: Properties of RedisEnterprise databases, as opposed to general resource properties like location, tags

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    RedisEnterpriseSpecAPIVersion (string alias)

    Value Description

    "2021-03-01"

    RedisEnterprise_Spec

    (Appears on:RedisEnterprise)

    Field Description
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    location
    string

    Location: The geo-location where the resource lives

    minimumTlsVersion
    ClusterPropertiesMinimumTlsVersion

    MinimumTlsVersion: The minimum TLS version for the cluster to support, e.g. ‘1.2’.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    sku
    Sku

    Sku: SKU parameters supplied to the create RedisEnterprise operation.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    zones
    []string

    Zones: The Availability Zones where this cluster will be deployed.

    RedisEnterprise_SpecARM

    Field Description
    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the RedisEnterprise cluster.

    properties
    ClusterPropertiesARM

    Properties: Properties of RedisEnterprise clusters, as opposed to general resource properties like location, tags

    sku
    SkuARM

    Sku: SKU parameters supplied to the create RedisEnterprise operation.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    zones
    []string

    Zones: The Availability Zones where this cluster will be deployed.

    ResourceState_Status (string alias)

    (Appears on:ClusterProperties_StatusARM, Cluster_Status, DatabaseProperties_StatusARM, Database_Status)

    Value Description

    "CreateFailed"

    "Creating"

    "DeleteFailed"

    "Deleting"

    "DisableFailed"

    "Disabled"

    "Disabling"

    "EnableFailed"

    "Enabling"

    "Running"

    "UpdateFailed"

    "Updating"

    Sku

    (Appears on:RedisEnterprise_Spec)

    Field Description
    capacity
    int

    Capacity: The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, …) for Enterprise SKUs and (3, 9, 15, …) for Flash SKUs.

    name
    SkuName

    Name: The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.).

    SkuARM

    (Appears on:RedisEnterprise_SpecARM)

    Field Description
    capacity
    int

    Capacity: The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, …) for Enterprise SKUs and (3, 9, 15, …) for Flash SKUs.

    name
    SkuName

    Name: The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.).

    SkuName (string alias)

    (Appears on:Sku, SkuARM)

    Value Description

    "Enterprise_E10"

    "Enterprise_E100"

    "Enterprise_E20"

    "Enterprise_E50"

    "EnterpriseFlash_F1500"

    "EnterpriseFlash_F300"

    "EnterpriseFlash_F700"

    SkuStatusName (string alias)

    (Appears on:Sku_Status, Sku_StatusARM)

    Value Description

    "Enterprise_E10"

    "Enterprise_E100"

    "Enterprise_E20"

    "Enterprise_E50"

    "EnterpriseFlash_F1500"

    "EnterpriseFlash_F300"

    "EnterpriseFlash_F700"

    Sku_Status

    (Appears on:Cluster_Status)

    Field Description
    capacity
    int

    Capacity: The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, …) for Enterprise SKUs and (3, 9, 15, …) for Flash SKUs.

    name
    SkuStatusName

    Name: The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)

    Sku_StatusARM

    (Appears on:Cluster_StatusARM)

    Field Description
    capacity
    int

    Capacity: The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, …) for Enterprise SKUs and (3, 9, 15, …) for Flash SKUs.

    name
    SkuStatusName

    Name: The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)