Redis - Update

Atualizar um cache Redis existente.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}?api-version=2021-06-01

Parâmetros de URI

Name In Required Type Description
name
path True
  • string

O nome do cache Redis.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

subscriptionId
path True
  • string

obtém as credenciais de assinatura que identificam exclusivamente a assinatura Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API do cliente.

Corpo da solicitação

Name Type Description
identity

A identidade do recurso.

properties.enableNonSslPort
  • boolean

Especifica se a porta do servidor Redis não SSL (6379) está habilitada.

properties.minimumTlsVersion

Opcional: requer que os clientes usem uma versão de TLS especificada (ou superior) para se conectar (e, g, ' 1,0 ', ' 1,1 ', ' 1,2 ')

properties.publicNetworkAccess

Se o acesso ao ponto de extremidade público é permitido ou não para este cache. O valor é opcional, mas se passado em, deve ser ' Enabled ' ou ' disabled '. Se ' disabled ', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é ' Enabled '

properties.redisConfiguration

todos os Configurações Redis. Algumas chaves possíveis: RDB-backup-habilitado, RDB-Storage-Connection-String, RDB-backup-Frequency, MaxMemory-Delta, MaxMemory-Policy, notificate-keyspace-Events, MaxMemory-samples, SlowLog-log-lento-o, 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 etc.

properties.redisVersion
  • string

Versão Redis. Somente a versão principal será usada na solicitação PUT/PATCH com os valores válidos atuais: (4, 6)

properties.replicasPerMaster
  • integer

O número de réplicas a serem criadas por primário.

properties.replicasPerPrimary
  • integer

O número de réplicas a serem criadas por primário.

properties.shardCount
  • integer

o número de fragmentos a serem criados em um Premium Cache de Cluster.

properties.sku

A SKU do cache Redis a ser implantada.

properties.tenantSettings
  • object

Um dicionário de configurações de locatário

tags
  • object

Marcas de recurso.

Respostas

Name Type Description
200 OK

O cache Redis existente foi atualizado com êxito. Verifique provisioningState para ver o status detalhado.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

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 representar sua conta de usuário

Exemplos

RedisCacheUpdate

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1?api-version=2021-06-01
{
  "properties": {
    "enableNonSslPort": true,
    "replicasPerPrimary": 2
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
  "location": "West US",
  "name": "cache1",
  "type": "Microsoft.Cache/Redis",
  "tags": {},
  "properties": {
    "accessKeys": {
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>"
    },
    "provisioningState": "Succeeded",
    "redisVersion": "3.0",
    "sku": {
      "name": "Premium",
      "family": "P",
      "capacity": 1
    },
    "enableNonSslPort": true,
    "replicasPerMaster": 2,
    "replicasPerPrimary": 2,
    "redisConfiguration": {
      "maxclients": "1000",
      "maxmemory-reserved": "50",
      "maxmemory-delta": "50"
    },
    "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
      }
    ]
  }
}

Definições

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário)

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

PrivateEndpoint

O recurso ponto de extremidade privado.

PrivateEndpointConnection

O recurso conexão de ponto de extremidade privado.

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

PrivateEndpointServiceConnectionStatus

O status da conexão do ponto de extremidade privado.

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

ProvisioningState

Status de provisionamento da instância do Redis.

PublicNetworkAccess

Se o acesso ao ponto de extremidade público é permitido ou não para esse cache. O valor é opcional, mas, se passado, deve ser 'Habilitado' ou 'Desabilitado'. Se 'Desabilitado', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled'

RedisAccessKeys

Chaves de acesso do cache Redis.

RedisConfiguration

todos os Configurações Redis. Algumas chaves possíveis: RDB-backup-habilitado, RDB-Storage-Connection-String, RDB-backup-Frequency, MaxMemory-Delta, MaxMemory-Policy, notificate-keyspace-Events, MaxMemory-samples, SlowLog-log-lento-o, 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 etc.

RedisInstanceDetails

Detalhes da instância única do redis.

RedisLinkedServer

ID do servidor vinculado

RedisResource

Um único item Redis na operação de lista ou de obtenção.

RedisUpdateParameters

Parâmetros fornecidos para a operação Atualizar Redis.

Sku

Parâmetros de SKU fornecidos para a operação criar Redis.

SkuFamily

A família de SKU a ser usada. Valores válidos: (C, P). (C = Básico/Standard, P = Premium).

SkuName

O tipo de cache Redis a ser implantado. Valores válidos: (Básico, Standard, Premium)

TlsVersion

Opcional: exige que os clientes usem uma versão TLS especificada (ou superior) para se conectar (por exemplo, '1.0', '1.1', '1.2')

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Type Description
info
  • object

As informações adicionais.

type
  • string

O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name Type Description
additionalInfo

As informações adicionais do erro.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro.

ErrorResponse

Resposta de erro

Name Type Description
error

O objeto de erro.

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário)

Name Type Description
principalId
  • string

A ID da entidade de serviço da identidade atribuída ao sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.

tenantId
  • string

A ID de locatário da identidade atribuída ao sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.

type

Tipo de identidade de serviço gerenciada (onde os tipos SystemAssigned e userassigned são permitidos).

userAssignedIdentities

Identidades de User-Assigned
O conjunto de identidades atribuídas ao usuário associadas ao recurso. As chaves de dicionário userAssignedIdentities serão IDs de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ( {} ) em solicitações.

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

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

PrivateEndpoint

O recurso ponto de extremidade privado.

Name Type Description
id
  • string

O identificador arm para o ponto de extremidade privado

PrivateEndpointConnection

O recurso conexão de ponto de extremidade privado.

Name Type Description
id
  • string

ID de recurso totalmente qualificada para o recurso. Por ex- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

O nome do recurso

properties.privateEndpoint

O recurso do ponto de extremidade privado.

properties.privateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

properties.provisioningState

O estado de provisionamento do recurso de conexão de ponto de extremidade privado.

type
  • string

Tipo do recurso. Por ex.: "Microsoft.Compute/virtualMachines" ou "Microsoft. Armazenamento/storageAccounts"

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

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

PrivateEndpointServiceConnectionStatus

O status da conexão do ponto de extremidade privado.

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

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

Name Type Description
actionsRequired
  • string

Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor.

description
  • string

O motivo da aprovação/rejeição da conexão.

status

Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

ProvisioningState

Status de provisionamento da instância do 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

Se o acesso ao ponto de extremidade público é permitido ou não para esse cache. O valor é opcional, mas, se passado, deve ser 'Habilitado' ou 'Desabilitado'. Se 'Desabilitado', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled'

Name Type Description
Disabled
  • string
Enabled
  • string

RedisAccessKeys

Chaves de acesso do cache Redis.

Name Type Description
primaryKey
  • string

A chave primária atual que os clientes podem usar para autenticar com o cache Redis.

secondaryKey
  • string

A chave secundária atual que os clientes podem usar para autenticar com o cache Redis.

RedisConfiguration

todos os Configurações Redis. Algumas chaves possíveis: RDB-backup-habilitado, RDB-Storage-Connection-String, RDB-backup-Frequency, MaxMemory-Delta, MaxMemory-Policy, notificate-keyspace-Events, MaxMemory-samples, SlowLog-log-lento-o, 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 etc.

Name Type Description
aof-storage-connection-string-0
  • string

Primeira cadeia de conexão da conta de armazenamento

aof-storage-connection-string-1
  • string

Segunda cadeia de conexão da conta de armazenamento

maxclients
  • string

A configuração máxima de clientes

maxfragmentationmemory-reserved
  • string

Valor em megabytes reservado para fragmentação por fragmento

maxmemory-delta
  • string

Valor em megabytes reservado para uso não cache por fragmento, por exemplo, failover.

maxmemory-policy
  • string

A estratégia de remoção usada quando os dados não se ajustarem em seu limite de memória.

maxmemory-reserved
  • string

Valor em megabytes reservado para uso não cache por fragmento, por exemplo, failover.

preferred-data-archive-auth-method
  • string

Método de autenticação preferencial para se comunicar com a conta de armazenamento usada para arquivamento de dados, especificar SAS ou ManagedIdentity, o valor padrão é SAS

preferred-data-persistence-auth-method
  • string

Método de autenticação preferencial para se comunicar com a conta de armazenamento usada para persistência de dados, especificar SAS ou ManagedIdentity, o valor padrão é SAS

rdb-backup-enabled
  • string

Especifica se o backup do RDB está habilitado

rdb-backup-frequency
  • string

Especifica a frequência para criar o backup de RDB

rdb-backup-max-snapshot-count
  • string

Especifica o número máximo de instantâneos para backup de RDB

rdb-storage-connection-string
  • string

A cadeia de conexão da conta de armazenamento para armazenar o arquivo RDB

zonal-configuration
  • string

Configuração zonal

RedisInstanceDetails

Detalhes da instância única do redis.

Name Type Description
isMaster
  • boolean

Especifica se a instância é um nó primário.

isPrimary
  • boolean

Especifica se a instância é um nó primário.

nonSslPort
  • integer

Se enableNonSslPort for true, o fornece a porta não SSL da instância do Redis.

shardId
  • integer

Se o clustering estiver habilitado, a ID do fragmento da Instância redis

sslPort
  • integer

Porta SSL da instância do Redis.

zone
  • string

Se o Cache usar zonas de disponibilidade, especificará a zona de disponibilidade em que essa instância está localizada.

RedisLinkedServer

ID do servidor vinculado

Name Type Description
id
  • string

ID do servidor vinculado.

RedisResource

Um único item Redis na operação de lista ou de obtenção.

Name Type Description
enableNonSslPort
  • boolean

Especifica se a porta do servidor Redis não SSL (6379) está habilitada.

id
  • string

ID de recurso totalmente qualificada para o recurso. Ex-/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

A identidade do recurso.

location
  • string

A localização geográfica em que o recurso reside

minimumTlsVersion

Opcional: requer que os clientes usem uma versão de TLS especificada (ou superior) para se conectar (e, g, ' 1,0 ', ' 1,1 ', ' 1,2 ')

name
  • string

O nome do recurso

properties.accessKeys

As chaves do cache Redis-não serão definidas se esse objeto não for a resposta para criar ou atualizar o cache Redis

properties.hostName
  • string

Nome do host Redis.

properties.instances

Lista das instâncias de Redis associadas ao cache

properties.linkedServers

Lista dos servidores vinculados associados ao cache

properties.port
  • integer

Redis porta não SSL.

properties.privateEndpointConnections

Lista de conexões de ponto de extremidade privado associadas ao cache Redis especificado

properties.provisioningState

Status de provisionamento da instância Redis.

properties.sku

A SKU do cache Redis a ser implantada.

properties.sslPort
  • integer

Porta SSL Redis.

properties.staticIP
  • string

Endereço IP estático. Opcionalmente, pode ser especificado ao implantar um cache Redis dentro de uma rede virtual do Azure existente; atribuído automaticamente por padrão.

properties.subnetId
  • string

A ID de recurso completa de uma sub-rede em uma rede virtual para implantar o cache Redis no. Exemplo de formato:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Rede | ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1

publicNetworkAccess

Se o acesso ao ponto de extremidade público é permitido ou não para este cache. O valor é opcional, mas se passado em, deve ser ' Enabled ' ou ' disabled '. Se ' disabled ', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é ' Enabled '

redisConfiguration

todos os Configurações Redis. Algumas chaves possíveis: RDB-backup-habilitado, RDB-Storage-Connection-String, RDB-backup-Frequency, MaxMemory-Delta, MaxMemory-Policy, notificate-keyspace-Events, MaxMemory-samples, SlowLog-log-lento-o, 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 etc.

redisVersion
  • string

Versão Redis. Somente a versão principal será usada na solicitação PUT/PATCH com os valores válidos atuais: (4, 6)

replicasPerMaster
  • integer

O número de réplicas a serem criadas por primário.

replicasPerPrimary
  • integer

O número de réplicas a serem criadas por primário.

shardCount
  • integer

o número de fragmentos a serem criados em um Premium Cache de Cluster.

tags
  • object

Marcas de recurso.

tenantSettings
  • object

Um dicionário de configurações de locatário

type
  • string

Tipo do recurso. Por ex.: "Microsoft. Compute/virtualMachines" ou "Microsoft. Armazenamento/storageAccounts "

zones
  • string[]

Uma lista de zonas de disponibilidade que indicam de onde o recurso precisa vir.

RedisUpdateParameters

Parâmetros fornecidos para a operação Atualizar Redis.

Name Type Description
identity

A identidade do recurso.

properties.enableNonSslPort
  • boolean

Especifica se a porta do servidor Redis não ssl (6379) está habilitada.

properties.minimumTlsVersion

Opcional: exige que os clientes usem uma versão TLS especificada (ou superior) para se conectar (por exemplo, '1.0', '1.1', '1.2')

properties.publicNetworkAccess

Se o acesso ao ponto de extremidade público é permitido ou não para esse cache. O valor é opcional, mas, se passado, deve ser 'Habilitado' ou 'Desabilitado'. Se 'Desabilitado', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled'

properties.redisConfiguration

Todos os redis Configurações. Poucas chaves possíveis: 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 etc.

properties.redisVersion
  • string

Versão Redis. Somente a versão principal será usada na solicitação PUT/PATCH com valores válidos atuais: (4, 6)

properties.replicasPerMaster
  • integer

O número de réplicas a serem criadas por primário.

properties.replicasPerPrimary
  • integer

O número de réplicas a serem criadas por primário.

properties.shardCount
  • integer

O número de fragmentos a serem criados em um cache Premium cluster.

properties.sku

O SKU do cache Redis a ser implantado.

properties.tenantSettings
  • object

Um dicionário de configurações de locatário

tags
  • object

Marcas de recurso.

Sku

Parâmetros de SKU fornecidos para a operação criar Redis.

Name Type Description
capacity
  • integer

O tamanho do cache Redis a ser implantado. valores válidos: para a família C (Basic/Standard) (0, 1, 2, 3, 4, 5, 6), para a família P (Premium) (1, 2, 3, 4).

family

A família de SKU a ser usada. Valores válidos: (C, P). (C = Basic/Standard, P = Premium).

name

O tipo de cache Redis a ser implantado. Valores válidos: (Basic, Standard Premium)

SkuFamily

A família de SKU a ser usada. Valores válidos: (C, P). (C = Básico/Standard, P = Premium).

Name Type Description
C
  • string
P
  • string

SkuName

O tipo de cache Redis a ser implantado. Valores válidos: (Básico, Standard, Premium)

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

TlsVersion

Opcional: exige que os clientes usem uma versão TLS especificada (ou superior) para se conectar (por exemplo, '1.0', '1.1', '1.2')

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

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Name Type Description
clientId
  • string

A ID do cliente da identidade atribuída.

principalId
  • string

A ID da entidade de identidade atribuída.