你当前正在访问 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=2021-06-01

URI 参数

Name In Required Type Description
subscriptionId
path True
  • string

获取唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

客户端 API 版本。

响应

Name Type Description
200 OK
Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

RedisCacheList

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/redis?api-version=2021-06-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,
        "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

列表 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”)

UserAssignedIdentity

用户分配的标识属性

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

ManagedServiceIdentity

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

Name Type Description
principalId
  • string

系统分配标识的服务主体 ID。 此属性仅适用于系统分配的标识。

tenantId
  • string

系统分配标识的租户 ID。 此属性仅适用于系统分配的标识。

type

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

userAssignedIdentities

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

ManagedServiceIdentityType

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

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

PrivateEndpoint

专用终结点资源。

Name Type Description
id
  • string

专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

Name Type Description
id
  • string

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

name
  • string

资源的名称

properties.privateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

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

properties.provisioningState

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

type
  • string

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

PrivateEndpointConnectionProvisioningState

当前预配状态。

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

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

Name Type Description
actionsRequired
  • string

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

description
  • string

批准/拒绝连接的原因。

status

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

ProvisioningState

Redis 实例预配状态。

Name Type Description
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”

Name Type Description
Disabled
  • string
Enabled
  • string

RedisAccessKeys

Redis 缓存访问密钥。

Name Type Description
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 等。

Name Type Description
aof-backup-enabled
  • string

指定是否启用 aof 备份

aof-storage-connection-string-0
  • string

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

aof-storage-connection-string-1
  • string

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

authnotrequired
  • string

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

maxclients
  • string

最大客户端配置

maxfragmentationmemory-reserved
  • string

为每个分片分段保留的 MB 值

maxmemory-delta
  • string

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

maxmemory-policy
  • string

数据不符合其内存限制时使用的逐出策略。

maxmemory-reserved
  • string

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

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 备份的频率

rdb-backup-max-snapshot-count
  • string

指定 rdb 备份的最大快照数

rdb-storage-connection-string
  • string

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

zonal-configuration
  • string

区域配置

RedisInstanceDetails

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

Name Type Description
isMaster
  • boolean

指定实例是否为主节点。

isPrimary
  • boolean

指定实例是否为主节点。

nonSslPort
  • integer

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

shardId
  • integer

如果已启用群集,则 Redis 实例的分片 ID

sslPort
  • integer

Redis 实例 SSL 端口。

zone
  • string

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

RedisLinkedServer

链接服务器 ID

Name Type Description
id
  • string

链接的服务器 ID。

RedisListResult

列表 Redis 操作的响应。

Name Type Description
nextLink
  • string

下一页结果的链接。

value

Redis 缓存实例列表。

RedisResource

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

Name Type Default Value Description
enableNonSslPort
  • boolean
False

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

id
  • string

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

identity

资源的标识。

location
  • string

资源所在的地理位置

minimumTlsVersion

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

name
  • string

资源的名称

properties.accessKeys

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

properties.hostName
  • string

Redis 主机名。

properties.instances

与缓存关联的 Redis 实例列表

properties.linkedServers

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

properties.port
  • integer

Redis 非 SSL 端口。

properties.privateEndpointConnections

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

properties.provisioningState

Redis 实例预配状态。

properties.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 Enabled

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

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[.build]]”的形式, (只需要“major”) 或值“latest”,该值引用可用的最新稳定 Redis 版本。 仅在 PUT/PATCH 请求中使用主版本和次要版本。 支持的版本:4.0、6.0。

replicasPerMaster
  • integer

要为每个主要副本创建的副本数。

replicasPerPrimary
  • integer

要为每个主要副本创建的副本数。

shardCount
  • integer

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

tags
  • object

资源标记。

tenantSettings
  • object

租户设置字典

type
  • string

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

zones
  • string[]

表示资源需要从何处获取的可用性区域的列表。

Sku

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

Name Type Description
capacity
  • integer

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

family

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

name

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

SkuFamily

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

Name Type Description
C
  • string
P
  • string

SkuName

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

Name Type Description
Basic
  • string
Premium
  • string
Standard
  • string

TlsVersion

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

Name Type Description
1.0
  • string
1.1
  • string
1.2
  • string

UserAssignedIdentity

用户分配的标识属性

Name Type Description
clientId
  • string

分配的标识的客户端 ID。

principalId
  • string

分配的标识的主体 ID。