Compartir a través de

Base de datos Microsoft.DocumentDBAccounts/mongodbDatabases/throughputSettings 2024-05-15-preview

  • Artículo

Definición de recursos de Bicep

El tipo de recurso databaseAccounts/mongodbDatabases/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 los recursos

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2024-05-15-preview' = {
  name: 'default'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
    }
  }
}

Valores de propiedad

databaseAccounts/mongodbDatabases/throughputSettings

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 'default'
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
primario 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 más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: mongodbDatabases
identidad Identidad del recurso. ManagedServiceIdentity
properties Propiedades para actualizar el rendimiento de recursos de Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (obligatorio)

ManagedServiceIdentity

Nombre Descripción Value
type Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned", UserAssigned incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. 'Ninguno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Nombre Descripción Valor
resource Formato JSON estándar de un rendimiento de recursos ThroughputSettingsResourceOrThroughputSettingsGetPro... (obligatorio)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Nombre Descripción Valor
autoscaleSettings Recurso de Cosmos DB para la configuración de escalado automático. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. AutoscaleSettingsResource
throughput Valor del rendimiento del recurso de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. int

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

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 El valor de ThroughputPolicy está activo o no bool

Definición de recursos de plantilla de ARM

El tipo de recurso databaseAccounts/mongodbDatabases/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 los recursos

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
  "apiVersion": "2024-05-15-preview",
  "name": "default",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int"
    }
  }
}

Valores de propiedad

databaseAccounts/mongodbDatabases/throughputSettings

Nombre Descripción Value
type Tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings'
apiVersion La versión de la API de recursos "2024-05-15-preview"
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM JSON.		 'default'
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
identidad Identidad del recurso. ManagedServiceIdentity
properties Propiedades para actualizar el rendimiento de recursos de Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (obligatorio)

ManagedServiceIdentity

Nombre Descripción Value
type Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned", UserAssigned incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. 'Ninguno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Nombre Descripción Valor
resource Formato JSON estándar de un rendimiento de recursos ThroughputSettingsResourceOrThroughputSettingsGetPro... (obligatorio)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Nombre Descripción Valor
autoscaleSettings Recurso de Cosmos DB para la configuración de escalado automático. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. AutoscaleSettingsResource
throughput Valor del rendimiento del recurso de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. int

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

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 El valor de ThroughputPolicy está activo o no bool

Definición de recursos de Terraform (proveedor AzAPI)

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

  • Grupos de recursos

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

Formato de los recursos

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2024-05-15-preview"
  name = "default"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
      }
    }
  })
}

Valores de propiedad

databaseAccounts/mongodbDatabases/throughputSettings

Nombre Descripción Value
type Tipo de recurso "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2024-05-15-preview"
name El nombre del recurso "predeterminado"
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: mongodbDatabases
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta.
identidad Identidad del recurso. ManagedServiceIdentity
properties Propiedades para actualizar el rendimiento de recursos de Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (obligatorio)

ManagedServiceIdentity

Nombre Descripción Value
type Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned", UserAssigned incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Matriz de identificadores de identidad de usuario.

ManagedServiceIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Nombre Descripción Valor
resource Formato JSON estándar de un rendimiento de recursos ThroughputSettingsResourceOrThroughputSettingsGetPro... (obligatorio)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Nombre Descripción Valor
autoscaleSettings Recurso de Cosmos DB para la configuración de escalado automático. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. AutoscaleSettingsResource
throughput Valor del rendimiento del recurso de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos. int

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

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 El valor de ThroughputPolicy está activo o no bool