Compartilhar via

Banco de dados Microsoft.DocumentDBAccounts/mongodbDatabases/collections/throughputSettings 2024-02-15-preview

  • Artigo

Definição de recurso do Bicep

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

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

Formato de recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2024-02-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 propriedade

databaseAccounts/mongodbDatabases/collections/throug...

Name Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.		 'default'
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Confira Marcas em modelos
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 o recurso do tipo: coleções
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para atualizar a taxa de transferência de recursos do Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (obrigatório)

ManagedServiceIdentity

Name 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 'None' removerá todas as identidades do serviço. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name Descrição Valor
recurso O formato JSON padrão de uma taxa de transferência de recurso ThroughputSettingsResourceOrThroughputSettingsGetPro... (obrigatório)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name Descrição Valor
autoscaleSettings Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou dimensionamento automáticoConfigurações é necessária, mas não ambas. AutoscaleSettingsResource
throughput Valor da taxa de transferência do recurso do Cosmos DB. A taxa de transferência é necessária ou dimensionamento automáticoConfigurações é necessária, mas não ambas. INT

AutoscaleSettingsResource

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

AutoUpgradePolicyResource

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

ThroughputPolicyResource

Name Descrição Valor
incrementPercent Representa o percentual pelo 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

Definição de recurso de modelo do 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 de recurso

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
  "apiVersion": "2024-02-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 propriedade

databaseAccounts/mongodbDatabases/collections/throug...

Name Descrição Valor
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings'
apiVersion A versão da API de recursos '2024-02-15-preview'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.		 'default'
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). No máximo 15 marcas podem ser fornecidas para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para atualizar a taxa de transferência de recursos do Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (obrigatório)

ManagedServiceIdentity

Name 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 'None' removerá as identidades do serviço. 'None'
'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 do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name Descrição Valor
recurso O formato JSON padrão de uma taxa de transferência de recurso ThroughputSettingsResourceOrThroughputSettingsGetPro... (obrigatório)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name Descrição Valor
autoscaleSettings Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou dimensionamento automáticoConfigurações é necessária, mas não ambas. AutoscaleSettingsResource
throughput Valor da taxa de transferência do recurso do Cosmos DB. A taxa de transferência é necessária ou dimensionamento automáticoConfigurações é necessária, mas não ambas. INT

AutoscaleSettingsResource

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

AutoUpgradePolicyResource

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

ThroughputPolicyResource

Name Descrição Valor
incrementPercent Representa o percentual pelo 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

Definição de recurso do 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 de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2024-02-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 propriedade

databaseAccounts/mongodbDatabases/collections/throug...

Name Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2024-02-15-preview"
name O nome do recurso "default"
local O local do grupo de recursos ao qual o recurso pertence. string
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: coleções
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). No máximo 15 marcas podem ser fornecidas para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas.
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para atualizar a taxa de transferência de recursos do Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (obrigatório)

ManagedServiceIdentity

Name 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 'None' removerá todas as identidades do serviço. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids A lista de identidades de usuário associadas ao recurso. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Matriz de IDs de identidade do usuário.

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name Descrição Valor
recurso O formato JSON padrão de uma taxa de transferência de recurso ThroughputSettingsResourceOrThroughputSettingsGetPro... (obrigatório)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name Descrição Valor
autoscaleSettings 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
throughput Valor da taxa de transferência do recurso do Cosmos DB. A taxa de transferência é necessária ou o autoscaleSettings é necessário, mas não ambos. INT

AutoscaleSettingsResource

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

AutoUpgradePolicyResource

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

ThroughputPolicyResource

Name Descrição Valor
incrementPercent 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 o ThroughputPolicy está ativo ou não bool