你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Redis - List By Subscription

获取指定订阅中的所有 Redis 缓存。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redis?api-version=2023-08-01

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

RedisListResult

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

RedisCacheList

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/redis?api-version=2023-08-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
      "location": "West US",
      "name": "cache1",
      "type": "Microsoft.Cache/Redis",
      "tags": {},
      "properties": {
        "provisioningState": "Creating",
        "redisVersion": "3.2",
        "sku": {
          "name": "Standard",
          "family": "C",
          "capacity": 6
        },
        "enableNonSslPort": true,
        "replicasPerMaster": 2,
        "replicasPerPrimary": 2,
        "updateChannel": "Stable",
        "redisConfiguration": {},
        "hostName": "cache1.redis.cache.windows.net",
        "port": 6379,
        "sslPort": 6380,
        "instances": [
          {
            "sslPort": 15000,
            "nonSslPort": 13000,
            "isMaster": true,
            "isPrimary": true
          },
          {
            "sslPort": 15001,
            "nonSslPort": 13001,
            "isMaster": false,
            "isPrimary": false
          },
          {
            "sslPort": 15002,
            "nonSslPort": 13002,
            "isMaster": false,
            "isPrimary": false
          }
        ]
      }
    }
  ]
}

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ManagedServiceIdentity

托管服务标识 (系统分配的标识和/或用户分配的标识)

ManagedServiceIdentityType

) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。

PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

ProvisioningState

Redis 实例预配状态。

PublicNetworkAccess

是否允许对此缓存进行公共终结点访问。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”。 如果为“Disabled”,则专用终结点是独占访问方法。 默认值为“Enabled”

RedisAccessKeys

Redis 缓存访问密钥。

RedisConfiguration

所有 Redis 设置。 几个可能的密钥:rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-than、slowlog-max-len ,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value 等。

RedisInstanceDetails

redis 的单个实例的详细信息。

RedisLinkedServer

链接服务器 ID

RedisListResult

list Redis 操作的响应。

RedisResource

列表或获取操作中的单个 Redis 项。

Sku

提供给创建 Redis 操作的 SKU 参数。

SkuFamily

要使用的 SKU 系列。 有效值: (C、P) 。 (C = 基本/标准,P = 高级) 。

SkuName

要部署的 Redis 缓存的类型。 有效值: (Basic、Standard、Premium)

TlsVersion

可选:要求客户端使用指定的 TLS 版本 (或更高版本) 来连接 (,例如“1.0”、“1.1”、“1.2”)

UpdateChannel

可选:指定 Redis 缓存将接收的每月 Redis 更新的更新通道。 使用“预览”更新通道的缓存至少比“稳定”通道缓存早 4 周获取最新的 Redis 更新。 默认值为“Stable”。

UserAssignedIdentity

用户分配的标识属性

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ManagedServiceIdentity

托管服务标识 (系统分配的标识和/或用户分配的标识)

名称 类型 说明
principalId

string

系统分配的标识的服务主体 ID。 此属性仅针对系统分配的标识提供。

tenantId

string

系统分配的标识的租户 ID。 此属性仅针对系统分配的标识提供。

type

ManagedServiceIdentityType

) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned 标识
与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将是采用以下格式的 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是请求中) ({} 空对象。

ManagedServiceIdentityType

) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。

名称 类型 说明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateEndpoint

专用终结点资源。

名称 类型 说明
id

string

专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.privateEndpoint

PrivateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

properties.provisioningState

PrivateEndpointConnectionProvisioningState

专用终结点连接资源的预配状态。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProvisioningState

当前预配状态。

名称 类型 说明
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

名称 类型 说明
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

名称 类型 说明
actionsRequired

string

一条消息,指示服务提供商的更改是否需要对使用者进行任何更新。

description

string

批准/拒绝连接的原因。

status

PrivateEndpointServiceConnectionStatus

指示连接是否已由服务的所有者批准/拒绝/删除。

ProvisioningState

Redis 实例预配状态。

名称 类型 说明
ConfiguringAAD

string

Creating

string

Deleting

string

Disabled

string

Failed

string

Linking

string

Provisioning

string

RecoveringScaleFailure

string

Scaling

string

Succeeded

string

Unlinking

string

Unprovisioning

string

Updating

string

PublicNetworkAccess

是否允许对此缓存进行公共终结点访问。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”。 如果为“Disabled”,则专用终结点是独占访问方法。 默认值为“Enabled”

名称 类型 说明
Disabled

string

Enabled

string

RedisAccessKeys

Redis 缓存访问密钥。

名称 类型 说明
primaryKey

string

客户端可用于对 Redis 缓存进行身份验证的当前主密钥。

secondaryKey

string

客户端可用于对 Redis 缓存进行身份验证的当前辅助密钥。

RedisConfiguration

所有 Redis 设置。 几个可能的密钥:rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-than、slowlog-max-len ,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value 等。

名称 类型 说明
aad-enabled

string

指定是已为缓存启用或禁用基于 AAD 的身份验证

aof-backup-enabled

string

指定是否启用 aof 备份

aof-storage-connection-string-0

string

第一个存储帐户连接字符串

aof-storage-connection-string-1

string

第二个存储帐户连接字符串

authnotrequired

string

指定是否禁用身份验证。 从安全角度来看,强烈建议不要设置此属性。

maxclients

string

最大客户端配置

maxfragmentationmemory-reserved

string

为每个分片的碎片保留的值(以兆字节为单位)

maxmemory-delta

string

为每个分片的非缓存使用量保留的值(以 MB 为单位),例如故障转移。

maxmemory-policy

string

数据超出内存限制时使用的逐出策略。

maxmemory-reserved

string

为每个分片的非缓存使用量保留的值(以 MB 为单位),例如故障转移。

preferred-data-archive-auth-method

string

与用于数据存档的存储帐户通信的首选身份验证方法,请指定 SAS 或 ManagedIdentity,默认值为 SAS

preferred-data-persistence-auth-method

string

用于与用于数据持久性的存储帐户通信的首选身份验证方法,请指定 SAS 或 ManagedIdentity,默认值为 SAS

rdb-backup-enabled

string

指定是否启用 rdb 备份

rdb-backup-frequency

string

指定创建 rdb 备份的频率(以分钟为单位)。 有效值: (15、30、60、360、720、1440)

rdb-backup-max-snapshot-count

string

指定 rdb 备份的最大快照数

rdb-storage-connection-string

string

用于存储 rdb 文件的存储帐户连接字符串

storage-subscription-id

string

使用 ManagedIdentity 进行持久性 (aof/rdb) 的存储帐户的 SubscriptionId。

zonal-configuration

string

区域配置

RedisInstanceDetails

redis 的单个实例的详细信息。

名称 类型 说明
isMaster

boolean

指定实例是否为主节点。

isPrimary

boolean

指定实例是否为主节点。

nonSslPort

integer

如果 enableNonSslPort 为 true,则提供 Redis 实例非 SSL 端口。

shardId

integer

如果启用了 聚类分析,则为 Redis 实例的分片 ID

sslPort

integer

Redis 实例 SSL 端口。

zone

string

如果缓存使用可用性区域,则指定此实例所在的可用性区域。

RedisLinkedServer

链接服务器 ID

名称 类型 说明
id

string

链接服务器 ID。

RedisListResult

list Redis 操作的响应。

名称 类型 说明
nextLink

string

下一页结果的链接。

value

RedisResource[]

Redis 缓存实例的列表。

RedisResource

列表或获取操作中的单个 Redis 项。

名称 类型 默认值 说明
enableNonSslPort

boolean

False

指定是否启用非 ssl Redis 服务器端口 (6379) 。

id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedServiceIdentity

资源的标识。

location

string

资源所在的地理位置

minimumTlsVersion

TlsVersion

可选:要求客户端使用指定的 TLS 版本 (或更高版本) 来连接 (,例如“1.0”、“1.1”、“1.2”)

name

string

资源的名称

properties.accessKeys

RedisAccessKeys

Redis 缓存的键 - 如果此对象不是创建或更新 redis 缓存的响应,则不设置

properties.hostName

string

Redis 主机名。

properties.instances

RedisInstanceDetails[]

与缓存关联的 Redis 实例列表

properties.linkedServers

RedisLinkedServer[]

与缓存关联的链接服务器列表

properties.port

integer

Redis 非 SSL 端口。

properties.privateEndpointConnections

PrivateEndpointConnection[]

与指定的 redis 缓存关联的专用终结点连接列表

properties.provisioningState

ProvisioningState

Redis 实例预配状态。

properties.sku

Sku

要部署的 Redis 缓存的 SKU。

properties.sslPort

integer

Redis SSL 端口。

properties.staticIP

string

静态 IP 地址。 (可选)在现有 Azure 虚拟网络中部署 Redis 缓存时指定 ;默认情况下自动分配。

properties.subnetId

string

虚拟网络中要在其中部署 Redis 缓存的子网的完整资源 ID。 示例格式:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft。{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1

publicNetworkAccess

PublicNetworkAccess

Enabled

是否允许对此缓存进行公共终结点访问。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”。 如果为“Disabled”,则专用终结点是独占访问方法。 默认值为“Enabled”

redisConfiguration

RedisConfiguration

所有 Redis 设置。 几个可能的密钥:rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-than、slowlog-max-len ,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value 等。

redisVersion

string

Redis 版本。 这应采用“major[.minor]”格式, (只需要“major”) 或值“latest”(表示可用的最新稳定 Redis 版本)。 支持的版本:4.0、6.0 (最新) 。 默认值为“latest”。

replicasPerMaster

integer

每个主数据库要创建的副本数。

replicasPerPrimary

integer

每个主数据库要创建的副本数。

shardCount

integer

在高级群集缓存上创建的分片数。

tags

object

资源标记。

tenantSettings

object

租户设置字典

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

updateChannel

UpdateChannel

可选:指定 Redis 缓存将接收的每月 Redis 更新的更新通道。 使用“预览”更新通道的缓存至少比“稳定”通道缓存早 4 周获取最新的 Redis 更新。 默认值为“Stable”。

zones

string[]

指示资源需要来自何处的可用性区域列表。

Sku

提供给创建 Redis 操作的 SKU 参数。

名称 类型 说明
capacity

integer

要部署的 Redis 缓存的大小。 有效值:对于 C (Basic/Standard) 系列 (0、1、2、3、4、5、6) ,对于 P (Premium) 系列 (1、2、3、4) 。

family

SkuFamily

要使用的 SKU 系列。 有效值: (C、P) 。 (C = 基本/标准,P = 高级) 。

name

SkuName

要部署的 Redis 缓存的类型。 有效值: (Basic、Standard、Premium)

SkuFamily

要使用的 SKU 系列。 有效值: (C、P) 。 (C = 基本/标准,P = 高级) 。

名称 类型 说明
C

string

P

string

SkuName

要部署的 Redis 缓存的类型。 有效值: (Basic、Standard、Premium)

名称 类型 说明
Basic

string

Premium

string

Standard

string

TlsVersion

可选:要求客户端使用指定的 TLS 版本 (或更高版本) 来连接 (,例如“1.0”、“1.1”、“1.2”)

名称 类型 说明
1.0

string

1.1

string

1.2

string

UpdateChannel

可选:指定 Redis 缓存将接收的每月 Redis 更新的更新通道。 使用“预览”更新通道的缓存至少比“稳定”通道缓存早 4 周获取最新的 Redis 更新。 默认值为“Stable”。

名称 类型 说明
Preview

string

Stable

string

UserAssignedIdentity

用户分配的标识属性

名称 类型 说明
clientId

string

已分配标识的客户端 ID。

principalId

string

分配的标识的主体 ID。