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 do URI

Name	Em	Necessá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 hífen(-). Não pode haver liderança, nem descida, nem hífenes consecutivas 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 do Pedido

Name	Necessário	Tipo	Description
location	True	string	A geolocalização onde o recurso vive
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 TLS mínima para o cluster suportar, por exemplo, '1.2'
tags		object	Tags de recursos.
zones		string[]	As zonas de disponibilidade onde esse cluster será implantado.

Respostas

Name	Tipo	Description
200 OK	Cluster	O cluster foi/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 descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

RedisEnterpriseCreate

Pedido de amostra

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 da amostra

Código de estado:: 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 estado:: 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

Name	Description
Cluster	Descreve o cluster RedisEnterprise
CmkIdentityType	Somente userAssignedIdentity é suportado nesta versão da API; Outros tipos podem ser suportados no futuro
CustomerManagedKeyEncryption	Todas as propriedades de criptografia de chave gerenciadas 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	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
KeyEncryptionKeyIdentity	Toda a configuração de identidade para configurações de chave gerenciadas pelo cliente definindo qual identidade deve ser usada para autenticação no Cofre de Chaves.
ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
PrivateEndpoint	O recurso Ponto Final Privado.
PrivateEndpointConnection	O recurso Private Endpoint Connection.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointServiceConnectionStatus	O status da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
ProvisioningState	Status atual do provisionamento
ResourceState	Status atual do recurso
Sku	Parâmetros de SKU fornecidos para a operação create RedisEnterprise.
SkuName	O tipo de cluster RedisEnterprise a ser implantado. Valores possíveis: (Enterprise_E10, EnterpriseFlash_F300 etc.)
TlsVersion	A versão TLS mínima para o cluster suportar, por exemplo, '1.2'
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

Cluster

Descreve o cluster RedisEnterprise

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	A identidade do recurso.
location	string	A geolocalização onde o recurso vive
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 TLS mínima para o cluster suportar, por exemplo, '1.2'
properties.privateEndpointConnections	PrivateEndpointConnection[]	Lista de conexões de ponto de extremidade privadas associadas ao cluster RedisEnterprise especificado
properties.provisioningState	ProvisioningState	Status de provisionamento atual do cluster
properties.redisVersion	string	Versão do redis que o cluster suporta, por exemplo, '6'
properties.resourceState	ResourceState	Status atual do recurso do cluster
sku	Sku	A SKU a ser criada, o que afeta o preço, o desempenho e os recursos.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"
zones	string[]	As zonas de disponibilidade onde esse cluster será implantado.

CmkIdentityType

Somente userAssignedIdentity é suportado nesta versão da API; Outros tipos podem ser suportados no futuro

Name	Tipo	Description
systemAssignedIdentity	string
userAssignedIdentity	string

CustomerManagedKeyEncryption

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

Name	Tipo	Description
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	Toda a configuração de identidade para configurações de chave gerenciadas pelo cliente definindo qual identidade deve ser usada para autenticação no Cofre de Chaves.
keyEncryptionKeyUrl	string	URL da chave de encriptação da chave, apenas versionada. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

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

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

ErrorAdditionalInfo

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

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

KeyEncryptionKeyIdentity

Toda a configuração de identidade para configurações de chave gerenciadas pelo cliente definindo qual identidade deve ser usada para autenticação no Cofre de Chaves.

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

ManagedServiceIdentity

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

Name	Tipo	Description
principalId	string	O ID da entidade de serviço da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
tenantId	string	O ID do locatário da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identidades O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do 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 (onde os tipos SystemAssigned e UserAssigned são permitidos).

Name	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

O recurso Ponto Final Privado.

Name	Tipo	Description
id	string	O identificador ARM para Private Endpoint

PrivateEndpointConnection

O recurso Private Endpoint Connection.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado 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 final privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
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.

Name	Tipo	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

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

Name	Tipo	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.

Name	Tipo	Description
actionsRequired	string	Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor.
description	string	O motivo da aprovação/rejeição da ligação.
status	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

ProvisioningState

Status atual do provisionamento

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

ResourceState

Status atual do recurso

Name	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 create RedisEnterprise.

Name	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 Enterprise SKUs e (3, 9, 15, ...) para Flash SKUs.
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.)

Name	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 TLS mínima para o cluster suportar, por exemplo, '1.2'

Name	Tipo	Description
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Name	Tipo	Description
clientId	string	O ID do cliente da identidade atribuída.
principalId	string	O ID principal da identidade atribuída.

Partilhar via