Partilhar via


Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections/throughputSettings 2024-09-01-preview

Definição de recursos do bíceps

O tipo de recurso databaseAccounts/mongodbDatabases/collections/throughputSettings pode ser implantado com operações direcionadas:

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

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

AutoscaleSettingsResource

Designação Descrição Valor
autoUpgradePolicy Política de atualização automática de recursos do Cosmos DB AutoUpgradePolicyResource
maxTaxa de transferência Representa a taxa de transferência máxima que o contêiner pode dimensionar. int (obrigatório)

AutoUpgradePolicyResource

Designação Descrição Valor
taxa de transferênciaPolítica Representa a política de taxa de transferência à qual o serviço deve aderir para atualização automática ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

ManagedServiceIdentity

Designação Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

Designação Descrição Valor
identidade Identidade do recurso. ManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso 'default' (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para recurso do tipo: databaseAccounts/mongodbDatabases/collections
propriedades Propriedades para atualizar a taxa de transferência de recursos do Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

Etiquetas

Designação Descrição Valor

ThroughputPolicyResource

Designação Descrição Valor
incrementoPercentagem Representa a porcentagem pela qual a taxa de transferência pode aumentar sempre que a política de taxa de transferência é iniciada. Int
isEnabled Determina se a ThroughputPolicy está ativa ou não Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Designação Descrição Valor
autoscaleConfigurações Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou o autoscaleSettings é necessário, mas não ambos. AutoscaleSettingsResource
taxa de transferência Valor da taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o autoscaleSettings é necessário, mas não ambos. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Designação Descrição Valor
recurso O formato JSON padrão de uma taxa de transferência de recursos ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (obrigatório)

Definição de recurso de modelo ARM

O tipo de recurso databaseAccounts/mongodbDatabases/collections/throughputSettings pode ser implantado com operações direcionadas:

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

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
  "apiVersion": "2024-09-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

AutoscaleSettingsResource

Designação Descrição Valor
autoUpgradePolicy Política de atualização automática de recursos do Cosmos DB AutoUpgradePolicyResource
maxTaxa de transferência Representa a taxa de transferência máxima que o contêiner pode dimensionar. int (obrigatório)

AutoUpgradePolicyResource

Designação Descrição Valor
taxa de transferênciaPolítica Representa a política de taxa de transferência à qual o serviço deve aderir para atualização automática ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

ManagedServiceIdentity

Designação Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

Designação Descrição Valor
apiVersion A versão api '2024-09-01-pré-visualização'
identidade Identidade do recurso. ManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso 'default' (obrigatório)
propriedades Propriedades para atualizar a taxa de transferência de recursos do Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings'

Etiquetas

Designação Descrição Valor

ThroughputPolicyResource

Designação Descrição Valor
incrementoPercentagem Representa a porcentagem pela qual a taxa de transferência pode aumentar sempre que a política de taxa de transferência é iniciada. Int
isEnabled Determina se a ThroughputPolicy está ativa ou não Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Designação Descrição Valor
autoscaleConfigurações Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou o autoscaleSettings é necessário, mas não ambos. AutoscaleSettingsResource
taxa de transferência Valor da taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o autoscaleSettings é necessário, mas não ambos. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Designação Descrição Valor
recurso O formato JSON padrão de uma taxa de transferência de recursos ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (obrigatório)

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso databaseAccounts/mongodbDatabases/collections/throughputSettings pode ser implantado com operações direcionadas:

  • Grupos de recursos

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

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

AutoscaleSettingsResource

Designação Descrição Valor
autoUpgradePolicy Política de atualização automática de recursos do Cosmos DB AutoUpgradePolicyResource
maxTaxa de transferência Representa a taxa de transferência máxima que o contêiner pode dimensionar. int (obrigatório)

AutoUpgradePolicyResource

Designação Descrição Valor
taxa de transferênciaPolítica Representa a política de taxa de transferência à qual o serviço deve aderir para atualização automática ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

ManagedServiceIdentity

Designação Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

Designação Descrição Valor
identidade Identidade do recurso. ManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso 'default' (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: databaseAccounts/mongodbDatabases/collections
propriedades Propriedades para atualizar a taxa de transferência de recursos do Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2024-09-01-preview"

Etiquetas

Designação Descrição Valor

ThroughputPolicyResource

Designação Descrição Valor
incrementoPercentagem Representa a porcentagem pela qual a taxa de transferência pode aumentar sempre que a política de taxa de transferência é iniciada. Int
isEnabled Determina se a ThroughputPolicy está ativa ou não Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Designação Descrição Valor
autoscaleConfigurações Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou o autoscaleSettings é necessário, mas não ambos. AutoscaleSettingsResource
taxa de transferência Valor da taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o autoscaleSettings é necessário, mas não ambos. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Designação Descrição Valor
recurso O formato JSON padrão de uma taxa de transferência de recursos ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (obrigatório)