Redis Enterprise - Create

Referência

Serviço:: Redis Cache

Versão da API:: 2024-10-01

Cria ou atualiza um cluster de cache existente (substituir/recriar, com tempo de inatividade potencial)

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}?api-version=2024-10-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
clusterName	path	True	string	O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos Padrão Regex: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	A localização geográfica onde o recurso reside
sku	True	Sku	A SKU a ser criada, o que afeta o preço, o desempenho e os recursos.
identity		ManagedServiceIdentity	A identidade do recurso.
properties.encryption		Encryption	Configuração de criptografia em repouso para o cluster.
properties.minimumTlsVersion		TlsVersion	A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'
tags		object	Marcas de recurso.
zones		string[]	As Zonas de Disponibilidade em que esse cluster será implantado.

Respostas

Nome	Tipo	Description
200 OK	Cluster	O cluster estava/está sendo atualizado. Verifique provisioningState e resourceState para ver o status detalhado.
201 Created	Cluster	O cluster foi/está sendo criado. Verifique provisioningState e resourceState para ver o status detalhado.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

RedisEnterpriseCreate

Solicitação de exemplo

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1?api-version=2024-10-01

{
  "location": "West US",
  "sku": {
    "name": "EnterpriseFlash_F300",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {}
    }
  },
  "properties": {
    "minimumTlsVersion": "1.2",
    "encryption": {
      "customerManagedKeyEncryption": {
        "keyEncryptionKeyIdentity": {
          "identityType": "userAssignedIdentity",
          "userAssignedIdentityResourceId": "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity"
        },
        "keyEncryptionKeyUrl": "https://your-kv.vault.azure.net/keys/your-key/your-key-version"
      }
    }
  },
  "tags": {
    "tag1": "value1"
  }
}

Resposta de exemplo

Código de status:: 201

{
  "name": "cache1",
  "type": "Microsoft.Cache/redisEnterprise",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1",
  "location": "West US",
  "sku": {
    "name": "EnterpriseFlash_F300",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "hostName": "cache1.westus.something.azure.net",
    "redisVersion": "5",
    "minimumTlsVersion": "1.2",
    "encryption": {
      "customerManagedKeyEncryption": {
        "keyEncryptionKeyIdentity": {
          "userAssignedIdentityResourceId": "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity",
          "identityType": "userAssignedIdentity"
        },
        "keyEncryptionKeyUrl": "https://your-kv.vault.azure.net/keys/your-key/your-key-version"
      }
    }
  },
  "tags": {
    "tag1": "value1"
  }
}

Código de status:: 200

{
  "name": "cache1",
  "type": "Microsoft.Cache/redisEnterprise",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1",
  "location": "West US",
  "sku": {
    "name": "EnterpriseFlash_F300",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceState": "Running",
    "hostName": "cache1.westus.something.azure.net",
    "redisVersion": "5",
    "minimumTlsVersion": "1.2"
  },
  "tags": {
    "tag1": "value1"
  }
}

Definições

Nome	Description
Cluster	Descreve o cluster RedisEnterprise
CmkIdentityType	Somente userAssignedIdentity tem suporte nesta versão da API; outros tipos podem ter suporte no futuro
CustomerManagedKeyEncryption	Todas as propriedades de criptografia de chave gerenciada pelo cliente para o recurso. Defina isso como um objeto vazio para usar a criptografia de chave gerenciada pela Microsoft.
Encryption	Configuração de criptografia em repouso para o cluster.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
KeyEncryptionKeyIdentity	Toda a configuração de identidade para configurações de chave gerenciada pelo cliente definindo qual identidade deve ser usada para autenticar no Key Vault.
ManagedServiceIdentity	Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
PrivateEndpoint	O recurso de 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 do provisionamento atual
ResourceState	Status do recurso atual
Sku	Parâmetros de SKU fornecidos para a operação criar RedisEnterprise.
SkuName	O tipo de cluster RedisEnterprise a ser implantado. Valores possíveis: (Enterprise_E10, EnterpriseFlash_F300 etc.)
TlsVersion	A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

Cluster

Descreve o cluster RedisEnterprise

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	A identidade do recurso.
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties.encryption	Encryption	Configuração de criptografia em repouso para o cluster.
properties.hostName	string	Nome DNS do ponto de extremidade do cluster
properties.minimumTlsVersion	TlsVersion	A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'
properties.privateEndpointConnections	PrivateEndpointConnection[]	Lista de conexões de ponto de extremidade privado associadas ao cluster RedisEnterprise especificado
properties.provisioningState	ProvisioningState	Status de provisionamento atual do cluster
properties.redisVersion	string	A versão do redis dá suporte ao cluster, por exemplo, '6'
properties.resourceState	ResourceState	Status do recurso atual do cluster
sku	Sku	A SKU a ser criada, o que afeta o preço, o desempenho e os recursos.
tags	object	Marcas de recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"
zones	string[]	As Zonas de Disponibilidade em que esse cluster será implantado.

CmkIdentityType

Somente userAssignedIdentity tem suporte nesta versão da API; outros tipos podem ter suporte no futuro

Nome	Tipo	Description
systemAssignedIdentity	string
userAssignedIdentity	string

CustomerManagedKeyEncryption

Todas as propriedades de criptografia de chave gerenciada pelo cliente para o recurso. Defina isso como um objeto vazio para usar a criptografia de chave gerenciada pela Microsoft.

Nome	Tipo	Description
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	Toda a configuração de identidade para configurações de chave gerenciada pelo cliente definindo qual identidade deve ser usada para autenticar no Key Vault.
keyEncryptionKeyUrl	string	Url da chave de criptografia de chave, somente com versão. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

Configuração de criptografia em repouso para o cluster.

Nome	Tipo	Description
customerManagedKeyEncryption	CustomerManagedKeyEncryption	Todas as propriedades de criptografia de chave gerenciada pelo cliente para o recurso. Defina isso como um objeto vazio para usar a criptografia de chave gerenciada pela Microsoft.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

KeyEncryptionKeyIdentity

Toda a configuração de identidade para configurações de chave gerenciada pelo cliente definindo qual identidade deve ser usada para autenticar no Key Vault.

Nome	Tipo	Description
identityType	CmkIdentityType	Somente userAssignedIdentity tem suporte nesta versão da API; outros tipos podem ter suporte no futuro
userAssignedIdentityResourceId	string	Identidade atribuída pelo usuário a ser usada para acessar a URL da chave de criptografia de chave. Ex: /subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.}

ManagedServiceIdentity

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

Nome	Tipo	Description
principalId	string	A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
tenantId	string	A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	Identidades de User-Assigned O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do 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).

Nome	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

O recurso de ponto de extremidade privado.

Nome	Tipo	Description
id	string	O identificador do ARM para o ponto de extremidade privado

PrivateEndpointConnection

O recurso conexão de ponto de extremidade privado.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.privateEndpoint	PrivateEndpoint	O recurso do ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	O estado de provisionamento do recurso de conexão de ponto de extremidade privado.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

Nome	Tipo	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

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

Nome	Tipo	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.

Nome	Tipo	Description
actionsRequired	string	Uma mensagem que indica 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	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

ProvisioningState

Status do provisionamento atual

Nome	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ResourceState

Status do recurso atual

Nome	Tipo	Description
CreateFailed	string
Creating	string
DeleteFailed	string
Deleting	string
DisableFailed	string
Disabled	string
Disabling	string
EnableFailed	string
Enabling	string
Running	string
Scaling	string
ScalingFailed	string
UpdateFailed	string
Updating	string

Sku

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

Nome	Tipo	Description
capacity	integer	O tamanho do cluster RedisEnterprise. O padrão é 2 ou 3, dependendo da SKU. Os valores válidos são (2, 4, 6, ...) para SKUs Empresariais e (3, 9, 15, ...) para SKUs Flash.
name	SkuName	O tipo de cluster RedisEnterprise a ser implantado. Valores possíveis: (Enterprise_E10, EnterpriseFlash_F300 etc.)

SkuName

O tipo de cluster RedisEnterprise a ser implantado. Valores possíveis: (Enterprise_E10, EnterpriseFlash_F300 etc.)

Nome	Tipo	Description
EnterpriseFlash_F1500	string
EnterpriseFlash_F300	string
EnterpriseFlash_F700	string
Enterprise_E1	string
Enterprise_E10	string
Enterprise_E100	string
Enterprise_E20	string
Enterprise_E200	string
Enterprise_E400	string
Enterprise_E5	string
Enterprise_E50	string

TlsVersion

A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'

Nome	Tipo	Description
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Description
clientId	string	A ID do cliente da identidade atribuída.
principalId	string	A ID da entidade de segurança da identidade atribuída.

Compartilhar via