Partilhar via


Microsoft.Cache redisEnterprise 2023-03-01-preview

Definição de recurso do Bicep

O tipo de recurso redisEnterprise pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Cache/redisEnterprise, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Cache/redisEnterprise@2023-03-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    encryption: {
      customerManagedKeyEncryption: {
        keyEncryptionKeyIdentity: {
          identityType: 'string'
          userAssignedIdentityResourceId: 'string'
        }
        keyEncryptionKeyUrl: 'string'
      }
    }
    minimumTlsVersion: 'string'
  }
  zones: [
    'string'
  ]
}

Valores de propriedade

redisEnterprise

Nome Descrição Valor
name O nome do recurso cadeia (obrigatório)
localização A localização geográfica onde o recurso se encontra cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku O SKU a criar, que afeta o preço, o desempenho e as funcionalidades. SKU (obrigatório)
identidade A identidade do recurso. ManagedServiceIdentity
propriedades Outras propriedades do cluster. ClusterProperties
zonas O Zonas de Disponibilidade onde este cluster será implementado. cadeia[]

ManagedServiceIdentity

Nome Descrição Valor
tipo Tipo de identidade de serviço gerida (onde os tipos SystemAssigned e UserAssigned são permitidos). "Nenhum"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned" (obrigatório)
userAssignedIdentities O conjunto de identidades atribuídas pelo utilizador associadas ao recurso. As chaves de dicionário userAssignedIdentities serão IDs de recursos do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) nos pedidos. UserAssignedIdentities

UserAssignedIdentities

Nome Descrição Valor
{customized property} UserAssignedIdentity

UserAssignedIdentity

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

ClusterProperties

Nome Descrição Valor
Encriptação Configuração de encriptação inativa para o cluster. ClusterPropertiesEncryption
minimumTlsVersion A versão mínima do TLS para o cluster suportar, por exemplo, "1.2" '1.0'
'1.1'
'1.2'

ClusterPropertiesEncryption

Nome Descrição Valor
customerManagedKeyEncryption Todas as propriedades de encriptação de chaves geridas pelo cliente para o recurso. Defina isto como um objeto vazio para utilizar a encriptação de chaves gerida pela Microsoft. ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

Nome Descrição Valor
keyEncryptionKeyIdentity Toda a configuração de identidade para definições de chaves geridas pelo cliente que definem a identidade que deve ser utilizada para autenticar para Key Vault. ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...
keyEncryptionKeyUrl Url da chave de encriptação de chaves, apenas com versão. Por exemplo: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 string

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

Nome Descrição Valor
identityType Apenas userAssignedIdentity é suportado nesta versão da API; outros tipos podem ser suportados no futuro "systemAssignedIdentity"
"userAssignedIdentity"
userAssignedIdentityResourceId Identidade atribuída pelo utilizador a utilizar para aceder ao URL da chave de encriptação de chaves. Por exemplo: /subscriptions/{sub uuid}/resourceGroups/{resource group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. string

Sku

Nome Descrição Valor
capacidade O tamanho do cluster RedisEnterprise. A predefinição é 2 ou 3 consoante o SKU. Os valores válidos são (2, 4, 6, ...) para SKUs empresariais e (3, 9, 15, ...) para SKUs Flash. int
name O tipo de cluster RedisEnterprise a implementar. Valores possíveis: (Enterprise_E10, EnterpriseFlash_F300 etc.) 'EnterpriseFlash_F1500'
'EnterpriseFlash_F300'
'EnterpriseFlash_F700'
'Enterprise_E10'
'Enterprise_E100'
'Enterprise_E20'
"Enterprise_E50" (obrigatório)

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Redis Enterprise com Vetor DB

Implementar no Azure
Este modelo cria uma Cache de Redis que pode ser utilizada como DB de Vetor para armazenar e consultar incorporações através de índices. Para esta funcionalidade, o módulo Redis Search é ativado no Azure Redis

Definição de recurso de modelo do ARM

O tipo de recurso redisEnterprise pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Cache/redisEnterprise, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Cache/redisEnterprise",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "encryption": {
      "customerManagedKeyEncryption": {
        "keyEncryptionKeyIdentity": {
          "identityType": "string",
          "userAssignedIdentityResourceId": "string"
        },
        "keyEncryptionKeyUrl": "string"
      }
    },
    "minimumTlsVersion": "string"
  },
  "zones": [ "string" ]
}

Valores de propriedade

redisEnterprise

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Cache/redisEnterprise"
apiVersion A versão da API de recursos "2023-03-01-preview"
name O nome do recurso cadeia (obrigatório)
localização A localização geográfica onde o recurso se encontra cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku O SKU a criar, que afeta o preço, o desempenho e as funcionalidades. SKU (obrigatório)
identidade A identidade do recurso. ManagedServiceIdentity
propriedades Outras propriedades do cluster. ClusterProperties
zonas O Zonas de Disponibilidade onde este cluster será implementado. cadeia[]

ManagedServiceIdentity

Nome Descrição Valor
tipo Tipo de identidade de serviço gerida (onde os tipos SystemAssigned e UserAssigned são permitidos). "Nenhum"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned" (obrigatório)
userAssignedIdentities O conjunto de identidades atribuídas pelo utilizador associadas ao recurso. As chaves de dicionário userAssignedIdentities serão IDs de recursos do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) nos pedidos. UserAssignedIdentities

UserAssignedIdentities

Nome Descrição Valor
{customized property} UserAssignedIdentity

UserAssignedIdentity

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

ClusterProperties

Nome Descrição Valor
Encriptação Configuração de encriptação inativa para o cluster. ClusterPropertiesEncryption
minimumTlsVersion A versão mínima do TLS para o cluster suportar, por exemplo, "1.2" '1.0'
'1.1'
'1.2'

ClusterPropertiesEncryption

Nome Descrição Valor
customerManagedKeyEncryption Todas as propriedades de encriptação de chaves geridas pelo cliente para o recurso. Defina-o como um objeto vazio para utilizar a encriptação de chaves gerida pela Microsoft. ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

Nome Descrição Valor
keyEncryptionKeyIdentity Toda a configuração de identidade para definições de chaves geridas pelo cliente que definem que identidade deve ser utilizada para autenticar para Key Vault. ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...
keyEncryptionKeyUrl URL da chave de encriptação de chaves, apenas com versão. Por exemplo: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 string

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

Nome Descrição Valor
identityType Apenas userAssignedIdentity é suportado nesta versão da API; outros tipos podem ser suportados no futuro "systemAssignedIdentity"
"userAssignedIdentity"
userAssignedIdentityResourceId Identidade atribuída pelo utilizador a utilizar para aceder ao URL da chave de encriptação de chaves. Por exemplo: /subscriptions/{sub uuid}/resourceGroups/{resource group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. string

Sku

Nome Descrição Valor
capacidade O tamanho do cluster RedisEnterprise. A predefinição é 2 ou 3 consoante o SKU. Os valores válidos são (2, 4, 6, ...) para SKUs Empresariais e (3, 9, 15, ...) para SKUs Flash. int
name O tipo de cluster RedisEnterprise a implementar. Valores possíveis: (Enterprise_E10, EnterpriseFlash_F300 etc.) 'EnterpriseFlash_F1500'
'EnterpriseFlash_F300'
'EnterpriseFlash_F700'
'Enterprise_E10'
'Enterprise_E100'
'Enterprise_E20'
'Enterprise_E50' (obrigatório)

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Redis Enterprise com BD de Vetor

Implementar no Azure
Este modelo cria uma Cache de Redis que pode ser utilizada como BD de Vetor para armazenar e consultar incorporações através de índices. Para esta funcionalidade, o módulo Redis Search está ativado no Azure Redis

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso redisEnterprise pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.Cache/redisEnterprise, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redisEnterprise@2023-03-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      encryption = {
        customerManagedKeyEncryption = {
          keyEncryptionKeyIdentity = {
            identityType = "string"
            userAssignedIdentityResourceId = "string"
          }
          keyEncryptionKeyUrl = "string"
        }
      }
      minimumTlsVersion = "string"
    }
    zones = [
      "string"
    ]
    sku = {
      capacity = int
      name = "string"
    }
  })
}

Valores de propriedade

redisEnterprise

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Cache/redisEnterprise@2023-03-01-preview"
name O nome do recurso cadeia (obrigatório)
localização A localização geográfica onde reside o recurso cadeia (obrigatório)
parent_id Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas.
sku O SKU a criar, que afeta o preço, o desempenho e as funcionalidades. SKU (obrigatório)
identidade A identidade do recurso. ManagedServiceIdentity
propriedades Outras propriedades do cluster. ClusterProperties
zonas O Zonas de Disponibilidade onde este cluster será implementado. cadeia[]

ManagedServiceIdentity

Nome Descrição Valor
tipo Tipo de identidade de serviço gerida (onde os tipos SystemAssigned e UserAssigned são permitidos). "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned" (obrigatório)
identity_ids O conjunto de identidades atribuídas pelo utilizador associadas ao recurso. As chaves de dicionário userAssignedIdentities serão IDs de recursos do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) nos pedidos. Matriz de IDs de identidade de utilizador.

UserAssignedIdentities

Nome Descrição Valor
{customized property} UserAssignedIdentity

UserAssignedIdentity

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

ClusterProperties

Nome Descrição Valor
Encriptação Configuração de encriptação inativa para o cluster. ClusterPropertiesEncryption
minimumTlsVersion A versão mínima do TLS para o cluster suportar, por exemplo, "1.2" "1.0"
"1.1"
"1.2"

ClusterPropertiesEncryption

Nome Descrição Valor
customerManagedKeyEncryption Todas as propriedades de encriptação de chaves geridas pelo cliente para o recurso. Defina isto como um objeto vazio para utilizar a encriptação de chaves gerida pela Microsoft. ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

Nome Descrição Valor
keyEncryptionKeyIdentity Toda a configuração de identidade para definições de chaves geridas pelo cliente que definem a identidade que deve ser utilizada para autenticar para Key Vault. ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...
keyEncryptionKeyUrl Url da chave de encriptação de chaves, apenas com versão. Por exemplo: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 string

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

Nome Descrição Valor
identityType Apenas userAssignedIdentity é suportado nesta versão da API; outros tipos podem ser suportados no futuro "systemAssignedIdentity"
"userAssignedIdentity"
userAssignedIdentityResourceId Identidade atribuída pelo utilizador a utilizar para aceder ao URL da chave de encriptação de chaves. Por exemplo: /subscriptions/{sub uuid}/resourceGroups/{resource group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. string

Sku

Nome Descrição Valor
capacidade O tamanho do cluster RedisEnterprise. A predefinição é 2 ou 3 consoante o SKU. Os valores válidos são (2, 4, 6, ...) para SKUs empresariais e (3, 9, 15, ...) para SKUs Flash. int
name O tipo de cluster RedisEnterprise a implementar. Valores possíveis: (Enterprise_E10, EnterpriseFlash_F300 etc.) "EnterpriseFlash_F1500"
"EnterpriseFlash_F300"
"EnterpriseFlash_F700"
"Enterprise_E10"
"Enterprise_E100"
"Enterprise_E20"
"Enterprise_E50" (obrigatório)