Partager via

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/throughputSettings

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts/mongodbDatabases/throughputSettings peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2024-12-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
      throughputBuckets: [
        {
          id: int
          maxThroughputPercentage: int
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

AutoscaleSettingsResource

Nom Description Valeur
autoUpgradePolicy Stratégie de mise à niveau automatique des ressources Cosmos DB AutoUpgradePolicyResource
maxThroughput Représente le nombre maximal de conteneurs à débit pouvant être mis à l’échelle. int (obligatoire)

AutoUpgradePolicyResource

Nom Description Valeur
throughputPolicy Représente la stratégie de débit à laquelle le service doit adhérer pour la mise à niveau automatique ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings

Nom Description Valeur
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource 'default' (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : databaseAccounts/mongodbDatabases
Propriétés Propriétés permettant de mettre à jour le débit des ressources Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

Étiquettes

Nom Description Valeur

DébitBucketResource

Nom Description Valeur
id Représente l’ID du compartiment de débit int (obligatoire)
maxThroughputPercentage Représente le débit maximal de pourcentage qui peut être utilisé par le compartiment int (obligatoire)

ThroughputPolicyResource

Nom Description Valeur
incrementPercent Représente le pourcentage par lequel le débit peut augmenter chaque fois que la stratégie de débit est lancée. Int
isEnabled Détermine si La stratégie de débit est active ou non Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Nom Description Valeur
autoscaleSettings Ressource Cosmos DB pour les paramètres de mise à l’échelle automatique. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. autoscaleSettingsResource
débit Valeur du débit des ressources Cosmos DB. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. Int
débitBuckets Tableau de limites de compartiment de débit à appliquer au conteneur Cosmos DB DébitBucketResource[]

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Nom Description Valeur
ressource Format JSON standard d’un débit de ressources ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (obligatoire)

Définition de ressource de modèle ARM

Le type de ressource databaseAccounts/mongodbDatabases/throughputSettings peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
  "apiVersion": "2024-12-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",
      "throughputBuckets": [
        {
          "id": "int",
          "maxThroughputPercentage": "int"
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

AutoscaleSettingsResource

Nom Description Valeur
autoUpgradePolicy Stratégie de mise à niveau automatique des ressources Cosmos DB AutoUpgradePolicyResource
maxThroughput Représente le nombre maximal de conteneurs à débit pouvant être mis à l’échelle. int (obligatoire)

AutoUpgradePolicyResource

Nom Description Valeur
throughputPolicy Représente la stratégie de débit à laquelle le service doit adhérer pour la mise à niveau automatique ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings

Nom Description Valeur
apiVersion Version de l’API '2024-12-01-preview'
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource 'default' (obligatoire)
Propriétés Propriétés permettant de mettre à jour le débit des ressources Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings'

Étiquettes

Nom Description Valeur

DébitBucketResource

Nom Description Valeur
id Représente l’ID du compartiment de débit int (obligatoire)
maxThroughputPercentage Représente le débit maximal de pourcentage qui peut être utilisé par le compartiment int (obligatoire)

ThroughputPolicyResource

Nom Description Valeur
incrementPercent Représente le pourcentage par lequel le débit peut augmenter chaque fois que la stratégie de débit est lancée. Int
isEnabled Détermine si La stratégie de débit est active ou non Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Nom Description Valeur
autoscaleSettings Ressource Cosmos DB pour les paramètres de mise à l’échelle automatique. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. autoscaleSettingsResource
débit Valeur du débit des ressources Cosmos DB. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. Int
débitBuckets Tableau de limites de compartiment de débit à appliquer au conteneur Cosmos DB DébitBucketResource[]

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Nom Description Valeur
ressource Format JSON standard d’un débit de ressources ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (obligatoire)

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/mongodbDatabases/throughputSettings peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings, ajoutez terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2024-12-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
        throughputBuckets = [
          {
            id = int
            maxThroughputPercentage = int
          }
        ]
      }
    }
  })
}

Valeurs de propriété

AutoscaleSettingsResource

Nom Description Valeur
autoUpgradePolicy Stratégie de mise à niveau automatique des ressources Cosmos DB AutoUpgradePolicyResource
maxThroughput Représente le nombre maximal de conteneurs à débit pouvant être mis à l’échelle. int (obligatoire)

AutoUpgradePolicyResource

Nom Description Valeur
throughputPolicy Représente la stratégie de débit à laquelle le service doit adhérer pour la mise à niveau automatique ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings

Nom Description Valeur
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource 'default' (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : databaseAccounts/mongodbDatabases
Propriétés Propriétés permettant de mettre à jour le débit des ressources Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2024-12-01-preview »

Étiquettes

Nom Description Valeur

DébitBucketResource

Nom Description Valeur
id Représente l’ID du compartiment de débit int (obligatoire)
maxThroughputPercentage Représente le débit maximal de pourcentage qui peut être utilisé par le compartiment int (obligatoire)

ThroughputPolicyResource

Nom Description Valeur
incrementPercent Représente le pourcentage par lequel le débit peut augmenter chaque fois que la stratégie de débit est lancée. Int
isEnabled Détermine si La stratégie de débit est active ou non Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Nom Description Valeur
autoscaleSettings Ressource Cosmos DB pour les paramètres de mise à l’échelle automatique. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. autoscaleSettingsResource
débit Valeur du débit des ressources Cosmos DB. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. Int
débitBuckets Tableau de limites de compartiment de débit à appliquer au conteneur Cosmos DB DébitBucketResource[]

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Nom Description Valeur
ressource Format JSON standard d’un débit de ressources ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (obligatoire)