Base de dados Microsoft.DocumentDBContas/mongodbDatabases/collections/throughputSettings 2022-05-15-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso databaseAccounts/mongodbDatabases/collections/throughputSettings 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.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

databaseAccounts/mongodbDatabases/collections/throug...

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.		 "predefinição"
localização A localização do grupo de recursos ao qual o recurso pertence. string
etiquetas As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas na visualização e agrupamento deste recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Tabela", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: coleções
identidade Identidade do recurso. ManagedServiceIdentity
propriedades Propriedades para atualizar o débito de recursos do Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (obrigatório)

ManagedServiceIdentity

Nome Descrição Valor
tipo O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned,UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço. "Nenhum"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". objeto

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Nome Descrição Valor
recurso O formato JSON padrão de um débito de recurso ThroughputSettingsResourceOrThroughputSettingsGetPro... (obrigatório)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Nome Descrição Valor
dimensionamento automáticoDefinições Recurso do Cosmos DB para definições de dimensionamento automático. O débito é necessário ou o dimensionamento automáticoDefinições é necessário, mas não ambos. AutoscaleSettingsResource
de transferência de dados Valor do débito de recursos do Cosmos DB. O débito é necessário ou o dimensionamento automáticoDefinições é necessário, mas não ambos. int

AutoscaleSettingsResource

Nome Descrição Valor
autoUpgradePolicy Política de atualização automática de recursos do Cosmos DB AutoUpgradePolicyResource
maxThroughput Representa o contentor de débito máximo que pode aumentar verticalmente. int (obrigatório)

AutoUpgradePolicyResource

Nome Descrição Valor
throughputPolicy Representa a política de débito a que o serviço tem de cumprir para a atualização automática ThroughputPolicyResource

ThroughputPolicyResource

Nome Descrição Valor
incrementPercent Representa a percentagem pela qual o débito pode aumentar sempre que a política de débito é iniciada. int
isEnabled Determina se o ThroughputPolicy está ativo ou não bool

Definição de recurso de modelo do ARM

O tipo de recurso databaseAccounts/mongodbDatabases/collections/throughputSettings 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.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

databaseAccounts/mongodbDatabases/collections/throug...

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings"
apiVersion A versão da API de recursos "2022-05-15-preview"
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON.		 "predefinição"
localização A localização do grupo de recursos ao qual o recurso pertence. string
etiquetas As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas na visualização e agrupamento deste recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Tabela", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
identidade Identidade do recurso. ManagedServiceIdentity
propriedades Propriedades para atualizar o débito de recursos do Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (obrigatório)

ManagedServiceIdentity

Nome Descrição Valor
tipo O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned,UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço. "Nenhum"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". objeto

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Nome Descrição Valor
recurso O formato JSON padrão de um débito de recurso ThroughputSettingsResourceOrThroughputSettingsGetPro... (obrigatório)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Nome Descrição Valor
dimensionamento automáticoDefinições Recurso do Cosmos DB para definições de dimensionamento automático. O débito é necessário ou o dimensionamento automáticoDefinições é necessário, mas não ambos. AutoscaleSettingsResource
de transferência de dados Valor do débito de recursos do Cosmos DB. O débito é necessário ou o dimensionamento automáticoDefinições é necessário, mas não ambos. int

AutoscaleSettingsResource

Nome Descrição Valor
autoUpgradePolicy Política de atualização automática de recursos do Cosmos DB AutoUpgradePolicyResource
maxThroughput Representa o contentor de débito máximo que pode aumentar verticalmente. int (obrigatório)

AutoUpgradePolicyResource

Nome Descrição Valor
throughputPolicy Representa a política de débito a que o serviço tem de cumprir para a atualização automática ThroughputPolicyResource

ThroughputPolicyResource

Nome Descrição Valor
incrementPercent Representa a percentagem pela qual o débito pode aumentar sempre que a política de débito é iniciada. int
isEnabled Determina se o ThroughputPolicy está ativo ou não bool

Definição de recurso do Terraform (fornecedor AzAPI)

O tipo de recurso databaseAccounts/mongodbDatabases/collections/throughputSettings pode ser implementado com operações que visam:

  • Grupos de recursos

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.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, adicione o seguinte Terraform ao seu modelo.

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

databaseAccounts/mongodbDatabases/collections/throug...

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2022-05-15-preview"
name O nome do recurso "predefinição"
localização A localização do grupo de recursos ao qual o recurso pertence. string
parent_id O ID do recurso que é o principal para este recurso. ID para recurso do tipo: coleções
etiquetas As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas na visualização e agrupamento deste recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Tabela", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de etiquetas.
identidade Identidade do recurso. ManagedServiceIdentity
propriedades Propriedades para atualizar o débito de recursos do Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (obrigatório)

ManagedServiceIdentity

Nome Descrição Valor
tipo O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned,UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Matriz de IDs de identidade de utilizador.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Nome Descrição Valor
recurso O formato JSON padrão de um débito de recurso ThroughputSettingsResourceOrThroughputSettingsGetPro... (obrigatório)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Nome Descrição Valor
dimensionamento automáticoDefinições Recurso do Cosmos DB para definições de dimensionamento automático. O débito é necessário ou o dimensionamento automáticoDefinições é necessário, mas não ambos. AutoscaleSettingsResource
de transferência de dados Valor do débito de recursos do Cosmos DB. O débito é necessário ou o dimensionamento automáticoDefinições é necessário, mas não ambos. int

AutoscaleSettingsResource

Nome Descrição Valor
autoUpgradePolicy Política de atualização automática de recursos do Cosmos DB AutoUpgradePolicyResource
maxThroughput Representa o contentor de débito máximo que pode aumentar verticalmente. int (obrigatório)

AutoUpgradePolicyResource

Nome Descrição Valor
throughputPolicy Representa a política de débito que o serviço tem de cumprir para a atualização automática ThroughputPolicyResource

ThroughputPolicyResource

Nome Descrição Valor
incrementPercente Representa a percentagem pela qual o débito pode aumentar sempre que a política de débito é iniciada. int
isEnabled Determina se a ThroughputPolicy está ativa ou não bool