Compartir a través de

Base de datos Microsoft.DocumentDBAccounts/mongodbDatabases/collections/throughputSettings 2021-05-15

  • Artículo

Definición de recursos de Bicep

El tipo de recurso databaseAccounts/mongodbDatabases/collections/throughputSettings se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-05-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'default'
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

AutoscaleSettingsResource

Nombre Descripción Valor
autoUpgradePolicy Directiva de actualización automática de recursos de Cosmos DB AutoUpgradePolicyResource
maxThroughput Representa el contenedor de rendimiento máximo al que se puede escalar verticalmente. int (obligatorio)

AutoUpgradePolicyResource

Nombre Descripción Valor
throughputPolicy Representa la directiva de rendimiento a la que debe cumplir el servicio para la actualización automática. ThroughputPolicyResource

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

Nombre Descripción Valor
ubicación Ubicación del grupo de recursos al que pertenece el recurso. cuerda
nombre El nombre del recurso 'default' (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: databaseAccounts/mongodbDatabases/collections
Propiedades Propiedades para actualizar el rendimiento de los recursos de Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

Etiquetas

Nombre Descripción Valor

ThroughputPolicyResource

Nombre Descripción Valor
incrementPercent Representa el porcentaje por el que el rendimiento puede aumentar cada vez que se inicia la directiva de rendimiento. Int
isEnabled Determina si la propiedad ThroughputPolicy está activa o no. Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Nombre Descripción Valor
autoscaleSettings Recurso de Cosmos DB para la configuración de escalabilidad automática. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. autoscaleSettingsResource
Rendimiento Valor del rendimiento del recurso de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Nombre Descripción Valor
recurso El formato JSON estándar de un rendimiento de recursos ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (obligatorio)

Definición de recursos de plantilla de ARM

El tipo de recurso databaseAccounts/mongodbDatabases/collections/throughputSettings se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
  "apiVersion": "2021-05-15",
  "name": "string",
  "location": "string",
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

AutoscaleSettingsResource

Nombre Descripción Valor
autoUpgradePolicy Directiva de actualización automática de recursos de Cosmos DB AutoUpgradePolicyResource
maxThroughput Representa el contenedor de rendimiento máximo al que se puede escalar verticalmente. int (obligatorio)

AutoUpgradePolicyResource

Nombre Descripción Valor
throughputPolicy Representa la directiva de rendimiento a la que debe cumplir el servicio para la actualización automática. ThroughputPolicyResource

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

Nombre Descripción Valor
apiVersion La versión de api '2021-05-15'
ubicación Ubicación del grupo de recursos al que pertenece el recurso. cuerda
nombre El nombre del recurso 'default' (obligatorio)
Propiedades Propiedades para actualizar el rendimiento de los recursos de Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo El tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings'

Etiquetas

Nombre Descripción Valor

ThroughputPolicyResource

Nombre Descripción Valor
incrementPercent Representa el porcentaje por el que el rendimiento puede aumentar cada vez que se inicia la directiva de rendimiento. Int
isEnabled Determina si la propiedad ThroughputPolicy está activa o no. Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Nombre Descripción Valor
autoscaleSettings Recurso de Cosmos DB para la configuración de escalabilidad automática. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. autoscaleSettingsResource
Rendimiento Valor del rendimiento del recurso de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Nombre Descripción Valor
recurso El formato JSON estándar de un rendimiento de recursos ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (obligatorio)

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso databaseAccounts/mongodbDatabases/collections/throughputSettings se puede implementar con operaciones destinadas a:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-05-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
      }
    }
  })
}

Valores de propiedad

AutoscaleSettingsResource

Nombre Descripción Valor
autoUpgradePolicy Directiva de actualización automática de recursos de Cosmos DB AutoUpgradePolicyResource
maxThroughput Representa el contenedor de rendimiento máximo al que se puede escalar verticalmente. int (obligatorio)

AutoUpgradePolicyResource

Nombre Descripción Valor
throughputPolicy Representa la directiva de rendimiento a la que debe cumplir el servicio para la actualización automática. ThroughputPolicyResource

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

Nombre Descripción Valor
ubicación Ubicación del grupo de recursos al que pertenece el recurso. cuerda
nombre El nombre del recurso 'default' (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: databaseAccounts/mongodbDatabases/collections
Propiedades Propiedades para actualizar el rendimiento de los recursos de Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (obligatorio)
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta.
tipo El tipo de recurso "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-05-15"

Etiquetas

Nombre Descripción Valor

ThroughputPolicyResource

Nombre Descripción Valor
incrementPercent Representa el porcentaje por el que el rendimiento puede aumentar cada vez que se inicia la directiva de rendimiento. Int
isEnabled Determina si la propiedad ThroughputPolicy está activa o no. Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Nombre Descripción Valor
autoscaleSettings Recurso de Cosmos DB para la configuración de escalabilidad automática. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. autoscaleSettingsResource
Rendimiento Valor del rendimiento del recurso de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Nombre Descripción Valor
recurso El formato JSON estándar de un rendimiento de recursos ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (obligatorio)